netr0m / brewsource-rpi

BrewSource, a Raspberry Pi-powered monitor for your fermentation:beers:. Written in :snake:Python and :sailboat:Sails.js

BrewSource | Raspberry Pi Project - 🐍Python

BrewSource is an open source, Raspberry Pi-powered monitor for your beer fermentation 🍻. Written in 🐍Python and ⛵Sails.js. We'd love help of any kind, whether you'd like to contribute by submitting a bug, or have a request for a feature. You can also contribute with development, but please read the guidelines on Contribution before you begin.

BrewSource Application Repository

Table of contents

• Getting Started
• Documentation
• Features
• Bugs and feature requests
• Contribution
• License
• Contributors

Getting Started

• You will also need Python 3.x.x for the Raspberry Pi in order to get the temperature-monitoring and camera stream going.

• The thermometer script is dependent on a package called pymongo

• You'll also need a DS18B20 Waterproof Digital Temperature Sensor to read temperatures

• After you've cloned the repository:

• Open a terminal, navigate to your local clone (folder), and type:

sudo apt-get install python-pip
pip install pymongo

• You'll need to create an account, a brewery, and finally a batch which the temperatures belong to

• Copy the ID of the batch you want to monitor, and paste it in the "batchID" variable in the thermometer.py script

• Finally, open the folder temperature. Type:

sudo python thermometer.py

The launcher.sh script is used to run the python script on reboot

In order to get this working, you'll need to do the following:

sudo crontab -e

@reboot sh /home/pi/brewpi/launcher.sh >/home/pi/logs/cronlog 2>&1

Documentation

https://github.com/mortea15/BrewSource-RPi/wiki

Features

Coming soon

Contribution

We would love your help in the development of BrewSource. Please follow our guidelines on Contribution on how to report bugs and request features you'd like to see, in addition to how you can contribute with development. By following these guidelines, we make sure that communication is efficient and understandable, which hopefully will help us improve the project.

Bugs and feature requests

If you want to submit a feature request or bug, please keep this in mind:

• Stay on topic, both regarding the request/bug itself and any discussion around it.
• Please avoid opening issues if it involves lines of code you do not understand.

Bug reports

Definition of a bug: A bug is an error, fault or failure in the application which is caused by the sourcecode found in this repository, which results in an incorrect or unexpected result.

We appreciate feedback of any sort, and it helps us in developing a great service. Thank you!

• Please browse the issue tracker before you submit a bug or feature, to avoid duplicate entries.
• Before submitting, make sure to pull the latest version to check if the bug is fixed, or feature is implemented.
• Stick to ONE bug per issue.

• Please use the following format when submitting:

Short description of what happened

Description

Expected behaviour

Description

Actual Behaviour

Description

Steps to reproduce

Description

Your enviroment

Operative System, Python Version, Raspberry Pi version, and any other information of relevance

Feature requests

We're open for adding new features, please keep in mind that it should be of relevance to this project.

• Including details when submitting feature requests is essential. It makes it easier for the developers to understand the request.

Pull requests

• Please include documentation on all code submitted
• If a new feature is implemented, it should be explained with detail in the Wiki

License

GPL3.0

Contributors

Developed by:

• Morten Amundsen.py
• Svenn-Roger Sørensen.js

brewsource-rpi's Issues

Change from MySQL to MongoDB

Sails Application has been changed to use MongoDB, so we'll need to change the python temperature logging script to use MongoDB

Camera Streaming

Currently, the camera streaming is limited to local viewing only.
A potential fix could be to Dockerize the script.

Should also make a tab/view in the application for displaying the stream

Wrong timezone when logging temperatures

Short description of what happened
When logging temperatures from the RPi using the temperature script, the timezone is incorrect

• 2 hours behind local time
• Potential fix

Expected behaviour
Use the actual timezone of where the user is located

Actual Behaviour
Wrong timezone (GMT+0000 UTC) is logged, which is two hours behind the RPi's local time zone

Steps to reproduce
Run the temperature script on an RPi

Your enviroment
Raspbian, Python v3.6