Difference between revisions of "Edge Configuration"

From AMTech WikiDocs
Jump to: navigation, search
(M2MBridge configuration)
Line 1: Line 1:
 
For details on Edge see [[AMTech...#Edge|Edge]]
 
For details on Edge see [[AMTech...#Edge|Edge]]
 
==M2MBridge configuration==
 
==M2MBridge configuration==
Configuration is based on cloning. You make a reference to a M2MBridge referenced as template and all its configuration will be cloned. The objective is to have a single configuration that allows you to create and maintain multiples deployments. It requires you to define template id and prefix in a file named <code>bridgeConfig.json</code>.
+
Configuration is based on cloning. You make a reference to a M2MBridge referenced as template and all its configuration will be cloned. The objective is to have a single configuration that allows you to create and maintain multiples deployments. It requires you to define template id and prefix in a file named <code>bridgeConfig.json</code>. Other configuration options are described below by using an example.
  
 
==Example of Clone Configuration ==
 
==Example of Clone Configuration ==

Revision as of 12:59, 12 October 2016

For details on Edge see Edge

M2MBridge configuration

Configuration is based on cloning. You make a reference to a M2MBridge referenced as template and all its configuration will be cloned. The objective is to have a single configuration that allows you to create and maintain multiples deployments. It requires you to define template id and prefix in a file named bridgeConfig.json. Other configuration options are described below by using an example.

Example of Clone Configuration

bridgeConfig.json located at M2MBridge.js directory

{
    "description": "AMTech M2M Bridge", 
    "description:children" : true,
    "dap":{   
        "dapUrl": "https://dap.amtech.mx",     
        "userId": "xxxxxxx@amtech.mx",
        "tenant" : "xxxxxxx",  
        "password" :"xxxxxxxx"
    },
    "templateId":"m2mCreator:m2mBridge",
    "bridgeIdPrefix":"tienda1",       
    "location": "{\"wkt\":\"POINT(-99.17125583 19.40501031)\",\"sContext\":\"geo\"}",  
    "location:children" : true,
    "address" :{				 
        "country" : "usa",
        "city": "Las Vegas",
        "road": "Las Vegas Boulevard South",
        "number":"3960"
    },
}
  • "description": "AMTech M2M Bridge" Text to be assigned to M2MBridges description property
  • "description:children" : true If the description property will be assigned to M2MBridge's linked things
  • "dapUrl": "https://dap.amtech.mx" Amtech IoT DAP url
  • "userId": "xxxxxxx@amtech.mx" m2mBridge instance user id
  • "tenant" : "xxxxxxx", bridge tenant
  • "password" :"xxxxxxxx" m2mBridge password
  • "templateId":"m2mCreator:m2mBridge" M2MBridge instance id to be cloned
  • "bridgeIdPrefix":"tienda1", Prefix to add to the unique M2MBridge identifier, the mac address of the device is use as unique id, In absence of the prefix just the mac address is used as identifier
  • "location": "{\"wkt\":\"POINT(-99.17125583 19.40501031)\",\"sContext\":\"geo\"}" wkt location to set m2mBridge location overrides address
  • "location:children" : true, if the location property will be assigned to M2MBridge's linked things
  • "address" Address to be used to get m2mBridge's location

Configuration validation

  • At startup time the M2MBridge validates it configuration with the cloud is an error occurrences the application aborts
  • To simplify the process of validation configuration there is an option to validate to the configuration for a M2MBridge instance (See here)