hotzenklotz / picobrew-server

A reverse engineered server for the proprietary PicoBrew Zymatic protocol
MIT License
61 stars 16 forks source link

picobrew-server

This project reverse-engineers a server for the proprietary PicoBrew protocol for use with the PicoBrew Zymatic, a homebrewing machine. It is intended to provide an alternative to run the machine without a connection to the official servers at picobrew.com. Run your own server and sync your recipes offline.

HTTP API

The PicoBrew Zymatic's built-in Ardunio uses an unencrypted HTTP communication protocol. All request are GET requests and are not authenticated. The following documentation is based on Firmware 1.1.8.

Installation

  1. Install Python 3.7 or above
  2. In a terminal download, install and run the project:
    
    // Download and install
    pip install picobrew_server

// Start the server in production mode on port 80

// Windows set FLASK_APP=picobrew_server flask run --port 80 --host 0.0.0.0

// OSX / Linux export FLASK_APP=picobrew_server flask run --port 80 --host 0.0.0.0


- Connect the PicoBrew machine to your computer and enable DNS spoofing. Re-route `www.picobrew.com` to your computer.
[More Details](https://github.com/hotzenklotz/picobrew-server/wiki/Install)

# Development 

1. Install Python 3.7+ & [Poetry](https://python-poetry.org/):

```bash
pip install poetry
  1. Install all dependecies:
poetry install

// Start the server on http://localhost:5000
FLASK_APP=picobrew_server flask run
  1. Lint, Format, and Type Check changes:
    pylint picobrew_server
    black picobrew_server
    mypy picobrew_server

Demo

You can try out the admin UI for uploading your XML files in this online demo. Please note, this website is for showcasing only and you should deploy your own version.

Features

ToDo

Machine Support

ToDo

Disclaimer

This software is provided "as is" and any expressed or implied warranties are disclaimed. This software submits recipes with temperature targets to your PicoBrew machine and will cause it to heat water. Any damage to your PicoBrew machine is at your own risk.

If the Zymatic faults and the screen goes blank, DON'T leave it powered on. The circulating pump will shut off and the heater stays on. A tube in the glycol loop may rupture.

License

MIT @ Tom Herold