Getting started with Keepy Visualizations - Crelde/iotapoweredplants GitHub Wiki
Here you can see how to set up this version of Keepy where you can follow the data live through a web page! :)
Here is a gif of the visualization page in action:
The installation instructions are actually the same as the original Keepy project, I have just added some extra endpoints.
A prerequisite is that you must set up your Streams Gateway first.
Before sharing the instructions on how to set it up, I will mention talk about the endpoints that I have created.
GET /viz
Takes you to a new webpage that lets you select which sensor data point you want to explore in the graph. The dropdown is automatically populated based on the datapoints found in Keepy! ** You need to go into the viz.html file and add your Keepy URL and optionally your own stream explorer url to start seeing the data!**
GET /channels
Returns all distinct channels used in keepy, in order to be able to select which data you want to see.
I will copy paste the current instructions form the original Keepy project below:
Preparing the system
Assuming you are on a fresh VPS you will need to install Git, Nodejs, NPM and Mysql. Feel free to skip those you know are already installed on your system.
sudo apt update
sudo apt install git nodejs npm mysql-server
Next, we will secure our Mysql Server. Here you will be able to define your user password, which will be needed later. You should answer "Yes" to most of the questions the script will do in order to get a secure/clean Mysql Server.
sudo mysql_secure_installation
By default, Keepy runs on the port 3002. We found that some Raspberries do not have that port available, so if you are going to be using the default port you may want to be sure it is open. Install ufw, enable it and allow traffic on the port 3002. If you are installing Keepy on a VPS, this step is not needed.
sudo apt-get install ufw
sudo ufw enable
sudo ufw allow 3002
Keepy Installation
Get the Keepy repository from the I2T Hub
git clone https://github.com/iot2tangle/Keepy.git
Head to the Keepy directory and edit the keepy.sql file to setup your mysql user and password. By default the user is keepy but you can change that.
CREATE USER 'keepy'@'localhost' IDENTIFIED BY 'your_password';
GRANT ALL PRIVILEGES ON * . * TO 'keepy'@'localhost';
ALTER USER 'keepy'@localhost IDENTIFIED WITH mysql_native_password BY 'your_password';
Once all the mysql related changes are done, run this command to import the database and tables needed by Keepy (it will ask for the mysql root password you set during the mysql_secure_installation configuration)
sudo mysql -u root -p < keepy.sql
Edit the database-config.js to provide the correct database name (by default, "keepy"), mysql user and password.
nano database-config.js
Run npm install to get all the needed Nodejs modules.
npm install
Edit the .env.example file and set your Streams Gateway URL, port and endpoint.
# Rename this file to .env
GATEWAY_URL=http://YOUR_GW_IP:8080/sensor_data
Then rename .env.example to .env to launch Keepy with the necessary ENV variables.
mv .env.example .env
Finally, run Keepy!
node keepy.js
You can now send POST/GET requests with your sensors data formatted with the I2T Standard to Keepy. Check the Endpoints section coming next to learn more about it.
http://YOUR_KEEPY_HOST:3002/messages
Endpoints
By default, Keepy runs on the port 3002. You can change that on the keepy.js file.
POST /messages
Before pointing your sensors to Keepy, you can test it with Postman or using the following payload.
curl --location --request POST 'YOUR_KEEPY_HOST:3002/messages' --header 'Content-Type: application/json' --data-raw '{ "iot2tangle": [ { "sensor": "Gyroscope", "data": [ { "x": "4514" }, { "y": "244" }, { "z": "-1830" } ] }, { "sensor": "Acoustic", "data": [ { "mp": "1" } ] } ], "device": "DEVICE_ID_1", "timestamp": 1558511111 }'
[Note: When using Postman, send the data in the Body using the raw tab, and don't forget to specify the body as JSON(application/json)]
If the data is valid (validation is performed in the Streams HTTP Gateway, the validation messages are re-routed), the resulting data will be inserted into the database.
GET /messages
Returns all the available messages stored in the database, sorted by descending order. It accepts the filters limit, which takes a number of elements, and channelId, which filters by Channel ID.
GET /messages?limit=20
Returns the last 20 messages stored in the database, sorted by descending order. You can specify the limit parameter to the number of messages you wish to retrieve.
GET /messages?channelId=YOUR_CHANNEL_ID
Returns the last 20 messages stored in the database, sorted by descending order. You can specify the limit parameter to the number of messages you wish to retrieve.
GET /messages?channelId=YOUR_CHANNEL_ID&limit=5
Returns the last 5 messages that match the specified channelId, sorted by descending order.
GET /messages/last
Returns the last message saved to the database.
Next steps
That was the end of the walk through, by now you should have all three things running and you should see your own sensor data in your /viz.