Class OpenDoorPacket

Command to open the door with an optional PIN.

Hierarchy (View Summary)

BoksPacket
- OpenDoorPacket

Index

Constructors

Properties

pin rawPayload opcode

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new OpenDoorPacket(pin: string): OpenDoorPacket
Parameters
- pin: string
Returns OpenDoorPacket
Overrides BoksPacket.constructor
- Defined in src/protocol/downlink/OpenDoorPacket.ts:16

Properties

`Readonly`pin

pin: string

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Static` `Readonly`opcode

opcode: OPEN_DOOR = BoksOpcode.OPEN_DOOR

Accessors

opcode

get opcode(): BoksOpcode
Returns BoksOpcode
Overrides BoksPacket.opcode
- Defined in src/protocol/downlink/OpenDoorPacket.ts:12

Methods

encode

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

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

toPayload

toPayload(): Uint8Array<ArrayBufferLike>
Returns Uint8Array<ArrayBufferLike>
Overrides BoksPacket.toPayload
- Defined in src/protocol/downlink/OpenDoorPacket.ts:25

`Static`fromPayload

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