Difference between revisions of "M2M Bridge"

From AMTech WikiDocs
Jump to: navigation, search
Line 6: Line 6:
 
# [[How to install]]
 
# [[How to install]]
 
# [[HelloWorld plugin]]
 
# [[HelloWorld plugin]]
 
+
# [[Example plugins]]
== Example plugins (See [https://github.com/AMTechMX/M2MBridge/tree/master/plugins exiting plugins])==
+
 
+
=== 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
+
*Edge Intelligence
+
**Implementing smoothing for new and lost tag
+
**EPC decoding
+
**Groups tags read by antennas groups
+
**Groups tags by EPC decoding.
+
*Placeholders (See [[Observation enrichment#Placeholders substitution|Placeholders]])
+
** #{antennaId} Llrp protocol antenna Id set at antennas supported property
+
** #{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]
+
** #{llrpReaderProximity} Set the llrp reader proximity area supported property value to targetThing proximity value field
+
** #{antennaProximity} Set the llrp antenna proximity area supported property value to targetThing proximity value field
+
** #{tagEncoding} EPC encoding name
+
**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.     
+
    #{epcUri|companyPrefix|itemReference|serialNumber|
+
    serialReference|locationReference|extension|assetType|
+
    individualAssetReference|serviceReference|documentType|
+
    managerNumber|objectClass|cAGEOrDODAAC}
+
*Produced observations (see /amtech/linkeddata/types/composite/observation)
+
**/amtech/linkeddata/types/composite/observation/observationresourcecrud
+
**/amtech/linkeddata/types/composite/observation/graiEPC
+
**/amtech/linkeddata/types/composite/observation/graiEPC
+
**/amtech/linkeddata/types/composite/observation/decode96EPC
+
**/amtech/linkeddata/types/composite/observation/sgtinEPC
+
**/amtech/linkeddata/types/composite/observation/dodEPC
+
**/amtech/linkeddata/types/composite/observation/giaiEPC
+
**/amtech/linkeddata/types/composite/observation/ssccEPC
+
**/amtech/linkeddata/types/composite/observation/gdtiEPC
+
**/amtech/linkeddata/types/composite/observation/llrpError
+
**/amtech/linkeddata/types/composite/observation/dataEPC
+
**/amtech/linkeddata/types/composite/observation/encoded96EPC
+
**/amtech/linkeddata/types/composite/observation/gidEPC
+
*Commands (see /amtech/linkeddata/types/composite/observation)
+
**/amtech/linkeddata/types/composite/observation/gpoWriteDataEPC
+
 
+
=== BLEbeaconsScanner ===
+
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
+
*Edge Intelligence
+
**Implementing smoothing for new, broadcast and lost tag
+
*Placeholders (See [[Observation enrichment#Placeholders substitution|Placeholders]])
+
** #{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]
+
** #{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
+

Revision as of 19:18, 23 April 2016

  1. Functionality
  2. Edge Configuration
  3. Cloud Configuration
  4. Implementation notes
  5. How to implement a new plugin
  6. How to install
  7. HelloWorld plugin
  8. Example plugins