Class NiimbotBluetoothClient

Uses Web Bluetooth API

Hierarchy (View Summary)

NiimbotAbstractClient
- NiimbotBluetoothClient

Index

Constructors

constructor

Properties

debug heartbeatData mutex packetIntervalMs printerInfo protocol rfidInfo prefixed

Constructors

constructor

new NiimbotBluetoothClient(): NiimbotBluetoothClient
Returns NiimbotBluetoothClient
Inherited from NiimbotAbstractClient.constructor
- Defined in src/client/abstract_client.ts:79

Properties

`Protected`debug

debug: boolean = false

`Protected`heartbeatData

heartbeatData: HeartbeatData = {}

`Protected`mutex

mutex: Mutex = ...

`Protected`packetIntervalMs

packetIntervalMs: number = NIIMBOT_CLIENT_DEFAULTS.packetIntervalMs

See

https://github.com/MultiMote/niimblue/issues/5

`Protected`printerInfo

printerInfo: PrinterInfo = ...

`Readonly`protocol

protocol: NiimbotProtocol

`Protected`rfidInfo

rfidInfo: CombinedRfidInfo = {}

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends keyof ClientEventMap>(
    event: T,
    fn: (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>]) => void
- Optionalcontext: any
Returns this
Inherited from NiimbotAbstractClient.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(options?: NiimbotBluetoothClientConnectOptions): Promise<ConnectionInfo>
Connect to printer port.
Parameters
- Optionaloptions: NiimbotBluetoothClientConnectOptions
Returns Promise<ConnectionInfo>
Overrides NiimbotAbstractClient.connect
- Defined in src/client/bluetooth_impl.ts:56

`Protected`connectNegotiate

connectNegotiate(): Promise<void>
Send "connect" packet and fetch the protocol version.

Returns Promise<void>
Inherited from NiimbotAbstractClient.connectNegotiate
- Defined in src/client/abstract_client.ts:253

disconnect

disconnect(): Promise<void>
Disconnect from printer port.

Returns Promise<void>
Overrides NiimbotAbstractClient.disconnect
- Defined in src/client/bluetooth_impl.ts:149

emit

emit<T extends keyof ClientEventMap>(
event: T,
...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
- ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>]
Returns boolean
Inherited from NiimbotAbstractClient.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof ClientEventMap)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof ClientEventMap)[]
Inherited from NiimbotAbstractClient.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

fetchHeartbeatData

fetchHeartbeatData(): Promise<HeartbeatData | undefined>
Fetch heartbeat information and store it. Emits heartbeat/heartbeatfailed event. Do not throws exceptions.

Returns Promise<HeartbeatData | undefined>
Inherited from NiimbotAbstractClient.fetchHeartbeatData
- Defined in src/client/abstract_client.ts:362

fetchPrinterInfo

fetchPrinterInfo(): Promise<PrinterInfo>
Fetch printer information and store it

Returns Promise<PrinterInfo>
Inherited from NiimbotAbstractClient.fetchPrinterInfo
- Defined in src/client/abstract_client.ts:263

fetchRfidInfo

fetchRfidInfo(): Promise<CombinedRfidInfo>
Fetch label and ribbon RFID information and store it. Do not throws exceptions.

Returns Promise<CombinedRfidInfo>
Inherited from NiimbotAbstractClient.fetchRfidInfo
- Defined in src/client/abstract_client.ts:308

getDebug

getDebug(): boolean
Returns boolean
Inherited from NiimbotAbstractClient.getDebug
- Defined in src/client/abstract_client.ts:522

getHeartbeatAutoStart

getHeartbeatAutoStart(): boolean
Returns boolean
Inherited from NiimbotAbstractClient.getHeartbeatAutoStart
- Defined in src/client/abstract_client.ts:108

getHeartbeatData

getHeartbeatData(): HeartbeatData
Get the stored heartbeat information about RFID tags. Call fetchHeartbeatData to update.

Returns HeartbeatData
Inherited from NiimbotAbstractClient.getHeartbeatData
- Defined in src/client/abstract_client.ts:420

