Raspberry Pi

In this guide, you will deploy MyEMS onto Raspberry Pi.

Prerequisites

Raspberry Pi 5 or Raspberry Pi 4 Model B
Raspberry Pi OS (64-bit) A port of Debian Bookworm with the Raspberry Pi Desktop Released:2024-07-04

Clone Source Code

sudo apt install git

sudo apt install pip

sudo apt install ufw

cd ~ && git clone https://github.com/myems/myems

Step 1 Database

Setup MySQL Server

sudo apt update

sudo apt upgrade

sudo apt install mariadb-server

By default, MySQL is installed without any password set up meaning you can access the MySQL server without any authentication. Run the following command to begin the MySQL securing process.

sudo mysql_secure_installation

Enter current password for root (enter for none): [Enter key or return key]
Switch to unix_socket authentication [Y/n] Y
Change the root password? [Y/n] Y
New password: !MyEMS1
Re-enter new password: !MyEMS1
Remove anonymous users? [Y/n] Y
Disallow root login remotely? [Y/n] n
Remove test database and access to it? [Y/n] Y
Reload privilege tables now? [Y/n] Y

Install database schema and scripts for MyEMS.

See Database

Step 2 myems-api

Install myems-api service:

sudo cp -r ~/myems/myems-api /myems-api

cd /myems-api

To prevent 'error: externally-managed-environment', create a virtual environment configuration folder:

sudo python -m venv venv

Start using the virtual environment

source venv/bin/activate

Install the requirements

sudo venv/bin/pip install -r requirements.txt

Deactive the virtual environment

deactivate

Create .env file based on example.env and edit the .env file if needed:

sudo cp /myems-api/example.env /myems-api/.env

sudo nano /myems-api/.env

Change the gunicorn path in myems-api.service:

sudo nano /myems-api/myems-api.service

[Unit]
Description=myems-api daemon
Requires=myems-api.socket
After=network.target

[Service]
PIDFile=/run/myems-api/pid
User=root
Group=root
WorkingDirectory=/myems-api
ExecStart=/myems-api/venv/bin/gunicorn -b 0.0.0.0:8000 --pid /run/myems-api/pid --timeout 600 --workers=4 app:api
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
PrivateTmp=true

[Install]
WantedBy=multi-user.target

Add port to firewall:

sudo ufw allow 8000

Setup systemd configure files:

sudo cp /myems-api/myems-api.service /lib/systemd/system/

sudo cp /myems-api/myems-api.socket /lib/systemd/system/

sudo cp /myems-api/myems-api.conf /usr/lib/tmpfiles.d/

Next enable the services so that they autostart at boot:

sudo systemctl enable myems-api.socket

sudo systemctl enable myems-api.service

Start the services :

sudo systemctl start myems-api.socket

sudo systemctl start myems-api.service

Step 3 myems-admin

Install NGINX Server

refer to http://nginx.org/en/linux_packages.html#Debian

sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring

curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null

gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/debian `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list

echo -e "Package: *\nPin: origin nginx.org\nPin: release o=nginx\nPin-Priority: 900\n" | sudo tee /etc/apt/preferences.d/99nginx

sudo apt update

sudo apt install nginx

Configure NGINX

sudo nano /etc/nginx/nginx.conf

In the 'http' section, add some directives:

http {
    client_header_timeout 600;
    client_max_body_size 512M;
    gzip on;
    gzip_min_length 512;
    gzip_proxied any;
    gzip_types *;
    gzip_vary on;
    proxy_buffering off;

    ...
}

In the 'http' section, add a new 'server' section with directives as below:

  server {
      listen                 8001;
      server_name     myems-admin;
      location / {
          root    /var/www/myems-admin;
          index index.html index.htm;
      }
      ## To avoid CORS issue, use Nginx to proxy myems-api to path /api
      ## Add another location /api in 'server' and replace demo address http://127.0.0.1:8000/ with actual url
      location /api {
          proxy_pass http://127.0.0.1:8000/;
          proxy_connect_timeout 75;
          proxy_read_timeout 600;
          send_timeout 600;
      }
  }

Install myems-admin :

sudo mkdir /var/www

sudo cp -r ~/myems/myems-admin  /var/www/myems-admin

sudo chmod 0755 -R /var/www/myems-admin

Check the config file and change it if necessary:

sudo nano /var/www/myems-admin/app/api.js

caution

The 'upload' folder is for user uploaded files. DO NOT delete/move/overwrite the 'upload' folder when you upgraded myems-admin.

 /var/www/myems-admin/upload

Start the Nginx:

sudo systemctl start nginx

Add port to firewall:

sudo ufw allow 8001

Step 4 myems-modbus-tcp

In this step, you will install myems-modbus-tcp service.

sudo cp -r ~/myems/myems-modbus-tcp /myems-modbus-tcp

cd /myems-modbus-tcp

To prevent 'error: externally-managed-environment', create a virtual environment configuration folder:

sudo python -m venv venv

Start using the virtual environment

source venv/bin/activate

Install the requirements

sudo venv/bin/pip install -r requirements.txt

Deactive the virtual environment

deactivate

Copy exmaple.env file to .env and modify the .env file:

sudo cp /myems-modbus-tcp/example.env /myems-modbus-tcp/.env

sudo nano /myems-modbus-tcp/.env

Change python path in myems-modbus-tcp.service

sudo nano myems-modbus-tcp.service

[Unit]
Description=myems-modbus-tcp daemon
After=network.target

[Service]
User=root
Group=root
ExecStart=/myems-modbus-tcp/venv/bin/python3 /myems-modbus-tcp/main.py
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
PrivateTmp=true
Restart=always

[Install]
WantedBy=multi-user.target

Setup systemd service:

sudo cp myems-modbus-tcp.service /lib/systemd/system/

Enable the service:

sudo systemctl enable myems-modbus-tcp.service

Start the service:

sudo systemctl start myems-modbus-tcp.service

Monitor the service:

sudo systemctl status myems-modbus-tcp.service

View the log:

cat /myems-modbus-tcp.log

Step 5 myems-cleaning

In this step, you will install myems-cleaning service.

sudo cp -r ~/myems/myems-cleaning /myems-cleaning

cd /myems-cleaning

To prevent 'error: externally-managed-environment', create a virtual environment configuration folder:

sudo python -m venv venv

Start using the virtual environment

source venv/bin/activate

Install the requirements

sudo venv/bin/pip install -r requirements.txt

Deactive the virtual environment

deactivate

Copy exmaple.env file to .env and modify the .env file:

sudo cp /myems-cleaning/example.env /myems-cleaning/.env

nano /myems-cleaning/.env

Change python path in myems-cleaning.service

sudo nano myems-cleaning.service

[Unit]
Description=myems-cleaning daemon
After=network.target

[Service]
User=root
Group=root
ExecStart=/myems-cleaning/venv/bin/python3 /myems-cleaning/main.py
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
PrivateTmp=true
Restart=always

[Install]
WantedBy=multi-user.target

Setup systemd service:

sudo cp /myems-cleaning/myems-cleaning.service /lib/systemd/system/

Enable the service:

sudo systemctl enable myems-cleaning.service

Start the service:

sudo systemctl start myems-cleaning.service

Monitor the service:

sudo systemctl status myems-cleaning.service

View the log:

cat /myems-cleaning.log

Step 6 myems-normalization

In this step, you will install myems-normalization service.

sudo cp -r ~/myems/myems-normalization /myems-normalization

cd /myems-normalization

To prevent 'error: externally-managed-environment', create a virtual environment configuration folder:

sudo python -m venv venv

Start using the virtual environment

source venv/bin/activate

Install the requirements

sudo venv/bin/pip install -r requirements.txt

Deactive the virtual environment

deactivate

Copy exmaple.env file to .env and modify the .env file:

sudo cp /myems-normalization/example.env /myems-normalization/.env

sudo nano /myems-normalization/.env

Change python path in myems-normalization.service

sudo nano myems-normalization.service

[Unit]
Description=myems-normalization daemon
After=network.target

[Service]
User=root
Group=root
ExecStart=/myems-normalization/venv/bin/python3 /myems-normalization/main.py
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
PrivateTmp=true
Restart=always

[Install]
WantedBy=multi-user.target

Setup systemd service:

sudo cp /myems-normalization/myems-normalization.service /lib/systemd/system/

Enable the service:

sudo systemctl enable myems-normalization.service

Start the service:

sudo systemctl start myems-normalization.service

Monitor the service:

sudo systemctl status myems-normalization.service

View the log:

cat /myems-normalization.log

Step 7 myems-aggregation

In this step, you will install myems-aggregation service.

sudo cp -r ~/myems/myems-aggregation /myems-aggregation

cd /myems-aggregation

To prevent 'error: externally-managed-environment', create a virtual environment configuration folder:

sudo python -m venv venv

Start using the virtual environment

source venv/bin/activate

Install the requirements

sudo venv/bin/pip install -r requirements.txt

Deactive the virtual environment

deactivate

Copy exmaple.env file to .env and modify the .env file:

sudo cp /myems-aggregation/example.env /myems-aggregation/.env

sudo nano /myems-aggregation/.env

Change python path in myems-aggregation.service

sudo nano myems-aggregation.service

[Unit]
Description=myems-aggregation daemon
After=network.target

[Service]
User=root
Group=root
ExecStart=/myems-aggregation/venv/bin/python3 /myems-aggregation/main.py
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
PrivateTmp=true
Restart=always

[Install]
WantedBy=multi-user.target

Setup systemd service:

sudo cp /myems-aggregation/myems-aggregation.service /lib/systemd/system/

Enable the service:

sudo systemctl enable myems-aggregation.service

Start the service:

sudo systemctl start myems-aggregation.service

Monitor the service:

sudo systemctl status myems-aggregation.service

View the log:

cat /myems-aggregation.log

Step 8 myems-web

In this step, you will install myems-web UI service.

Install NGINX Server (If already installed in myems-admin, it can be ignored) refer to http://nginx.org/en/docs/install.html
Configure NGINX

sudo nano /etc/nginx/nginx.conf

In the 'http' section, add some directives (If already configured in myems-admin, it can be ignored)

http {
    client_header_timeout 600;
    client_max_body_size 512M;
    gzip on;
    gzip_min_length 512;
    gzip_proxied any;
    gzip_types *;
    gzip_vary on;
    proxy_buffering off;

    ...
}

In the 'http' section, add a new 'server' section with directives as below:

  server {
      listen                 80;
      server_name     myems-web;
      location / {
          root    /var/www/myems-web;
          index index.html index.htm;
          # add try_files directive to avoid 404 error while refreshing pages
          try_files $uri  /index.html;
      }
      ## To avoid CORS issue, use Nginx to proxy myems-api to path /api
      ## Add another location /api in 'server'
      ## NOTE: replace dafault address http://127.0.0.1:8000/ with actual IP or URL
      location /api {
          proxy_pass http://127.0.0.1:8000/;
          proxy_connect_timeout 75;
          proxy_read_timeout 600;
          send_timeout 600;
      }
  }

Install MyEMS Web UI:

Install NodeJS:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo bash -

sudo apt-get install -y nodejs

Modify the config.js file:

note

Get mapboxToken at https://mapbox.com and then set showOnlineMap to true. If you wnat to turn off online map feature, set showOnlineMap to false

cd ~/myems/myems-web

sudo nano src/config.js

Build and Compress:

sudo npm i --unsafe-perm=true --allow-root --legacy-peer-deps

sudo npm run build

Install

sudo mv build  /var/www/myems-web

Restart the NGINX:

sudo systemctl restart nginx

Add port to firewall:

sudo ufw allow 80

Post-installation

Congratulations! You are able to login the MyEMS Admin UI and Web UI now.

Default Ports

MyEMS Web UI: 80

MyEMS API: 8000

MyEMS Admin UI: 8001

Default Passwords

Admin UI

administrator

!MyEMS1

Web UI

administrator@myems.io

!MyEMS1

Raspberry Pi

Prerequisites​

Clone Source Code​

Step 1 Database​

Step 2 myems-api​

Step 3 myems-admin​

Step 4 myems-modbus-tcp​

Step 5 myems-cleaning​

Step 6 myems-normalization​

Step 7 myems-aggregation​

Step 8 myems-web​

Post-installation​

Default Ports​

Default Passwords​

Troubleshooting​

Prerequisites

Clone Source Code

Step 1 Database

Step 2 myems-api

Step 3 myems-admin

Step 4 myems-modbus-tcp

Step 5 myems-cleaning

Step 6 myems-normalization

Step 7 myems-aggregation

Step 8 myems-web

Post-installation

Default Ports

Default Passwords

Troubleshooting