Goal

After the Getting Started tutorial, you should know how to create a spinal-system with one model and one organ. We will now see how to create an intelligent system with more synchronized information.

System architecture:

In this tutorial you will learn how to make a list of items and how to launch your organs with more efficiency.

Requirements

For this tutorial, you just need the basic requirements

The equipment and equipementList models

In this part we will create 2 new models:

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

But first you need to create a spinal-system called 'equipement-system' like in the section Creating a new Spinal System in the Getting Started tutorial, then create a folder spinal-model to store the differents models. Within this folder create a file model.js

spinal-model/model.js

const spinalCore = require("spinal-core-connectorjs");
// Equipment model
function equipment() {
    equipment.super(this);
// Creating attributes
    this.add_attr({
        id: 0,
        name: "",
        hydrometry: 0,
        temperature: 0,
        pressed: false
    });
}
// Registering the equipment model in the Spinal system
spinalCore.extend(equipment, Model);
module.exports = equipment;

// equipmentList model
function equipmentList() {
    equipmentList.super(this);
// Array of equipments
    this.add_attr({
        equipments: []
    });
}
// Registering the equipmentList model in the Spinal system
spinalCore.extend(equipmentList, Model);
module.exports = equipmentList;

Create a list of 2 equipments

With our new models we will now create a list of 2 equipments. We will create an organ for each equipment. Each one will have an automate which changes its hydrometry and temperature.

Equipment 1

Make a folder named equipment1 and the file index.js in it.

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

This organ will create the first equipment and will revover data from a simulated sensor.

equipment1/index.js

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

//  Tries to load 'List'
spinalCore.load(conn, "List", function (list) {
//  If the list exists but is empty a first equipment is added
  if (list.equipments.length < 1)
    addItem(list);
// Else the first equipment is pressed
  else
    press(list.equipments[0]);
}, function () {
// If 'List' doesn't exist an empty list is created and its first equipment is pressed
  const list = new equipmentList();
  spinalCore.store(conn, list, "List", function () {
    addItem(list);
  });
});

// Creates a new equipment and adds it to the list
function addItem(list) {
  const item = new equipment();

  item.id.set(0);
  item.name.set("equipment0");
  list.equipments.push(item);
  press(item);
}

// Gives random values to the hydrometry and temperature of an equipment
function press(equipment) {
  const hydro = Math.floor(Math.random() * 100);
  const degrees = Math.floor(Math.random() * 30);

  equipment.hydrometry.set(hydro);
  equipment.temperature.set(degrees);
// Repeats every second
  setTimeout(function () {
    console.log("equipment 1: has been pressed");
    press(equipment);
  }, 1000);
}

You can launch your new organ with node.

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

Go to the admin UI and put 'List' into the inspector and you should see the hydrometry and temperature of equipment0 change every second.

Equipment2

Equipment2 will be almost identical to equipment1 so I suggest you start by copying equipment1.

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

There are very few changes to make to index.js.

equipment2/index.js

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

spinalCore.load(conn, "List", function (list) {
//  An item is created if there are less than 2 equipments in the list
  if (list.equipments.length < 2)
    addItem(list);
//  The second item is pressed (instead of the first)
  press(list.equipments[1]);
}, function () {
  spinalCore.store(conn, list, "List", function () {
    addItem(list);
  });
});

function addItem(list) {
  let item = new equipment();

  item.id.set(1);
// The new item is named equipment1 (instead of equipment0)
  item.name.set("equipment1");
  list.equipments.push(item);
  press(item);
}

function press(equipment) {
  const hydro = Math.floor(Math.random() * 100);
  const degrees = Math.floor(Math.random() * 30);

  equipment.hydrometry.set(hydro);
  equipment.temperature.set(degrees);
  setTimeout(function () {
//  This message changes
    console.log("equipment 2: has been pressed");
    press(equipment);
  }, 1000);
}

Now launch equipment2 with node.

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

If you go back to the inspector you will notice that a new equipment has appeared in the List.

How to launch you organs effectively

After the last part you might have noticed that the way we have been launching our organs isn't very effective, you have to launch and stop organs one by one.

This is because this is not the right way to do it. In this part you will learn how to launch your organs effectively.

To do that we need to look at .apps.json. When you open it for the first time it should look like this:

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

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

name: The name they will be identified by pm2
script: The name of the script to be executed to launch the organ
cwd: The location of the script (relative to the root of the project)

With all that in mind let's add equipment 1 and 2 to the list.

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

Now all we have to do is let pm2 do the work.

~/equipement-system$ pm2 restart launch.config.json

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

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 effectively

This tutorial will be continued in Basic Automate Tutorial.

Table of contents

Quick navigation

System architecture:

Equipment 1

Equipment2

Conclusion

Basic Equipment Tutorial

Table of contents

Quick navigation

System architecture:

Equipment 1

Equipment2

Conclusion