Panel

title	Goal

Anchor

	1
	1

In this tutorial you will learn how to :

Create a model or a Digital twin of your equipments sensors sensors equipment.
Create organs that simulate your sensors behaviourbehavior.
Launch your organs with efficiency. efficiently

System architecture:

Image RemovedImage Added

Panel

title	Requirements

For this tutorial, you just need the basic requirements

Panel

title	Create 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:

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).
Create a folder called spinal-model-equipments models to store the different models you are going to create. Within this folder create a file modelsnamed model.js.
Complete the file model.js:

Create the sensor model.
Extend the sensor model with the Model of spinal-coreclass from spinalCore.
Export the sensor model.
Create the sensor list.
Extend the sensor list with the Model of spinal-corespinalCore.
Export the sensor list.

Your model file should look like this:

spinal-model-equipmentsmodels/modelmodels.js

Code Block

language	js
theme	DJango
title	models.js
linenumbers	true

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;


// SensorList model
function SensorListSensorListModel inherits from Model
class SensorListModel extends Model {
  constructor() {
    SensorList.super(this);
    // Array of equipments
    this.add_attr({
 
      sensors: []
    });
 	// Creates}
a new sensor and add it to the list
	this.addItem {
    	const item = new Sensor();
    	item.id.set(0);
    	item.name.set("sensor0");
    	this.sensors.push(item);
	};
}
// SensorList inherit of model
spinalCore.extend(SensorList, Model);
module.exports.SensorList = SensorList;

Panel

}
module.exports.SensorListModel = SensorListModel;

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.

Take a look at .app.json
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)
run the commande pm2 start launch.config.json.

.apps.json contains the organs that should be launched. They are identified by:

Panel

title	Instantiate a list of 2 Sensors

Anchor

	3
	3

In this part your are going to instantiate a list of 2 virtual sensors digital twin in the hub database and create two "organs" of the system that will simulate the sensor behaviourbehavior.

Each organ will simulate changes of hygrometry of hygrometry and temperature.

Create a new folder spinal-organ-sensor1 and within it a file named index.js.
in the index.js file:
1. Require spinal-core.
2. Get the connection parameter from the config.js file in the main folder
3. Create a function addItem. This function create, set and add an item to the list given in argument.
4. Create a function simulate. This function simulate the value of the sensor.
5. 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.
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
2. Load list from spinal-core.
Load list from spinal-core.
Create a new folder spinal-organ-sensor2
Copy paste this folder the index.js into sensor2 folder and do the appropriate modification in index.js .appropriate modifications.
Don't forget to install spinal-core-connectorjs from GitHub in the two folders

Panel

title	Note

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.

// Requirement and connection const spinalCore = require('spinal-core-connectorjs'); require('../spinal-model/models.js'); const connection_string = require("../config"); const conn = spinalCore.connect(connection_string); // Gives random values 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(() => { console.log("sensor 1: data has changed"); simulate(sensor); }, 1000); }; findIndexById = (id, list) => { if (list.sensors.length <= 0) return -1; let i; for (i = 0; i <

Code Block

language	js
theme	DJango
title	sensor1/index.js
linenumbers	true


title	spinal-organ-sensor1/index.js
linenumbers	true

// Requirements and connection
const spinalCore = require('spinal-core-connectorjs');
const models = require('../spinal-models/models.js');


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 hygrometry and temperature of a sensor
function simulate(sensor) {
  const hydro = Math.floor(Math.random() * 100);
  const degrees = Math.floor(Math.random() * 30);
  sensor.hygrometry.set(hydro);
  sensor.temperature.set(degrees);
  // Repeats every second
  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 && list.sensors[i].id !== id; i++); {
    if (i < list.sensors.length)[i].id.get() === id) {
      item  return i= list.sensors[i];
    else  break;
     }
return -1; };
 //this functionif will(typeof beitem called if the list is successfully load
onSuccess = (list) => {
    const index = findIndexById(0, list=== "undefined") {
    item = new models.SensorModel();
    item.id.set(id);
    consoleitem.name.logset("successsensor" 2+ : index:", index);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, 0));
};

//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, 0);

  spinalCore.store(conn, list, "List", () => {
        addItem(listsimulate(item);
 
  });
};

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

Run sensor1 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

language	js
theme	DJango
title	Sensor2spinal-organ-sensor2/index.js
linenumbers	true

// 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

title	Launch efficiently your organs

Anchor

4

Image Added

Panel

title	Launch 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.

Take a look at .app.json.
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)
run the commande pm2 restart launch.config.json.

Your .app.json should look like this:

Code Block

language	js
theme	DJango
linenumbers	true

{
  "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.

...

Versions Compared

Old Version 46

New Version Current

Key

Table of contents

Quick navigation

System architecture:

Conclusion

Page Comparison

Versions Compared

Old Version 46

New Version Current

Key

Table of contents

Quick navigation

System architecture:

Conclusion