API / CNCDeviceGrbl

Class: abstract CNCDeviceGrbl

src/CNCDeviceGrbl.ts:31

Extends

• CNCDevice

Extended by

• CNCDeviceNodeSerialGrbl
• CNCDeviceWebSerialGrbl
• CNCDeviceWebSocketGrbl

Constructors

new CNCDeviceGrbl()

new CNCDeviceGrbl(options): CNCDeviceGrbl

src/CNCDeviceGrbl.ts:41

Returns

CNCDeviceGrbl

Properties

Accessors

isOpen

Get Signature

get isOpen(): boolean

src/CNCDeviceGrbl.ts:50

Returns

boolean

Methods

addListener()

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

Returns

this

close()

close(): Promise<void>

src/CNCDeviceGrbl.ts:121

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()

home(axes?): Promise<void>

src/CNCDeviceGrbl.ts:151

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()

open(): Promise<void>

src/CNCDeviceGrbl.ts:54

Returns

Promise<void>

pause()

pause(): Promise<void>

src/CNCDeviceGrbl.ts:176

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()

reset(): Promise<void>

src/CNCDeviceGrbl.ts:161

Returns

Promise<void>

resume()

resume(): Promise<void>

src/CNCDeviceGrbl.ts:181

Returns

Promise<void>

send()

send(line, emitMessage): Promise<void>

src/CNCDeviceGrbl.ts:130

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.

sleep()

sleep(): Promise<void>

src/CNCDeviceGrbl.ts:166

Returns

Promise<void>

unlock()

unlock(): Promise<void>

src/CNCDeviceGrbl.ts:171

Returns

Promise<void>