...
Bridge Commissioning Web GUI
- The commissioning gui GUI can be reached at 193192.167168.110.1:8080/commissioning.html
- Click the WIFI SCAN button at the top
- This will cause the service to perform a scan for all 2.4 Ghz GHz networks
- List all found networks with their associated SSID, Frequency, RSSI, and Security types
- Input the PASSWORD into the password field at the bottom of the form
- Currently, there is no mechenism mechanism to support join a network with no security
- Press the WIFI ASSOCIATE button at the bottom of the form
- This will cause the service to attempt to join the selected network
- The Gateway's IP Address will be returned in green on success
...
We can ignore all non b/g/n and all non 2.4Ghz 4GHz results
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Wifi Scan Results",
"description": "Result of Wifi Scan and Wifi Networks found",
"type": "object",
"properties": {
"result": {
"description": "Did the Wifi Scan succeed or fail?",
"type": "boolean"
},
"found": {
"description": "List of Wifi Networks found",
"type": "array",
"items": {
"type": "object",
"properties": {
"ssid": {
"description": "Name of Wifi Network",
"type": "string"
},
"security": {
"description": "The security type of the Wifi Network",
"type": "string"
},
"rssi": {
"description": "The signal strength",
"type": "integer"
},
"frequency": {
"description": "The frequency of the Wifi Network",
"type": "string",
"default": "2.4",
"enum": [
"2.4",
"3.6",
"4.9",
"5",
"5.9"
]
}
},
"required": [
"ssid",
"security",
"rssi"
]
}
}
},
"required": [
"result"
],
"additionalProperties": false
} |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Wifi Scan Results",
"description": "Passing Opaque data",
"type": "object",
"properties": {
"result": {
"description": "Whether the Associate succeeded",
"type": "boolean"
}
},
"required": [
"result"
],
"additionalProperties": false
} |
POST /sys/connect
Input
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Wifi Scan Results", "description": "Passing Opaque data", "type": "object" } |
...
204 No Content
GET /sys/info
Input
None
Output
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Get System Info",
"description": "Sotfware and Hardware information about the gateway",
"type": "object",
"properties": {
"Manufacturer": {
"type": "string",
"value": "MMB Networks"
},
"Model_Number": {
"type": "string",
"value": "AMA01GW10"
},
"Kernel_Version": {
"type": "string"
},
"RFS_Version": {
"type": "string"
},
"MMB_Version": {
"type": "string"
},
"ETH_MAC": {
"type": "string"
},
}
} |
...
| Code Block |
|---|
{
"$schema":"http://json-schema.org/draft-06/schema#",
"title":"Gateway Configuration whitelist data structure",
"description":"Whitelist to determine which files are to be written to disk when reading the /sys/configure endpoint data",
"type":"object",
"properties":{
"whitelist":{
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the file",
"type":"string"
},
"path":{
"description":"The location the file should be placed (No trailing slash)",
"type":"string"
},
"type":{
"description":"The type of the file",
"type":"string",
"enum":[
"json",
"text"
]
},
"user":{
"description":"Which user should own the file (default: mmb)",
"type":"string"
},
"group":{
"description":"Which group should own the file (default: mmb)",
"type":"string"
}
},
"required":[
"name",
"path",
"type"
]
}
}
},
"required":[
"whitelist"
]
} |
Input
| Code Block |
|---|
{
"$schema":"http://json-schema.org/draft-06/schema#",
"title":"Gateway Configuration data structure to be written to disk",
"description":"Passing Opaque data, along with a specific API version number for future use",
"type":"object",
"properties":{
"version":{
"type":"number"
},
"config_data":{
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"type":"string"
},
"contents":{
"type":[
"string",
"object"
]
}
},
"required":[
"name",
"contents"
]
}
}
},
"required":[
"version",
"config_data"
]
} |
Output
Commissioning result
Client side
...
customizing and branding
The client side Javascript and CSS files are available on the Gateway in /opt/commissioning/gui/
...