« Previous -
Version 13/27
(diff) -
Next » -
Current version
J. Simmons, 10/29/2017 03:35 pm
Holoseat Serial Protocol¶
Introduction¶
Note: Beginning with version 0.4.0, this document supersedes the material covered in Project Software.
The HoloSeat firmware has a serial protocol, the Holoseat Serial Protocol (HSP), to enable the desktop configuration app to modify all key parameters and to determine the current configuration of the Holoseat at runtime. It is laid out to mirror the REST API presented to Holoseat clients by the desktop application.
Serial Port Configuration¶
| Field | Value |
| Baud Rate | 115200 |
| Data Bits | 8 |
| Parity | None |
| Stop Bit | 1 |
Command Structure¶
Commands are sent as JSON strings with a URI, an HTTP verb, and possibly arguments. TODO (fill this in more)
Low Level Commands¶
The low level commands are intended to be used to establish a connection between the Holoseat controller and the REST API server. These commands will not be reproduced in the Holoseat REST API.
| Command Name | URI | Verb | Example Command | Example Result |
| Set Logging | /main/logging | PUT | {"uri":"/main/logging","verb":"PUT", "args":{"enabled":1,"interval":1}} |
{"result":"OK"} |
Public Commands¶
The following commands mirror the REST API to implement the features of the REST API.
| Command Name | URI | Verb | Example Command | Example Result |
| Get Device Name | /main/devicename | GET | {"uri":"/main/devicename","verb":"GET"} |
{"device":"Holoseat Alpha"} |
| Get Version | /main/version | GET | {"uri":"/main/version","verb":"GET"} |
{"hwVer":"v0.4","fwVer":"v0.4.0","hspVer":"v0.4.0"} |