API / CNCDeviceBambu
Class: CNCDeviceBambu
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
Parameter | Type |
---|---|
options | { accessCode : string ; host : string ; serialNumber : string ; } |
options.accessCode | string |
options.host | string |
options.serialNumber | string |
Returns
Properties
Accessors
isOpen
Get Signature
get isOpen():
boolean
Returns
boolean
Methods
addListener()
addListener<
T
>(event
,fn
,context
?):this
Type Parameter |
---|
T extends keyof CNCDeviceEvents |
Parameter | Type |
---|---|
event | T |
fn | (...args ) => void |
context ? | any |
Returns
this
close()
close():
Promise
<void
>
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 |
Parameter | Type |
---|---|
event | T |
...args | ArgumentMap <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
>
Run the homing sequence.
Returns
Promise
<void
>
listenerCount()
listenerCount(
event
):number
Return the number of listeners listening to a given event.
Parameter | Type |
---|---|
event | keyof CNCDeviceEvents |
Returns
number
listeners()
listeners<
T
>(event
): (...args
) =>void
Return the listeners registered for a given event.
Type Parameter |
---|
T extends keyof CNCDeviceEvents |
Parameter | Type |
---|---|
event | T |
Returns
(...args
) => void
off()
off<
T
>(event
,fn
?,context
?,once
?):this
Type Parameter |
---|
T extends keyof CNCDeviceEvents |
Parameter | Type |
---|---|
event | T |
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 |
Parameter | Type |
---|---|
event | T |
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 |
Parameter | Type |
---|---|
event | T |
fn | (...args ) => void |
context ? | any |
Returns
this
open()
open():
Promise
<void
>
Returns
Promise
<void
>
pause()
pause():
Promise
<void
>
Returns
Promise
<void
>
removeAllListeners()
removeAllListeners(
event
?):this
Remove all listeners, or those of the specified event.
Parameter | Type |
---|---|
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 |
Parameter | Type |
---|---|
event | T |
fn ? | (...args ) => void |
context ? | any |
once ? | boolean |
Returns
this
reset()
reset():
Promise
<void
>
Returns
Promise
<void
>
resume()
resume():
Promise
<void
>
Returns
Promise
<void
>
send()
send(
line
):Promise
<void
>
Parameter | Type |
---|---|
line | string |
Returns
Promise
<void
>
sendLines()
sendLines(
source
,totalLines
?):Promise
<void
>
Send multiple lines of G-code.
Parameter | Type | Description |
---|---|---|
source | GCodeSource | The source of the G-code. |
totalLines ? | number | The total number of lines to send. |
Returns
Promise
<void
>
A promise that resolves when all lines are sent.