Class PowerOffHistoryPacket

Log: Power Off event.

Hierarchy (View Summary)

BoksHistoryEvent
- PowerOffHistoryPacket

Index

Constructors

Properties

_opcode _rawPayload? age date rawPayload reason opcode

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new PowerOffHistoryPacket(
    age?: number,
    reason?: number,
    rawPayload?: Uint8Array<ArrayBufferLike>,
): PowerOffHistoryPacket
Parameters
- age: number = 0
- reason: number = 0
- OptionalrawPayload: Uint8Array<ArrayBufferLike>
Returns PowerOffHistoryPacket
Overrides BoksHistoryEvent.constructor
- Defined in src/protocol/uplink/history/PowerOffHistoryPacket.ts:10

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 = ...

`Readonly`reason

reason: number = 0

`Static` `Readonly`opcode

opcode: POWER_OFF = BoksOpcode.POWER_OFF

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