Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Quick navigation

Child pages (Children Display)
alltrue
pageSimple Iot TutorialTutorials


Panel
titleGoal

Anchor
1
1

In this tutorial you will learn how to :

  1. Create a model or a Digital twin of your equipments sensors sensors equipment.
  2. Create organs that simulate your sensors behaviourbehavior.
  3. Launch your organs with efficiency. efficiently
System architecture:

Image RemovedImage Added


Panel
titleRequirements

For this tutorial, you just need the basic requirements


Panel
titleCreate the models / Digital twins

Anchor
2
2

In this part you’re going to create two sensor models:

  • Sensor, a object model with 4 attributes:
    • id : unique intinteger
    • name : string 
    •  hygrometry hygrometry : intinteger
    •  temperature temperature : intinteger
  • sensorListSensorList, an object a model with 1 listattribute:
    • sensors :  []array of sensors

Create your spinal system and digital twin by following these steps:

  1. Create a new spinal-system with from the browser-admin template like it’s (explained in the in the section section "Creating a new Spinal System" in the Getting Started tutorial).
  2. Create a folder called spinal-model models to store the different models you are going to create. Within this folder create a file modelsnamed model.js.
  3. Complete the file model.js:
    1. Create the sensor model.
    2. Extend the sensor model with the Model of spinal-coreclass from spinalCore.
    3. Export the sensor model.
    4. Create the sensor list.
    5. Extend the sensor list with the Model of spinal-corespinalCore.
    6. Export the sensor list.

Your model file should look like this:

spinal-modelmodels/modelmodels.js

Code Block
languagejs
themeDJango
titlemodels.js
linenumberstrue
const// spinalCoreSensorModel = require("spinal-core-connectorjs");

// Sensor model
function Sensorinherits from Model
class SensorModel extends Model {
  constructor() {
    Sensor.super(this);
    // add attributes to the model
    this.add_attr({
 
      id: 0,

       name: "",
        hydrometryhygrometry: 0,
 
      temperature: 0,
    });
}
//
Sensor inherit of model
spinalCore.extend(Sensor, Model);
}
}
module.exports.SensorSensorModel = SensorSensorModel;


// SensorListSensorListModel model
function SensorListinherits from Model
class SensorListModel extends Model {
  constructor() {
    SensorList.super(this);
    // Array of equipments
    this.add_attr({
        sensors: []
    });
}
// SensorList inherit of model
spinalCore.extend(SensorList, Model);}
}
module.exports.SensorListSensorListModel = SensorListSensorListModel;



If you have and API to
  1.  Don't forget to install spinal-core-connectorjs from GitHub in the two folders


Panel
titleCreate Instantiate a list of 2 SensorSensors

Anchor
3
3

In this part your are going to create instantiate a list of 2 sensors.

Every sensor will have its own organ.

Each one of those will have an automate which will change its hydrometry and temperature.

create a list of two sensor:virtual sensors in the database and create two "organs" of the system that will simulate the sensor behavior.

Each organ will simulate changes of hygrometry and temperature.


  1. Create a new folder spinal-organ-sensor1 and within it a file named index.js.
  2. in the index.js file:
    1. Require spinal-core.
    2. Get the connection
    string
    1. parameter from the config.js
    .
    1. file in the main folder
    2. Create a function addItem. This function create, set and add an item to the list given in argument.
    3. Create a function simulate. This function simulate the value of the sensor.
    4. Create a function onSuccess.
    this
    1. This function will be executed if the loading of ‘List’ is successful.
    For this part you to add an element to the list if the list is empty and simulate the data of this element this element.
    1.  
    2. Create a function onFaill.
    this
    1. This function will be executed if the loading of ‘List’ fail.
    For this part if the loading fail you want to create a new list and store it into
    1. Load list from spinal-core.
    Load list from spinal-core.
  3. Create a new folder spinal-organ-sensor2 
  4. Copy paste this folder the index.js into sensor2 folder and do the appropriate modification in indexmodifications.js .
Panel
titleNote
Panel
titleNote
  • If you have and API to retrieve the real data of your sensor use it to send real data to the graph.
  • You can run every sensor independently by running the corresponding index.js (node index.js)


Your file spinal-organ-sensor1/index.js should look like this.

