Welcome to the BrewPi Wiki!

This Wiki is maintained by us with the help of our community. Anyone can create new pages and improve existing pages. You only need to register, which you can do with the button on the top right. Changes will be approved by an admin before they are published.

If you are unsure about editing a page but do want to notify us of something, you can also click the discussion icon on the right. This brings you to the discussion page that exists for each normal wiki page. It works just like a normal wiki page, but is used as a meta area for discussing the content. If the discussion page does not exist for the page you that you want to discuss, feel free to create it.

If you are reading this, you probably just received your BrewPi Spark. Thank you for ordering one and supporting us!

A quick note on how BrewPi works

All your sensors and actuators (heaters/coolers) are plugged into the BrewPi Spark, our temperature controller. Inside the BrewPi Spark is a Particle P1 or Photon microcontroller which runs the temperature control algorithms. It can do this on its own.

The BrewPi Spark communicates with a BrewPi server. The BrewPi server logs the data and hosts the web interface in which you can change settings and view charts. The BrewPi server can be hosted on a Raspberry Pi, but we also support other platforms.

Finally, from any PC, tablet or phone, you van visit the website hosted by the BrewPi server to manage your brew.

First time setup

To get start, you will need to do a few things:

1. Set up a BrewPi server

We recommend you to use Docker to set up the BrewPi server.

To set up Docker on a Raspberry Pi and install BrewPi, follow these instructions:

Installing Docker and BrewPi on a Raspberry Pi

Installing Docker and BrewPi on Windows

Installing Docker and BrewPi on Ubuntu

Installing Docker and Brewpi on a Synology NAS

2. Connect your BrewPi Spark to the BrewPi server

You can connect the BrewPi Spark to the BrewPi server over WiFi or USB. Follow these instructions.

To set up WiFi on the BrewPi spark, follow these instructions.

3. Set up your hardware (temperature sensors, SSRs, heating, cooling, etc)

4. Configure the BrewPi Spark

TODO

5. Updating

Development documentation

Name Description GitHub
firmware the embedded software that runs on the BrewPi Spark for temperature control link
brewpi-script the python scripts that run on the web server and connect to the BrewPi Spark link
brewpi-www the BrewPi web interface that connects to the script link

Prototyping and next-gen, not currently used in production:

brewpi-ui a prototype mashing interface built with React.js, currently only used for controlling motorized ball valves link