API / CNCDevice

Class: abstract CNCDevice

src/CNCDevice.ts:21

Extends

• EventEmitter<CNCDeviceEvents>

Extended by

• CNCDeviceGrbl
• CNCDeviceBambu

Constructors

new CNCDevice()

new CNCDevice(): CNCDevice

Returns

CNCDevice

Properties

Accessors

isOpen

Get Signature

get abstract isOpen(): boolean

src/CNCDevice.ts:22

Returns

boolean

Methods

addListener()

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

Returns

this

close()

abstract close(): Promise<void>

src/CNCDevice.ts:26

Returns

Promise<void>

emit()

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

Calls each of the listeners registered for a given event.

Returns

boolean

eventNames()

eventNames(): keyof CNCDeviceEvents

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

Returns

keyof CNCDeviceEvents

home()

abstract home(axes?): Promise<void>

src/CNCDevice.ts:34

Run the homing sequence.

Returns

Promise<void>

listenerCount()

listenerCount(event): number

Return the number of listeners listening to a given event.

Returns

number

listeners()

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

Return the listeners registered for a given event.

Returns

(...args) => void

off()

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

Returns

this

on()

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

Add a listener for a given event.

Returns

this

once()

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

Add a one-time listener for a given event.

Returns

this

open()

abstract open(): Promise<void>

src/CNCDevice.ts:24

Returns

Promise<void>

pause()

abstract pause(): Promise<void>

src/CNCDevice.ts:38

Returns

Promise<void>

removeAllListeners()

removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Returns

this

removeListener()

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

Remove the listeners of a given event.

Returns

this

reset()

abstract reset(): Promise<void>

src/CNCDevice.ts:36

Returns

Promise<void>

resume()

abstract resume(): Promise<void>

src/CNCDevice.ts:40

Returns

Promise<void>

send()

abstract send(line, emitMessage?): Promise<void>

src/CNCDevice.ts:28

Returns

Promise<void>

sendLines()

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

src/CNCDevice.ts:48

Send multiple lines of G-code.

Returns

Promise<void>

A promise that resolves when all lines are sent.