Class CodeKeyValidHistoryPacket

Log: Successful Key code usage (Physical keypad).

Hierarchy (View Summary)

BoksHistoryEvent
- CodeKeyValidHistoryPacket

Index

Constructors

Properties

_opcode _rawPayload? age code date rawPayload opcode

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new CodeKeyValidHistoryPacket(
    age?: number,
    code?: string,
    rawPayload?: Uint8Array<ArrayBufferLike>,
): CodeKeyValidHistoryPacket
Parameters
- age: number = 0
- code: string = ''
- OptionalrawPayload: Uint8Array<ArrayBufferLike>
Returns CodeKeyValidHistoryPacket
Overrides BoksHistoryEvent.constructor
- Defined in src/protocol/uplink/history/CodeKeyValidHistoryPacket.ts:11

Properties

`Protected` `Readonly`_opcode

_opcode: BoksOpcode

`Protected` `Optional` `Readonly`_rawPayload

_rawPayload?: Uint8Array<ArrayBufferLike>

age

age: number = 0

`Readonly`code

code: string = ''

`Readonly`date

date: Date

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Static` `Readonly`opcode

opcode: LOG_CODE_KEY_VALID = BoksOpcode.LOG_CODE_KEY_VALID

Accessors

opcode

get opcode(): BoksOpcode
Returns BoksOpcode
Inherited from BoksHistoryEvent.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 BoksHistoryEvent.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 BoksHistoryEvent.toPayload
- Defined in src/protocol/uplink/_BoksRXPacketBase.ts:25

`Static`fromPayload

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