Code Block
languagejs
themeDJango
titlespinal-organ-sensor1/index.js
linenumberstrue
// RequirementRequirements and connection
const spinalCore = require('spinal-core-connectorjs');
const models = require('../spinal-modelmodels/models.js');

const
connection_string = require("../config");process.env.SPINALHUB_PORT = 7777;
process.env.SPINALHUB_IP = "127.0.0.1";
process.env.SPINAL_USER_ID = 168;
process.env.SPINAL_PASSWORD = "JHGgcz45JKilmzknzelf65ddDadggftIO98P";

const conn = spinalCore.connect(connection_string);
`http://${process.env.SPINAL_USER_ID}:${process.env.SPINAL_PASSWORD}@${process.env.SPINALHUB_IP}:${process.env.SPINALHUB_PORT}/`);

// CreatesGives arandom newvalues sensorto andthe addhygrometry itand totemperature theof lista addItemsensor
=function simulate(listsensor) => {

   const itemhydro = new Sensor();
    item.id.set(0);
    item.name.set("sensor0" Math.floor(Math.random() * 100);
  const degrees = Math.floor(Math.random() * 30);
  sensor.hygrometry.set(hydro);
    listsensor.sensorstemperature.push(item);
    simulate(itemset(degrees);
};  // GivesRepeats randomevery valuessecond
to the hydrometry and temperature of a sensor
simulate = (sensor) => {
    const hydro = Math.floor(Math.random() * 100);
    const degrees = Math.floor(Math.random() * 30);

    sensor.hydrometry.set(hydro);
    sensor.temperature.set(degrees);

    // Repeats every second
    setTimeout(() =>setTimeout(() => {
    console.log(sensor.name.get() + ": data has changed");
    simulate(sensor);
  }, 1000);
};

// Finds a Sensor in the SensorList, if it doesn't exist, creates it
function getSensorById(list, id) {
  let item;

  for (let i = 0; i < list.sensors.length; i++) {
    if (list.sensors[i].id.get() === id) {
      item = console.log("sensor 1: data has changed");
        simulate(sensor)list.sensors[i];
      break;
    },
 1000); };
 findIndexById =if (id,typeof list)item =>=== "undefined") {
    if (list.sensors.length <= 0)item = new models.SensorModel();
    item.id.set(id);
    return -1 item.name.set("sensor" + id);
    let ilist.sensors.push(item);
  }
  return item;
}

for// (iThis =function 0;will ibe <called iif <the list.sensors.length && list.sensors[i].id !== id; i++);

    if (i < list.sensors.length)
        return i;
    else
        return -1;
};

//this function will be called if the list is successfully load
onSuccess = (list is successfully loaded
function onSuccess(list) {
  simulate(getSensorById(list, 0));
};

// This function will be called if the list cannot be loaded
function onFailure() {
  const list = new models.SensorListModel();
  const item = getSensorById(list, 0);

  spinalCore.store(conn, list, "List", () => {
    const index = findIndexById(0, listsimulate(item);
  });
};

  consolespinalCore.logload("success 2 : index:", index);
    if (index !== -1)
        simulate(list.sensors[index]);
    else
        addItem(list);
};

//this function will be called if the list is failed to load
onFail = () => {
    const list = new SensorList();
    spinalCore.store(conn, list, "List", () => {
        addItem(list);
    });
};

spinalCore.load(conn, "List", onSuccess, onFail);

Run sensor1 and go to the
conn, "List", onSuccess, onFailure);


Run spinal-organ-sensor1/index.js and go to the admin UI and put 'List' into the inspector and you should see the hydrometry hygrometry and temperature of sensor0 change every second.

Image RemovedImage Added


Your file file spinal-organ-sensor2/index.js should look like this.

Code Block
languagejs
themeDJango
titleSensor2spinal-organ-sensor2/index.js
linenumberstrue
// RequirementRequirements and connection
const spinalCore = require('spinal-core-connectorjs');
const models = require('../spinal-modelmodels/models.js');
const connection_string = require("../config");
const conn = spinalCore.connect(connection_string);


