History

Project Software

Introduction

The Holoseat project has three software elements. The first software element is the firmware running on the Holoseat controller. The second software element is the desktop configuration app. And the third software element is the test rig software (composed of more firmware and test execution software). This page covers each of these elements and the serial protocol between the Holoseat controller and the desktop configuration app.

Controller Firmware

The Holoseat controller firmware can be found in the SVN Repository. It runs on an Adafruit Feather and relies on the Bounce2 library for button debouncing. Its function is to detect pedal events from the sensor, use the timing of those events to determine the cadence (in RPM) and direction (forward or backward), and then send the walk command (generally by pressing the 'w' or 's' key) when the pedal speed is greater than the specified trigger cadence.

The default parameters for the firmware are stored in the holoseat_constants.h file so they will be available at start up without the need for a connection to the desktop configuration app. The following parameters have default values in the constants file.

  • Default Walk Forward Character - what key is sent to move the character forward in the game
  • Default Walk Backward Character - what key is sent to move the character backward in the game
  • Default Holoseat Enabled - is the Holoseat enabled by default?
  • Default Trigger Cadence - how fast does the user need to pedal (in RPM) to trigger walking?
  • Default Logging Enabled - is serial logging enabled by default?
  • Default Logging Interval - how long between messages in serial logging in deci-seconds (0.1 of a second)

Desktop App

The Holoseat configuration app can be found in the SVN Repository. It is written in C# and runs in the Windows System Tray (other operating systems will be supported in future releases). The configuration app requires a locally installed copy of the Arduino IDE to update the default parameters in the Holoseat controller and uses the SerialPortStream 2.0 library to manage the serial communications with the Holoseat controller for live updates to the Holoseat settings. Its function is to display and modify current settings for the Holoseat and allow users to update the default values for those settings.

Update Default Parameters

The configuration app modifies the default parameters by updating the values of the corresponding constants in holoseat_constants.h and then flashing updated firmware to the Holoseat controller. It is the need to flash the controller with updated firmware that drives the need for a local installation of the Arduino IDE. If it is not present, the configuration app disables this feature.

Live Updates to Holoseat Settings

The configuration app uses the Holoseat Serial Protocol (see below) to display and update the current settings. These settings will remain in the Holoseat controller until they are changed again using the configuration app or the Holoseat loses power (e.g. when unplugged or the host computer is shutdown). At which point, the Holoseat reverts to its default parameter values when next used.

Test Rig Software

The test rig software can be found in the SVN Repository. The test rig was developed to support research into the sensor and magnet pairing. It is made up of an Arduino Uno driving a stepper motor. The stepper motor has an arm attached to it with magnets on the end to simulate users pedaling. Finally, a Raspberry Pi runs the tests and hosts the sensors under test, receiving signals from the magnets attached to the stepper motor as it turns. A test case includes a magnet, a sensor, and a simulated pedaling cadence.

The test rig software is made up of two components:

  • test rig firmware - running on the Arduino Uno driving a stepper motor
  • test scripts running on the Raspberry Pi, written in NodeJS, defining the tests performed with the test rig

Test Rig Firmware

The test rig firmware uses AccelStepper v1.45 to implement an open loop controller on the test rig's stepper motor. This controller drives the stepper motor at a specified cadence (in rpm). The cadence is specified as an integer on the serial port.

Test Scripts

The test scripts use the Johnny-Five library to connect to the peripherals required for the test. The first peripheral is the Arduino running the stepper motor controller (over serial port). The second peripheral is the sensor under test (over a GPIO port). Tests are defined first in a csv file. The generate-test-files.js script converts the csv file listing all of the desired tests into a set of JSON files, each defining a single test. The scripts run-char-tests.js and run-doe-test.js implement two testing patterns (characterization and Design of Experiments, respectively). These scripts parse a test definition JSON file and write out test results in a csv time history file. The set-cadence.js script is a command line tool to set the stepper motor cadence (used before and after tests to start and stop the stepper motor). The remaining scripts are demonstration tools to verify code was functional before being integrated into the test execution scripts.

HoloSeat Serial Protocol

Note: This documentation is deprecated for v0.4.0+. See HSP page for updated documentation.

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.

Protocol Commands

The HSP supports three commands. Each command is made up of a single upper case character indicating the statement type. One command, the (S)et statement, also takes an input string.

  • ? - Ready(?) command; used to determine if the HoloSeat is ready to receive commands over the HSP (will reply with the (R)eady message followed by one standard state message if the HoloSeat is ready)
  • S <config string> - (S)et command; used to send updated configuration to HoloSeat (HoloSeat will reply with OK on success). The config string has the following format:
    <WFC>,<WBC>,<E>,<TC>,<L>,<LI> - example: S w,s,0,60,0,20
    • <WFC> - Walk forward character (example: w)
    • <WBC> - Walk backward character (example: s)
    • <E> - Enabled? Must be a 0 (disabled) or a 1 (enabled) (example: 1)
    • <TC> - Trigger cadence (example: 65)
    • <L> - Logging enabled? Must be a 0 (disabled) or a 1 (enabled) (example: 1)
    • <LI> - Logging interval in deci-seconds (example: 10)
  • Q - (Q)uery command; used to request the HoloSeat send one standard state message (see Protocol Messages below)

Protocol Messages

The HSP has two messages. One is a single character message similar to the commands and one is the HSP standard state message which is sent after initialization, in reply to a (Q)uery command, and as the serial logging message.

  • R - (R)eady; sent by the HoloSeat to indicate it is ready for serial communication; sent in reply to the Ready(?) command and when serial port is attached in debug mode (to be added)
  • <VER>,<WFC>(<DWFC>),<WBC>(<DWBC>),<E>(<DE>),<C>/<TC>(<DTC>),<L>(<DL>)/<LI>(<DLI>) - standard state message, see below for key; example: 1.2.3,w(w),s(s),1(1),70/65(75),1(0)/10(10)
    • <VER> - Firmware version string (example: 1.2.3)
    • <WFC> - Walk forward character (example: w)
    • <DWFC> - Default walk forward character (example: w)
    • <WBC> - Walk backward character (example: s)
    • <DWBC> - Default walk backward character (example: s)
    • <E> - Enabled? Must be a 0 (disabled) or a 1 (enabled) (example: 1)
    • <DE> - Default enabled state, same format as <E> (example: 1)
    • <C> - Current cadence rounded to whole number; positive value means direction is forward, negative value means direction is backward (example: 70)
    • <TC> - Trigger cadence (example: 65)
    • <DTC> - Default trigger cadence (example: 75)
    • <L> - Logging enabled? Must be a 0 (disabled) or a 1 (enabled) (example: 1)
    • <DL> - Default logging enabled, same format as <L> (example: 0)
    • <LI> - Logging interval in deci-seconds (example: 10)
    • <DLI> - Default logging interval in deci-seconds (example: 10)

Protocol Usage

Always start a serial session by sending a Ready(?) command. If a (R)eady message is not received, wait and try again until a timeout is reached or a (R)eady message is received. Be sure to check the version string sent in the initial standard state message to ensure your app is compatible with the version of the HoloSeat firmware.

After you have initialized your connection, you can then use the (Set) and (Q)uery commands as necessary to control and observe the HoloSeat's state.

Also available in: HTML TXT