Quick navigation

Child pages (Children Display)

all	true
page	Simple Iot TutorialTutorials

Panel

title	Goal

Anchor

	1
	1

In the previous tutorial we created a list of 2 equipmentssensors. In this tutorial we're going to create an organ which will make equipments sensors for us and 2 two automates to handle this new list.

System architecture:

Image RemovedImage Added

Panel

title	RequiermentsRequirements

To follow this tutorial you must have done the Basic Equipment Tutorial.

Before we can use our new model we're going to need equipments for them to handle.

The createEquipment organ will create 10 equipments in a new list stored as "automate".

createEquipment/index.js

Panel

title	The automate model

Anchor

	2
	2

In this part we will create another model a new model, named an "automate", that will be in charge of a group of equipmentsensors. This model needs 2 attributes:

name: so we can create multiple automates without losing track of and identify them
equipmentssensors: an an array of the equipments the automate has in charge

To append at the end of spinal-model/model

sensors that are managed by this automate

We're going to add an empty array named automates as property of the SensorListModel and create a model Automate with the two previously described attributes.

Take care of SensorListModel, an automate as been added to the model.

spinal-models/models.js

Code Block

language	js
theme	DJango
linenumbers	true

function automateclass SensorModel extends Model {
  constructor() {
    automate.super(this);
    this.add_attr({
      nameid: ""0,
      equipments: []name: "",
      hydrometry: 0,
      temperature: 0,
      pressed: false
    });
  }
spinalCore.extend(automate, Model);
}
module.exports.SensorModel = automate;

Panel

title	The createEquipment organ

Anchor

3

Code Block

language	js
theme	DJango
linenumbers	true

