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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
|
/*!
* \mainpage Websocket Plugin Protocol Documentation
* \version @PROJECT_VERSION@
*
* <a href="../../../html/index.html">Back to AMB Documentation Main</a>
* \section intro Introduction
* This document describes the AMB Websocket protocol. The messages are passed either as JSON or in binary format. The binary format is
* defined by the <a href="http://doc.qt.io/qt-5/qjsondocument.html#toBinaryData">Qt project</a>. The JSON format is described in protocol.idl.
*
* For information about the using the plugin with AMB, see <a href="../../websocket.README">the plugin documentation</a>
*
* \section example Example javascript
* The following is an example of using the websocket protocol in html5. For a more complete example, see the <a href="../test/index.html">html test</a>.
* \code
* socket = new WebSocket('ws://localhost:23000/');
* socket.onmessage = function (msg)
* {
* // we got a reply!
* console.log(msg);
* };
*
* socket.onopen = function() {
* var obj = {
* "type" : "method",
* "name" : "getSupported",
* "transactionid" : 'ReallyUniqueId1',
* }
* socket.send(JSON.stringify(obj));
* };
* \endcode
*/
/*!
* \file protocol.idl
* \brief this document describes the websocket protocol
*
*/
enum MessageType {
"method",
"methodReply",
"valuechanged"
}
interface BaseMessage {
/*!
* \brief transactionid, id for this transaction. For messages with responses, the transaction id is used to match the request with the response.
*/
attribute DOMString transactionid;
}
enum PropertyType {
"UInt16",
"UInt32",
"Int16",
"Int32",
"String",
"Double",
"Boolean"
}
/*!
* \brief Property represents an AMB property
*/
interface Property {
/*!
* \brief property - AMB Property name
*/
attribute DOMString? property;
/*!
* \brief value, value of the property
*/
attribute DOMString? value;
/*!
* \brief zone, zone which this property is in
*/
attribute unsigned short zone;
/*!
* \brief type - type of value
*/
attribute PropertyType? type;
/*!
* \brief timestamp
*/
attribute unsigned double? timestamp;
/*!
* \brief sequence
*/
attribute unsigned long? sequence;
}
/*!
* \brief ValueChanged is a message which is generated when a subscribed Property changes.
* Subscribe will cause this message to be generated. Unsubscribe stops this message.
* \see Subscribe
* \see Unsubscribe
* The following is an example message for this interface:
* \code
* {"type" : "valuechanged", "name" : "VehicleSpeed", "data" : {"value" : "217", "zone" : 0, 'type' : 'UInt16', "timestamp" : "1354521964.60253", "sequence" : "0"}, "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66" }
* \endcode
*/
interface ValueChanged : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "valuechanged";
/*!
* \brief name of this message.
* This represents the property name which changed in this message
*/
attribute DOMString name;
/*!
* \brief data represents the value for the property indicated by 'name'
*/
attribute Property data;
}
/*!
* \brief GetPropertyRequest - request the value of a property
* The following is an example of this message:
* \code
* {"type" : "method", "name" : "get", "data" : { "property" : "VehicleSpeed", "zone" : 0 }, "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface GetPropertyRequest : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "method";
/*!
* \brief name of this message.
* This represents the property name which changed in this message
*/
const DOMString name = "get";
/*!
* \brief data represents property to get
* Property attributes type, timestamp, value, and sequence are ignored.
*/
attribute Property data;
}
/*!
* \brief GetPropertyReply - response to GetPropertyRequest
* The following is an example of this message:
* \code
* {"type" : "methodReply", "name" : "get", "data" : {"property" : "VehicleSpeed", "value" : "17", "timestamp" : "1354521964.24962", "sequence" : "0" }, "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface GetPropertyReply : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "methodReply";
/*!
* \brief name of this methodReply.
*/
const DOMString name = "get";
/*!
* \brief data represents the requested property value
*/
attribute Property data;
}
/*!
* \brief GetSupportedRequest - request supported properties
* The following is an example of this message:
* \code
* {"type" : "method", "name" : "getSupported", "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface GetSupportedRequest : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "method";
/*!
* \brief name of this method.
*/
const DOMString name = "getSupported";
}
/*!
* \brief GetSupportedReply- reply for supported properties
* The following is an example of this message:
* \code
* {"type" : "methodReply", "name" : "getSupported", "data" : [{'property' :'EngineSpeed', 'zone' : 0, 'type' : 'UInt16'}, "{'property' :'VehicleSpeed', 'zone' : 0, 'type' : 'UInt16'}], "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface GetSupportedReply : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "methodReply";
/*!
* \brief name of this methodReply.
*/
const DOMString name = "getSupported";
/*!
* \brief data - array of properties supported by the system
*/
attribute Property[] data;
}
/*!
* \brief SupportedChanged - message occures when the system's supported properties changes
* NOTE: this message is not being generated in 0.13
* The following is an example of this message:
* \code
* {"type" : "methodReply", "name" : "supportedChanged", "data" : [{'property' :'EngineSpeed', 'zone' : 0, 'type' : 'UInt16'}, "{'property' :'VehicleSpeed', 'zone' : 0, 'type' : 'UInt16'}], "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface SupportedChanged : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "methodReply";
/*!
* \brief name of this methodReply.
*/
const DOMString name = "getSupported";
/*!
* \brief data - array of properties supported by the system
*/
attribute Property[] data;
}
/*!
* \brief Subscribe - subscribe request
* The following is an example of this message:
* \code
* {"type" : "method", "name" : "subscribe", "property" : "EngineSpeed", "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface Subscribe : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "method";
/*!
* \brief name of the method.
*/
const DOMString name = "subscribe";
/*!
* \brief property to subscribe to
*/
attribute DOMString property;
}
/*!
* \brief Unsubscribe - unsubscribe request
* The following is an example of this message:
* \code
* {"type" : "method", "name" : "unsubscribe", "property" : "EngineSpeed", "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface Unsubscribe : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "method";
/*!
* \brief name of the method.
*/
const DOMString name = "subscribe";
/*!
* \brief property to subscribe to
*/
attribute DOMString property;
}
/*!
* \brief GetRangedRequest - request a range of logged properties
* The following is an example of this message:
* \code
* {"type" : "method", "name" : "getRange", "data" : ["VehicleSpeed", "EngineSpeed"], "timeBegin" : "1368825008.35948",
* "timeEnd" : "1368825018.35948", "sequenceBegin" : "-1", "sequenceEnd" : "-1", "transactionid" : "b07589ba-417c-4604-80c6-01c0dcbd524d"}
* \endcode
*/
interface GetRangedRequest : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "method";
/*!
* \brief name of the method.
*/
const DOMString name = "getRange";
/*!
* \brief data - properties to request
*/
attribute DOMString[] data;
/*!
* \brief zone, zone which this property is in
*/
attribute unsigned short? zone;
/*!
* \brief timeBegin in seconds since Unix Epoc
*/
attribute unsigned double? timeBegin;
/*!
* \brief timeEnd in seconds since Unix Epoc
*/
attribute unsigned double? timeEnd;
/*!
* \brief sequenceBegin
*/
attribute unsigned long? sequenceBegin;
/*!
* \brief sequenceEnd
*/
attribute unsigned long? sequenceEnd;
}
/*!
* \brief GetRangedReply - reply for GetRangedRequest
* The following is an example of this message:
* \code
* {"type" : "methodReply", "name" : "getRanged", "data" : [{'property' :'EngineSpeed', 'zone' : 0, 'type' : 'UInt16'}, "{'property' :'VehicleSpeed', 'zone' : 0, 'type' : 'UInt16'}], "transactionid" : "d293f670-f0b3-11e1-aff1-0800200c9a66"}
* \endcode
*/
interface GetRangedReply : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "methodReply";
/*!
* \brief name of this methodReply.
*/
const DOMString name = "getRanged";
/*!
* \brief data - array of properties supported by the system
*/
attribute Property[] data;
}
/*!
* \brief SetPropertyRequest - request to set a property
* The following is an example of this message:
* \code
* { "type" : "method", "name" : "set", "data" : { "property" : "MachineGunTurretStatus", "value" : "true", "zone" : 0 }, "transactionid" : "4123123123" }
* \endcode
*/
interface SetPropertyRequest : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "method";
/*!
* \brief name of this methodReply.
*/
const DOMString name = "set";
/*!
* \brief data represents the new property value
*/
attribute Property data;
}
enum Error {
"NoError",
"Timeout",
"InvalidOperation",
"PermissionDenied",
"ZoneNotSupported"
}
/*!
* \brief SetPropertyReply - reply for SetPropertyRequest
* The following is an example of this message:
* \code
* { "type" : "methodReply", "name" : "set", "data" : { "property" : "MachineGunTurretStatus", "value" : "true", "zone" : 0}, "success" : true, "error" : "NoError", "transactionid" : "4123123123" }
* \endcode
*/
interface SetPropertyReply : BaseMessage {
/*!
* \brief message type
*/
const MessageType type = "methodReply";
/*!
* \brief name of this methodReply.
*/
const DOMString name = "set";
/*!
* \brief data represents the new property value
*/
attribute Property data;
/*!
* \brief success - true if the set operation was successful
*/
attribute boolean success;
/*!
* \brief error - error code
*/
attribute Error error;
}
|
