API / CNCDeviceBambu

Class: CNCDeviceBambu

src/CNCDeviceBambu.ts:22

A CNCDevice implementation for Bambu Lab printers. Original implementation is based on https://github.com/THE-SIMPLE-MARK/bambu-node

Extends

Constructors

new CNCDeviceBambu()

new CNCDeviceBambu(options): CNCDeviceBambu

src/CNCDeviceBambu.ts:33

ParameterType
options{ accessCode: string; host: string; serialNumber: string; }
options.accessCodestring
options.hoststring
options.serialNumberstring

Returns

CNCDeviceBambu

Properties

PropertyModifierType
prefixedstaticstring | boolean

Accessors

isOpen

Get Signature

get isOpen(): boolean

src/CNCDeviceBambu.ts:44

Returns

boolean

Methods

addListener()

addListener<T>(event, fn, context?): this

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT
fn(...args) => void
context?any

Returns

this

close()

close(): Promise<void>

src/CNCDeviceBambu.ts:175

Returns

Promise<void>

emit()

emit<T>(event, ...args): boolean

Calls each of the listeners registered for a given event.

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT
...argsArgumentMap<CNCDeviceEvents>[Extract<T, keyof CNCDeviceEvents>]

Returns

boolean

eventNames()

eventNames(): keyof CNCDeviceEvents

Return an array listing the events for which the emitter has registered listeners.

Returns

keyof CNCDeviceEvents

home()

home(): Promise<void>

src/CNCDeviceBambu.ts:161

Run the homing sequence.

Returns

Promise<void>

listenerCount()

listenerCount(event): number

Return the number of listeners listening to a given event.

ParameterType
eventkeyof CNCDeviceEvents

Returns

number

listeners()

listeners<T>(event): (...args) => void

Return the listeners registered for a given event.

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT

Returns

(...args) => void

off()

off<T>(event, fn?, context?, once?): this

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT
fn?(...args) => void
context?any
once?boolean

Returns

this

on()

on<T>(event, fn, context?): this

Add a listener for a given event.

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT
fn(...args) => void
context?any

Returns

this

once()

once<T>(event, fn, context?): this

Add a one-time listener for a given event.

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT
fn(...args) => void
context?any

Returns

this

open()

open(): Promise<void>

src/CNCDeviceBambu.ts:48

Returns

Promise<void>

pause()

pause(): Promise<void>

src/CNCDeviceBambu.ts:167

Returns

Promise<void>

removeAllListeners()

removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

ParameterType
event?keyof CNCDeviceEvents

Returns

this

removeListener()

removeListener<T>(event, fn?, context?, once?): this

Remove the listeners of a given event.

Type Parameter
T extends keyof CNCDeviceEvents
ParameterType
eventT
fn?(...args) => void
context?any
once?boolean

Returns

this

reset()

reset(): Promise<void>

src/CNCDeviceBambu.ts:165

Returns

Promise<void>

resume()

resume(): Promise<void>

src/CNCDeviceBambu.ts:171

Returns

Promise<void>

send()

send(line): Promise<void>

src/CNCDeviceBambu.ts:143

ParameterType
linestring

Returns

Promise<void>

sendLines()

sendLines(source, totalLines?): Promise<void>

src/CNCDevice.ts:48

Send multiple lines of G-code.

ParameterTypeDescription
sourceGCodeSourceThe source of the G-code.
totalLines?numberThe total number of lines to send.

Returns

Promise<void>

A promise that resolves when all lines are sent.