Skip to content

Latest commit

 

History

History
200 lines (164 loc) · 7.61 KB

README.MD

File metadata and controls

200 lines (164 loc) · 7.61 KB
Raw

BierBot Logo

Raspberry Pi powered Brewing Software

This README is also available in German Germany

Deprecation Notice ⚠

This repository is no longer actively developed. Please use the "BierBot Bricks Raspberry Pi"-client instead. Available for free here. If you want to be maintainer, please create an issue and reach out!

Key features

  • Runs on Raspberry Pi (compatible Pis)
  • Free, do-the-fuck-you-want Open Source license (MIT)
  • Easy to setup (one liner)
  • Simple: one sensor, one relay
  • PD controller that works with a simple and cheap non PWM/SSR relay and yet eliminates temperature overshoots
  • Modes for mashing and fermentation
  • Multi-language (German, English, pull-requests welcome)
  • Integrated recipes: Set the temperature, the time, etc.
  • Integrated logging: See your temperature log during the mash and export a PDF after brewing
  • User authentication
  • Can send messages to Telegram during brewing
  • Works perfectly on any web browser

Updates

To run a manual update:

  1. Connect to your BierBot using SSH (type ssh [email protected] in your favorite Terminal, with the IP being the IP of your BierBot).
  2. Change into the BierBot folder cd cd /home/pi/BierBot
  3. Discard any local changes to your BierBot files git reset --hard
  4. Pull the newest version from GitHub git pull (depending on your install, you might get permission errors, run sudo git pull)
  • v.2.1.0 (23.01.2021)

Screenshots

Software-Installation

Prepare SD-Card and Raspberry Pi

  1. Download RASPBIAN BUSTER LITE from the official website. Recommended version is from February 2020 (Release Date 2020-02-13), with kernel version 4.19.
  2. Flash it to the SD card as described on the setup page
  3. Connect at least an (micro) HDMI cable (monitor), USB keyboard and microUSB (USB-C) for power to your Raspberry Pi (4). Wait for it to boot twice.
  4. Login using user pi and password raspberry
  5. Run (=type) sudo raspi-config,
    1. select 5 Interfacing Options > P2 SSH and confirm with <yes>
    2. Optional: If you want to connect to your WiFi: now is your time: select 2 Network options > N2 Wifi. This is also possible via the BierBot Software later.
    3. Also optional but recommended: 1 Change user password.
  6. You may now unplug your HDMI and keyboard and operate the Raspberry Pi soley over Ethernet / WiFi.
  7. Connect to your router to figure out the IP of your Raspberry Pi.

Install the BierBot software

Now, we are ready to update the Raspberry Pi and install all requirements, such as NodeJS and the database which is the promised one-liner.

cd ~ && wget https://raw.githubusercontent.com/BernhardSchlegel/BierBot/master/bierbot-setup.sh && chmod +x bierbot-setup.sh && sudo ./bierbot-setup.sh

Congrats, you're done. Your BierBot is now accessible at http://BierBotBen (you can change the name of your BierBot on the configuration page)

If you want to know what the script does in the background, check out the (potentially outdated) explanation here.

Compatibility

The BierBot install script and Software has been tested on the following Raspberry Pis (source):

Raspberry Pi 1 2 3 4
Type A A+ B B+ B B v1.2 A+ B v.1.2 B+ B
ARM ARMv6 (32 Bit) ARMv7 (32Bit) ARMv8 (64 Bit)
Power to beep 1m 31s 1m 36s 1m 33s
setupscript ✔️ ✔️ ✔️
software ✔️ ✔️ ✔️

TL;DR: Get the cheapest one, in terms of startup speed: No difference.

If you happen to own one of the models with a blank cell, shoot me a message!

Hardware-Setup

The default BierBot wiring is as follows (I'll use the RPi# (pigpio#) syntax):

BierBot Wiring

  • The DS18B20 sensor is connected to 3,3V, GND, and Pin Number RPi 7 (pi-gpio 7). With the latter being the data-channel of your sensor.
  • The control channel of your Relais is connected to 11 (17). This will be used to turn on/off your heating / cooling device.
  • Your motor (for stirring your mash) is connected to Pin 12 (18). This is a PWM Pin - which will be used. You can set your Motor Voltage on the BierBot settings page.
  • Pin 13 (27) is optional: If you want your temperature sensor to be hot pluggable connect this pin. It will trigger an ISR on either edge (falling / rising) and is pulled via an internal resistor to ground.
  • Pin 15 (22) is also optional: If you connect a piezzo buzzer the BierBot tells you with a beeping symphony when the next step is reached or the brew is finished.

TODOS

  • migrate client package management from bower to yarn.

Contributing

If you want to contribute, your Pull-Request or translation is very welcome! Please see the notes for developers to get you started!

License

  • My Code: MIT
  • Orange Mash BierBot Logo: (c) by Bernhard Schlegel, all rights reserved.

Copyright (c) 2014-present, Bernhard Schlegel