Class BoksHistoryEvent`Abstract`

Base class for all Boks History Event packets.

Hierarchy (View Summary)

BoksRXPacket
- BoksHistoryEvent

Index

Constructors

Properties

_opcode _rawPayload? age date rawPayload

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

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

Properties

`Protected` `Readonly`_opcode

_opcode: BoksOpcode

`Protected` `Optional` `Readonly`_rawPayload

_rawPayload?: Uint8Array<ArrayBufferLike>

age

age: number = 0

`Readonly`date

date: Date

`Protected`rawPayload

rawPayload: Uint8Array = ...

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): BoksPacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- _payload: Uint8Array
Returns BoksPacket
Inherited from BoksRXPacket.fromPayload
- Defined in src/protocol/_BoksPacketBase.ts:28