Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
etc
 
 
 
 
 
 
 
 
 
 
var
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

unipi logo

EVOK - the UniPi API

EVOK is the primary Web-services API for NEURON, AXON and UniPi 1.1 devices. It provides a RESTful interface over HTTP, a JSON-RPC interface, a WebSocket interface a SOAP interface and a bulk JSON interface to UniPi devices.

Evok is still in active development, so any testing, feedback and contributions are very much welcome and appreciated.

APIs included in EVOK:

  • RESTful WebForms API
  • RESTful JSON API
  • Bulk request JSON API
  • WebSocket API
  • SOAP API
  • JSON-RPC API

EVOK also supports sending notifications via webhook.

For more information see our documentation at api-docs.io.

Installation process on AXON/Neuron PLCs using pre-build OS images (recommended)

The latest images for Axon/Neuron controllers can be downloaded from:

UniPi.technology Knowledge Base

All necessary APT UniPi repositories are already preconfigured in the OS images. Therefore, all that's required is to login to the PLC via SSH (there is a large number of clients you can use, for windows we recommend using PUTTY). The default username for Axon PLCs is "unipi" and the default password is "unipi.technology". After you connect to your Axon PLC execute the following commands:

sudo su
apt-get update
apt-get upgrade
reboot

sudo su
apt-get install evok
systemctl enable evok
reboot

It is possible that some (or all) of the above steps will already have been finished previously; in that case simply continue on with the next steps. Performing all the steps will ensure you have the latest version of the software installed.

You can use the following commands to update your EVOK package distribution to a new version:

sudo su
apt-get install evok
reboot

Installation process on Neuron family controllers with fresh Rapsbian image

Warning: if you have previously used the shell script install method noted below you will need to use a clean image!

In order to install EVOK on Neuron you will need an SD card with a standard (Lite) Raspbian Stretch or Raspbian Buster image. It is also necessary to enable SSH on the image by creating an empty file named "ssh" in the boot partition of your SD card (the partition should be visible on all systems which support FAT16, which includes Windows, Linux and OSX among others).

To install EVOK itself first connect to your Neuron using SSH (there is a large number of clients you can use, for windows we recommend using PUTTY). The default username for Raspbian is "pi" and the default password is "raspberry". After you connect to your Neuron execute the following commands:

NOTE: The installation process will overwrite default server configuration for NGINX

sudo su
echo "deb https://repo.unipi.technology/debian $(lsb_release -sc) main" >> /etc/apt/sources.list.d/unipi.list
wget https://repo.unipi.technology/debian/unipi_pub.gpg -O - | apt-key add
apt-get update
apt-get upgrade
reboot

sudo su
apt-get install nginx
rm -f /etc/nginx/sites-enabled/default
apt-get install evok
systemctl enable evok
reboot

It is possible that some (or all) of the above steps will already have been finished previously; in that case simply continue on with the next steps. Performing all the steps will ensure you have the latest version of the software installed.

You can use the following commands to update your EVOK package distribution to a new version:

sudo su
apt-get install unipi-modbus-tools
apt-get install evok
reboot

Legacy installation process using a shell script (REQUIRED FOR UNIPI 1.1!)

In order to install EVOK on your device you will need an SD card with a standard Raspbian Buster or Raspbian Stretch image. It is also necessary to enable SSH on the image by creating an empty file named "ssh" in the boot partition of your SD card (the partition should be visible on all systems which support FAT16, which includes Windows, Linux and OSX among others).

To install EVOK itself first connect to your device using SSH (there is a large number of clients you can use, for windows we recommend using PUTTY). The default username for Raspbian is "pi" and the default password is "raspberry". After you connect to your device execute the following commands:

sudo su
wget https://github.com/UniPiTechnology/evok/archive/2.3.4.zip
unzip 2.3.4.zip
cd evok-2.3.4
bash install-evok.sh

The installation script should take care of everything else, but be aware there may be some issues with limited and/or broken functionality. Please report any bugs you find on the github repository.

Instructions for use

The EVOK API can be accessed in several different ways, including SOAP, REST, Bulk JSON, JSON, WebSocket et al.

For details on how to do so please see our documentation at api-docs.io.

Debugging

When reporting a bug or posting questions to our forum please set proper logging levels in /etc/evok.conf, restart your device and check the log file (/var/log/evok.log). For more detailed log information you can also run evok by hand. To do that you need to first stop the service by executing the following commands (section split according to installation method):

NOTE: Running EVOK manually is more difficult if using the .deb package installation system; it may be simpler to use the log file instead, unless the information it provides is not sufficient

Debian package installation

First execute the command below:

sudo systemctl stop evok

and then run evok manually as root user by executing the following commands:

sudo su
/bin/cp -f /etc/nginx/sites-available/evok /etc/nginx/sites-enabled/
/bin/mv -f /etc/nginx/sites-enabled/mervis /etc/nginx/sites-available/
/bin/rm -f /etc/nginx/sites-enabled/mervis
/bin/ln -sf /etc/nginx/sites-enabled/evok /etc/evok-nginx.conf
cd /opt/evok
systemctl restart nginx
/opt/evok/bin/python /opt/evok/lib/python2.7/site-packages/evok/evok.py

You can then look through/paste the output of the script.

Script installation

First execute the command below:

sudo systemctl stop evok

and then run evok manually as root user by executing the following commnad:

sudo python /opt/evok/evok.py

You can then look through/paste the output of the script.

Uninstallation

Debian package installation

To uninstall EVOK please remove the evok package using the following apt command

sudo su
apt-get remove evok
reboot

Script installation

To uninstall EVOK please run the uninstallation script which is located in the /opt/evok/ folder.

sudo su
bash uninstall-evok.sh

Note that after uninstalling Evok you have to reboot your device to ensure all the files and settings are gone.

The installation script also enables the I2C subsystem (if it is not otherwise enabled before), but the uninstallation script does not disable it again.

Developer Note

Do you feel like contributing to EVOK, or perhaps have a neat idea for an improvement to our system? Great! We are open to all ideas. Get in touch with us via email to info at unipi DOT technology

License

Apache License, Version 2.0


Raspberry Pi is a trademark of the Raspberry Pi Foundation

You can’t perform that action at this time.