Open-Source Firmware for the Raspberry Pi UPS Solution
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Open-Source Firmware for the Joy-IT StromPi 3


StromPi v3 - by Joy-IT OpenSource-Firmware published under MIT-License


This following pieces of Code defines the Firmware of the StromPi3 Raspberry Pi expansion.
Its main functions are included into the integrated OpenSource FreeRTOS
The Basis I/O HAL Drivers of the STM32F031 are generated with STM32CubeMX and can be modified here in Source
or with the "StromPi3.ioc" - File.

The main functionality of the StromPi3 is realized with the STM32 ADC Watchdog - which is configured to monitor
the voltage of the configured primary voltage source. If the voltage source fails and the measured voltage
falls under the threshold, then the STM32 switch to the voltage/powerpath of the configured backup source.
The STM32 switches the powerpath through Mosfets connected to its GPIO-Ports.
The voltage-sources which can be configured are the following:

	- mUSB
	- Wide-Range (StepDown Regulator Output)
	- Battery

If the Battery-PowerPath isn't selected as the voltage-source, the Battery-Hat Expansion would be configured
into its charging mode.
For further reference of the topology of the StromPi3, please refer to the schematic-files which are also
included into the OpenSource-Files

The FreeRTOS Operating System is generated with two Tasks:

	- Main Operating Task with the AlarmHandler (for Time based Operations like timed WakeUp or Shutdown),
	  the function to repower the Raspberry Pi in case that the main voltage source comes back
	  and the functions to read out the ADC-Values for Voltage Output.
	  This Task is timed to operate in a period of 1 second

	  The Sourcecode of this Task is defined in this "main.c" File

	- Serial Console Task which is processing the the in- and output of the serial interface.

	  The Sourecode of this Task is defined in the "UART_CLI.c" File

The ADC-Watchdog is processed in its own HAL-Based Interrupt-Routine through flags, which then are
processed in the main Task.

Further Informations about the Schematic and the PCB Layout of the StromPi3, 
you can find in the "Schematic+Hardware-Layout"-Folder.

The Files are created in the Atollic TrueSTUDIO for STM32, which can be used for STM32 for free.
You can include the .cproject file in the IDE and start to code your own modifications
and debug them with a ST-Linkv2 connected to the StromPi3 or make your own binary which can be flashed
with the stm32flasher in flashmode of the StromPi 3
(Please refer to the manual provided in our firmware updates in the download section of strompi.joy-it.net)

(connections have to be soldered for InCircuit debugging- please refer to the Hardware-Layout provided in 
the "Schematic Files+Hardware-Layout" Folder)

Please refer to the additional comments in the corresponding sections for further explanations.

If there are questions or something is unclear, please feel free
to contact us via E-Mail: service@joy-it.net

Firmware Changelog


Firmware 1.0 – original Firmware Files

Firmware 1.1 – Power Fail Warning

  • In the configuration terminal a new option has been included „warning-enable “
  • If this option is enabled, a warning is sent through the serial interface, when the primary voltage source fails – this option is similar to the function „shutdown-enable“ where a warning is sent out to shutdown the Raspbery Pi

Firmware 1.2 – PowerBack Detection

  • After a power failure of the primary voltage source the shutdown-time can now be canceled if in the configured shutdown-time the voltage-source turns back on. In this case there would be an additional message sent out the serial interface which can be processed in a python script for example – a modified serialShutdown.py script is added with this firmware update.

Firmware 1.21 – Fix Shutdown Timer

  • Bug-Fix: Shutdown Timer can now be set > 255 seconds

Firmware 1.3 Beta

  • Bug-Fix: PowerOff-Alarm Fixed
  • StromPi3_Status.py Support: Now it is possible to read out the Configuration of the StromPi3 through a python Script. It is also possible to read out the current ADC Voltage Values (like the current battery volatge) and process them in own python functions
  • Firmware Version Output in "show-status" function

Firmware 1.4

  • Serial-Less Mode: If the Serial-Interface is blocked by another HAT or an other module, it is possible to use the StromPi3 in a Serial-Less Mode. In this case the Shutdown-Signal is not sent out through the serial Interface as a message, but is indicated through a connected GPIO-LINE (Like in the previous versions of the StromPi family) As for this needed extra connection, please refer to the manuals located in the "SerialLess" Folder
  • Battery-Voltagelevel percentage output in "adc-output"
  • Charging State Output
  • Batterylevel-Shutdown: The Battery-Voltage is measured and then mapped on 4 available voltage levels (1:10%, 2:25%, 3:50%, 4:100%) at the end of the main-Task. In the case the Batterylevel-Shutdown is configured, the StromPi3 give a shutdown-signal to the Raspberry Pi and cuts of the PowerPath in a fixed 10 seconds timer, when the Battery has been discharged to the configured level.

Firmware 1.41

  • Bugfix for StromPi3_Status.py (Time Output)

Request Firmware Updates:


If you would need a function which isn't currently included in the StromPi3, please feel free to contact us via Mail (service@joy-it.net), so we can include it in our next Firmware-Updates