Class NiimbotCrc32Packet

NIIMBOT packet object with CRC32 checksum. Used in firmware process.

Hierarchy (View Summary)

NiimbotPacket
- NiimbotCrc32Packet

Index

Constructors

Properties

_command _data HEAD TAIL

Accessors

checksum chunkNumber command data dataLength length oneWay validResponseIds

Methods

toBytes fromBytes

Constructors

constructor

new NiimbotCrc32Packet(
    command: RequestCommandId | ResponseCommandId,
    chunkNumber: RequestCommandId | ResponseCommandId,
    data: Uint8Array<ArrayBufferLike> | number[],
    validResponseIds?: ResponseCommandId[],
): NiimbotCrc32Packet
Parameters
- command: RequestCommandId | ResponseCommandId
- chunkNumber: RequestCommandId | ResponseCommandId
- data: Uint8Array<ArrayBufferLike> | number[]
- validResponseIds: ResponseCommandId[] = []
Returns NiimbotCrc32Packet
Overrides NiimbotPacket.constructor
- Defined in src/packets/packet.ts:167

Properties

`Protected`_command

_command: RequestCommandId | ResponseCommandId

`Protected`_data

_data: Uint8Array

`Static` `Readonly`HEAD

HEAD: Uint8Array<ArrayBuffer> = ...

`Static` `Readonly`TAIL

TAIL: Uint8Array<ArrayBuffer> = ...

Accessors

checksum

get checksum(): number
Calculate CRC checksum from command and data

Returns number
Overrides NiimbotPacket.checksum
- Defined in src/packets/packet.ts:182

chunkNumber

get chunkNumber(): number
Returns number
- Defined in src/packets/packet.ts:177

command

get command(): RequestCommandId | ResponseCommandId
Returns RequestCommandId | ResponseCommandId
Inherited from NiimbotPacket.command
- Defined in src/packets/packet.ts:64

data

get data(): Uint8Array
Returns Uint8Array
Inherited from NiimbotPacket.data
- Defined in src/packets/packet.ts:68

dataLength

get dataLength(): number
Data length (header, command, dataLen, checksum, tail are excluded).

Returns number
Inherited from NiimbotPacket.dataLength
- Defined in src/packets/packet.ts:34

length

get length(): number
Returns number
Inherited from NiimbotPacket.length
- Defined in src/packets/packet.ts:37

oneWay

get oneWay(): boolean
Returns boolean
Inherited from NiimbotPacket.oneWay
- Defined in src/packets/packet.ts:52
set oneWay(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from NiimbotPacket.oneWay
- Defined in src/packets/packet.ts:48

validResponseIds

get validResponseIds(): ResponseCommandId[]
Returns ResponseCommandId[]
Inherited from NiimbotPacket.validResponseIds
- Defined in src/packets/packet.ts:56
set validResponseIds(ids: ResponseCommandId[]): void
Parameters
- ids: ResponseCommandId[]
Returns void
Inherited from NiimbotPacket.validResponseIds
- Defined in src/packets/packet.ts:60

Methods

toBytes

toBytes(): Uint8Array
[0x55, 0x55, CMD, CHUNK_NUMBER, DATA_SIZE, DA =//= TA, CRC32_CHECKSUM, 0xAA, 0xAA]

Returns Uint8Array
Overrides NiimbotPacket.toBytes
- Defined in src/packets/packet.ts:232

`Static`fromBytes

fromBytes(buf: Uint8Array): NiimbotCrc32Packet
Parameters
- buf: Uint8Array
Returns NiimbotCrc32Packet
Overrides NiimbotPacket.fromBytes
- Defined in src/packets/packet.ts:187