// Requirements and connection
const spinalCore = require('spinal-core-connectorjs');
require('../spinal-model/model.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}/`);

//  We load our automate
spinalCore.load(conn, "Automate", function (automate) {
  // callback success
}, function () {
  // callback error: We create a new list
  var list = new equipmentList();
  spinalCore.store(conn, list, "Automate", function () {
    addItem(list);
  });
}
);

//  We add 10 new equipments to the list
function addItem(list) {
  for (let i = 0; i < 10; i++) {
    let item = new equipment();

    item.id.set(i);
    item.name.set("equipment" + i);
    item.hydrometry.set(Math.floor(Math.random() * 30));
    item.temperature.set(Math.floor(Math.random() * 100));
    list.equipments.push(item);
  }
}

You can test it to see if it is working fine.

Code Block

language	bash
theme	DJango

~/equipment-system/createEquipment$ node index.js

A new list named "Automate" should have appeared in the admin UI, put it in the inspector.

Image Removed

You can see that that the equipment array contains 10 items whereas the automate array is empty.

At this point in this tutorial our spinal system looks like this:

Image Removed

Panel

title	Simulate sensors with automates

Anchor44

We are now going to create 2 automates. Each one will be in charge of 5 equipment from the list. Both will periodically choose one of their equipment and change its hydrometry and temperature.

Automate 1

Create a new organ named "automate1".

Code Block

language	bash
theme	DJango

~/equipment-system$ mkdir automate1
~/equipment-system$ cd automate1
~/equipment-system/automate1$ touch index.js

automate1/index.js

Code Block

language	js
theme	DJango
linenumbers	true

// Requirements and connection
const spinalCore = require('spinal-core-connectorjs');
require('../spinal-model-button/model.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}/`);

// Loading the list
spinalCore.load(conn, "Automate", function (list) {
// callback success: if the array of automates is empty we create a first automate, else we press the first automate
  if (list.automates.length < 1)
    addAutomate(list);
  press(list.automates[0]);
}, function () {
// callback error
});

// Adds an automate to the list and attributes him the first 5 equipments
function addAutomate(list) {
  var automate1 = new automate();

  automate1.name.set("automate0");
  for (let i = 0; i < 5; i++) {
    automate1.equipments.push(list.equipments[i]);
  }
  list.automates.push(automate1);
}

// Randomly selects an equipment in the list and changes its hydrometry and temperature
function press(automate) {
  let selectEquipement = Math.floor(Math.random() * 5);
  const equipment = automate.equipments[selectEquipement];
  let hydro = Math.floor(Math.random() * 100);
  let degrees = Math.floor(Math.random() * 30);

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

// Repeats every second
  setTimeout(function () {
    console.log("automate1: has been pressed");
    press(automate);
  }, 1000);
}

Automate 2

Automate2 will be almost identical to automate1 so I suggest you start by copying automate1.

Code Block

language	bash
theme	DJango

~/equipment-system/automate1$ cd ..
~/equipment-system$ cp -r automate1 automate2
~/equipment-system$ cd automate2

There are very few changes to make to index.js so I will point them out instead of explaining everything again.

Code Block

language	js
theme	DJango
linenumbers	true

var spinalCore = require('spinal-core-connectorjs');
require('../spinal-model/model.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";

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

spinalCore.load(conn, "Automate", function (list) {
//  An automate is created if there are less than 2 (instead of 1)
  if (list.automates.length < 2)
    addAutomate(list);
//  The list.automates[1] is pressed (instead of list.automates[0])
  press(list.automates[1]);
}, function () {
});

function addAutomate(list) {
// The variable is named automate2 in this function (instead of automate1)
  var automate2 = new automate();

// The name of the automate is automate1 (instead of automate0)
  automate2.name.set("automate1");
// The loop goes from 5 to 10 (instead of from 0 to 5)
  for (let i = 5; i < 10; i++) {
    automate2.equipments.push(list.equipments[i]);
  }
  list.automates.push(automate2);
}

function press(automate) {
  let selectEquipement = Math.floor(Math.random() * 5);
  const equipment = automate.equipments[selectEquipement];
  let hydro = Math.floor(Math.random() * 100);
  let degrees = Math.floor(Math.random() * 30);

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

  setTimeout(function () {
// This log message changes
    console.log("automate2: has been pressed");
    press(automate);
  }, 1000);
}

Panel

title	Test your system

Anchor55

Don't forget to add all this new organs to your .apps.json if it isn't already done.

.apps.json

Code Block

language	js
theme	DJango
linenumbers	true

{
  "apps": [
    {
      "name": "spinal-core-hub",
      "script": "spinalhub.js",
      "cwd": "./nerve-center/"
    },
    {
      "name": "createEquipement",
      "script": "index.js",
      "cwd": "./createEquipement/"
    },
    {
      "name": "automate1",
      "script": "index.js",
      "cwd": "./automate1/"
    },
    {
      "name": "automate2",
      "script": "index.js",
      "cwd": "./automate2/"
    }
  ]
}

Image Removed

2 new automates with 5 equipment each should have appeared in your list. You can compare the equipments in the equipments array and those in the automates to verify that they correspond.

Panel

title	Create warnings

Anchor66

We now have 2 automates that change the data of equipments. Let's add analytic to the press function to catch those modifications.

We will change the press function in both so that when the hydrometry exceeds 70% or the temperature

automate1/index.js

Code Block

language	js
theme	DJango
firstline	29
linenumbers	true

function press(automate) {
  let selectEquipement = Math.floor(Math.random() * 5);
  const equipment = automate.equipments[selectEquipement];
  let hydro = Math.floor(Math.random() * 100);
  let degrees = Math.floor(Math.random() * 30);

  equipment.hydrometry.set(hydro);
  equipment.temperature.set(degrees);
//  If the equipment's hydrometry or temperature are above certain value we send a message and press the equipment 
  if (hydro > 70 || degrees > 20) {
    equipment.pressed.set(true);
    console.log("Alert: " + equipment.name.get() + " warning");
  } else
// Else we release the equipment
    pressed.set(false);

  setTimeout(function () {
    console.log("automate1: has been pressed");
    press(automate);
  }, 1000);
}

automate2/index.js

Code Block

language	js
theme	DJango
firstline	29
linenumbers	true

function press(automate) {
  let selectEquipementSensorModel;

class SensorListModel extends Model {
  constructor() {
    super();
    this.add_attr({
      sensors: [],
      automates: []
    });
  }
}
module.exports.SensorListModel = SensorListModel;

// Automate model
class AutomateModel extends Model {
  constructor() {
    super();
    this.add_attr({
      name: "",
      sensors: []
    });
  }
}
module.exports.AutomateModel = AutomateModel;

Panel

title	The createSensor organ

Anchor

	3
	3

Before we can use our new model we're going to need sensors for them to handle.

The createSensor organ will create 10 virtual sensors in a new list stored in the file "Automate".

Create a folder called createSensor and add a file called index.js inside.

createSensor/index.js

Code Block

language	js
theme	DJango
linenumbers	true

// 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}/`);

//  We load our automate
spinalCore.load(conn, "Automate", function (automate) {
  // callback success
}, function () {
  // callback error: We create a new list
  const list = new models.SensorListModel();
  spinalCore.store(conn, list, "Automate", function () {
    addItem(list);
  });
}
);

//  We add 10 new equipments to the list
function addItem(list) {
  for (let i = 0; i < 10; i++) {
    let item = new models.SensorModel();

    item.id.set(i);
    item.name.set("equipment" + i);
    item.hydrometry.set(Math.floor(Math.random() * 30));
    item.temperature.set(Math.floor(Math.random() * 100));
    list.sensors.push(item);
  }
}

Install spinal-core-connectorjs from GitHub.

You can test it to see if it is working fine.

A new file named "Automate" should have appeared in the admin UI. Drag & Drop it in the inspector.

Image Added

You can see that the sensor array contains 10 sensors whereas the automate array is still empty.

At this point in this tutorial our spinal system looks like this:

Image Added

Panel

title	Simulate sensors with automates

Anchor

	4
	4

We are now going to create 2 automates. Each one will be in charge of 5 sensors from the list. Both will periodically choose one of their sensors and change its hygrometry and temperature.

Create two folders, called automate1 and automate2 and inside, create a file index.js.

Don't forget to install spinal-core-connectorjs from GitHub, inside the two folders.

Automate 1

automate1/index.js

Code Block

language	js
theme	DJango
linenumbers	true

// 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}/`);

// Loading the list
spinalCore.load(conn, "Automate", function (list) {
// callback success: if the array of automates is empty we create a first automate, else we press the first automate
  if (list.automates.length < 1)
    addAutomate(list);
  press(list.automates[0]);
}, function () {
// callback error
});

// Adds an automate to the list and attributes him the first 5 equipments
function addAutomate(list) {
  var automate1 = new models.AutomateModel();

  automate1.name.set("automate0");
  for (let i = 0; i < 5; i++) {
    automate1.sensors.push(list.sensors[i]);
  }
  list.automates.push(automate1);
}

// Randomly selects a sensor in the list and changes its hygrometry and temperature
function press(automate) {
  let selectedEquipment = Math.floor(Math.random() * 5);
  const sensor = automate.sensors[selectedEquipment];
  let hydro = Math.floor(Math.random() * 100);
  let degrees = Math.floor(Math.random() * 30);

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

// Repeats every second
  setTimeout(function () {
    console.log("automate1: has been pressed");
    press(automate);
  }, 1000);
}

Automate 2

Automate2 will be almost identical to automate1 so I suggest you start by copying automate1 and modify the file as follow.

Code Block

language	js
theme	DJango
linenumbers	true

// 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}/`);

// Loading the list
spinalCore.load(conn, "Automate", function (list) {
  // callback success: if the array of automates is empty we create a first automate, else we press the first automate
  if (list.automates.length < 2)
    addAutomate(list);
  press(list.automates[1]);
}, function () {
  // callback error
});

// Adds an automate to the list and attributes him the first 5 sensors
function addAutomate(list) {
  var automate = new models.AutomateModel();

  automate.name.set("automate1");
  for (let i = 5; i < 10; i++) {
    automate.sensors.push(list.sensors[i]);
  }
  list.automates.push(automate);
}

// Randomly selects a sensor in the list and changes its hygrometry and temperature
function press(automate) {
  let selectedSensor = Math.floor(Math.random() * 5);
  const sensor = automate.sensors[selectedSensor];
  let hydro = Math.floor(Math.random() * 100);
  let degrees = Math.floor(Math.random() * 30);

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

  // Repeats every second
  setTimeout(function () {
    console.log("automate2: has been pressed");
    press(automate);
  }, 1000);
}

Panel

title	Test your system

Anchor

	5
	5

Don't forget to add all this new organs to your .apps.json if you wan't to use pm2 to launch them.

.apps.json

Code Block

language	js
theme	DJango
linenumbers	true

{
  "apps": [
    {
      "name": "spinal-core-hub",
      "script": "spinalhub.js",
      "cwd": "./nerve-center/"
    },
    {
      "name": "createSensor",
      "script": "index.js",
      "cwd": "./createSensor/"
    },
    {
      "name": "automate1",
      "script": "index.js",
      "cwd": "./automate1/"
    },
    {
      "name": "automate2",
      "script": "index.js",
      "cwd": "./automate2/"
    }
  ]
}

Image Added

2 new automates with 5 sensors each should have appeared in your list. You can compare the sensors in the array and those in the automates to verify that they correspond.

Panel

title	Create warnings

Anchor

	6
	6

We now have 2 automates that change the data of their sensors. Let's add analytic to the press function to catch those modifications.

We will change the press function in both so that when the hygrometry exceeds 70% or the temperature exceeds 20°, it will create a alert log.

automate1/index.js

Code Block

language	js
theme	DJango
linenumbers	true

// 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}/`);

// Loading the list
spinalCore.load(conn, "Automate", function (list) {
// callback success: if the array of automates is empty we create a first automate, else we press the first automate
  if (list.automates.length < 1)
    addAutomate(list);
  press(list.automates[0]);
}, function () {
// callback error
});

// Adds an automate to the list and attributes him the first 5 equipments
function addAutomate(list) {
  var automate1 = new models.AutomateModel();

  automate1.name.set("automate0");
  for (let i = 0; i < 5; i++) {
    automate1.sensors.push(list.sensors[i]);
  }
  list.automates.push(automate1);
}

// Warning fonction alert log for hygrometry and temperature
function press(automate) {
  const selectedSensor = Math.floor(Math.random() * 5);
  const sensor = automate.sensors[selectedSensor];
  const hydro = Math.floor(Math.random() * 100);
  const degrees = Math.floor(Math.random() * 30);

  sensor.hydrometry.set(hydro);
  sensor.temperature.set(degrees);
  //  If the sensor's hygrometry or temperature are above certain value we send a message and press the sensor
  if (hydro > 70 || degrees > 20) {
    sensor.pressed.set(true);
    console.log("Alert: " + sensor.name.get() + " warning");
  } else
    // Else we release the sensor
    sensor.pressed.set(false);

  setTimeout(function () {
    console.log("automate1: has been pressed");
    press(automate);
  }, 1000);
}

automate2/index.js

Code Block

language	js
theme	DJango
linenumbers	true

// 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}/`);

// Loading the list
spinalCore.load(conn, "Automate", function (list) {
  // callback success: if the array of automates is empty we create a first automate, else we press the first automate
  if (list.automates.length < 2)
    addAutomate(list);
  press(list.automates[1]);
}, function () {
  // callback error
});

// Adds an automate to the list and attributes him the first 5 sensors
function addAutomate(list) {
  var automate = new models.AutomateModel();

  automate.name.set("automate1");
  for (let i = 5; i < 10; i++) {
    automate.sensors.push(list.sensors[i]);
  }
  list.automates.push(automate);
}

// Warning fonction alert log for hygrometry and temperature
function press(automate) {
    const selectedEquipment = Math.floor(Math.random() * 5);
    const equipmentsensor = automate.equipmentssensors[selectEquipementselectedEquipment];
    letconst hydro = Math.floor(Math.random() * 100);;
    letconst degrees = Math.floor(Math.random() * 30);

  equipment  sensor.hydrometry.set(hydro);
   equipment sensor.temperature.set(degrees);
    if (hydro > 70 || degrees > 20) {
       equipment sensor.pressed.set(true);
        console.log("Alert: " + equipmentsensor.name.get() + " warning");
    } else
        equipmentsensor.pressed.set(false);

    setTimeout(function () {
        console.log("automate2: has been pressed");
        press(automate);
    }, 1000);
}

Now use pm2 restart and pm2 log to see when an equipment is in dangerunder alarm.

Code Block

language	bash
theme	DJango

~/button-system$ pm2 restart launch.config.js
~/button-system$ pm2 log

You should see something like this.

Image Removed

Conclusion

In this tutorial you learned how to:

Automatically created equipments create sensors using an organ
Created 2 automates to handle the equipmentssensors
Made those automates display warnings if a problem occurs

This tutorial will be continued in Get your Automate in the viewer.

...

Versions Compared

Old Version 17

New Version Current

Key

Table of contents

Quick navigation

System architecture:

Automate 1

Automate 2

Automate 1

Automate 2

Conclusion

Page Comparison

Versions Compared

Old Version 17

New Version Current

Key

Table of contents

Quick navigation

System architecture:

Automate 1

Automate 2

Automate 1

Automate 2

Conclusion