Silviabot Documentation

# Pi Setup

Follow these steps to set up a raspberry pi, download the code and setup the web server and message broker.

# Quick Setup

A quick setup can be done using a script. First setup wireless in raspi-config:

$ sudo raspi-config

Then download the script and run.

$ sudo apt install git -y
$ git clone https://github.com/willhunt/silvia.git
$ cd /silvia/pi_setup
$ chmod +x raspi_setup.sh
$ ./raspi_setup.sh

Then setup Django database

$ cd ~/silvia/silvia
$ python manage.py migrate
$ python manage.py createsuperuser

Then follow prompts.

Some useful links for the following instructions are:

# Pi Setup

# Install operating system

Setup a raspberry pi with Raspberry Pi OS Lite as described at projects.raspberrypi.org.

# Update pi

$ sudo apt-get update -y
$ sudo apt-get upgrade -y
$ sudo apt-get autoremove

# Setup SSH

# Enable SSH

Allow SSH connections on the raspberry pi by using the raspi-config tool on the raspberry pi:

$ sudo raspi-config

The IP address can be found on the pi using

$ hostname -I

# Setup static IP address

Reference: Raspberry Pi Static IP Address. Here the IP address 192.168.0.6 is used.

Edit file:

$ sudo nano /etc/dhcpcd.conf

And add:

interface wlan0
static ip_address=192.168.0.6/24
static routers=192.168.0.1
static domain_name_servers=192.168.0.1

Replacing with relevant IP addresses. Use this to find router/name server:

$ ip r | grep default

Reboot

$ sudo reboot

# Connect via SSH

Once enabled access can be made via another networked computer:

$ ssh pi@<IP>

In my case:

$ ssh pi@192.168.0.6

# Allow remote access to files

It is possible to mount file system on a local machine to make editing files easier. This can be done on the other PC by the following:

$ sudo apt-get install sshfs
$ mkdir ~/remote_code
$ sshfs pi@192.168.0.6:/home ~/remote_code

Add debug option to help if there are any problems

$ sshfs pi@192.168.0.6:/home ~/remote_code -o debug

# Install requirements

$ sudo apt install git python3-venv libopenjp2-7 libtiff5 apache2 apache2-dev libapache2-mod-wsgi-py3 redis-server i2c-tools postgresql libpq-dev postgresql-client postgresql-client-common python-dev -y

# Download files

$ git clone https://github.com/willhunt/silvia.git

# Setup Python environment

$ python3 -m venv .virtualenvs/venv-silvia
$ source .virtualenvs/venv-silvia/bin/activate
$ cd silvia/silvia
$ pip install -r requirements.txt

Source virtual env by default by adding line to .bashrc

$ sudo nano .bashrc

Add at end:

source ~/.virtualenvs/venv-silvia/bin/activate

# Setup Apache server

# Edit server configuration

Replace contents of /etc/apache2/sites-available/000-default.conf with:

<VirtualHost *:80>
    # The ServerName directive sets the request scheme, hostname and port that
    # the server uses to identify itself. This is used when creating
    # redirection URLs. In the context of virtual hosts, the ServerName
    # specifies what hostname must appear in the request's Host: header to
    # match this virtual host. For the default virtual host (this file) this
    # value is not decisive as it is used as a last resort host regardless.
    # However, you must set it for any further virtual host explicitly.
    #ServerName www.example.com

    ServerAdmin webmaster@localhost
    DocumentRoot /var/www/html

    # Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
    # error, crit, alert, emerg.
    # It is also possible to configure the loglevel for particular
    # modules, e.g.
    #LogLevel info ssl:warn

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

    # For most configuration files from conf-available/, which are
    # enabled or disabled at a global level, it is possible to
    # include a line for only one particular virtual host. For example the
    # following line enables the CGI configuration for this host only
    # after it has been globally disabled with "a2disconf".
    #Include conf-available/serve-cgi-bin.conf

    Alias /static /home/pi/silvia/silvia/staticfiles
        <Directory /home/pi/silvia/silvia/staticfiles>
            Require all granted
        </Directory>

    WSGIDaemonProcess silvia python-path=/home/pi/silvia/silvia python-home=/home/pi/.virtualenvs/venv-silvia
    WSGIProcessGroup silvia
    WSGIScriptAlias / /home/pi/silvia/silvia/silvia/wsgi.py

    <Directory /home/pi/silvia/silvia>
        <Files wsgi.py>
                Require all granted
        </Files>
    </Directory>
