settings

type AesGcmParameter struct {
	InvocationCounter uint64

	// xml  This is used only on xml parser.
	Xml *GXDLMSTranslatorStructure

	Tag uint8

	// Used transaction ID.
	TransactionId uint64

	Settings *GXDLMSSettings
	// Is data send as a broadcast or unicast.
	Broacast bool

	// V.44 Compression is used.
	Compression bool

	Type CountType

	CountTag []byte

	// Date time.
	DateTime []byte

	// Other information.
	OtherInformation []byte

	// Key parameters.
	KeyParameters int

	// Key ciphered datg.
	KeyCipheredData []byte

	// Ciphered content.
	CipheredContent []byte

	// Signature.
	Signature []byte

	// Used security suite.
	SecuritySuite enums.SecuritySuite

	// System title is not send on pre-established connections.
	IgnoreSystemTitle bool
	// contains filtered or unexported fields
}

type CountType int

type GXCoAPSettings struct {

	// CoAP version.
	Version uint8

	// CoAP type.
	Type constants.CoAPType

	// CoAP class code.
	Class constants.CoAPClass

	// CoAP Method.
	Method constants.CoAPMethod

	// CoAP Success.
	Success constants.CoAPSuccess

	// CoAP client error.
	ClientError constants.CoAPClientError

	// CoAP server error.
	ServerError constants.CoAPServerError

	// CoAP signaling.
	Signaling constants.CoAPSignaling

	// CoAP message Id.
	MessageId uint16

	// CoAP token.
	Token uint64

	// Uri host.
	Host string

	// Uri Path.
	Path string

	// Uri port.
	Port uint16

	// If none match.
	IfNoneMatch enums.CoAPContentType

	// Content format.
	ContentFormat enums.CoAPContentType

	// Max age.
	MaxAge uint16

	// Unknown options.
	Options map[uint16]any
	// contains filtered or unexported fields
}

type GXDLMSGateway struct {
	// NetworkID is the network ID.
	NetworkID uint8
	// PhysicalDeviceAddress is the physical device address.
	PhysicalDeviceAddress []byte
}

type GXDLMSPrimeDataConcentrator struct {
	// MacAddress is the MAC address.
	MacAddress []byte
}

