Software Source Code

Version 8 (J. Simmons, 12/30/2017 03:10 am)

1 1 J. Simmons
h1. Software Source Code
2 1 J. Simmons
3 1 J. Simmons
h2. Firmware
4 1 J. Simmons
5 1 J. Simmons
h3. Common
6 1 J. Simmons
7 1 J. Simmons
|*Field*|*Value*|
8 8 J. Simmons
|Baud Rate|57600|
9 1 J. Simmons
|Data Bits|8|
10 1 J. Simmons
|Parity|None|
11 1 J. Simmons
|Stop Bit|1|
12 1 J. Simmons
13 1 J. Simmons
Commands are sent as JSON strings with a message ID (may be an empty string, but must be present), a URI, an HTTP verb, and possibly arguments. 
14 1 J. Simmons
15 4 J. Simmons
Direction of 1 means CW and -1 means CCW.
16 4 J. Simmons
17 1 J. Simmons
h3. Tone Ring Controller
18 1 J. Simmons
19 1 J. Simmons
|*Command Name*|*URI*|*Verb*|
20 4 J. Simmons
|Run the motor|/motor|PUT|
21 5 J. Simmons
||\2. @{"messageId":"1000","uri":"/motor","verb":"PUT", "args":{"revolutions":1, "cadence": 30, "direction":1}}@|
22 6 J. Simmons
||\2. @{messageId":"1000","revolutions":1, "cadence": 29, "CW":1}@|
23 1 J. Simmons
|\3. |
24 2 J. Simmons
25 2 J. Simmons
h3. Sensor Controller
26 2 J. Simmons
27 2 J. Simmons
|*Command Name*|*URI*|*Verb*|
28 2 J. Simmons
|Get the sensor stats|/stats|GET|
29 2 J. Simmons
||\2. @{"messageId":"1000","uri":"/stats","verb":"GET"}@|
30 7 J. Simmons
||\2. @{messageId":"1000","poles":18, "maxCadence": 30, "direction":1}@|
31 2 J. Simmons
|\3. |
32 2 J. Simmons
|Clear the sensor stats|/stats|DELETE|
33 2 J. Simmons
||\2. @{"messageId":"1000","uri":"/stats","verb":"DELETE"}@|
34 7 J. Simmons
||\2. @{messageId":"1000","poles":0, "maxCadence": 0, "direction":0}@|