// Creates a new sensor and add it to the list
addItem = (list) => {
    const item = new Sensor();
    item.id.set(1);
    item.name.set("sensor1");
    list.sensors.push(item);
    simulate(item);
}
console.log("Configuration Environment not found, using default config");
process.env.SPINALHUB_PORT = 7777;
process.env.SPINALHUB_IP = "127.0.0.1";
process.env.SPINAL_USER_ID = 168;
process.env.SPINAL_PASSWORD = "JHGgcz45JKilmzknzelf65ddDadggftIO98P";

const conn = spinalCore.connect(`http://${process.env.SPINAL_USER_ID}:${process.env.SPINAL_PASSWORD}@${process.env.SPINALHUB_IP}:${process.env.SPINALHUB_PORT}/`);

// Gives random values to the hydrometryhygrometry and temperature of a sensor
function simulate = (sensor) => {
 
  const hydro = Math.floor(Math.random() * 100);
 
  const degrees = Math.floor(Math.random() * 30);

    sensor.hydrometryhygrometry.set(hydro);
 
  sensor.temperature.set(degrees);

    // Repeats every second
 
  setTimeout(() => {
  
     console.log("sensor 2.name.get() + ": data has changed");
 
      simulate(sensor);
 
  }, 1000);
};

findIndexById// =Finds (id, list) => {
    if (list.sensors.length <= 0)
        return -1;
 a Sensor in the SensorList, if it doesn't exist, creates it
function getSensorById(list, id) {
  let iitem;

   for (let i = 0; i < i < list.sensors.length && list.sensors[i].id !== id; i++);

    if (i < list.sensors.length) {
    if (list.sensors[i].id.get() === returnid) i;{
    else  item = list.sensors[i];
    return -1; }break;
 //this function will be}
called if the}
list is successfullyif load(typeof onSuccessitem = (list) =>== "undefined") {
    item const= index = findIndexById(1, listnew models.SensorModel();
    consoleitem.id.log("success 2 : index:", indexset(id);
    item.name.set("sensor" + id);
    list.sensors.push(item);
 if (index}
!== -1) return item;
}

// This function  simulate(list.sensors[index]);
    else
        addItem(list)will be called if the list is successfully loaded
function onSuccess(list) {
  simulate(getSensorById(list, 1));
};

//this This function will be called if the list iscannot failedbe toloaded
load
onFail = function onFailure() => {

   const list = new SensorListmodels.SensorListModel();
  const item = getSensorById(list, 1);

  spinalCore.store(conn, list, "List", () => {
   
    addItemsimulate(listitem);
    });
};

spinalCore.load(conn, "List", onSuccess, onFailonFailure);


Image Removed

Panel
titleLaunch efficiently your organs
Anchor44

You might have noticed that running every organ independently is painful.

If you wonder why it’s so painful it’s because you are not supposed to do that :p.

In this part you will learn a to run you organs efficiently.

  1. Take a look at .app.json
  2. add dependency to your organs.
    1. name: The name they will be identified by pm2
    2. script: The name of the script to be executed to launch the organ
    3. cwd: The location of the script (relative to the root of the project)
  3. run the commande pm2 start launch.config.json.
.apps.json contains the organs that should be launched. They are identified by:
 


Image Added


Panel
titleLaunch efficiently your organs

Anchor
4
4

You might have noticed that you are running every organ independently.

In a system where all the organs run on the same server, you can simplify this process and monitor your organs using pm2.

  1. Take a look at .app.json.
  2. add dependency to your organs.
    1. name: The name they will be identified by pm2
    2. script: The name of the script to be executed to launch the organ
    3. cwd: The location of the script (relative to the root of the project)
  3. run the commande pm2 restart launch.config.json.

Your .app.json should look like this:

Code Block
languagejs
themeDJango
linenumberstrue
{
  "apps": [
    {
      "name": "spinal-core-hub",
      "script": "spinalhub.js",
      "cwd": "./nerve-center/"
    },
    {
      "name": "sensor1",
      "script": "index.js",
      "cwd": "./spinal-organ-sensor1/"
    },
    {
      "name": "sensor2",
      "script": "index.js",
      "cwd": "./spinal-organ-sensor2/"
    }
  ]
}

pm2 will now show you sensor 1 and 2 along with spinal-core-hub.

Image RemovedImage Added


Conclusion


In this tutorial you learned:

  • how to create complex models
  • how to organize your data coming from multiple organs
  • how to launch you your organs effectivelyefficiently


This tutorial will be continued in Basic Automate Tutorial.

...