</VirtualHost>

# Change file permissions

# Change permissions
$ sudo chmod g+w ~/silvia/silvia/db.sqlite3 
$ sudo chmod g+w ~/silvia/silvia
# Change owner
$ sudo chown www-data:www-data ~/silvia/silvia/db.sqlite3
$ sudo chown www-data:www-data ~/silvia/silvia
$ sudo chown www-data:www-data ~/.virtualenvs/venv-silvia
# Change group
$ sudo groupadd server_group
$ sudo adduser pi server_group
$ sudo adduser www-data server_group
$ sudo adduser www-data dialout
$ sudo chgrp server_group ~/silvia/silvia/db.sqlite3
$ sudo chgrp server_group ~/silvia/silvia/

*Maybe try adding "-r" argument (recursive) for chown if having problems"

# Setup I2C

Edit this file for I2C permissions:

$ sudo nano /etc/udev/rules.d/99-com.rules

Change this line

SUBSYSTEM=="ic2-dev", GROUP="i2c", MODE="0660"

to this:

SUBSYSTEM=="ic2-dev", GROUP="i2c", MODE="0666"

Then add users to i2c group

$ sudo adduser pi i2c
$ sudo adduser www-data i2c

# Setup PostgreSQL Database

$ cd ~/silvia/silvia
$ python manage.py dumpdata --exclude=contenttypes --exclude=auth.Permission > datadump.json

Edit databse configuration:

$ sudo su - postgres
$ psql
$ CREATE DATABASE silviadatabase;
$ CREATE USER databaseadmin WITH PASSWORD 'databasepwd';
$ ALTER ROLE databaseadmin SET client_encoding TO 'utf8';
$ ALTER ROLE databaseadmin SET default_transaction_isolation TO 'read committed';
$ ALTER ROLE databaseadmin SET timezone TO 'GB';
$ GRANT ALL PRIVILEGES ON DATABASE silviadatabase TO databaseadmin;
$ \q
$ exit

Migrate and recreate superuser

$ python manage.py migrate
$ python manage.py createsuperuser

# Supervisor Setup

Make logging directories

sudo mkdir -p /var/log/celery
sudo mkdir -p /var/run/celery
sudo mkdir -p /var/log/silvia

Permissions

sudo chgrp -R server_group /var/run/celery
sudo chgrp -R server_group /var/log/celery
sudo chgrp -R server_group /var/log/silvia

Configure

sudo cp -f supervisor/silvia_celery.conf /etc/supervisor/conf.d/silvia_celery.conf
sudo cp -f supervisor/silvia_celerybeat.conf /etc/supervisor/conf.d/silvia_celerybeat.conf
sudo cp -f supervisor/silvia_interrupt.conf /etc/supervisor/conf.d/silvia_interrupt.conf
sudo chgrp -R server_group /var/log/supervisor
sudo chmod g+wr /var/log/supervisor/supervisord.log

# Arduino Flashing

Install arduino command line (cli) tool to flash it from the raspberry pi Reference https://siytek.com/arduino-cli-raspberry-pi/

Install

$ cd ~
$ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh

Add to shell path

$ nano ~/.bashrc

Add this at the end:

export PATH=$PATH:/home/pi/bin

sudo reboot

Reconnect, then create a configuration file, update board index and libraries:

$ arduino-cli config init
$ arduino-cli core update-index
$ arduino-cli core install arduino:avr
$ arduino-cli lib install PID "Adafruit SSD1306" "Adafruit GFX"
$ cd ~/Arduino/libraries
$ git clone https://github.com/br3ttb/Arduino-PID-AutoTune-Library.git
$ mv Arduino-PID-AutoTune-Library/PID_AutoTune_v0 .
$ sudo rm -r Arduino-PID-AutoTune-Library/

Upload sketch to Arduino:

$ cd ~/silvia
$ chmod +x update_arduino.sh 
$ ./update_arduino.sh

← Arduino Setup →