Cognitive Systems WiFi Motion App-Cloud API (v1-5-x)

App Cloud APIs are used by mobile applications.

Download OpenAPI description
v1-5-x.json
v1-5-x.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/

https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Show General Settings

Request

Android and iOS versions app have variations in how the request + response for GET /networks is made. There is a top level data key that is sometimes expected and other times is not, and there is differences in the id parameter.

Query
pageinteger
Default 1
expandArray of strings
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/networks?expand=string&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects
Example: [{"id":19,"name":"Test Network 1","created_at":"2020-11-17T18:40:34.936Z","updated_at":"2020-11-17T18:42:16.096Z","external_id":21,"user_count":1,"latitude":"0.0000000","longitude":"0.0000000","address":"","timezone":"Etc/GMT","pet_size":"none","building_type":"bungalow","building_size":"small","live_enabled":true,"scene_id":4,"owner_email":"cb549858-e70e-4359-81bf-3003f32ca071@wifimotion.ca","present_count":1,"claimed":true,"network_scene_config":19}]
Response
application/json
{
  "data": [
    { … }
  ]
}

Update Leaf Settings

Request

Bodyapplication/json
friendly_namestring
locationstring

Set as empty string to specify mobile device. Can also use 'mobile' boolean field to do this.

mac_addressstring^((([0-9A-F]{2}:){5})|(([0-9A-F]{2}-){5})|([0...required
network_idintegerrequired
autostring
Enum"1""""0"
mobileboolean
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/leaf \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "friendly_name": "string",
    "location": "string",
    "mac_address": "string",
    "network_id": 0,
    "auto": "1",
    "mobile": true
  }'

Responses

OK

Show Network Info

Request

Returns the following internal network identifiers:

  • guardian_id
  • external_id
  • network_id
  • nodes
curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/networks/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
guardian_idstring

The Guardian ID is a unique identifier for a WiFi Motion network.

Example: "add5cfe79g12797e253e3623"
external_idinteger(int32)

The unique identifier that the Motion Network System (MNS) uses to identify a network.

Example: 1
network_idinteger(int32)

A unique identifier that the App-Cloud uses to identify a network.

Example: 2
nodesobject

A node is a network device that contains Cognitive System's proprietary WiFi Motion software. Examples can include Access Points (APs) and IoT devices.

Example: {"esp_1A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_2A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_3A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_4A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"}}
Response
application/json
{
  "guardian_id": "add5cfe79g12797e253e3623",
  "external_id": 1,
  "network_id": 2,
  "nodes": {
    "esp_1A2B345C6D7E": { … },
    "esp_2A2B345C6D7E": { … },
    "esp_3A2B345C6D7E": { … },
    "esp_4A2B345C6D7E": { … }
  }
}

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations