Class Abstraction

Packet sender and parser.

Constructors

constructor

new Abstraction(client: NiimbotAbstractClient): Abstraction
Parameters
- client: NiimbotAbstractClient
Returns Abstraction
- Defined in src/packets/abstraction.ts:34

Methods

connectResult

connectResult(): Promise<ConnectResult>
Returns Promise<ConnectResult>
- Defined in src/packets/abstraction.ts:103

firmwareUpgrade

firmwareUpgrade(data: Uint8Array, version: string): Promise<void>
Parameters
- data: Uint8Array
- version: string
Returns Promise<void>
- Defined in src/packets/abstraction.ts:434

getAutoShutDownTime

getAutoShutDownTime(): Promise<AutoShutdownTime>
Returns Promise<AutoShutdownTime>
- Defined in src/packets/abstraction.ts:238

getBatteryChargeLevel

getBatteryChargeLevel(): Promise<BatteryChargeLevel>
Returns Promise<BatteryChargeLevel>
- Defined in src/packets/abstraction.ts:232

getClient

getClient(): NiimbotAbstractClient
Returns NiimbotAbstractClient
- Defined in src/packets/abstraction.ts:38

getHardwareVersion

getHardwareVersion(): Promise<string>
May be wrong, version format varies between models

Returns Promise<string>
- Defined in src/packets/abstraction.ts:258

getLabelType

getLabelType(): Promise<LabelType>
Returns Promise<LabelType>
- Defined in src/packets/abstraction.ts:274

getPacketTimeout

getPacketTimeout(): number
Returns number
- Defined in src/packets/abstraction.ts:42

getPrinterBluetoothMacAddress

getPrinterBluetoothMacAddress(): Promise<string>
Returns Promise<string>
- Defined in src/packets/abstraction.ts:295

getPrinterModel

getPrinterModel(): Promise<number>
Returns Promise<number>
- Defined in src/packets/abstraction.ts:134

getPrinterSerialNumber

getPrinterSerialNumber(): Promise<string>
Returns Promise<string>
- Defined in src/packets/abstraction.ts:280

getPrinterStatusData

getPrinterStatusData(): Promise<PrinterStatusData>
Returns Promise<PrinterStatusData>
- Defined in src/packets/abstraction.ts:109

getPrintStatus

getPrintStatus(tries?: number): Promise<PrintStatus>
Parameters
- tries: number = 1
Returns Promise<PrintStatus>
- Defined in src/packets/abstraction.ts:81

getSoftwareVersion

getSoftwareVersion(): Promise<string>
May be wrong, version format varies between models

Returns Promise<string>
- Defined in src/packets/abstraction.ts:245

heartbeat

heartbeat(): Promise<HeartbeatData>
Returns Promise<HeartbeatData>
- Defined in src/packets/abstraction.ts:182

isSoundEnabled

isSoundEnabled(soundType: SoundSettingsItemType): Promise<boolean>
Parameters
- soundType: SoundSettingsItemType
Returns Promise<boolean>
- Defined in src/packets/abstraction.ts:301

labelPositioningCalibration

labelPositioningCalibration(value: number): Promise<boolean>
When 1 or 2 sent to B1, it starts to throw out some, paper (~15cm)
Parameters
- value: number
  success
Returns Promise<boolean>
- Defined in src/packets/abstraction.ts:428

newPrintTask

newPrintTask(
name: "B1" | "D110" | "D11_V1" | "B21_V1" | "D110M_V4",
options?: Partial<PrintOptions>,
): AbstractPrintTask
Parameters
- name: "B1" | "D110" | "D11_V1" | "B21_V1" | "D110M_V4"
- Optionaloptions: Partial<PrintOptions>
Returns AbstractPrintTask
- Defined in src/packets/abstraction.ts:486

printEnd

printEnd(): Promise<boolean>
False returned when printEnd refused

Returns Promise<boolean>
- Defined in src/packets/abstraction.ts:418

printerReset

printerReset(): Promise<void>
Clear settings

Returns Promise<void>
- Defined in src/packets/abstraction.ts:313

rfidInfo

rfidInfo(): Promise<RfidInfo>
Read paper nfc tag info

Returns Promise<RfidInfo>
- Defined in src/packets/abstraction.ts:147

send

send(packet: NiimbotPacket, forceTimeout?: number): Promise<NiimbotPacket>
Send packet and wait for response
Parameters
- packet: NiimbotPacket
- OptionalforceTimeout: number
Returns Promise<NiimbotPacket>
- Defined in src/packets/abstraction.ts:55

sendAll

