This is the main source code repository for the firmware on the BrewPi brewing temperature controller.
End users will not have to compile the firmware themselves.
We provide pre-compiled binaries in releases.
Our update script (part of brewpi-tools) automatically downloads the latest release to flash to your controller.
To update your controller, the brewpi script and the web interface, you will generally just run:
cd ~/brewpi-tools
sudo python updater.py
You can also upload to your controller from the BrewPi web interface. For the Spark Core, this requires that you already have a version of BrewPi running on it. If not, read how to flash via DFU below.
If you want to make your own changes to the firmware, follow these steps:
Clone this repository and spark-firmware to the same parent folder (e.g. 'brewpi'). This repository depends on the spark-firmware repository to build.
- In the spark-firmware repo, change to the "feature/hal" branch:
git checkout feature/hal - in the firmwarwe repo, it is recommended to change to the "develop" branch:
git checkout develop
Then browse to platform/spark/ in the firmware repo and run make:
cd platform/spark
make
This will build the binary to the file platform/spark/target/brewpi.bin. You can upload your new binary via the BrewPi web interface.
The repository contains a NetBeans project. NetBeans is our editor of choice for development and hardware debugging.
If uploading firmware via the web interface fails, you can flash new firmware to your Spark Core with dfu-util. Please refer to this guide on our community forum.
You can also build the firmware and flash directly by running make progra-dfu from platform/spark.
We do not recommend the Arduino to new users. The Spark platform is much more powerful and future proof. We will try to make new features available where possible for our existing Arduino users, but we are running into the limits of the platform.
To build our firmware for Arduino, you will have to use Atmel Studio. The repo includes an Atmel studio project. Select the right processor (Atmega328P for the Arduino Uno, Atmega32U4 for the Leonardo) and set up the right shield in Config.h.
A list of the changes per release can be found in the CHANGELOG file.
Unless stated elsewhere, file headers or otherwise, all files herein are licensed under an GPLv3 license. For more information, please read the LICENSE file.
Contributions to our firmware are very welcome. Please contact us first via our community forum to discuss what you want to code to make sure that it aligns with our road map.
Please send pull requests against the develop branch. We can only accept your pull request if you have signed our Contributor License Agreement (CLA).