Class BoksPacketFactory

Factory class for creating Boks packets from raw data.

Index

Constructors

Methods

createFromPayload createRegeneratePackets fromResponse getConstructor

Constructors

constructor

new BoksPacketFactory(): BoksPacketFactory
Returns BoksPacketFactory

Methods

`Static`createFromPayload

createFromPayload(
    data: Uint8Array,
    logger?: (
        level: "info" | "warn" | "error" | "debug",
        event: "checksum_error",
        context: { expected: number; opcode: number; received: number },
    ) => void,
): BoksPacket | undefined
Creates a packet instance from a full raw Bluetooth payload. Expected format: [Opcode, Length, ...Payload, Checksum]
Parameters
- data: Uint8Array
- Optionallogger: (
      level: "info" | "warn" | "error" | "debug",
      event: "checksum_error",
      context: { expected: number; opcode: number; received: number },
  ) => void
Returns BoksPacket | undefined
- Defined in src/protocol/BoksPacketFactory.ts:210

`Static`createRegeneratePackets

createRegeneratePackets(
configKey: string,
newMasterKey: string | Uint8Array<ArrayBufferLike>,
): [RegeneratePartAPacket, RegeneratePartBPacket]
Helper to create regeneration packets from a 32-byte key.
Parameters
- configKey: string
- newMasterKey: string | Uint8Array<ArrayBufferLike>
Returns [RegeneratePartAPacket, RegeneratePartBPacket]
- Defined in src/protocol/BoksPacketFactory.ts:265

`Static`fromResponse

fromResponse(opcode: number, payload: Uint8Array): BoksPacket | undefined
Creates an RX packet instance from an opcode and its payload.
Parameters
- opcode: number
- payload: Uint8Array
Returns BoksPacket | undefined
- Defined in src/protocol/BoksPacketFactory.ts:255

`Static`getConstructor

getConstructor(opcode: number): BoksPacketConstructor | undefined
Get the constructor for a specific opcode.
Parameters
- opcode: number
Returns BoksPacketConstructor | undefined
- Defined in src/protocol/BoksPacketFactory.ts:248