Class NiimbotSerialClient

Uses Web Serial API

Hierarchy (View Summary)

NiimbotAbstractClient
- NiimbotSerialClient

Constructors

constructor

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

Properties

`Readonly`abstraction

abstraction: Abstraction

`Protected`debug

debug: boolean = false

`Protected`info

info: PrinterInfo = {}

`Protected`mutex

mutex: Mutex = ...

`Protected`packetIntervalMs

packetIntervalMs: number = 10

See

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

`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(): Promise<ConnectionInfo>
Connect to printer port.

Returns Promise<ConnectionInfo>
Overrides NiimbotAbstractClient.connect
- Defined in src/client/serial_impl.ts:16

disconnect

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

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

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

fetchPrinterInfo

fetchPrinterInfo(): Promise<PrinterInfo>
Fetches printer information and stores it.

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

getModelMetadata

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

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

getPrinterInfo

getPrinterInfo(): PrinterInfo
Get the stored information about the printer.

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

getPrintTaskType

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

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

`Protected`initialNegotiate

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

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

isConnected

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

Returns boolean
Overrides NiimbotAbstractClient.isConnected
- Defined in src/client/serial_impl.ts:105

isHeartbeatStarted

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

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

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

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

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:197

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:88

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/serial_impl.ts:109

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:325

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:248

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:318

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:257

stopHeartbeat

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

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

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:109

Class NiimbotSerialClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NiimbotSerialClient

Properties

Readonlyabstraction

Protecteddebug

Protectedinfo

Protectedmutex

ProtectedpacketIntervalMs

See

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

connect

Returns Promise<ConnectionInfo>

disconnect

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof ClientEventMap)[]

fetchPrinterInfo

Returns Promise<PrinterInfo>

getModelMetadata

Returns undefined | PrinterModelMeta

getPrinterInfo

Returns PrinterInfo

getPrintTaskType

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

ProtectedinitialNegotiate

Returns Promise<void>

isConnected

Returns boolean

isHeartbeatStarted

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

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

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

ProtectedprocessRawPacket

Parameters

Returns void

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

sendPacket

Parameters

Returns Promise<void>

sendPacketWaitResponse

Parameters

`Readonly`abstraction

`Protected`debug

`Protected`info

`Protected`mutex

`Protected`packetIntervalMs

`Static`prefixed

`Protected`initialNegotiate

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

`Protected`processRawPacket