Holoseat Serial Protocol¶

• Holoseat Serial Protocol
  • Introduction
  • Serial Port Configuration
  • Command Structure
  • Low Level Commands
  • Public Commands

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¶

Command Structure¶

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.

Note, the Holoseat Python serial library will insert a message ID if none is included. But users interacting directly with the serial port must include at least an empty message ID. This means that the message ID is optional from the app serial monitor and from the app libraries, but not the Arduino serial monitor.

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.

Public Commands¶

The following commands mirror the REST API to implement the features of the REST API.