Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uncodead/brewuno

High precision and accuracy, open source, online, extensible and low cost homebrew automation on top of ESP8266 microchip.
https://github.com/uncodead/brewuno

accuracy arduino beer brewbeer cplusplus esp8266 esp8266-arduino homebrew ntp ota pid pid-control pid-controller platformio precision react synchronization wifi-configurations

Last synced: about 2 months ago
JSON representation

High precision and accuracy, open source, online, extensible and low cost homebrew automation on top of ESP8266 microchip.

Awesome Lists containing this project

README 

        
# BrewUNO



High precision and accuracy, open source, online, extensible and low cost homebrew automation on top of ESP8266 microchip.



# BrewUNO Pro [novo]



Conforme o [licenciamento](https://github.com/uncodead/BrewUNO/blob/master/LICENSE.txt) do BrewUNO, é expressamente proibido a venda ou distribuição comercial deste projeto sem permissão do Bruno Leitão.



*(According to the BrewUNO [license](https://github.com/uncodead/BrewUNO/blob/master/LICENSE.txt), the sale or commercial distribution of this project without the permission of Bruno Leitão is prohibited.)*



Copyright (C) 2019 Bruno Leitão Todos os direitos reservados. Este projeto é gratuito para uso. É permitido modificar para uso pessoal. Não é permitido distribuir o projeto modificado. A modificação pode ser distribuída apenas através do lançamento oficial do BrewUNO. Não é permitido distribuir comercialmente sem permissão.



*(Copyright (C) 2019 Bruno Leitão All rights reserved. This project is free to use. It's permitted to modify for personal use. It's not permitted to distribute the modified project. Modification can be distributed via the official BrewUNO release only. It's not permitted to distribute in a commercial way without permission.)*



Caso você tenha comprado o BrewUNO (instalado) de alguma empresa ou fornecedor comercial, por favor, entre em contato comigo no email: [email protected]



*(If you have purchased BrewUNO (installed) from any company or commercial supplier, please contact me at email: [email protected])*



A versão 'PRO' está disponível com novas funcionalidades para atender a demanda comercial do BrewUNO. Apenas fornecedores cadastrados poderão vender a versão PRO. A versão gratuita/free continuará existindo e sendo mantida, tanto por mim como pela comunidade. Caso você queira comercializar ou comprar a versão PRO envie um email para [email protected]



*(The 'PRO' version is avaliabe with new features to meet the commercial demand of BrewUNO. Only registered suppliers can sell the PRO version. The free version will continue to exist and be maintained, both by me and the community. If you want to sell or buy the PRO version send an email to [email protected])*



## BrewUNO PRO features:

* Brewfather recipe import / *Importação de receita do Brewfather*

* Exporting and importing brewing configurations / *Exportação e importação das configurações de brassagem*

* Post-boil heating additions and control (Whirlpool / Hop Stand) / *Adições e controle de aquecimento pós-fervura (whirlpool/hop stand)*

* Persistent temperature chart / *Gráfico de temperatura persistente*

* Reverse pump relay in settings / *Configuração para inverter o relé da bomba*

* Performance improvements / *Melhorias de performance*



![BrewUNO](http://brewuno.com/images/home-brewuno.png)



## Features:



* 100% mobile interface

* Brew with Start/Stop/Resume 

* Responsive interface with stats

* PID control to heat mash SSR

* PID control to heat sparge SSR

* Mash configurations with different steps/temperature and recirculation

* Boil configurations with hops additions

* Configurable WiFi

* Configurable access point

* Synchronization with NTP

* The ability to perform OTA updates

* 20x4 LCD display

* Three vessel limited support

* Up to 5 ds18b20 sensors



![BrewUNO](https://i.imgur.com/6Zki2pi_d.jpg?maxwidth=840)



## Getting Started



### Simple Wiring and construction:



![WireUP](https://i.imgur.com/NsDjUTW.png)



This is the easiest way to mount your brewuno, you can improve it!



### Installing with Flash Download Tools ([video](https://www.youtube.com/watch?v=xouQFcmvW0Y&feature=youtu.be))



* Download [bin files](https://github.com/uncodead/BrewUNO/tree/master/bin)

* Download [Flash Download Tools](http://brewuno.com/download/flash_download_tools_v3.6.6_0.zip)

* Setup like this: [setup](http://brewuno.com/download/esp8266-download-tool.png)

* firmware.bin offset: 0x0

* spiffs.bin offset: 0x00300000

* Click START button

* Restart WEMOS

* Connect to BrewUNO wifi (SSID: BrewUNO, Password: brew-uno). 

* Access AP mode ip: 192.168.4.1

* Scan and configure your wifi under WiFi menu



### Installing & Deployment with VS Code



### Prerequisites



You will need the following before you can get started.



* [VS Code](https://code.visualstudio.com/)

* [PlatformIO](https://platformio.org/) - IDE for development **with ESP8266 v2.2.2 platform installed**

* [NPM](https://www.npmjs.com/) - For building the interface (if you want)

* Bash shell, or Git Bash if you are under windows



Pull the project and add it to PlatformIO as a project folder (File > Add Project Folder).



PlatformIO should download the ESP8266 platform and the project library dependencies automatically.



Once the platform and libraries are downloaded the back end should be compiling.



Edit /data/config/wifiSettings.json with yours wifi configurations.



Under PlatformIO menu: Upload File System image, and then, Upload and Monitor. You will see the ip address to access interface. AP mode ip: 192.168.4.1



### Building the interface



The interface has been configured with create-react-app and react-app-rewired so the build can customized for the target device. The large artefacts are gzipped and source maps and service worker are excluded from the production build.



You will find the interface code in the ./interface directory. Change to this directory with your bash shell (or Git Bash) and use the standard commands you would with any react app built with create-react-app:



#### Download and install the node modules



```bash

npm install

```



#### Build the interface



```bash

npm run build

```



**NB: The build command will also delete the previously built interface (the ./data/www directory) and replace it with the freshly built one, ready for upload to the device.**



#### Running the interface locally



```bash

npm start

```



**NB: To run the interface locally you will need to modify the endpoint root path and enable CORS.**



The endpoint root path can be found in .env.development, defined as the environment variable 'REACT_APP_ENDPOINT_ROOT'. This needs to be the root URL of the device running the back end, for example:



```

REACT_APP_ENDPOINT_ROOT=http://192.168.0.6/rest/

```



CORS can be enabled on the back end by uncommenting the -D ENABLE_CORS build flag in platformio.ini and re-deploying.



## Configuration



Standard configuration settings, such as build flags, libraries and device configuration can be found in platformio.ini. See the [PlatformIO docs](http://docs.platformio.org/en/latest/projectconf.html) for full details on what you can do with this.



By default, the target device is "esp12e". This is a common ESP8266 variant with 4mb of flash though any device with at least 2mb of flash should be fine. The settings configure the interface to upload via serial by default, you can change the upload mechanism to OTA by uncommenting the relevant lines.



As well as containing the interface, the SPIFFS image (in the ./data folder) contains a JSON settings file for each of the configurable features. The config files can be found in the ./data/config directory:



File | Description

---- | -----------

apSettings.json | Access point settings

ntpSettings.json | NTP synchronization settings

otaSettings.json | OTA Update configuration

wifiSettings.json | WiFi connection settings



The default settings configure the device to bring up an access point on start up which can be used to configure the device:



* SSID: BrewUNO

* Password: brew-uno



# Thanks to:



* Eduardo 'Dumpa' Sanches

* Guilherme Wood

* Paiakan

* [ESP8266 React](https://github.com/rjwats/esp8266-react) - rjwats/esp8266-react



## Donation

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=492TNNF63C9WG&source=url)

[![apoiese](http://brewuno.com/images/apoia-se.png)](https://apoia.se/brewuno)