Difference between revisions of "Cloud configuration for M2MBridge"

From AMTech WikiDocs
Jump to: navigation, search
(Created page with "In order to set up a new bridge or network of bridges, a configuration needs to be done in the cloud (PaaS and SaaS experiences). This process involves several steps that we w...")
 
Line 1: Line 1:
In order to set up a new bridge or network of bridges, a configuration needs to be done in the cloud (PaaS and SaaS experiences). This process involves several steps that we will break down in the following sections.
+
In order to set up a new bridge or network of bridges, a configuration needs to be done in the cloud (PaaS and SaaS experiences). This process involves several steps that will be broken down in the following sections. We will assume you have the following situation to illustrate each step and follow a guiding thread that can actually be a real use case:
  
== Set up an actor (necessarily inside an activity) ==
+
* You will have several bridges forming a Bridge Network (communicating using the standard protocol over a XBee Network) that will cooperate between them to determine the movement of people inside a give space. You will use a network of bridges because only one bridge will l have network connection and the others will be located in spots where no network connection is available. To detect these people, we will assume that you have provided each one of them with an iBeacon that contains personal information. To be more specific about the situation we will assume that you will be located inside a mine and each person is a miner.
=== Create an activity ===
+
=== Add actor and permissions ===
+
=== Publish the activity ===
+
  
== Configure templates ==
+
* You will create one or more reasoners that will allow you to represent each detected person and update their positions as they move around the mine. The location of the bridges will be used as an approximation (proximity-based location) of the person's location.
=== Create bridge template(s) ===
+
=== Create plugin templates ===
+
=== Add plugin templates to bridge(s) as bridge instances ===
+
=== Share bridge with follower tenant ===
+
  
== Subscribe to activity as follower admin (SaaS admin) ==
+
== Conception of required things inside the AMTech platform ==
=== Add invited follower to your team and grant actor's permissions ===
+
To represent all this scenario you will have several actors implied:
 +
* Bridge instances (instances of amtechM2mBridge core type) to represent each bridge that is deployed.
 +
* BLE detectors (instances of BLEbeaconsScanner core type) to represent the configuration of each BLE detector inside the bridge network.
 +
* A new type to represent a miner. You will be able to add customized properties to this miner in addition to the core properties that it already inherit from a generic thing inside AMTech platform.
  
== Do something with the result of this bridge ==
+
== Creator tasks ==
 +
All the actions in this section will be performed by a creator. As such, you will go to {http://platform.amtech.mx Amtech platform} and login as a creator.
 +
 
 +
=== Create thing types for representation ===
 +
You will start for creating a miner type inside the PaaS. A miner will be a thing that has an ID (provided by the beacon) and a location. You will be able to add other custom properties but so far we will be reusing the "name" and "location" properties that all things already inherit.
 +
 
 +
* You go to Activities => Thing Types and you click on the plus (+) button to create a new thing type.
 +
* You name it as you want (we will use DemoMiner for the example) and click on the "check" icon.
 +
* Here you can customize some general options like description, icon, etc and then go to "Properties" and configure additional properties. For the example you will only add a description and accept all the other settings with default values by clicking on the "save" icon.
 +
 
 +
=== Set up an actor (necessarily inside an activity) ===
 +
Now, you will be setting up an actor to represent the permissions that you will give to the followers of this activity. This actor will allow the execution of a bridge with the components previously mentioned and give access to the DemoMiner that you just created.
 +
 
 +
==== Create an activity ====
 +
We will start by going to Activities menu and clicking the "plus" icon to create a new activity. We will give it a name 'MineActivity' and start making some changes:
 +
* Set a description for the activity
 +
* Save changes
 +
 
 +
==== Add actor and permissions ====
 +
Inside the activity you will
 +
 
 +
==== Publish the activity ====
 +
 
 +
=== Configure templates ===
 +
==== Create bridge template(s) ====
 +
==== Create plugin templates ====
 +
==== Add plugin templates to bridge(s) as bridge instances ====
 +
==== Share bridge with follower tenant ====
 +
 
 +
== Follower admin tasks ==
 +
=== Subscribe to activity as follower admin (SaaS admin) ===
 +
==== Add invited follower to your team and grant actor's permissions ====
 +
 
 +
=== Do something with the result of this bridge ===
 +
==== Create a reasoner ====
 +
 
 +
== Invited follower tasks ==

Revision as of 14:03, 12 April 2018

In order to set up a new bridge or network of bridges, a configuration needs to be done in the cloud (PaaS and SaaS experiences). This process involves several steps that will be broken down in the following sections. We will assume you have the following situation to illustrate each step and follow a guiding thread that can actually be a real use case:

  • You will have several bridges forming a Bridge Network (communicating using the standard protocol over a XBee Network) that will cooperate between them to determine the movement of people inside a give space. You will use a network of bridges because only one bridge will l have network connection and the others will be located in spots where no network connection is available. To detect these people, we will assume that you have provided each one of them with an iBeacon that contains personal information. To be more specific about the situation we will assume that you will be located inside a mine and each person is a miner.
  • You will create one or more reasoners that will allow you to represent each detected person and update their positions as they move around the mine. The location of the bridges will be used as an approximation (proximity-based location) of the person's location.

Conception of required things inside the AMTech platform

To represent all this scenario you will have several actors implied:

  • Bridge instances (instances of amtechM2mBridge core type) to represent each bridge that is deployed.
  • BLE detectors (instances of BLEbeaconsScanner core type) to represent the configuration of each BLE detector inside the bridge network.
  • A new type to represent a miner. You will be able to add customized properties to this miner in addition to the core properties that it already inherit from a generic thing inside AMTech platform.

Creator tasks

All the actions in this section will be performed by a creator. As such, you will go to {http://platform.amtech.mx Amtech platform} and login as a creator.

Create thing types for representation

You will start for creating a miner type inside the PaaS. A miner will be a thing that has an ID (provided by the beacon) and a location. You will be able to add other custom properties but so far we will be reusing the "name" and "location" properties that all things already inherit.

* You go to Activities => Thing Types and you click on the plus (+) button to create a new thing type.
* You name it as you want (we will use DemoMiner for the example) and click on the "check" icon.
* Here you can customize some general options like description, icon, etc and then go to "Properties" and configure additional properties. For the example you will only add a description and accept all the other settings with default values by clicking on the "save" icon.

Set up an actor (necessarily inside an activity)

Now, you will be setting up an actor to represent the permissions that you will give to the followers of this activity. This actor will allow the execution of a bridge with the components previously mentioned and give access to the DemoMiner that you just created.

Create an activity

We will start by going to Activities menu and clicking the "plus" icon to create a new activity. We will give it a name 'MineActivity' and start making some changes:

* Set a description for the activity
* Save changes

Add actor and permissions

Inside the activity you will

Publish the activity

Configure templates

Create bridge template(s)

Create plugin templates

Add plugin templates to bridge(s) as bridge instances

Share bridge with follower tenant

Follower admin tasks

Subscribe to activity as follower admin (SaaS admin)

Add invited follower to your team and grant actor's permissions

Do something with the result of this bridge

Create a reasoner

Invited follower tasks