When checking out this repository, be sure to fill in the submodules, or things will not work: git submodule update --init --recursive
The console software sends and receives data from all of the other pieces. It is responsible for determining a good signal, updating the scoreboard, triggering the flame effect when queued by the operator.
The console hardware includes a wireless card acting as the AP for the project. Configuration for that may be found in server-setup/.
The server code is written in Kotlin and located in the console/backend/ directory. To compile it, type './gradlew shadowJar' in that directory, which will assemble a fat jar containing all dependencies. The current static version of the frontend code is also included. To run that jar, do java -jar build/libs/AsOne-Console-abc123-0.1-all.jar, substituting the git hash from the actual filename for abc123. If this is successful, you will be able to access the running server at http://localhost:12345/.
A JSON-encoded ordered list of the last 100 sensor readings can be read at via GET request to /sensors/latest
To test that and other services, fire up Postman and load the AsOne-Console collection. When adding or changing services, please update this collection, as it is effectively our API documentation.
--disable-serial: Turn off the reading of serial ports. This is useful when trying to debug Arduino code over a board's serial connection.
--hostname <name>: Specify a hostname or IP address to operate on. Defaults to localhost. Useful for binding to the IP of the AP-mode wifi interface so that the open ports are not externally available.
With the server running, simulated sensors can be used to test other parts of the server stack, such as scoreboard output. To create one of these, POST a request to http://localhost:12345/sensors/simulated/add. That will return a relative location fragment containing the simulator's name, which further actions can be directed to. To remove the simulator, send a DELETE request to the relevant sensor url. To simulate picking up the controller, reading a heartbeat, etc, please see the Postman collection linked above.
The server's frontend is written in React using create-react-app, along with several UI libraries. The code may be found at console/frontend/.
To get up and running with hacking on it, cd into that directory and issue npm install, presuming you have a working node + npm setup. When that is complete, you should be able to bring up the frontend in a browser with npm run start. The development server is set to proxy unknown request from port 3000, which it serves on, to port 12345, which is where the server is actually running. Thus, you won't have to wait for a server redeploy when making frontend changes.
The codebase conforms to JavaScript Standard Style. To auto-format current changes to match, issue npm run standardize.
When shipping a feature, don't forget to do npm run make-static, which generates and copies the static files over into the server's static directory. We're currently checking them into source control there to avoid a more complicated build system -- c'est la vie.
Firmware builds are done with the Arduino environment -- the most recently tested version is 1.8.9. Set your sketchbook location to sketchbook-arduino wherever you have the project checked out. Arduino should find and load the libraries directory automatically.
You'll need to add ESP32 and ESP8266 board support to your arduino install as well. Once you can get 'blink' to run on your board you should be ready to rock-n-roll. Be sure to have this repository's submodules checked out as well, as some libraries are vendored that way: git submodule update --init --recursive
The heartrate sensor runs on an ESP32 with the Arduino environment and reports its data over USB serial. The code may be found in sketchbook-arduino/handheld-2/. The checked-in pin assignments are for the 'DOIT ESP32 DEVKIT V1' board in the boards menu.
The flame effect is controlled by an ESP8266 running Arduino code. It sends and receives state over MQTT over WiFi. Check it: sketchbook-arduino/flame-effect/. We're using the 'Adafruit Feather HUZZAH ESP8266' board.
The scoreboard has two modes currently, one which receives raw frames in the form of an array of RGB values, and another which understands context and can display numerical bpm and timer values etc. For the 2019 build we will be using the former mode exclusively, rendering the game and display state on the server. Lots more information and background may be found in the README. This is also an adafruit feather huzzah board.