Skip to content

Commit 9587661

Browse files
authored
Update README.md
1 parent 88d33f1 commit 9587661

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -83,23 +83,22 @@ controller.addListener('connection:read', (data) => {
8383

8484
Name | Description
8585
:--- | :----------
86-
connect | Fired upon a connection including a successful reconnection.
87-
connect_error | Fired upon a connection error.
88-
connect_timeout | Fired upon a connection timeout.
89-
error | Fired when an error occurs.
90-
disconnect | Fired upon a disconnection.
91-
reconnect | Fired upon a successful reconnection.
92-
reconnect_attempt | Fired upon an attempt to reconnect.
93-
reconnecting | Fired upon an attempt to reconnect.
94-
reconnect_error | Fired upon a reconnection attempt error.
95-
reconnect_failed | Fired when couldn't reconnect within reconnectionAttempts.
86+
connect() | Fired upon a connection including a successful reconnection.
87+
connect_error(error) | Fired upon a connection error.
88+
connect_timeout() | Fired upon a connection timeout.
89+
error() | Fired when an error occurs.
90+
disconnect() | Fired upon a disconnection.
91+
reconnect(attempt) | Fired upon a successful reconnection.
92+
reconnect_attempt() | Fired upon an attempt to reconnect.
93+
reconnecting(attempt) | Fired upon a successful reconnection.
94+
reconnect_error(error) | Fired upon a reconnection attempt error.
95+
reconnect_failed() | Fired when couldn't reconnect within `reconnectionAttempts`.
9696
9797
### CNCjs Events
9898
9999
Name | Description
100100
:--- | :----------
101101
startup(data) |
102-
ports(ports) |
103102
config:change() |
104103
task:start(taskId) |
105104
task:finish(taskId, code) |
@@ -115,7 +114,7 @@ connection:read(options, data) |
115114
connection:write(options, data, context) |
116115
feeder:status(status) |
117116
sender:status(status) |
118-
sender:load(name, gcode, context) |
117+
sender:load(data, context) |
119118
sender:unload() |
120119
workflow:state(state) |
121120
message(message) |
@@ -193,13 +192,13 @@ Writes data and a newline character to the open connection.
193192
Gets a list of available serial ports.
194193
195194
#### Arguments
196-
1. [callback] <i>(object)</i>: Called once completed.
195+
1. [callback] <i>(function)</i>: The error-first callback.
197196
198197
### getBaudRates([callback])
199198
Gets a list of supported baud rates.
200199
201200
#### Arguments
202-
1. [callback] <i>(object)</i>: Called once completed.
201+
1. [callback] <i>(function)</i>: The error-first callback.
203202
204203
### getMachineState()
205204
Gets the machine state.

0 commit comments

Comments
 (0)