type GXDLMSSettings struct {

	// LongInvokeID is the long Invoke ID.
	LongInvokeID uint32

	// SenderFrame is the HDLC sender frame sequence number.
	SenderFrame uint8

	// ReceiverFrame is the HDLC receiver frame sequence number.
	ReceiverFrame uint8

	// ClientPublicKeyCertificate is the optional ECDSA public key certificate that is sent in part of AARQ.
	ClientPublicKeyCertificate *types.GXx509Certificate

	// ServerPublicKeyCertificate is the optional ECDSA public key certificate that is sent in part of AARE.
	ServerPublicKeyCertificate *types.GXx509Certificate

	// PreEstablishedSystemTitle is the pre-established system title.
	PreEstablishedSystemTitle []byte

	// Kek is the Key Encrypting Key, also known as Master key.
	Kek []byte

	// Count is the Long data count.
	Count uint32

	// Index is the Long data index.
	Index uint32

	// TargetEphemeralKey is the target ephemeral public key.
	TargetEphemeralKey interface{} // TODO: Replace with actual GXPublicKey type when implemented

	// ProtocolVersion is the protocol version.
	ProtocolVersion string

	// ProposedConformance is what client tells it wants to use when connection is made.
	ProposedConformance enums.Conformance

	// NegotiatedConformance is what server tells is available and client will know it.
	NegotiatedConformance enums.Conformance

	// Cipher is the cipher interface.
	// GXDLMSAssociationShortName and GXDLMSAssociationLogicalName use this if GMAC authentication is used.
	Cipher GXICipher

	// UserID is the identifier of the user.
	// This value is used if user list on Association LN is used.
	UserID int

	// QualityOfService is the quality of service.
	QualityOfService uint8

	// UseUtc2NormalTime indicates if meter is configured to use UTC time (UTC to normal time).
	// Standard says that Time zone is from normal time to UTC in minutes.
	// If meter is configured to use UTC time (UTC to normal time) set this to true.
	UseUtc2NormalTime bool

	// DateTimeSkips are the skipped date time fields.
	// This value can be used if meter can't handle deviation or status.
	DateTimeSkips enums.DateTimeSkips

	// Standard is the used standard.
	Standard enums.Standard

	// Command is the last executed command.
	Command enums.Command

	// CommandType is the last executed command type.
	CommandType uint8

	// InvocationCounter is the invocation counter object.
	InvocationCounter interface{}

	// EphemeralKek is the ephemeral KEK.
	EphemeralKek []byte

	// EphemeralBlockCipherKey is the ephemeral Block cipher key.
	EphemeralBlockCipherKey []byte

	// EphemeralBroadcastBlockCipherKey is the ephemeral broadcast block cipherKey.
	EphemeralBroadcastBlockCipherKey []byte

	// EphemeralAuthenticationKey is the ephemeral authentication key.
	EphemeralAuthenticationKey []byte

	// Keys is the list of certificates to decrypt the data (for XML).
	Keys []*types.GXKeyValuePair[*types.GXPkcs8, *types.GXx509Certificate]

	// UseCustomChallenge indicates if custom challenges are used.
	// If custom challenge is used new challenge is not generated if it is set.
	// This is for debugging purposes.
	UseCustomChallenge bool

	// StartingBlockIndex is the starting block index.
	// Default is One based, but some meters use Zero based value.
	// Usually this is not used.
	StartingBlockIndex uint32

	// DLMSVersion is the DLMS version number.
	DLMSVersion uint8

	// BlockIndex is the current block index.
	BlockIndex uint32

	// Priority is the used priority.
	Priority enums.Priority

	// ServiceClass is the used service class.
	ServiceClass enums.ServiceClass

	// Objects is the collection of the objects.
	Objects interface{}

	// Authentication is the used authentication.
	Authentication enums.Authentication

	// Password is the client password.
	Password []byte

	// Closing indicates if connection is closing.
	// Some meters might return invalid data when disconnect is called and cause infinity loop.
	// This property is used to ignore it.
	Closing bool

	// Connected is the connection state.
	Connected enums.ConnectionState

	// BlockNumberAck is the block number acknowledged in GBT.
	BlockNumberAck uint16

	// OverwriteAttributeAccessRights indicates if association view tells wrong access rights and they are overwritten.
	OverwriteAttributeAccessRights bool

	// Hdlc contains HDLC framing
	Hdlc *GXHdlcSettings

	// Gateway contains gateway
	Gateway *GXDLMSGateway

	// Plc contains PLC
	Plc *GXPlcSettings

	// MBus contains M-Bus
	MBus *GXMBusSettings

	// Pdu contains PDU
	Pdu *GXPduSettings

	// Coap contains CoAP
	Coap *GXCoAPSettings

	// Broadcast indicates if data is sent as a broadcast or unicast.
	Broadcast bool

	// Compression indicates if V.44 Compression is used.
	Compression bool

	// InterfaceType is the used interface.
	InterfaceType enums.InterfaceType

	// ClientAddress is the client address.
	ClientAddress int

	// PushClientAddress is the address server uses when sending push messages.
	// Client address is used if PushAddress is zero.
	PushClientAddress int

	// GbtCount is the General Block Transfer count in server.
	GbtCount uint8

	// ServerAddress is the server address.
	ServerAddress int

	// ServerAddressSize is the size of Server address.
	ServerAddressSize uint8

	// Version can be used for backward compatibility.
	Version int

	// AutoIncreaseInvokeID indicates if Invoke ID is auto increased.
	AutoIncreaseInvokeID bool

	// CryptoNotifier for external HSM operations.
	CryptoNotifier interface{} // TODO: Replace with GXCryptoNotifier when implemented
	// contains filtered or unexported fields
}

type GXDLMSTranslatorStructure struct {
	ShowStringAsHex bool

	// Are comments added.
	Comments bool

	// Are spaces ignored.
	IgnoreSpaces bool
	// contains filtered or unexported fields
}

type GXHdlcSettings struct {
	// contains filtered or unexported fields
}

