Difference between revisions of "Edge Configuration"
From AMTech WikiDocs
(→Configuration validation) |
(→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== | ||
+ | *Can be achieved in 2 ways | ||
+ | **Editing bridgeConfig.json in the M2MBridge locate at | ||
+ | |||
+ | |||
+ | |||
Configuration is based on cloning. You reference an M2MBridge Thing as a template and all its configuration will be cloned. The objective is to have a single configuration that can then be used to create and maintain multiples deployments. The template is described through a template id and prefix in a file named <code>bridgeConfig.json</code>. Other configuration options are described below: | Configuration is based on cloning. You reference an M2MBridge Thing as a template and all its configuration will be cloned. The objective is to have a single configuration that can then be used to create and maintain multiples deployments. The template is described through a template id and prefix in a file named <code>bridgeConfig.json</code>. Other configuration options are described below: | ||
Revision as of 14:57, 19 September 2017
For details on Edge see Edge
M2MBridge Configuration
- Can be achieved in 2 ways
- Editing bridgeConfig.json in the M2MBridge locate at
Configuration is based on cloning. You reference an M2MBridge Thing as a template and all its configuration will be cloned. The objective is to have a single configuration that can then be used to create and maintain multiples deployments. The template is described through a template id and prefix in a file named bridgeConfig.json
. Other configuration options are described below:
- description Text to be assigned to M2MBridges description property. Type: string.
- description:children If the description property will be assigned to M2MBridge's linked things. Type: boolean.
- dap DAP connection options. Type: JSON, having:
- dapUrl AMTech IoT DAP URL. Type: string, valid URL
- userId Bridge instance user ID. Type: string.
- tenant Bridge tenant. Type: string.
- password Bridge password. Type: string.
- Note: You should use an invited follower in the authentication. See remarks in this section
- templateId Bridge instance ID to be cloned. Type: string, valid bridge name.
- bridgeIdPrefix Prefix to add to the unique M2MBridge identifier, the MAC address of the device is used as unique ID. In the absence of a prefix, just the MAC address is used as identifier. Type: string.
- location WKT location to set to the M2MBridge location. Overrides address if also present. Type: stringified version of JSON representing the WKT.
- location:children Express if the location property will be assigned to M2MBridge's linked things. Type: boolean.
- address Address to be used to guess M2MBridge location. Type: JSON.
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"
},
}
Configuration validation
- At startup time the M2MBridge validates its configuration with the cloud. If there is an error, the application aborts
- To simplify the process of validation configuration there is an option to validate the configuration for a M2MBridge instance (See here)