If you are switching to the HAT from custom cabling that used the GPIO UART pins, you don't need to do anything. The HAT uses those same pins so it all looks the same to the Pi.
Install Raspberry Pi OS on a micro-SD card per the details in Setup/Imager.md, the username is important, many of the script rely upon that specific username. A different username can be used, but many scripts and the services will need to be reconfigured to work. Once the Pi boots, open a terminal console and run the following commands.
git clone https://github.com/skipfire/genmon-addon
cd genmon-addon/Setup
./RaspberryPi.sh
After it installs all the components it will prompt you to reboot, press 'y' and it will reboot. Once it boots back up you should be done with GenMon, the Captive Portal, and the Fan Manager all being installed and running. Keep in mind that when it is not connected to a generator, GenMon does take an extra minute or two to boot up as it waits for an initial timeout on all data reads from the not-connected generator. The RAMDISK (log2ram), fan manager, captive portal, and genmon will all be installed at this point and you do not need to follow any instructions to install them.
Set the WiFi country and turn off Auto login in raspi-config.
If you are setting this up for a specific install and not a reusable image, go ahead and connect the WiFi, set the Time Zone, and chnage the password.
- CaptivePortal - all the files for the CaptivePortal service supporting configuration of your Pi.
- docker - files supporting setting up a docker image for GenMon, primarily used with a serial-TCP bridge. This is based on Debian.
- ESP32 - contains the ESPHome device yaml file for OpenGenSet to be used in serial bridge mode.
- Genmon HAT 2.0 Instructions.pdf - instructions linked on the store site for installing the v2.0+ HATs, pHATs, and pre-loaded units.
- HatTester - the files used to test the generator HATs, pHATs, and toppers on a workbench, we use this to validate every unit before it is packed up.
- LICENSE.md - the license (currently MIT) for this project. We do ask, but not require, that any improvements to these files make their way back here.
- README.md - this file.
- Setup/Common.sh - Do not call directly, it is executed by RaspberryPi.sh and VirtualizedForSerial.sh. This script calls apt update and upgrade, installs several packages that will be needed, and sets locale to the US.
- Setup/RaspberryPi.sh - This script is used to setup the pre-loaded units, then tests are run, an image created, compressed, and duplicated.
- Setup/VirtualizedForSerial.sh - This script can be used along with the Common to setup GenMon for Serial over TCP on Ubuntu.
- Preloaded units a captive portal capability installed to create a WiFi hotspot to configure the Pi's WiFi and timezone.
- To activate the hotspot and captive portal, press and hold the button on the HAT/pHAT for 5 seconds. It will first turn RED as a warning, then it will turn WHITE when it is activating the hotspot.
- The hotspot will show up with a name of
configand the key isgenmon00. Connect to it and then browse to http://genmon/ or http://10.42.0.1/ to configure. It may take a moment for your device to fully connect to the endpoint. If the page is not found give it up to 2 minutes. Mobile devices may automatically drop the connection as it will not provide internet access. - You can load just the portal by pressing the button 3 times, the LED will turn green, and then you can connect to your device at http://genmon/ or by IP.
- Be sure to shut down the portal when you are done. Update will shut down the portal after it updates (so that it can apply the update), and the shutdown portal and any reboot will both shut it down as well.
- The Captive Portal does not work on releases before Bookworm.
- Images created after September 30th, 2023 have RAMDISK setup for /var/log/. This reduces wear and tear on the SD card, however can also result in lost log data in the event it does not shut off cleanly. Logs should be backed to the SD card daily and upon a clean shutdown.
- Guide for setting it up is at https://ostechnix.com/how-to-write-log-files-in-ram-using-log2ram-in-linux/.
The PintSizeFanManager is retired and the code has been removed. We recommend you use the built-in fan manager that can be configured in raspi-config. The setting is under performance, fan; it will ask you for the GPIO to use and you want to pick 9. You can set your target temp between 60 and 80, and when the Pi reaches that temp it will turn the fan on until the CPU temp is dropped to 10 degrees below that point (example of 60 for the on point would have 50 for the off point).
If you had installed the fan manager, you can disable it with the following command:
sudo systemctl disable PintSizeFanManager
We do not provide support for running in Docker, however we do have a starter dockerfile and docker-compose file in the docker folder. This can be a great option when used with Serial over TCP.
The current plan is to have OpenGenSet be open source, though with restricted licensing. Some resources, such as circuit digrams, will not be opened until things are complete, and we reserve the right to change our minds on it. When OpenGenSet is open sourced, it will be placed in its own repository and a link will be placed in this readme. We are currently estimating July 2024.
I welcome anyone contributing to the cause.