Class SetConfigurationPacket

Set configuration (e.g. La Poste NFC).

Hierarchy (View Summary)

AuthPacket
- SetConfigurationPacket

Index

Constructors

Properties

configKey configType rawPayload value opcode

Accessors

Methods

encode toPayload extractConfigKey fromPayload

Constructors

constructor

new SetConfigurationPacket(
    configKey: string,
    configType: number,
    value: boolean,
): SetConfigurationPacket
Parameters
- configKey: string
- configType: number
- value: boolean
Returns SetConfigurationPacket
Overrides AuthPacket.constructor
- Defined in src/protocol/downlink/SetConfigurationPacket.ts:16

Properties

`Readonly`configKey

configKey: string

`Readonly`configType

configType: number

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Readonly`value

value: boolean

`Static` `Readonly`opcode

opcode: SET_CONFIGURATION = BoksOpcode.SET_CONFIGURATION

Accessors

opcode

get opcode(): BoksOpcode
Returns BoksOpcode
Overrides AuthPacket.opcode
- Defined in src/protocol/downlink/SetConfigurationPacket.ts:12

Methods

encode

encode(): Uint8Array
Encodes the full packet: [Opcode, Length, ...Payload, Checksum]

Returns Uint8Array
Inherited from AuthPacket.encode
- Defined in src/protocol/_BoksPacketBase.ts:35

toPayload

toPayload(): Uint8Array<ArrayBuffer>
Returns Uint8Array<ArrayBuffer>
Overrides AuthPacket.toPayload
- Defined in src/protocol/downlink/SetConfigurationPacket.ts:48

`Static`extractConfigKey

extractConfigKey(payload: Uint8Array): string
Helper to quickly extract the config key string from a standard AuthPacket payload.
Parameters
- payload: Uint8Array
Returns string
Inherited from AuthPacket.extractConfigKey
- Defined in src/protocol/downlink/_AuthPacketBase.ts:24

`Static`fromPayload

fromPayload(payload: Uint8Array): SetConfigurationPacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- payload: Uint8Array
Returns SetConfigurationPacket
Overrides AuthPacket.fromPayload
- Defined in src/protocol/downlink/SetConfigurationPacket.ts:24