In this tutorial you will learn how to :

1. Create a model or a Digital twin of your sensors equipment.
2. Create organs that simulate your sensors behavior.
3. Launch your organs with efficiently

System architecture:

Image RemovedIn Image Added

In this part we will create 2 new you’re going to create two sensor models:

• equipmentSensor, a complex model with 5 4 attributes:
  • id
  , name, hydrometry, temperature and pressed (boolean)
• equipmentList, a model that contains an array of equipments

• • : unique integer
  • name : string 
  • hygrometry : integer
  • temperature : integer
• SensorList, a model with 1 attribute:
  
  • sensors : array of sensors
    

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

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

Your model file should look like this:

spinal-models/models.js

const// spinalCoreSensorModel = require("spinal-core-connectorjs");
// 1: Previously used buttonModel
function buttonModel() {
    buttonModel.super(this);
    this.add_attr({
        pressed: false
    });
}
spinalCore.extend(buttonModel, Model);
module.exports = buttonModel;inherits from Model
class SensorModel extends Model {
  constructor() {
    super();
    // 2:add Equipmentattributes modelto functionthe equipment()model
{     equipment.super(this);
// 3: Creating attributes
    this.add_attr({
          id: 0,
          name: "",
         hydrometryhygrometry: 0,
         temperature: 0,
    });
  }
pressed: false
    });
}}
module.exports.SensorModel = SensorModel;

// 4:SensorListModel Registeringinherits thefrom equipmentModel
modelclass in the Spinal system
spinalCore.extend(equipment, Model);
module.exports = equipment;

// 5: equipmentList model
function equipmentList() {
    equipmentList.super(this);
// 6:SensorListModel extends Model {
  constructor() {
    super();
    // Array of equipments
      this.add_attr({
         equipmentssensors: []
      });
} // 4: Registering the equipmentList model in the Spinal system
spinalCore.extend(equipmentList, Model);
}
}
module.exports.SensorListModel = equipmentListSensorListModel;

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

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.

Equipment 1

1. Create a

1. new folder spinal-organ-sensor1 and within it a file named index.js

~/button-system$ mkdir equipment1
~/button-system$ cd equipment1
~/button-system/equipment1$ touch index.js

1. .
2. 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 function will be executed if the loading of ‘List’ is successful. 
   6. Create a function onFaill. This function will be executed if the loading of ‘List’ fail.
   7. Load list from spinal-core.
3. Create a new folder spinal-organ-sensor2 
4. Copy paste the index.js into sensor2 folder and do the appropriate modifications.
5.  Don't forget to install spinal-core-connectorjs from GitHub in the two folders

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

// 

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; i++) {
    if (list.sensors[i].id.get() === id) {
      item = list.sensors[i];
      break;
    }
  }
  if (typeof item === "undefined") {
  

  item = new 

models.SensorModel();
    item.id.set(

id);
    item.name.set("

sensor" + id);
    list.

sensors.push(item);
  

}
  return item;
}

// 

This function will be called if the 

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", () => {
    

simulate(item);
  });
};

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

~/button-system/equipment1$ node index.js

Run spinal-organ-sensor1/index.js and go to the admin UI and put 'List' into the inspector and you should see the

hygrometry and temperature of

sensor0 change every second.

Image Removed

Equipment2

Image Added

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

equipment2/index.js

~/button-system/equipement1$ cd ..
~/button-system$ cp -r equipment1 equipment2
~/button-system$ cd equipment2

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

models/

models.js');

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

~/button-system/equipment2$ node index.js

sensors.length; i++) {
    if (list.sensors[i].id.get() === id) {
      item = list.sensors[i];
      break;
    }
  }
  if (typeof item === "undefined") {
    item = new models.SensorModel();
    item.id.set(id);
    item.name.set("sensor" + id);
    list.sensors.push(item);
  }
  return item;
}

// This function will be called if the list is successfully loaded
function onSuccess(list) {
  simulate(getSensorById(list, 1));
};

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

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

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