Difference between revisions of "M2M Bridge"

From AMTech WikiDocs
Jump to: navigation, search
(→‎Cloud Configuration)
 
(342 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
== Functionality ==
+
[[File:AmtechM2mBridge.svg|40px]] M2MBridge is a software stack that implements M2M edge functionality leveraging AMTech IoT Protocol
−
* Configurable edge intelligence
+
# [[M2MBridge Functionality|Functionality]]
−
* Bridges standard and proprietary protocols to AMTech IoT DAP.
+
# [[Configuration example]]
−
** MQTT, LLRP, CoAP, STOMP, SmartM2M, LWM2M, PLC, Zigbee and others
+
# [[M2MBridge network]]
−
* Device-to-device or device-to-cloud communications.
+
#: [[Aggregation]]
−
* Allow remote and centralized administration of IoT devices and gateways.
+
#: [[Edge reasoners]]
−
** SNMP/MIB/TRAP and other
+
#: [[Mesh network]]
−
* Configurable auto-discover
+
# [[Intelligence at the Edge]]
−
* Implements common functionality and orchestrates the execution of the protocols
+
#: [[WhatIsAPlugin|What is a plugin?]]
−
* Network failure detection and recovery
+
#: [[EPC (Electronic product code)]]
−
* Get centralized configuration information at startup and real time modifications
+
#: [[Smoothing observations]]
−
* Access control policies to manage observation production and consumption
+
# [[Observations production and consumption]]
−
*The following diagram illustrates a M2MBrdige configuration:
+
# [[Cloud Configuration]]
−
**Using LLRP protocol to get the data from EPC tags and send commands to the reader
+
#: [[Observation production config]]
−
**Using SNMP to monitor the health o the readers
+
#: [[Validation]]
−
**Implementing smoothing, decoding, grouping, access control and other edge intelligence 
+
#: [[Sample configuration for beacons]]
−
[[File:Example.jpg]]
+
# [[Automatic updates on bridge instance delete]]
−
 
+
# [[Implementation notes]]
−
== Edge Configuration ==
+
# [[How to implement a new plugin]]
−
*bridgeConfig.json located at M2MBridge.js directory
+
# [[Set up a new Raspberry PI]]
−
    {
+
# [[Edge Configuration|M2MBridge Edge Configuration]]
−
    <span style="color:red">//text to be assigned to M2MBridges description property</span>
+
# [[M2MBridge updates]]
−
    "description": "AMTech M2M Bridge",
+
# [[How to install & execute]]
−
    <span style="color:red">//if the description property will be assigned to M2MBridge's linked things</span>
+
# [[HelloWorld plugin]]
−
    "description:children" : true,
+
# Supported plugins
−
        "dap":{
+
## [[File:wi-fi.svg|35px]] [[File:tcp-ip.svg|35px]] [https://en.wikipedia.org/wiki/Ethernet Wifi or RJ45 Ethernet]
−
            <span style="color:red">//amtech IoT DAP ur</span>
+
##: [[File:SNMPDevice.svg|35px]] [[SNMPDevice]]
−
            "dapUrl": "https://dap.amtech.mx",   
+
##: [[File:LLRPReader.svg|35px]] [[LLRPReader]]
−
            <span style="color:red">//userid for the m2mBridge instance bridgeId</span>
+
##:: [[File:LLRPAntenna.svg|35px]] [[LLRPAntenna]]
−
            "userId": "xxxxxxx@amtech.mx",
+
##: [[File:thing-magic.svg|35px]] [[ThingMagicEPCReader]]
−
            <span style="color:red">// tenant where bridge been configured</span>     
+
##:: [[File:LLRPAntenna.svg|35px]] [[LLRPAntenna]]
−
            "tenant" : "xxxxxxx", 
+
##: [[File:plc-icon.svg|35px]] [[OPCUADevice]]
−
            <span style="color:red">//m2mBridge userId password</span> 
+
##: [[File:modbus.svg|45px]] [[ModbusDevice]]
−
            "password" :"xxxxxxxx"
+
##: [[File:wioGeneric.png|45px]] [[Wio Devices]] (troubleshooting inside)
−
        },
+
##:: [[File:wioNode.svg.svg|35px]] [[wioNode]]
−
        <span style="color:red">//M2MBridge instance id to be cloned</span>
+
##:: [[File:wioLink.svg|35px]] [[wioLink]]
−
        "templateId":"m2mCreator:m2mBridge",
+
## [[File:bt.svg|35px]] [https://en.wikipedia.org/wiki/Bluetooth_Low_Energy BLE 4.0]
−
        <span style="color:red">//Prefix to add to the unique M2MBridge identifier, the mac address of the device is use as unique id</span>
+
##: [[File:BLEbeaconsScanner.svg|35px]] [[BLEbeaconsScanner]]
−
        <span style="color:red">//In absence of the prefix just the mac address is used as identifier</span>
+
##: [[File:bleOBDScanner.svg|35px]] [[BLEODB2Scanner]]
−
        "bridgeIdPrefix":"tienda1",     
+
##: [[File:BLEPeripheralsScanner.svg|35px]] [[BLEPeripheralsScanner]]
−
        <span style="color:red">//wkt location to set m2mBridge location overrides address</span>
+
##: [[File:BluvisioniBEEK.jpg|65px]] [[BLEBluvisionBeeksScanner]]
−
        "location": "{\"wkt\":\"POINT(-99.17125583 19.40501031)\",\"sContext\":\"geo\"}", 
+
##: [[File:BLEGattCentral.svg|35px]] [[BLEGattCentral]]
−
        <span style="color:red">//if the location property will be assigned to M2MBridge's linked things</span>
+
## [[File:i2c.svg|35px]] [https://en.wikipedia.org/wiki/I%C2%B2C I2C]
−
        "location:children" : true,
+
##: [[File:watersensor.svg|35px]] [[PCA9536I2CWaterDetectionWithBuzzer]]
−
        <span style="color:red">//Address to be used to get m2mBridge's location</span>
+
##: [[File:TSL2561Light.svg|65px]] [[TSL2561I2CLight]]
−
        "address" :{
+
##: [[File:soundvibration.svg|35px]] [[ADC121C021I2CSoundVibrationShock]]
−
            "country" : "usa",
+
##: [[File:ncd-i2c.png|65px]] [https://store.ncd.io/shop/?fwp_interface=i2c-interface NCD I2C devices]
−
            "city": "Las Vegas",
+
##: [[File:grove-log.png|65px]] [https://www.seeedstudio.com/category/Grove-c-1003%7C%7C24.html?p=0 Grove devices via I2C]
−
            "road": "Las Vegas Boulevard South",
+
## [[File:usb-logo.svg|35px]] [https://en.wikipedia.org/wiki/USB USB 2.0]
−
            "number":"3960"
+
##: [[File:thing-magic.svg|35px]] [[ThingMagicEPCReader]]
−
        },
+
##:: [[File:LLRPAntenna.svg|35px]] [[LLRPAntenna]]
−
    }
+
##: [[File:Phidgets-Logo.png|65px]] [https://www.phidgets.com/?tier=0&catid=3&pcid=12 Phidgets USB sensors]
−
 
+
<!--##:[[File:modbus.svg|45px]] [[ModbusDevice]]-->
−
== Cloud Configuration ==
+
## [[File:xbee-pro-900hp.svg|35px]] [https://www.digikey.com/catalog/en/partgroup/xbee-pro-900hp/33082?utm_adgroup=RF%20&%20RFID XBee-Pro 900HP]
−
*Create an amtechM2mBridge instance (See "/amtech/linkeddata/types/composite/entity/amtechM2mBridge")
+
##: [[File:relay-home-automation.svg|35px]] [[NCDXbee900Relay]]
−
* Create an actor actorX with the polices required by the activity(s) (See [[Access control#Actors|Actors]])
+
##: [[File:energy-monitor.svg|35px]] [[NCDXbee900EnergyMonitor]]
−
** Add the things type polices the bridge needs to the actor actorX
+
##: [[File:ncd-i2c.png|65px]] [https://store.ncd.io/shop/?fwp_interface=900hp-s3b NCD devices supporting XBee-Pro 900HP communication]
−
*Register a follower (See [[Access control#Actors|Roles]])
+
<!-- ## [[File:libelium.svg|45px]] [[waspmoteBLECentral]]-->
−
** Assign to follower actor actorX access
+
##: [[File:libelium.svg|65px]] [http://www.libelium.com/libeliumworld/waspmote/ Libelium waspmote]
−
*Activity observation configuration (See [[Activities#Observation production configuration|Observation production configuration]])
+
##:: [[File:SmartEnvironment.jpg|65px]] [[Smart environment PRO]]
−
** Add the Things types the bridge will use (See [[Activities#Thing types|Thing types]])
+
##:: [[File:SmartAgriculture.png|65px]] [[Smart Agriculture]]
−
*** Add the observations types from selected thing type the bridge will produce or consume (See [[Sensor's network#Observations and observation types|Observations and observation types]] [[Sensor's network#Crud observation|CRUD observations]])
+
##:: [[File:SmartWater.jpg|65px]] [[Smart Water]]
−
** Configure the topic that m2mBridge will listen for crud and command observations has to matched with others things' observation production configuration linked to this m2mBridge configuration (See [[Activities#Observation production configuration|Observation production configuration]] [[Sensor's network#Topics|Topics]])
+
##:: [[File:SmartWaterIons.png|65px]] [[Smart Water Ions]]
−
*Things instance creation
+
##:: [[File:SmartCities.jpg|65px]] [[Smart Cities]]
−
**Configuring autoDiscover (See [[M2M Bridge#Edge Configuration|Edge Configuration]])
+
##:: [[File:SmartParking.jpg|65px]] [[Smart Parking]]
−
***The bridge will request the DAP to clone templateId instance with the name convention bridgeIdPrefix:(device mac address) from bridgeConfig.json
+
##:: [[File:SmartSecurity.jpg|65px]] [[Smart Security]]
−
***the things instances linked to the templateId property bridgeInstances will be cloned with the name convention bridgeIdPrefix:(device mac address):thing._name from bridgeConfig.json
+
##:: [[File:Radiation.png|65px]] [[Radiation]]
−
***cloned instance will be giving the access control owner to the follower user id of the bridge that requested it.
+
##:: [[File:AmbientControl.png|65px]] [[Ambient Control]]
−
*Monitoring M2MBridge status
+
−
**Create an SNMPDevice instance and give access to your M2MBridge actor (See "/amtech/linkeddata/types/composite/entity/SNMPDevice")
+
−
***Send observations to /m2mBridge/snmp/read a core activity /amtech/activities/monitorM2MBridgeStatus will analyze the data and notify to the user and guestusers of the M2MBridge instance.
+
−
 
+
−
== Implementation notes ==
+
−
*M2MBridge is an open source stack developed by the AMTEch team; it discovers, loads nodes modules implementing "M2MBridge plugin interface" and creates thing types instances (See [[Activities#Thing types|Thing types]]) tacking into account the observation production configuration (See [[Activities#Observation production configuration|Observation production configuration]]) and M2MBridge credentials (See [[Access control#Actors|Actors]] and [[M2M Bridge#Edge Configuration|Edge Configuration]]).
+
−
**It leverages AMTech IoT DAP (See [[Integration Guideline|Integration Guideline]])
+
−
***Gets observation production configuration (See [[Integration Guideline#DAP Restful API#Get observation production configuration|Observation production configuration API]])
+
−
***Gets thing types instances (See [[Integration Guideline#Get instances by thing type|Observation instances API]])
+
−
***Creates a web socket to receive asynchronous commands and thing instances changes (crud operations) (See [[Integration Guideline#Commands|CRUD and Commands API]])
+
−
****Dispatch command observations to plugin instance leveraging thing type instance @id (See [[Activities#Thing types|Thing types]])
+
−
****Restart instance when supported properties change by calling stop and star plugin interface
+
−
***Creates configuration information for Thing type leveraging configuration information and client side M2MBridge placeholders (See [[Activities#Observation production configuration|Observation production configuration]] and [[Sensor's network#Placeholders|Placeholders]])
+
−
***Load plugin nodes modules required by configuration
+
−
***Creates an instance of plugin for each type from observation production configuration leveraging thing type instance @id (See [[Activities#Thing types|Thing types]])
+
−
****JavaScript object is extended with the properties values from the thing instance (See [https://github.com/AMTechMX/M2MBridge/blob/master/plugins/SNMPDevice/SNMPDevice.js plugin example] )
+
−
****Properties and methods are injected like common logg for m2mBridge plugins, methods to send observations with and without transformation, methods for restarting, observation production configuration and others (See [https://github.com/AMTechMX/M2MBridge/blob/master/plugins.js for details]) 
+
−
****If instance does not exist at the server side execute auto discover process from bridgeConfig.json can be configured (See [[M2M Bridge#Edge Configuration|Edge Configuration]])
+
−
***Creates a centralized observation dispatcher with persistence to ensure:
+
−
****Observations delivery in the order that observations occurred .
+
−
 
+
−
== How to implement a new plugin ==
+
−
*Clone git repository (https://github.com/AMTechMX/M2MBridge.git)
+
−
**at /.../M2MBridge/plugins create a directory that matched with the Thing type name to bridge example SNMPDevice (See [[Activities#Thing types|Thing types]])
+
−
*Create a thing type XXXDevice (See [[Activities#Thing types|Thing types]])
+
−
*Create the observations type the thing XXXDevice produces or consumes, example XXXDeviceObserv1 (See [[Sensor's network#Observations and observation types|Observations and observation types]])
+
−
*Associate the observation XXXDeviceObserv1 type to the XXXDevice
+
−
*Implement a nodejs module with the following interface
+
−
    function XXXThing() {
+
−
    }
+
−
    XXXThing.prototype.start = function ( complete) {
+
−
        try {
+
−
            complete(null);
+
−
        } catch (e) {
+
−
            complete(e);
+
−
        }
+
−
    };
+
−
    XXXThing.prototype.stop = function (complete) {
+
−
        try {
+
−
            complete(null);
+
−
        } catch (e) {
+
−
            complete(e);
+
−
        }
+
−
    };
+
−
    XXXThing.prototype.command = function (observation, complete) {
+
−
        try {
+
−
            complete(null);
+
−
        } catch (e) {
+
−
            complete(e);
+
−
        }
+
−
    };
+
−
    module.exports.XXXThing = XXXThing;
+
−
 
+
−
== How to install it ==
+
−
*Clone git repository (https://github.com/AMTechMX/M2MBridge.git)
+
−
*Install nodejs https://nodejs.org/en/download/package-manager/
+
−
*Install npm (http://blog.npmjs.org/post/85484771375/how-to-install-npm)
+
−
*Delete at /.../M2MBridge/plugins/xxx unneeded plug-ins
+
−
*Install packages for m2mBridge core and plug-ins (https://docs.npmjs.com/cli/install:)
+
−
*Execute npm install at:
+
−
**M2MBridge directory
+
−
**each plug-in directory
+
−
 
+
−
== Existing plugins ==
+
−
 
+
−
=== LLRPReader ===
+
−
 
+
−
=== BLEPeripheralsScanner ===
+
−
 
+
−
=== BLEbeaconsScanner ===
+
−
 
+
−
=== SNMPDevice ===
+
−
 
+
−
=== MQTTBroker ===
+
−
 
+
−
=== COAP ===
+

Latest revision as of 12:16, 14 January 2019

AmtechM2mBridge.svg M2MBridge is a software stack that implements M2M edge functionality leveraging AMTech IoT Protocol

  1. Functionality
  2. Configuration example
  3. M2MBridge network
    Aggregation
    Edge reasoners
    Mesh network
  4. Intelligence at the Edge
    What is a plugin?
    EPC (Electronic product code)
    Smoothing observations
  5. Observations production and consumption
  6. Cloud Configuration
    Observation production config
    Validation
    Sample configuration for beacons
  7. Automatic updates on bridge instance delete
  8. Implementation notes
  9. How to implement a new plugin
  10. Set up a new Raspberry PI
  11. M2MBridge Edge Configuration
  12. M2MBridge updates
  13. How to install & execute
  14. HelloWorld plugin
  15. Supported plugins
    1. Wi-fi.svg Tcp-ip.svg Wifi or RJ45 Ethernet
      SNMPDevice.svg SNMPDevice
      LLRPReader.svg LLRPReader
      LLRPAntenna.svg LLRPAntenna
      Thing-magic.svg ThingMagicEPCReader
      LLRPAntenna.svg LLRPAntenna
      Plc-icon.svg OPCUADevice
      Modbus.svg ModbusDevice
      WioGeneric.png Wio Devices (troubleshooting inside)
      WioNode.svg.svg wioNode
      WioLink.svg wioLink
    2. Bt.svg BLE 4.0
      BLEbeaconsScanner.svg BLEbeaconsScanner
      BleOBDScanner.svg BLEODB2Scanner
      BLEPeripheralsScanner.svg BLEPeripheralsScanner
      BluvisioniBEEK.jpg BLEBluvisionBeeksScanner
      BLEGattCentral.svg BLEGattCentral
    3. I2c.svg I2C
      Watersensor.svg PCA9536I2CWaterDetectionWithBuzzer
      TSL2561Light.svg TSL2561I2CLight
      Soundvibration.svg ADC121C021I2CSoundVibrationShock
      Ncd-i2c.png NCD I2C devices
      Grove-log.png Grove devices via I2C
    4. Usb-logo.svg USB 2.0
      Thing-magic.svg ThingMagicEPCReader
      LLRPAntenna.svg LLRPAntenna
      Phidgets-Logo.png Phidgets USB sensors
    5. Xbee-pro-900hp.svg XBee-Pro 900HP
      Relay-home-automation.svg NCDXbee900Relay
      Energy-monitor.svg NCDXbee900EnergyMonitor
      Ncd-i2c.png NCD devices supporting XBee-Pro 900HP communication
      Libelium.svg Libelium waspmote
      SmartEnvironment.jpg Smart environment PRO
      SmartAgriculture.png Smart Agriculture
      SmartWater.jpg Smart Water
      SmartWaterIons.png Smart Water Ions
      SmartCities.jpg Smart Cities
      SmartParking.jpg Smart Parking
      SmartSecurity.jpg Smart Security
      Radiation.png Radiation
      AmbientControl.png Ambient Control
Retrieved from "http://wiki.amtech.mx/mediawiki/index.php?title=M2M_Bridge&oldid=3918"