netr0m / brewsource

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

BrewSource | Application - ⛵Sails.js for the application/website, 🐍Python for the Raspberry Pi

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 Raspberry Pi Repository

Table of contents

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

Getting Started

• You will need NodeJS and SailsJS in order to run the Sails-driven part of the application on your machine.

• You will also need Python 3.x.x for the Raspberry Pi in order to get the temperature-monitoring and camera stream going. You can see more about that over at the Raspberry Pi/Python repository

• After you've cloned the repository:

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

• Finally, run sails lift in the command line

Documentation

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

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, NodeJS Version, SailsJS 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's Issues

RPi Temperature script performance

Short description of what happened
Temperature logging script (thermometer.py) crashes after a few hours of running.

Expected behaviour
Run infinitely (or until stopped manually)

Actual Behaviour
Crashes a few hours after run.

Steps to reproduce
Run temperature script, let it run for a few hours

Your enviroment
Raspbian, Python v3.6. Potentially a bug with connection to the DB?

Share a brewery

Let a user share his brewery with multiple users

Camera Streaming

Prerequisites:

Issue # 3 in the RPi repository needs to be resolved first.

What needs to be done:

Allow for viewing the livestream on the "livestream" tab for a batch

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

Add batches as a part of a brewery

Currently, the temperatures belong to a single brewery.
It should be possible to create a brewery, with batches (e.g. Brewdog Punk IPA), where the temperatures belong to a specific batch.

Adapt for smaller devices

Screens that should be adapted

• Sign Up
• Sign In
• User Administration (Table)
• Edit Profile
• Brewery list (Table)
• Edit Brewery
• About Us
• Add br below "Save"-button in Edit Profile

Graph for displaying temperatures

Implement a graph to display the temperatures of a given brewery

About-page

Create a page with an about-us section

Password Encryption

Passwords are not currently encrypted when checking towards DB during login/signup. Passwords SHOULD be encrypted, always.

Allow users to create accounts

Allow users to create accounts

• Sign Up
• Log In
• Log Out

Custom Routing

Currently, the blueprint shortcuts are exposed.
They should be disabled, and instead be limited to custom routes.

• Disable blueprint shortcuts
• Create custom routing

Editing of breweries

Short description of what happened
While attempting to change properties of a brewery, such as its name, nothing happens and no changes are saved.

Expected behaviour
Changes made should be saved

Actual Behaviour
Nothing

Steps to reproduce
Enter the page of a brewery, go to the editing page by clicking 'Edit brewery', change a value and hit save.

Your enviroment

• Our server; Ubuntu 16.04.
• Node v6.10.1.
• Sails v0.12.13.

Editing of Batches

Short description of what happened
While attempting to change properties of a batch, such as its name, nothing happens and no changes are saved.

Expected behaviour
Changes made should be saved.

Actual Behaviour
Nothing.

Steps to reproduce
Enter the page of a batch, go to the editing page by clicking 'Edit batch', change a value and hit save.

Your enviroment

• Our server; Ubuntu 16.04.
• Node v6.10.1.
• Sails v0.12.13.