Difference between revisions of "M2M Bridge"

From AMTech WikiDocs
Jump to: navigation, search
 
(178 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
# [[Edge Configuration]]
+
# [[M2MBridge Functionality|Functionality]]
 +
# [[Configuration example]]
 +
# [[M2MBridge network]]
 +
#: [[Aggregation]]
 +
#: [[Edge reasoners]]
 +
#: [[Mesh network]]
 +
# [[Intelligence at the Edge]]
 +
#: [[WhatIsAPlugin|What is a plugin?]]
 +
#: [[EPC (Electronic product code)]]
 +
#: [[Smoothing observations]]
 +
# [[Observations production and consumption]]
 
# [[Cloud Configuration]]
 
# [[Cloud Configuration]]
 +
#: [[Observation production config]]
 +
#: [[Validation]]
 +
#: [[Sample configuration for beacons]]
 +
# [[Automatic updates on bridge instance delete]]
 
# [[Implementation notes]]
 
# [[Implementation notes]]
 
# [[How to implement a new plugin]]
 
# [[How to implement a new plugin]]
# [[How to install]]
+
# [[Set up a new Raspberry PI]]
 +
# [[Edge Configuration|M2MBridge Edge Configuration]]
 +
# [[M2MBridge updates]]
 +
# [[How to install & execute]]
 
# [[HelloWorld plugin]]
 
# [[HelloWorld plugin]]
 
+
# Supported plugins
== Example plugins (See [https://github.com/AMTechMX/M2MBridge/tree/master/plugins exiting plugins])==
+
## [[File:wi-fi.svg|35px]] [[File:tcp-ip.svg|35px]] [https://en.wikipedia.org/wiki/Ethernet Wifi or RJ45 Ethernet]
 
+
##: [[File:SNMPDevice.svg|35px]] [[SNMPDevice]]
=== LLRPReader ===
+
##: [[File:LLRPReader.svg|35px]] [[LLRPReader]]
Bridge EPC Low Level reader protocol to IoT DAP (See [https://github.com/AMTechMX/M2MBridge/tree/master/plugins/LLRPReader LLRPReader]) and /amtech/linkeddata/types/composite/entity/LLRPReader
+
##:: [[File:LLRPAntenna.svg|35px]] [[LLRPAntenna]]
*Edge Intelligence
+
##: [[File:thing-magic.svg|35px]] [[ThingMagicEPCReader]]
**Implementing smoothing for new and lost tag
+
##:: [[File:LLRPAntenna.svg|35px]] [[LLRPAntenna]]
**EPC decoding
+
##: [[File:plc-icon.svg|35px]] [[OPCUADevice]]
**Groups tags read by antennas groups
+
##: [[File:modbus.svg|45px]] [[ModbusDevice]]
**Groups tags by EPC decoding.
+
##: [[File:wioGeneric.png|45px]] [[Wio Devices]] (troubleshooting inside)
*Placeholders (See [[Observation enrichment#Placeholders substitution|Placeholders]])
+
##:: [[File:wioNode.svg.svg|35px]] [[wioNode]]
** #{antennaId} Llrp protocol antenna Id set at antennas supported property
+
##:: [[File:wioLink.svg|35px]] [[wioLink]]
** #{smoothingResult} if smoothing has been set to true LLRP reader observations can be sent to a topic depending of the smoothing process result [new|lost]  
+
## [[File:bt.svg|35px]] [https://en.wikipedia.org/wiki/Bluetooth_Low_Energy BLE 4.0]
** #{llrpReaderProximity} Set the llrp reader proximity area supported property value to targetThing proximity value field
+
##: [[File:BLEbeaconsScanner.svg|35px]] [[BLEbeaconsScanner]]
** #{antennaProximity} Set the llrp antenna proximity area supported property value to targetThing proximity value field
+
##: [[File:bleOBDScanner.svg|35px]] [[BLEODB2Scanner]]
** #{tagEncoding} EPC encoding name
+
##: [[File:BLEPeripheralsScanner.svg|35px]] [[BLEPeripheralsScanner]]
**A component of  decoded epc tag; helpful to organize epc observations; for example company-prefix to inform companies about products arrival or set access control.      
+
##: [[File:BluvisioniBEEK.jpg|65px]] [[BLEBluvisionBeeksScanner]]
    #{epcUri|companyPrefix|itemReference|serialNumber|
+
##: [[File:BLEGattCentral.svg|35px]] [[BLEGattCentral]]
    serialReference|locationReference|extension|assetType|
+
## [[File:i2c.svg|35px]] [https://en.wikipedia.org/wiki/I%C2%B2C I2C]
    individualAssetReference|serviceReference|documentType|
+
##: [[File:watersensor.svg|35px]] [[PCA9536I2CWaterDetectionWithBuzzer]]
    managerNumber|objectClass|cAGEOrDODAAC}
+
##: [[File:TSL2561Light.svg|65px]] [[TSL2561I2CLight]]
*Produced observations (see /amtech/linkeddata/types/composite/observation)
+
##: [[File:soundvibration.svg|35px]] [[ADC121C021I2CSoundVibrationShock]]
**/amtech/linkeddata/types/composite/observation/observationresourcecrud
+
##: [[File:ncd-i2c.png|65px]] [https://store.ncd.io/shop/?fwp_interface=i2c-interface NCD I2C devices]
**/amtech/linkeddata/types/composite/observation/graiEPC
+
##: [[File:grove-log.png|65px]] [https://www.seeedstudio.com/category/Grove-c-1003%7C%7C24.html?p=0 Grove devices via I2C]
**/amtech/linkeddata/types/composite/observation/graiEPC
+
## [[File:usb-logo.svg|35px]] [https://en.wikipedia.org/wiki/USB USB 2.0]
**/amtech/linkeddata/types/composite/observation/decode96EPC
+
##: [[File:thing-magic.svg|35px]] [[ThingMagicEPCReader]]
**/amtech/linkeddata/types/composite/observation/sgtinEPC
+
##:: [[File:LLRPAntenna.svg|35px]] [[LLRPAntenna]]
**/amtech/linkeddata/types/composite/observation/dodEPC
+
##: [[File:Phidgets-Logo.png|65px]] [https://www.phidgets.com/?tier=0&catid=3&pcid=12 Phidgets USB sensors]
**/amtech/linkeddata/types/composite/observation/giaiEPC
+
<!--##:[[File:modbus.svg|45px]] [[ModbusDevice]]-->
**/amtech/linkeddata/types/composite/observation/ssccEPC
+
## [[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]
**/amtech/linkeddata/types/composite/observation/gdtiEPC
+
##: [[File:relay-home-automation.svg|35px]] [[NCDXbee900Relay]]
**/amtech/linkeddata/types/composite/observation/llrpError
+
##: [[File:energy-monitor.svg|35px]] [[NCDXbee900EnergyMonitor]]
**/amtech/linkeddata/types/composite/observation/dataEPC
+
##: [[File:ncd-i2c.png|65px]] [https://store.ncd.io/shop/?fwp_interface=900hp-s3b NCD devices supporting XBee-Pro 900HP communication]
**/amtech/linkeddata/types/composite/observation/encoded96EPC
+
<!-- ## [[File:libelium.svg|45px]] [[waspmoteBLECentral]]-->
**/amtech/linkeddata/types/composite/observation/gidEPC
+
##: [[File:libelium.svg|65px]] [http://www.libelium.com/libeliumworld/waspmote/ Libelium waspmote]
*Commands (see /amtech/linkeddata/types/composite/observation)
+
##:: [[File:SmartEnvironment.jpg|65px]] [[Smart environment PRO]]
**/amtech/linkeddata/types/composite/observation/gpoWriteDataEPC
+
##:: [[File:SmartAgriculture.png|65px]] [[Smart Agriculture]]
 
+
##:: [[File:SmartWater.jpg|65px]] [[Smart Water]]
=== BLEbeaconsScanner ===
+
##:: [[File:SmartWaterIons.png|65px]] [[Smart Water Ions]]
Bridge bluetooth low energy apple's ibecon and google's eddystone protocols to IoT DAP (See [https://github.com/AMTechMX/M2MBridge/tree/master/plugins/BLEbeaconsScanner BLEbeaconsScanner]) and /amtech/linkeddata/types/composite/entity/BLEbeaconsScanner
+
##:: [[File:SmartCities.jpg|65px]] [[Smart Cities]]
*Edge Intelligence
+
##:: [[File:SmartParking.jpg|65px]] [[Smart Parking]]
**Implementing smoothing for new, broadcast and lost tag
+
##:: [[File:SmartSecurity.jpg|65px]] [[Smart Security]]
*Placeholders (See [[Observation enrichment#Placeholders substitution|Placeholders]])
+
##:: [[File:Radiation.png|65px]] [[Radiation]]
** #{smoothingResult} if smoothing has been set to true EddystoneScan observations can be sent to a topic depending of the smoothing process result [new|lost|broadcast]
+
##:: [[File:AmbientControl.png|65px]] [[Ambient Control]]
** #{eddystoneType} Eddystone frame types, permissible values are uid, url and tlm
+
***uid broadcasts an opaque, unique 16-byte Beacon ID composed of a 10-byte namespace and a 6-byte instance.  
+
***url broadcasts a URL using a compressed encoding format in order to fit more within the limited advertisement packet.
+
***tlm telemetrics
+
** #{eddystoneNamespace} 10-byte ID Namespace
+
** #{eddystoneInstance} 6-byte ID Instance
+
** #{proximityarea} Set the EddystoneHub proximity area supported property value to targetThing proximity value field
+
** #{bleProtocol} [eddystone|ibeacon]  
+
** #{ibeaconUuid'} iBeacon advertised uuid
+
** #{'ibeaconMajor'} iBeacon advertised major
+
** #{'ibeaconMinor'} iBeacon advertised minor
+
** #{'ibeaconProximity} current proximity from sacanner [unknown|immediate|near|far]
+
*Produced observations (see /amtech/linkeddata/types/composite/observation)
+
**/amtech/linkeddata/types/composite/observation/observationresourcecrud
+
**/amtech/linkeddata/types/composite/observation/ibeaconScan
+
**/amtech/linkeddata/types/composite/observation/eddystoneBrodcast
+
**/amtech/linkeddata/types/composite/observation/eddystoneScan
+
**/amtech/linkeddata/types/composite/observation/eddystoneScan
+
 
+
=== SNMPDevice ===
+
Bridge simple network management protocol  to IoT DAP (See [https://github.com/AMTechMX/M2MBridge/tree/master/plugins/SNMPDevice SNMPDevice]) and /amtech/linkeddata/types/composite/entity/SNMPDevice
+
*Edge Intelligence
+
**Groups multiple snmp reads and writes in a single call
+
**Maps snmp oid into human readable names
+
*Produced observations (see /amtech/linkeddata/types/composite/observation)
+
**/amtech/linkeddata/types/composite/observation/observationresourcecrud
+
**/amtech/linkeddata/types/composite/observation/snmpError
+
**/amtech/linkeddata/types/composite/observation/snmpTrap
+
*Commands (see /amtech/linkeddata/types/composite/observation)
+
**/amtech/linkeddata/types/composite/observation/snmpSet
+

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