Giter Site home page Giter Site logo

bernhardschlegel / bierbot-bricks Goto Github PK

View Code? Open in Web Editor NEW
29.0 7.0 10.0 2.45 MB

Beer brewing and fermentation control for homebrewers with a nice web UI for 25 bucks.

License: GNU General Public License v3.0

C++ 44.82% C 55.18%
fermentation controller beer brewing homebrewing mashing automation

bierbot-bricks's Introduction

Bricks

BierBot Bricks

BierBot Bricks is a combination of brewing soft- and hardware that helps you to nail your temperatures (by controlling your heating and cooling equipment), monitor your gravity during fermentation, and much more. Everything is available on a beautiful website that works perfectly on all display sizes: bricks.bierbot.com.

โ„น๏ธ The hardware for this repo (Sonoff TH16 based on an ESP8266) is end of production and harder to get. But: we've got you covered. Its official successor, the TH Origin (supporting up to 20Amps), is fully supported. The respective software and repository is located here.

If you get stuck along the way, please dont hesitate to reach out - you're not alone and we're happy to help! If you ๐Ÿ‘ it, please consider giving this repo a star ๐ŸŒŸ - THANKS!

If you need more flexibility and have time to build your own RaspberryPi based solution, checkout the BierBot Bricks software for RaspberryPi.

Setup for easy use

There is a YouTube-Video that shows you how to build your Brick step-by-step. There is also a detailled howto guide including many pictures available on the official documentation.

In the following, you'll find a description that is boiled down to the most important steps.

First, we need to flash the firmware.

  1. Order a Sonoff TH16 + DS18B20 Temperature sensor.
  2. In case you don't have one laying around, you'll also need:
    1. FT232RL USB to TTL for flashing the BierBot Brick firmware onto your TH16. Make sure the jumper is set to 3.3V.
    2. the cheapest female rainbow cables you can find on the WWW to hook the TH16 and the FT232 up.
    3. a 4x1 pin header to solder it onto your TH16.
  3. Hook everything up as shown in the image below (left side).
  4. Download the NodeMCU Flasher.
  5. Grab the (current) release from here.
  6. Open the NodeMCU Flasher
    1. Select tab "Config", and paste the filename of the binary you've just downloaded into the first line ("firmware.bin") or select one using the dots on the right. ESP8266Flasher.exe and the firmware.bin must be located in the same directory.
    2. Press the button on your TH16 (and hold it), connect the FT232RL, release the button.
    3. Select tab "Operation" and hit "Flash"!

Image of AC connection

Second, read the disclaimer and cut a extension cable into two pieces and connect as shown in the picture (right side). ATTENTION โš ๏ธ check if the labels on YOUR PCB match the colors of the cables: L = Brown, N = Blue, E / Ground symbol = Yellow / Green. L IN must go to your plug, L OUT to your socket.

Your device is now ready to be used. ๐Ÿ˜ƒ๐Ÿ˜ค

Go to bricks.bierbot.com > "Brewery" > "Bricks" and hit "Add device". Copy the API-Key into your clipboard. Power up your BierBot Brick. Scan for the "BierBot Brick 101" WiFi and connect. Enter the credentials to your home WiFi and paste the API-key from your clipboard. Hit "Save".

DONE. The BierBot Brick should show up in your dashboard.

Help

For general questions please use Github Discussions.

If you think you found a bug or want to request a feature: Submit an issue.

In any case: Thanks for participating!

Developer

The information in this section is only relevant if you want to participate in development.

Developer Setup

  1. Install VSCode from here.
  2. Install PlatformIO as described here.
  3. Install driver for your Serial converter. E.g. from here.
  4. connect your TTL Converter to the Sonoff TH 16. If all cables are in a row, you likely did something wrong.
  5. Click the terminal Icon in the footer bar of VSCode saying "PlatformIO: new terminal" & type pio lib install.
  6. Click the alien on the right side > "Project Tasks" > "sonoff_th" > "Build" and then "Upload".

Notes for devs

To decode stacktraces use python3 ./decoder.py -e ./firmware.elf ./trace.txt -s from here.

If you get a bunch of WiFi Manager related compiling messages, unzip "./backup/2021_01_15_16_39_WiFiManager.zip" to ".pio/libdeps/sonoff_th".

TODOs

  • Reduce programm size to 50% FLASH so that OTA update works. Blocked by this.
  • set WiFiManager to a fixed version in Platform IO dependencies as soon as a stable version is released.
  • as soon as ESP8266 supports SSL without hardcoding fingerprints: Enable SSL.

Disclaimer

โš ๏ธ DANGER OF ELECTROCUTION โš ๏ธ

If your device connects to mains electricity (AC power) there is danger of electrocution if not installed properly. If you don't know how to install it, please call an electrician (Beware: certain countries prohibit installation without a licensed electrician present). Remember: SAFETY FIRST. It is not worth the risk to yourself, your family and your home if you don't know exactly what you are doing. Never tinker or try to flash a device using the serial programming interface while it is connected to MAINS ELECTRICITY (AC power).

We don't take any responsibility nor liability for using this software nor for the installation or any tips, advice, videos, etc. given by any member of this site or any related site.

disclaimer source

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.