-
Notifications
You must be signed in to change notification settings - Fork 21
/
serial.clj
367 lines (270 loc) · 15.4 KB
/
serial.clj
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
(ns chromex.app.serial
"Use the chrome.serial API to read from and write to a device
connected to a serial port.
* available since Chrome 33
* https://developer.chrome.com/apps/serial"
(:refer-clojure :only [defmacro defn apply declare meta let partial])
(:require [chromex.wrapgen :refer [gen-wrap-helper]]
[chromex.callgen :refer [gen-call-helper gen-tap-all-events-call]]))
(declare api-table)
(declare gen-call)
; -- functions --------------------------------------------------------------------------------------------------------------
(defmacro get-devices
"Returns information about available serial devices on the system. The list is regenerated each time this method is called.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [ports] where:
|ports| - https://developer.chrome.com/apps/serial#property-callback-ports.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-getDevices."
([] (gen-call :function ::get-devices &form)))
(defmacro connect
"Connects to a given serial port.
|path| - The system path of the serial port to open.
|options| - Port configuration options.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [connection-info] where:
|connection-info| - https://developer.chrome.com/apps/serial#property-callback-connectionInfo.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-connect."
([path options] (gen-call :function ::connect &form path options))
([path] `(connect ~path :omit)))
(defmacro update
"Update the option settings on an open serial port connection.
|connection-id| - The id of the opened connection.
|options| - Port configuration options.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [result] where:
|result| - https://developer.chrome.com/apps/serial#property-callback-result.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-update."
([connection-id options] (gen-call :function ::update &form connection-id options)))
(defmacro disconnect
"Disconnects from a serial port.
|connection-id| - The id of the opened connection.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [result] where:
|result| - https://developer.chrome.com/apps/serial#property-callback-result.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-disconnect."
([connection-id] (gen-call :function ::disconnect &form connection-id)))
(defmacro set-paused
"Pauses or unpauses an open connection.
|connection-id| - The id of the opened connection.
|paused| - Flag to indicate whether to pause or unpause.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [].
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-setPaused."
([connection-id paused] (gen-call :function ::set-paused &form connection-id paused)))
(defmacro get-info
"Retrieves the state of a given connection.
|connection-id| - The id of the opened connection.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [connection-info] where:
|connection-info| - https://developer.chrome.com/apps/serial#property-callback-connectionInfo.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-getInfo."
([connection-id] (gen-call :function ::get-info &form connection-id)))
(defmacro get-connections
"Retrieves the list of currently opened serial port connections owned by the application.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [connection-infos] where:
|connection-infos| - https://developer.chrome.com/apps/serial#property-callback-connectionInfos.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-getConnections."
([] (gen-call :function ::get-connections &form)))
(defmacro send
"Writes data to the given connection.
|connection-id| - The id of the connection.
|data| - The data to send.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [send-info] where:
|send-info| - https://developer.chrome.com/apps/serial#property-callback-sendInfo.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-send."
([connection-id data] (gen-call :function ::send &form connection-id data)))
(defmacro flush
"Flushes all bytes in the given connection's input and output buffers.
|connection-id| - https://developer.chrome.com/apps/serial#property-flush-connectionId.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [result] where:
|result| - https://developer.chrome.com/apps/serial#property-callback-result.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-flush."
([connection-id] (gen-call :function ::flush &form connection-id)))
(defmacro get-control-signals
"Retrieves the state of control signals on a given connection.
|connection-id| - The id of the connection.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [signals] where:
|signals| - https://developer.chrome.com/apps/serial#property-callback-signals.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-getControlSignals."
([connection-id] (gen-call :function ::get-control-signals &form connection-id)))
(defmacro set-control-signals
"Sets the state of control signals on a given connection.
|connection-id| - The id of the connection.
|signals| - The set of signal changes to send to the device.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [result] where:
|result| - https://developer.chrome.com/apps/serial#property-callback-result.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-setControlSignals."
([connection-id signals] (gen-call :function ::set-control-signals &form connection-id signals)))
(defmacro set-break
"Suspends character transmission on a given connection and places the transmission line in a break state until the
clearBreak is called.
|connection-id| - The id of the connection.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [result] where:
|result| - https://developer.chrome.com/apps/serial#property-callback-result.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-setBreak."
([connection-id] (gen-call :function ::set-break &form connection-id)))
(defmacro clear-break
"Restore character transmission on a given connection and place the transmission line in a nonbreak state.
|connection-id| - The id of the connection.
This function returns a core.async channel of type `promise-chan` which eventually receives a result value.
Signature of the result value put on the channel is [result] where:
|result| - https://developer.chrome.com/apps/serial#property-callback-result.
In case of an error the channel closes without receiving any value and relevant error object can be obtained via
chromex.error/get-last-error.
https://developer.chrome.com/apps/serial#method-clearBreak."
([connection-id] (gen-call :function ::clear-break &form connection-id)))
; -- events -----------------------------------------------------------------------------------------------------------------
;
; docs: https://github.com/binaryage/chromex/#tapping-events
(defmacro tap-on-receive-events
"Event raised when data has been read from the connection.
Events will be put on the |channel| with signature [::on-receive [info]] where:
|info| - Event data.
Note: |args| will be passed as additional parameters into Chrome event's .addListener call.
https://developer.chrome.com/apps/serial#event-onReceive."
([channel & args] (apply gen-call :event ::on-receive &form channel args)))
(defmacro tap-on-receive-error-events
"Event raised when an error occurred while the runtime was waiting for data on the serial port. Once this event is raised,
the connection may be set to paused. A 'timeout' error does not pause the connection.
Events will be put on the |channel| with signature [::on-receive-error [info]] where:
|info| - https://developer.chrome.com/apps/serial#property-onReceiveError-info.
Note: |args| will be passed as additional parameters into Chrome event's .addListener call.
https://developer.chrome.com/apps/serial#event-onReceiveError."
([channel & args] (apply gen-call :event ::on-receive-error &form channel args)))
; -- convenience ------------------------------------------------------------------------------------------------------------
(defmacro tap-all-events
"Taps all valid non-deprecated events in chromex.app.serial namespace."
[chan]
(gen-tap-all-events-call api-table (meta &form) chan))
; ---------------------------------------------------------------------------------------------------------------------------
; -- API TABLE --------------------------------------------------------------------------------------------------------------
; ---------------------------------------------------------------------------------------------------------------------------
(def api-table
{:namespace "chrome.serial",
:since "33",
:functions
[{:id ::get-devices,
:name "getDevices",
:callback? true,
:params [{:name "callback", :type :callback, :callback {:params [{:name "ports", :type "[array-of-objects]"}]}}]}
{:id ::connect,
:name "connect",
:callback? true,
:params
[{:name "path", :type "string"}
{:name "options", :optional? true, :type "serial.ConnectionOptions"}
{:name "callback",
:type :callback,
:callback {:params [{:name "connection-info", :type "serial.ConnectionInfo"}]}}]}
{:id ::update,
:name "update",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "options", :type "serial.ConnectionOptions"}
{:name "callback", :type :callback, :callback {:params [{:name "result", :type "boolean"}]}}]}
{:id ::disconnect,
:name "disconnect",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "callback", :type :callback, :callback {:params [{:name "result", :type "boolean"}]}}]}
{:id ::set-paused,
:name "setPaused",
:callback? true,
:params
[{:name "connection-id", :type "integer"} {:name "paused", :type "boolean"} {:name "callback", :type :callback}]}
{:id ::get-info,
:name "getInfo",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "callback",
:type :callback,
:callback {:params [{:name "connection-info", :type "serial.ConnectionInfo"}]}}]}
{:id ::get-connections,
:name "getConnections",
:callback? true,
:params
[{:name "callback",
:type :callback,
:callback {:params [{:name "connection-infos", :type "[array-of-serial.ConnectionInfos]"}]}}]}
{:id ::send,
:name "send",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "data", :type "ArrayBuffer"}
{:name "callback", :type :callback, :callback {:params [{:name "send-info", :type "object"}]}}]}
{:id ::flush,
:name "flush",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "callback", :type :callback, :callback {:params [{:name "result", :type "boolean"}]}}]}
{:id ::get-control-signals,
:name "getControlSignals",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "callback", :type :callback, :callback {:params [{:name "signals", :type "object"}]}}]}
{:id ::set-control-signals,
:name "setControlSignals",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "signals", :type "object"}
{:name "callback", :type :callback, :callback {:params [{:name "result", :type "boolean"}]}}]}
{:id ::set-break,
:name "setBreak",
:since "45",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "callback", :type :callback, :callback {:params [{:name "result", :type "boolean"}]}}]}
{:id ::clear-break,
:name "clearBreak",
:since "45",
:callback? true,
:params
[{:name "connection-id", :type "integer"}
{:name "callback", :type :callback, :callback {:params [{:name "result", :type "boolean"}]}}]}],
:events
[{:id ::on-receive, :name "onReceive", :params [{:name "info", :type "object"}]}
{:id ::on-receive-error, :name "onReceiveError", :params [{:name "info", :type "object"}]}]})
; -- helpers ----------------------------------------------------------------------------------------------------------------
; code generation for native API wrapper
(defmacro gen-wrap [kind item-id config & args]
(apply gen-wrap-helper api-table kind item-id config args))
; code generation for API call-site
(def gen-call (partial gen-call-helper api-table))