Class PacketGenerator

A helper class that generates various types of packets.

Constructors

constructor

new PacketGenerator(): PacketGenerator
Returns PacketGenerator

Methods

`Static`antiFake

antiFake(queryType: number): NiimbotPacket
Parameters
- queryType: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:60

`Static`checkLine

checkLine(line: number): NiimbotPacket
Parameters
- line: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:240

`Static`connect

connect(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:48

`Static`firmwareCommit

firmwareCommit(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:322

`Static`firmwareNoMoreChunks

firmwareNoMoreChunks(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:316

`Static`getPrinterInfo

getPrinterInfo(type: PrinterInfoType): NiimbotPacket
Parameters
- type: PrinterInfoType
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:68

`Static`getPrinterStatusData

getPrinterStatusData(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:52

`Static`getSoundSettings

getSoundSettings(soundType: SoundSettingsItemType): NiimbotPacket
Parameters
- soundType: SoundSettingsItemType
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:76

`Static`heartbeat

heartbeat(type: HeartbeatType): NiimbotPacket
Parameters
- type: HeartbeatType
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:80

`Static`labelPositioningCalibration

labelPositioningCalibration(value: number): NiimbotPacket
Parameters
- value: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:290

`Static`mapped

mapped(
sendCmd: RequestCommandId,
data?: Uint8Array<ArrayBufferLike> | number[],
): NiimbotPacket
Maps a request command ID to its corresponding response IDs and creates a packet object. Sends 0x01 as payload by default.
Parameters
- sendCmd: RequestCommandId
- data: Uint8Array<ArrayBufferLike> | number[] = ...
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:36

`Static`pageEnd

pageEnd(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:194

`Static`pageStart

pageStart(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:190

`Static`printBitmapRow

printBitmapRow(
    pos: number,
    repeats: number,
    data: Uint8Array,
    printheadPixels: number,
    countsMode?: "auto" | "split" | "total",
): NiimbotPacket
Parameters
- pos: number
- repeats: number
- data: Uint8Array
- printheadPixels: number
- countsMode: "auto" | "split" | "total" = "auto"
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:202

`Static`printBitmapRowIndexed

printBitmapRowIndexed(
    pos: number,
    repeats: number,
    data: Uint8Array,
    printheadPixels: number,
    countsMode?: "auto" | "split" | "total",
): NiimbotPacket
Printer powers off if black pixel count > 6
Parameters
- pos: number
- repeats: number
- data: Uint8Array
- printheadPixels: number
- countsMode: "auto" | "split" | "total" = "auto"
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:215

`Static`printClear

printClear(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:232

`Static`printEmptySpace

printEmptySpace(pos: number, repeats: number): NiimbotPacket
Parameters
- pos: number
- repeats: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:198

`Static`printEnd

printEnd(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:186

`Static`printerReset

printerReset(): NiimbotPacket
Reset printer settings (sound and maybe some other settings).

Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:152

`Static`printStart1b

printStart1b(): NiimbotPacket
B1 behavior: after pageEnd paper stops at printhead position, on printEnd paper moved further.

D110 behavior: ordinary.

Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:161

`Static`printStart2b

printStart2b(totalPages: number): NiimbotPacket
Parameters
- totalPages: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:165

`Static`printStart7b

printStart7b(totalPages: number, pageColor?: number): NiimbotPacket
B1 behavior: when totalPages > 1 after pageEnd paper stops at printhead position and waits for next page. When last page (totalPages) printed paper moved further.

D110 behavior: ordinary.
Parameters
- totalPages: number
  Declare how many pages will be printed
- pageColor: number = 0
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:177

`Static`printStart9b

printStart9b(
    totalPages: number,
    pageColor?: number,
    quality?: number,
    someFlag?: boolean,
): NiimbotPacket
First seen on D110M v4
Parameters
- totalPages: number
- pageColor: number = 0
- quality: number = 0
- someFlag: boolean = false
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:182

`Static`printStatus

printStatus(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:147

`Static`printTestPage

printTestPage(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:286

`Static`rfidInfo

rfidInfo(): NiimbotPacket
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:56

`Static`sendFirmwareChecksum

sendFirmwareChecksum(crc: number): NiimbotPacket
Parameters
- crc: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:304

`Static`sendFirmwareChunk

sendFirmwareChunk(idx: number, data: Uint8Array): NiimbotPacket
Parameters
- idx: number
- data: Uint8Array
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:310

`Static`setAutoShutDownTime

setAutoShutDownTime(time: AutoShutdownTime): NiimbotPacket
Parameters
- time: AutoShutdownTime
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:64

`Static`setDensity

setDensity(value: number): NiimbotPacket
Parameters
- value: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:84

`Static`setLabelType

setLabelType(value: number): NiimbotPacket
Parameters
- value: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:88

`Static`setPageSize13b

setPageSize13b(
    rows: number,
    cols: number,
    copiesCount: number,
    cutHeight?: number,
    cutType?: number,
    sendAll?: number,
    partHeight?: number,
): NiimbotPacket
First seen on D110M v4
Parameters
- rows: number
- cols: number
- copiesCount: number
- cutHeight: number = 0
- cutType: number = 0
- sendAll: number = 0
- partHeight: number = 0
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:122

`Static`setPageSize2b

setPageSize2b(rows: number): NiimbotPacket
Parameters
- rows: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:92

`Static`setPageSize4b

setPageSize4b(rows: number, cols: number): NiimbotPacket
B1 behavior: strange, first print is blank or printer prints many copies (use setPageSize6b instead)

D110 behavior: ordinary.
Parameters
- rows: number
  Height in pixels
- cols: number
  Width in pixels
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:104

`Static`setPageSize6b

setPageSize6b(rows: number, cols: number, copiesCount: number): NiimbotPacket
Parameters
- rows: number
  Height in pixels
- cols: number
  Width in pixels
- copiesCount: number
  Page instances
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:113

`Static`setPrintQuantity

setPrintQuantity(quantity: number): NiimbotPacket
Parameters
- quantity: number
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:143

`Static`setSoundSettings

setSoundSettings(soundType: SoundSettingsItemType, on: boolean): NiimbotPacket
Parameters
- soundType: SoundSettingsItemType
- on: boolean
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:72

`Static`startFirmwareUpgrade

startFirmwareUpgrade(version: string): NiimbotPacket
Parameters
- version: string
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:294

`Static`writeImageData

writeImageData(
image: EncodedImage,
options?: ImagePacketsGenerateOptions,
): NiimbotPacket[]
Parameters
- image: EncodedImage
- Optionaloptions: ImagePacketsGenerateOptions
Returns NiimbotPacket[]
- Defined in src/packets/packet_generator.ts:244

`Static`writeRfid

writeRfid(data: Uint8Array): NiimbotPacket
Parameters
- data: Uint8Array
Returns NiimbotPacket
- Defined in src/packets/packet_generator.ts:236