@@ -83,108 +83,158 @@ controller.addListener('connection:read', (data) => {
8383
8484#### Event : ' startup'
8585* ` data` * (Object )* data object
86- * ` data.availableControllers` * (Array )* A list of available controllers
86+ * ` data.availableControllers` * (Array )* a list of all available controllers
87+
88+ Fired upon system startup.
8789
8890#### Event : ' config:change'
8991
92+ Fired whenever config changes.
93+
9094#### Event : ' task:start'
9195* ` taskId` * (String )* task id
9296
97+ Fired when a task is started.
98+
9399#### Event : ' task:finish'
94100* ` taskId` * (String )* task id
95101* ` code` * (Number )* exit code
96102
103+ Fired when a task is finished.
104+
97105#### Event : ' task:error'
98106* ` taskId` * (String )* task id
99107* ` error` * (Object )* error object
100108
109+ Fired when an error occurred.
110+
101111#### Event : ' controller:type'
102112* ` type` * (String )* controller type
103113
114+ Fired when the controller type changes.
115+
104116#### Event : ' controller:settings'
105117* ` type` * (String )* controller type
106118* ` settings` * (Object )* controller settings
107119
120+ Fired when the controller settings changes.
121+
108122#### Event : ' controller:state'
109123* ` type` * (String )* controller type
110124* ` state` * (Object )* controller state
111125
126+ Fired when the controller state changes.
127+
112128#### Event : ' connection:open'
113129* ` options` * (Object )* connection options
114130
131+ Fired upon a connection open.
132+
115133#### Event : ' connection:close'
116134* ` options` * (Object )* connection options
117135
136+ Fired upon a connection close.
137+
118138#### Event : ' connection:change'
119139* ` options` * (Object )* connection options
120140* ` isOpen` * (Boolean )* True if the connection is open, flase otherwise.
121141
142+ Fired upon a connection change.
143+
122144#### Event : ' connection:error'
123145* ` options` * (Object )* connection options
124146* ` error` * (Object )* error object
125147
148+ Fired upon a connection error.
149+
126150#### Event : ' connection:read'
127151* ` options` * (Object )* connection options
128152* ` data` * (String )* data to read
129153
154+ Fired once a line is received from the connection.
155+
130156#### Event : ' connection:write'
131157* ` options` * (Object )* connection options
132158* ` data` * (String )* data to write
133159* ` context` * (Object )* associated context information
134160
161+ Fired when writing data to the connection.
162+
135163#### Event : ' feeder:status'
136- * ` status` * (Object )* feeder status object
164+ * ` status` * (Object )* feeder status
165+
166+ Fired when the feeder status changes.
137167
138168#### Event : ' sender:status'
139- * ` status` * (Object )* sender status object
169+ * ` status` * (Object )* sender status
170+
171+ Fired when the sender status changes.
140172
141173#### Event : ' sender:load'
142174* ` data` * (String )* data to load
143175* ` context` * (Object )* associated context information
144176
177+ Fired when a G - code program is loaded.
178+
145179#### Event : ' sender:unload'
146180
181+ Fired when a G - code program is unloaded.
182+
147183#### Event : ' workflow:state'
148184* ` state` * (String )* workflow state
149185
186+ Fired when the workflow state changes.
187+
150188#### Event : ' message'
151189* ` message` * (String )* message string
152190
191+ Fired when the server sends message to the client.
192+
153193### Socket .IO Events
154194
155195#### Event : ' connect'
196+
156197Fired upon a connection including a successful reconnection.
157198
158199#### Event : ' connect_error'
159200* ` error` * (Object )* error object
201+
160202Fired upon a connection error.
161203
162204#### Event : ' connect_timeout'
205+
163206Fired upon a connection timeout.
164207
165208#### Event : ' error'
166209* ` error` * (Object )* error object
210+
167211Fired when an error occurs.
168212
169213#### Event : ' disconnect'
170214* ` reason` * (String )* either ' io server disconnect' or ' io client disconnect'
215+
171216Fired upon a disconnection.
172217
173218#### Event : ' reconnect'
174219* ` attempt` * (Number )* reconnection attempt number
220+
175221Fired upon a successful reconnection.
176222
177223#### Event : ' reconnect_attempt'
224+
178225Fired upon an attempt to reconnect.
179226
180227#### Event : ' reconnecting'
181228* ` attempt` * (Number )* reconnection attempt number
229+
182230Fired upon a successful reconnection.
183231
184232#### Event : ' reconnect_error'
233+
185234Fired upon a reconnection attempt error.
186235
187236#### Event : ' reconnect_failed'
237+
188238Fired when couldn' t reconnect within `reconnectionAttempts`.
189239
190240## API Methods
0 commit comments