The Sgitheach Harwell dekatron clock is an open source dekatron clock.
The source code is distributed via Dropbox under a Creative Commons ShareAlike 4.0 International license.
This build frame work makes use of Earthly to build all firmware in a portable and reproducible manor.
Earthly depends on Docker.
By using this build framework, it enables us to build the firmware on:
- Linux
- MacOS
- Windows
Once you have Docker and Eathly installed for your Platform you can move on with building the firmware.
NOTE
Ensure Earthy and Docker are working before proceeding.
Download the zip files from Upstream and place them into the directory where this README.md is located.
NOTE There is no need to extract the zip files.
NOTE
You will need to adjust the name of the Earthly binary to match your Operating system.
In the case of Windows this would be earthly.exe
.
At the time of writing this guide(20220117) the latest release from Upstream is 1.2.1
.
This version is set as a default inside the Earthfile.
This can be overridden at build time by inserting the following option into the command line examples below.
Example to set version 1.3.0
and build al firmware:
earthy --build-arg UPSTREAM_VERSION=1.3.0 +all-firmware
Issue the following command:
earthly +all-firmware
Components currently supported are:
- bootloader (File name in dropbox: Bootloader VERSION_NUMBER Final.zip)
- dekatron (File name in dropbox: Dekatron.VERSION_NUMBER Final.zip)
- sam (File name in dropbox: Sgitheach.VERSION_NUMBER Final.zip)
Example to build just the SAM firmware:
earthly +sam
Once any of of the builds have finished you can find the firmware/build artifacts under the artifacts/
directory that will be automatically created for you inside this directory after a build has run.
For MacOS and Windows uses, please refer back to the respective Sgitheach PDF manuals and use the GUI's as instructed.
For Linux users, this build framework will be extended later to support CLI tooling to flash the firmware files.