Class NotifyNfcTagFoundPacket

Notification: NFC Tag found during scan.

Hierarchy (View Summary)

BoksRXPacket
- NotifyNfcTagFoundPacket

Index

Constructors

Properties

_opcode _rawPayload? rawPayload status uid opcode

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new NotifyNfcTagFoundPacket(
uid?: string,
rawPayload?: Uint8Array<ArrayBufferLike>,
): NotifyNfcTagFoundPacket
Parameters
- uid: string = ''
- OptionalrawPayload: Uint8Array<ArrayBufferLike>
Returns NotifyNfcTagFoundPacket
Overrides BoksRXPacket.constructor
- Defined in src/protocol/uplink/NotifyNfcTagFoundPacket.ts:12

Properties

`Protected` `Readonly`_opcode

_opcode: BoksOpcode

`Protected` `Optional` `Readonly`_rawPayload

_rawPayload?: Uint8Array<ArrayBufferLike>

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Readonly`status

status: "found" = 'found'

`Readonly`uid

uid: string = ''

`Static` `Readonly`opcode

opcode: NOTIFY_NFC_TAG_FOUND = BoksOpcode.NOTIFY_NFC_TAG_FOUND

Accessors

opcode

get opcode(): BoksOpcode
Returns BoksOpcode
Inherited from BoksRXPacket.opcode
- Defined in src/protocol/uplink/_BoksRXPacketBase.ts:18

Methods

encode

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

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

toPayload

toPayload(): Uint8Array<ArrayBufferLike>
For RX packets, toPayload returns the raw payload received.

Returns Uint8Array<ArrayBufferLike>
Inherited from BoksRXPacket.toPayload
- Defined in src/protocol/uplink/_BoksRXPacketBase.ts:25

`Static`fromPayload

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