sendAll(packets: NiimbotPacket[], forceTimeout?: number): Promise<void>
Parameters
- packets: NiimbotPacket[]
- OptionalforceTimeout: number
Returns Promise<void>
- Defined in src/packets/abstraction.ts:75

sendRepeatUntilSuccess

sendRepeatUntilSuccess(
    packet: NiimbotPacket,
    attempts: number,
    forceTimeout?: number,
): Promise<NiimbotPacket>
Send packet, wait for response, repeat if failed
Parameters
- packet: NiimbotPacket
- attempts: number
- OptionalforceTimeout: number
Returns Promise<NiimbotPacket>
- Defined in src/packets/abstraction.ts:60

setAutoShutDownTime

setAutoShutDownTime(time: AutoShutdownTime): Promise<void>
Parameters
- time: AutoShutdownTime
Returns Promise<void>
- Defined in src/packets/abstraction.ts:270

setDefaultPacketTimeout

setDefaultPacketTimeout(): void
Returns void
- Defined in src/packets/abstraction.ts:50

setPacketTimeout

setPacketTimeout(value: number): void
Parameters
- value: number
Returns void
- Defined in src/packets/abstraction.ts:46

setSoundEnabled

setSoundEnabled(soundType: SoundSettingsItemType, value: boolean): Promise<void>
Parameters
- soundType: SoundSettingsItemType
- value: boolean
Returns Promise<void>
- Defined in src/packets/abstraction.ts:308

waitUntilPrintFinishedByPageIndex

waitUntilPrintFinishedByPageIndex(
pagesToPrint: number,
timeoutMs?: number,
): Promise<void>
Parameters
- pagesToPrint: number
- timeoutMs: number = 5_000
Returns Promise<void>
- Defined in src/packets/abstraction.ts:317

waitUntilPrintFinishedByPrintEndPoll

waitUntilPrintFinishedByPrintEndPoll(
pagesToPrint: number,
pollIntervalMs?: number,
): Promise<void>
Poll printer every pollIntervalMs and resolve when printer pages equals pagesToPrint.

printprogress event is firing during this process.

PrintEnd call is not needed after this functions is done running.
Parameters
- pagesToPrint: number
  Total pages to print.
- pollIntervalMs: number = 500
  Poll interval in milliseconds.
Returns Promise<void>
- Defined in src/packets/abstraction.ts:394

waitUntilPrintFinishedByStatusPoll

waitUntilPrintFinishedByStatusPoll(
pagesToPrint: number,
pollIntervalMs?: number,
): Promise<void>
Poll printer every pollIntervalMs and resolve when printer pages equals pagesToPrint, pagePrintProgress=100, pageFeedProgress=100.

printprogress event is firing during this process.
Parameters
- pagesToPrint: number
  Total pages to print.
- pollIntervalMs: number = 300
  Poll interval in milliseconds.
Returns Promise<void>
- Defined in src/packets/abstraction.ts:359

Class Abstraction

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Abstraction

Methods

connectResult

Returns Promise<ConnectResult>

firmwareUpgrade

Parameters

Returns Promise<void>

getAutoShutDownTime

Returns Promise<AutoShutdownTime>

getBatteryChargeLevel

Returns Promise<BatteryChargeLevel>

getClient

Returns NiimbotAbstractClient

getHardwareVersion

Returns Promise<string>

getLabelType

Returns Promise<LabelType>

getPacketTimeout

Returns number

getPrinterBluetoothMacAddress

Returns Promise<string>

getPrinterModel

Returns Promise<number>

getPrinterSerialNumber

Returns Promise<string>

getPrinterStatusData

Returns Promise<PrinterStatusData>

getPrintStatus

Parameters

Returns Promise<PrintStatus>

getSoftwareVersion

Returns Promise<string>

heartbeat

Returns Promise<HeartbeatData>

isSoundEnabled

Parameters

Returns Promise<boolean>

labelPositioningCalibration

Parameters

Returns Promise<boolean>

newPrintTask

Parameters

Returns AbstractPrintTask

printEnd

Returns Promise<boolean>

printerReset

Returns Promise<void>

rfidInfo

Returns Promise<RfidInfo>

send

Parameters

Returns Promise<NiimbotPacket>

sendAll

Parameters

Returns Promise<void>

sendRepeatUntilSuccess

Parameters

Returns Promise<NiimbotPacket>

setAutoShutDownTime

Parameters

Returns Promise<void>

setDefaultPacketTimeout

Returns void

setPacketTimeout

Parameters

Returns void

setSoundEnabled

Parameters

Returns Promise<void>

waitUntilPrintFinishedByPageIndex

Parameters

Returns Promise<void>

waitUntilPrintFinishedByPrintEndPoll