Difference between revisions of "Edge Configuration"

From AMTech WikiDocs
Jump to: navigation, search
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
*Can be achieved in 2 ways
+
==Editing bridgeConfig.json==
**Editing bridgeConfig.json in the M2MBridge locate at m2mbridge directory
+
Locate at m2mbridge directory
**Go to http://<address of your pi>/ to start configuring the PI
+
Configuration is based on cloning. Referencing an M2MBridge instance as a template; 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. 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:
+
 
+
 
* '''description''' Text to be assigned to M2MBridges description property. Type: string.
 
* '''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.
 
* '''description:children''' If the description property will be assigned to M2MBridge's linked things. Type: boolean.
Line 22: Line 17:
 
* '''location:children''' Express if the location property will be assigned to M2MBridge's linked things. Type: boolean.
 
* '''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.
 
* '''address''' Address to be used to guess M2MBridge location. Type: JSON.
 
+
*bridgeConfig.json example
==Example of Clone Configuration ==
+
bridgeConfig.json located at M2MBridge.js directory
+
 
<syntaxhighlight lang="jsonld">
 
<syntaxhighlight lang="jsonld">
 
{
 
{
Line 47: Line 40:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
==Using m2mbridge web server==
 +
*http://<address of your pi>/ to start configuring the PI
 +
===Home===
 +
===Bridge Configuration===
 +
===Service Management===
 +
===Wireless Network Configuration===
 +
===Ethernet Network Configuration===
 
==Configuration validation==
 
==Configuration validation==
 
*At startup time the M2MBridge validates its configuration with the cloud. If there is an error, the application aborts
 
*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 [[Validation|here]])
 
*To simplify the process of validation configuration there is an option to validate the configuration for a M2MBridge instance (See [[Validation|here]])

Revision as of 16:21, 19 September 2017

For details on Edge see Edge M2MBridge Configuration can be achieved in 2 ways

Editing bridgeConfig.json

Locate at m2mbridge directory Configuration is based on cloning. Referencing an M2MBridge instance as a template; 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. 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.
  • bridgeConfig.json example
{
    "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"
    },
}

Using m2mbridge web server

  • http://<address of your pi>/ to start configuring the PI

Home

Bridge Configuration

Service Management

Wireless Network Configuration

Ethernet Network Configuration

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)