Edit History

HSP

Version 19 (J. Simmons, 10/29/2017 08:52 pm)

1 1 J. Simmons 
h1. Holoseat Serial Protocol
2 1 J. Simmons 






    3
    1
    J. Simmons
    
{{>toc}}






    4
    1
    J. Simmons
    






    5
    1
    J. Simmons
    
h2. Introduction






    6
    1
    J. Simmons
    






    7
    1
    J. Simmons
    
_*Note*: Beginning with version 0.4.0, this document supersedes the material covered in [[Software Source Code|Project Software]].






    8
    1
    J. Simmons
    
_






    9
    1
    J. Simmons
    
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.






    10
    1
    J. Simmons
    






    11
    1
    J. Simmons
    
h2. Serial Port Configuration






    12
    1
    J. Simmons
    






    13
    2
    J. Simmons
    
|*Field*|*Value*|






    14
    1
    J. Simmons
    
|Baud Rate|115200|






    15
    1
    J. Simmons
    
|Data Bits|8|






    16
    1
    J. Simmons
    
|Parity|None|






    17
    1
    J. Simmons
    
|Stop Bit|1|






    18
    2
    J. Simmons
    






    19
    4
    J. Simmons
    
h2. Command Structure






    20
    4
    J. Simmons
    






    21
    16
    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.  TODO (fill this in more)






    22
    4
    J. Simmons
    






    23
    2
    J. Simmons
    
h2. Low Level Commands






    24
    2
    J. Simmons
    






    25
    1
    J. Simmons
    
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.  






    26
    1
    J. Simmons
    






    27
    4
    J. Simmons
    
|*Command Name*|*URI*|*Verb*|*Example Command*|*Example Result*|






    28
    19
    J. Simmons
    
|Set Logging|/main/logging|PUT|@{"messageId":"ee764e45b0de469d9c949dc1c43beb1a","uri":"/main/logging","verb":"PUT", "args":{"enabled":1,"interval":1}}@|@{"messageId":"ee764e45b0de469d9c949dc1c43beb1a","result":"OK"}@|






    29
    8
    J. Simmons
    






    30
    8
    J. Simmons
    
h2. Public Commands






    31
    8
    J. Simmons
    






    32
    8
    J. Simmons
    
The following commands mirror the REST API to implement the features of the REST API.






    33
    8
    J. Simmons
    






    34
    1
    J. Simmons
    
|*Command Name*|*URI*|*Verb*|*Example Command*|*Example Result*|






    35
    16
    J. Simmons
    
|Get Device Name|/main/devicename|GET|@{"messageId":"ee764e45b0de469d9c949dc1c43beb1a","uri":"/main/devicename","verb":"GET"}@|@{messageId":"ee764e45b0de469d9c949dc1c43beb1a","deviceName":"Holoseat Alpha"}@|






    36
    16
    J. Simmons
    
|Get Version|/main/version|GET|@{"messageId":"ee764e45b0de469d9c949dc1c43beb1a","uri":"/main/version","verb":"GET"}@|@{"messageId":"ee764e45b0de469d9c949dc1c43beb1a","hwVer":"v0.4","fwVer":"v0.4.0","hspVer":"v0.4.0"}@|