Class RegisterNfcTagScanStartPacket

Command to start NFC scanning for registration.

Hierarchy (View Summary)

AuthPacket
- RegisterNfcTagScanStartPacket

Index

Constructors

Properties

configKey rawPayload opcode

Accessors

Methods

encode toPayload extractConfigKey fromPayload

Constructors

constructor

new RegisterNfcTagScanStartPacket(
configKey: string,
): RegisterNfcTagScanStartPacket
Parameters
- configKey: string
Returns RegisterNfcTagScanStartPacket
Overrides AuthPacket.constructor
- Defined in src/protocol/downlink/RegisterNfcTagScanStartPacket.ts:14

Properties

`Readonly`configKey

configKey: string

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Static` `Readonly`opcode

opcode: REGISTER_NFC_TAG_SCAN_START = BoksOpcode.REGISTER_NFC_TAG_SCAN_START

Accessors

opcode

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

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
Returns Uint8Array
Overrides AuthPacket.toPayload
- Defined in src/protocol/downlink/RegisterNfcTagScanStartPacket.ts:23

`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): RegisterNfcTagScanStartPacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- payload: Uint8Array
Returns RegisterNfcTagScanStartPacket
Overrides AuthPacket.fromPayload
- Defined in src/protocol/downlink/RegisterNfcTagScanStartPacket.ts:18