Software Source Code

Version 2 (J. Simmons, 12/29/2017 04:31 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 1 J. Simmons
|Baud Rate|115200|
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 1 J. Simmons
h3. Tone Ring Controller
16 1 J. Simmons
17 1 J. Simmons
|*Command Name*|*URI*|*Verb*|
18 2 J. Simmons
|Run the motor (use @"CW":-1@ for CCW direction)|/motor|PUT|
19 2 J. Simmons
||\2. @{"messageId":"1000","uri":"/motor","verb":"PUT", "args":{"revolutions":1, "cadence": 30, "CW":1}}@|
20 2 J. Simmons
||\2. @{messageId":"1000","revolutions":1, "cadence": 30, "CW":1}@|
21 1 J. Simmons
|\3. |
22 2 J. Simmons
23 2 J. Simmons
h3. Sensor Controller
24 2 J. Simmons
25 2 J. Simmons
|*Command Name*|*URI*|*Verb*|
26 2 J. Simmons
|Get the sensor stats|/stats|GET|
27 2 J. Simmons
||\2. @{"messageId":"1000","uri":"/stats","verb":"GET"}@|
28 2 J. Simmons
||\2. @{messageId":"1000","revolutions":1, "maxCadence": 30, "CW":1}@|
29 2 J. Simmons
|\3. |
30 2 J. Simmons
|Clear the sensor stats|/stats|DELETE|
31 2 J. Simmons
||\2. @{"messageId":"1000","uri":"/stats","verb":"DELETE"}@|
32 2 J. Simmons
||\2. @{messageId":"1000","revolutions":0, "maxCadence": 0, "CW":0}@|