getHeartbeatInterval

getHeartbeatInterval(): number
Returns number
Inherited from NiimbotAbstractClient.getHeartbeatInterval
- Defined in src/client/abstract_client.ts:433

getHeartbeatMaxFails

getHeartbeatMaxFails(): number
Returns number
Inherited from NiimbotAbstractClient.getHeartbeatMaxFails
- Defined in src/client/abstract_client.ts:533

getModelMetadata

getModelMetadata(): PrinterModelMeta | undefined
Get printer capabilities based on the printer model. Model library is hardcoded.

Returns PrinterModelMeta | undefined
Inherited from NiimbotAbstractClient.getModelMetadata
- Defined in src/client/abstract_client.ts:484

getPacketInterval

getPacketInterval(): number
Returns number
Inherited from NiimbotAbstractClient.getPacketInterval
- Defined in src/client/abstract_client.ts:511

getPrinterInfo

getPrinterInfo(): PrinterInfo
Get the stored information about the printer. Call fetchPrinterInfo to update.

Returns PrinterInfo
Inherited from NiimbotAbstractClient.getPrinterInfo
- Defined in src/client/abstract_client.ts:406

getPrintTaskType

getPrintTaskType(): | "B1"
| "B21_L2B"
| "D110"
| "H1S"
| "D11_V1"
| "B21_V1"
| "D110M_V4"
| undefined
Determine print task version if any.

Returns "B1" | "B21_L2B" | "D110" | "H1S" | "D11_V1" | "B21_V1" | "D110M_V4" | undefined
Inherited from NiimbotAbstractClient.getPrintTaskType
- Defined in src/client/abstract_client.ts:494

getRfidInfo

getRfidInfo(): CombinedRfidInfo
Get the stored information about RFID tags. Call fetchRfidInfo to update.

Returns CombinedRfidInfo
Inherited from NiimbotAbstractClient.getRfidInfo
- Defined in src/client/abstract_client.ts:413

getServiceUuidFilter

getServiceUuidFilter(): string[]
Returns string[]
- Defined in src/client/bluetooth_impl.ts:48

getType

getType(): NiimbotClientType
Returns NiimbotClientType
Overrides NiimbotAbstractClient.getType
- Defined in src/client/bluetooth_impl.ts:173

isConnected

isConnected(): boolean
Check if the client is connected.

Returns boolean
Overrides NiimbotAbstractClient.isConnected
- Defined in src/client/bluetooth_impl.ts:144

isFetchRfidOnPrintEnd

isFetchRfidOnPrintEnd(): boolean
Returns boolean
Inherited from NiimbotAbstractClient.isFetchRfidOnPrintEnd
- Defined in src/client/abstract_client.ts:537

isHeartbeatStarted

isHeartbeatStarted(): boolean
Checks if the heartbeat timer has been started.

Returns boolean
Inherited from NiimbotAbstractClient.isHeartbeatStarted
- Defined in src/client/abstract_client.ts:477

listenerCount