type GXICipher interface {
	// Used security level.
	Security() enums.Security

	// Set security level.
	SetSecurity(value enums.Security) error

	SetSecurityChangeCheck(value bool) error

	// Used security policy.
	SecurityPolicy() enums.SecurityPolicy

	// Set security policy.
	SetSecurityPolicy(value enums.SecurityPolicy) error

	// Used security suite.
	SecuritySuite() enums.SecuritySuite

	// System title.
	SystemTitle() []byte

	// Recipient system title.
	RecipientSystemTitle() []byte

	// Block cipher key.
	BlockCipherKey() []byte

	// Broadcast block cipher key.
	BroadcastBlockCipherKey() []byte

	// Authentication key.
	AuthenticationKey() []byte

	// Dedicated key.
	DedicatedKey() []byte

	// InvocationCounter returns the invocation counter value.
	InvocationCounter() uint32

	// SetInvocationCounter sets the invocation counter value.
	SetInvocationCounter(value uint32) error

	// Transaction Id.
	TransactionId() []byte

	// Ephemeral key pair.
	EphemeralKeyPair() *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]

	// Client's key agreement key pair.
	KeyAgreementKeyPair() *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]

	// Available certificates.
	Certificates() []types.GXx509Certificate

	// Signing key pair.
	SigningKeyPair() *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]

	// TLS signing key pair.
	TLSKeyPair() *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]

	// Used signing.
	Signing() enums.Signing

	// Used signing and ciphering order.
	SignCipherOrder() enums.SignCipherOrder

	// Are Initiate Request and Response signed.
	SignInitiateRequestResponse() bool

	//Reset returns the reset encrypt settings.
	Reset()

	// SetSystemTitle sets the system title.
	SetSystemTitle(value []byte) error

	// SetSecuritySuite sets the used security suite.
	SetSecuritySuite(value enums.SecuritySuite) error

	// Ephemeral key pair.
	SetEphemeralKeyPair(value *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]) error

	// Client's key agreement key pair.
	SetKeyAgreementKeyPair(value *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]) error

	// Signing key pair.
	SetSigningKeyPair(value *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]) error

	// TLS signing key pair.
	SetTLSKeyPair(value *types.GXKeyValuePair[*types.GXPublicKey, *types.GXPrivateKey]) error

	// SetBlockCipherKey sets the block cipher key.
	SetBlockCipherKey(value []byte) error

	// SetBroadcastBlockCipherKey sets the broadcast block cipher key.
	SetBroadcastBlockCipherKey(value []byte) error

	// SetAuthenticationKey sets the authentication key.
	SetAuthenticationKey(value []byte) error

	// SetDedicatedKey sets the dedicated key.
	SetDedicatedKey(value []byte) error

	// SetRecipientSystemTitle sets the recipient system title.
	SetRecipientSystemTitle(value []byte) error

	// SetSigning sets the used signing.
	SetSigning(value enums.Signing) error
}

type GXMBusSettings struct {
	// Device identification number.
	Id uint32

	// Manufacturer Id.
	ManufacturerId string

	// Version.
	Version uint8

	// Device type.
	MeterType constants.MBusMeterType
}

type GXPduSettings struct {
	// Time to wait in ms for PDU to fully received.
	// Because there is no end of the packet or data length app must wait given time to expect PDU to fully received.
	WaitTime uint16
}

type GXPlcSettings struct {

	// Initial credit (IC) tells how many times the frame must be repeated. Maximum value is 7.
	InitialCredit uint8

	// The current credit (CC) initial value equal to IC and automatically decremented by the MAC layer after each repetition.
	//          Maximum value is 7.
	CurrentCredit uint8

	// Delta credit (DC) is used by the system management application entity
	//          (SMAE) of the Client for credit management, while it has no meaning for a Server or a REPEATER.
	//          It represents the difference(IC-CC) of the last communication originated by the system identified by the DA address to the system identified by the SA address.
	//           Maximum value is 3.
	DeltaCredit uint8

	// Source MAC address.
	MacSourceAddress uint16

	// Destination MAC address.
	MacDestinationAddress uint16

	// Response probability.
	ResponseProbability uint8

	// Allowed time slots.
	AllowedTimeSlots uint16

	// Server saves client system title.
	ClientSystemTitle []byte
	// contains filtered or unexported fields
}