Raspberry Pi based Temperature and Water flow monitoring solution. I used this project to learn more about python, javascript, css, flask and more. I am new to these and would not mind any suggestions/advice from people that come to this repo.
It is currently running at jphmonitor.nl.
The purpose of the project is to monitor & control Raspberry Pi based sensors on the network.
| Program | Purpose |
|---|---|
| jph.py | Library of routines to manage the Multicast messaging |
| jphRedis.py | Cache last state of all messages in the network |
| jphFlask.py | Web Servers Gateway Interface |
| jphPostgreSQL.py | Store the data in a postgreSQL database |
| static/(www) | Files for the Web interface |
| static/config.json | Config file used by all components |
| templates/(www) | Files for the web interface |
| sensor.py | Routines that read the sensors |
| control.py | Command line interface for viewing/managing network |
| generateSQL.py | Generate SQL to create database from config |
| router.py | Route message between multiple networks (TBC) |
| requirements.txt | (TBC) |
Each component (e.g. server, sensor, data element) in the network is identified by a two character code called a Codifier. The JPH library will read the configuration and load the enviroment for a Codifier managing the control flow using three call backs:
| Nr. | Call back type | Usage |
|---|---|---|
| 1 | a timer | Called every 'SensorInterval' seconds. Is typically used to tell a sensor to perform a reading. |
| 2 | Control | Called everytime there is a control message received from another component. |
| 3 | Data | Called everytime there is a data message received from another component. |
The library exposes the following functions:
| Function | Purpose |
|---|---|
| jph() | Returns the channel for all communication with the JPH network |
| timeNow() | Returns the current time in milliseconds |
| getConfig() | Returns the entire configuration |
| getAllSensors() | Returns the array of all Codifiers |
| getSensor() | Returns a specific Sensor's configuration |
| getMySensor() | Returns my configuration |
| getMySensorElement() | Returns an element in my configuration |
| sendData() | Sends data on the Data Channel |
| sendCtrl() | Sends a message on the Control Channel |
| run() | Manage the state of the network and provide call back hooks |
The jph library will callback the sensors reading routine which can send data to the network using sendData().
| Interface | Example |
|---|---|
| Pipe | Return a value from a UNIX pipe |
| JSON | Do a http request to read JSON |
| ADC pi + | Analogue-to-Digital board output ADC Pi Plus |
| ADAfruit | The Temperature & Humidity sensors AM2302 |
| Dwarfpool | Read the current state of the mining on Dwarfpool |
| Nest | Read the data from a nest device |
| Zwave | Read the data from a zwave enabled device |
| Python | Make customized calculations (using ninja2 style variable injection) |
There are two networks:
- Control bus - All components talk to each other on this bus, sending keep-alive messages and commands.
- Data bus - Collector components listens to this bus and sensors components send data on this bus.
For both busses each message carries a millisecond time value, sequence number and a to/from Codifier. The following message types are supported:
| Flag | Purpose |
|---|---|
| I | I am alive |
| C | Request to (re)read the Config and restart |
| P | Ping a component, requesting a {T} response message |
| T | Time value response to a {P} message, responding with payload from {P} |
| S | Start the Data channel callbacks |
| H | Halt the Data channel callbacks |
| N/n | The sequence numbering from this point is New |
Message with Codifier destination '@@'' is a broadcast to all.
sudo ip link set dev macvtap0 allmulticast on
apt-get update
apt-get upgrade
apt-get install python-setuptools python-dev build-essential
easy_install pip
apt-get install git
apt-get install redis-server
pip install redis
pip install Flask
pip install Flask_redis
pip install Flask_login
pip install Flask_sqlalchemy
pip install bcrypt
apt-get install postgresql
apt-get install libpq-dev
pip install psycopg2
cat "secretPassword" > ~/.sqlpassword
export JPH_DEBUG=0
python generatePostgreSQL -c q1 -d > /tmp/x
sudo -u postgres psql < /tmp/x
apt-get install syslog-ng
echo "destination d_jph { file(\"/var/log/jph.log\"); };" > /tmp/x
echo "filter f_jph { program(\"jph*\" type(glob)); };" >> /tmp/x
echo "log { source(s_src); filter(f_jph); destination(d_jph); };" >> /tmp/x
cp /tmp/x /etc/syslog-ng/conf.d/jph.conf
export JPH_DEBUG=0
python generatePostgreSQL -c q1 -p user_name:password > /tmp/x
sudo -u postgres psql < /tmp/x
download: http://fontawesome.io/
download: http://jqwidgets.com/
Extract archives into ./static
File: JPHmonitor.wsgi
from jphFlask import app as application
File: apache2/sites-enabled/jphmonitor.conf
<VirtualHost *:80>
ServerName jphmonitor.nl
Redirect permanent / https://jphmonitor.nl/
</VirtualHost>
<IfModule mod_ssl.c>
<VirtualHost *:443>
ServerName jphmonitor.nl
ServerAdmin admin@jphmonitor.nl
WSGIScriptAlias / /data/www/JPHmonitor/JPHmonitor.wsgi
WSGIDaemonProcess JPHmonitor threads=5 user=jphmonitor group=jphmonitor python-path=/data/www/JPHmonitor
<Directory /data/www/JPHmonitor/>
WSGIProcessGroup JPHmonitor
WSGIApplicationGroup %{GLOBAL}
Order allow,deny
Allow from all
</Directory>
Alias /static /data/www/JPHmonitor/static
<Directory /data/www/JPHmonitor/static/>
Order allow,deny
Allow from all
</Directory>
ErrorLog ${APACHE_LOG_DIR}/error.log
LogLevel warn
CustomLog ${APACHE_LOG_DIR}/access.log combined
SSLCertificateFile /etc/letsencrypt/live/jphmonitor.nl/fullchain.pem
SSLCertificateKeyFile /etc/letsencrypt/live/jphmonitor.nl/privkey.pem
Include /etc/letsencrypt/options-ssl-apache.conf
<IfModule mod_headers.c>
Header always set Strict-Transport-Security "max-age=15768000; includeSubDomains; preload"
</IfModule>
</VirtualHost>
none available - is a hobby project