listenerCount(event: keyof ClientEventMap): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof ClientEventMap
Returns number
Inherited from NiimbotAbstractClient.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof ClientEventMap>(
    event: T,
): (
    (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void
)[]
Inherited from NiimbotAbstractClient.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

`Protected`negotiateAndGetPrinterInfo

negotiateAndGetPrinterInfo(cleanup?: () => void): Promise<void>
Calls connectNegotiate (exceptions are not ignored) then calls fetchPrinterInfo and fetchRfidInfo (exceptions ignored)
Parameters
- Optionalcleanup: () => void
  cleanup/disconnect function, called when initialNegotiate fails
Returns Promise<void>
Inherited from NiimbotAbstractClient.negotiateAndGetPrinterInfo
- Defined in src/client/abstract_client.ts:339

off

off<T extends keyof ClientEventMap>(
    event: T,
    fn?: (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
- Optionalfn: (...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from NiimbotAbstractClient.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof ClientEventMap>(
    event: T,
    fn: (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>]) => void
- Optionalcontext: any
Returns this
Inherited from NiimbotAbstractClient.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof ClientEventMap>(
    event: T,
    fn: (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>]) => void
- Optionalcontext: any
Returns this
Inherited from NiimbotAbstractClient.once
- Defined in node_modules/eventemitter3/index.d.ts:54

`Protected`processRawPacket

processRawPacket(
data: Uint8Array<ArrayBufferLike> | DataView<ArrayBufferLike>,
): void
Convert raw bytes to packet objects and fire events. Defragmentation included.
Parameters
- data: Uint8Array<ArrayBufferLike> | DataView<ArrayBufferLike>
  Bytes to process.
Returns void
Inherited from NiimbotAbstractClient.processRawPacket
- Defined in src/client/abstract_client.ts:202

removeAllListeners

removeAllListeners(event?: keyof ClientEventMap): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof ClientEventMap
Returns this
Inherited from NiimbotAbstractClient.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof ClientEventMap>(
    event: T,
    fn?: (
        ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof ClientEventMap
Parameters
- event: T
- Optionalfn: (...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from NiimbotAbstractClient.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

sendPacket

sendPacket(packet: NiimbotPacket, force?: boolean): Promise<void>
Parameters
- packet: NiimbotPacket
- Optionalforce: boolean
Returns Promise<void>
Inherited from NiimbotAbstractClient.sendPacket
- Defined in src/client/abstract_client.ts:245

sendPacketWaitResponse

sendPacketWaitResponse(
packet: NiimbotPacket,
timeoutMs?: number,
): Promise<NiimbotPacket>
Send packet and wait for response for timeoutMs milliseconds.

If () validResponseIds is defined, it will wait for packet with this command id.
Parameters
- packet: NiimbotPacket
- timeoutMs: number = 1000
Returns Promise<NiimbotPacket>
Packet object.

Throws
PrintError when ResponseCommandId.In_PrintError or ResponseCommandId.In_NotSupported received.
Inherited from NiimbotAbstractClient.sendPacketWaitResponse
- Defined in src/client/abstract_client.ts:136

sendRaw

sendRaw(data: Uint8Array, force?: boolean): Promise<void>
Send raw bytes to the printer port.
Parameters
- data: Uint8Array
  Bytes to send.
- Optionalforce: boolean
  Ignore mutex lock. It used internally and you should avoid using it.
Returns Promise<void>
Overrides NiimbotAbstractClient.sendRaw
- Defined in src/client/bluetooth_impl.ts:156

setAutoShutdownTime

setAutoShutdownTime(value: AutoShutdownTime): Promise<void>
Parameters
- value: AutoShutdownTime
Returns Promise<void>
Inherited from NiimbotAbstractClient.setAutoShutdownTime
- Defined in src/client/abstract_client.ts:397

setDebug

setDebug(value: boolean): void
Enable some debug information logging.
Parameters
- value: boolean
Returns void
Inherited from NiimbotAbstractClient.setDebug
- Defined in src/client/abstract_client.ts:518

setFetchRfidOnPrintEnd

setFetchRfidOnPrintEnd(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from NiimbotAbstractClient.setFetchRfidOnPrintEnd
- Defined in src/client/abstract_client.ts:541

setHeartbeatAutoStart

setHeartbeatAutoStart(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from NiimbotAbstractClient.setHeartbeatAutoStart
- Defined in src/client/abstract_client.ts:104

setHeartbeatInterval

setHeartbeatInterval(intervalMs: number): void
Set interval for startHeartbeat.
Parameters
- intervalMs: number
  Heartbeat interval, default is 1000ms
Returns void
Inherited from NiimbotAbstractClient.setHeartbeatInterval
- Defined in src/client/abstract_client.ts:429

setHeartbeatMaxFails

setHeartbeatMaxFails(value: number): void
Set max failed heartbeat attempts to disconnect. Use 0 to disable.
Parameters
- value: number
Returns void
Inherited from NiimbotAbstractClient.setHeartbeatMaxFails
- Defined in src/client/abstract_client.ts:529

setPacketInterval

setPacketInterval(milliseconds: number): void
Set the interval between packets in milliseconds.
Parameters
- milliseconds: number
Returns void
Inherited from NiimbotAbstractClient.setPacketInterval
- Defined in src/client/abstract_client.ts:507

setServiceUuidFilter

setServiceUuidFilter(ids: string[]): void
Parameters
- ids: string[]
Returns void
- Defined in src/client/bluetooth_impl.ts:52

setSoundEnabled

setSoundEnabled(soundType: SoundSettingsItemType, value: boolean): Promise<void>
Parameters
- soundType: SoundSettingsItemType
- value: boolean
Returns Promise<void>
Inherited from NiimbotAbstractClient.setSoundEnabled
- Defined in src/client/abstract_client.ts:383

startHeartbeat

startHeartbeat(): void
Starts the heartbeat timer, "heartbeat" is emitted after packet received.

If you need to change interval, call setHeartbeatInterval before.

Returns void
Inherited from NiimbotAbstractClient.startHeartbeat
- Defined in src/client/abstract_client.ts:442

stopHeartbeat

stopHeartbeat(): void
Stops the heartbeat by clearing the interval timer.

Returns void
Inherited from NiimbotAbstractClient.stopHeartbeat
- Defined in src/client/abstract_client.ts:469

waitForPacket

waitForPacket(
    ids?: ResponseCommandId[],
    catchErrorPackets?: boolean,
    timeoutMs?: number,
): Promise<NiimbotPacket>
Send wait for response for timeoutMs milliseconds.

If ids is set, it will wait for packet with this command ids.
Parameters
- ids: ResponseCommandId[] = []
- catchErrorPackets: boolean = true
- timeoutMs: number = 1000
Returns Promise<NiimbotPacket>
Packet object.

Throws
PrintError when ResponseCommandId.In_PrintError or ResponseCommandId.In_NotSupported received and catchErrorPackets is true.
Inherited from NiimbotAbstractClient.waitForPacket
- Defined in src/client/abstract_client.ts:157

Class NiimbotBluetoothClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NiimbotBluetoothClient

Properties

Protecteddebug

ProtectedheartbeatData

Protectedmutex

ProtectedpacketIntervalMs

See

ProtectedprinterInfo

Readonlyprotocol

ProtectedrfidInfo

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

connect

Parameters

Returns Promise<ConnectionInfo>

ProtectedconnectNegotiate

Returns Promise<void>

disconnect

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof ClientEventMap)[]

fetchHeartbeatData

Returns Promise<HeartbeatData | undefined>

fetchPrinterInfo

Returns Promise<PrinterInfo>

fetchRfidInfo

Returns Promise<CombinedRfidInfo>

getDebug

Returns boolean

getHeartbeatAutoStart

Returns boolean

getHeartbeatData

Returns HeartbeatData

getHeartbeatInterval

Returns number

getHeartbeatMaxFails

Returns number

getModelMetadata

Returns PrinterModelMeta | undefined

getPacketInterval

Returns number

getPrinterInfo

Returns PrinterInfo

getPrintTaskType

Returns "B1" | "B21_L2B" | "D110" | "H1S" | "D11_V1" | "B21_V1" | "D110M_V4" | undefined

getRfidInfo

Returns CombinedRfidInfo

getServiceUuidFilter

Returns string[]

getType

Returns NiimbotClientType

isConnected

Returns boolean

isFetchRfidOnPrintEnd

Returns boolean

isHeartbeatStarted

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>], ) => void)[]

`Protected`debug

`Protected`heartbeatData

`Protected`mutex

`Protected`packetIntervalMs

`Protected`printerInfo

`Readonly`protocol

`Protected`rfidInfo

`Static`prefixed

`Protected`connectNegotiate

Returns (
(
...args: ArgumentMap<ClientEventMap>[Extract<T, keyof ClientEventMap>],
) => void
)[]

`Protected`negotiateAndGetPrinterInfo

`Protected`processRawPacket