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

Sounding v2

Operations

Get Client State

Request

This endpoint allows client-level sounding control and feedback.

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/sounding/clients \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
devicesArray of objects(SoundingClientDeviceStatus)
Response
application/json
{
  "devices": [
    { … },
    { … }
  ]
}

Set Client Config

Request

This endpoint allows client-level sounding control and feedback.

Query
updateboolean

Default: false When true the new configuration is immediately propagated to the network this node is part of.

If this value is false, the change will be propagated to edge either when the device is rebooted or an update is triggered.

Bodyapplication/json
devicesArray of objects(SoundingClientDeviceConfig)required
Example: [{"id":0,"location":"LocationA"},{"mac":"00:11:22:33:44:55","sensitivity":1,"sounding_mode":"allow"}]
devices[].​macstring

Mac address of the target device, either this or id must be provided.

Example: "22:33:44:ff:ee:dd"
devices[].​idstring

Internal node_id of the target node, either this or mac must be provided.

devices[].​friendly_namestring

Human readable name assigned to the Device or Node. Maximum of 256 characters, supporting letters, spaces, digits, with only the following special characters: =, +, -, _, @, !. Supports base64 encoding. Can also be an empty string.

Example: "name"
devices[].​locationstring

Device location name assigned to the Device or Node. Maximum of 256 characters, supporting letters, spaces, digits, with only the following special characters: =, +, -, _, @, !. Supports base64 encoding. Can also be an empty string.

Example: "location"
devices[].​sensitivity_modestring

Indicates whether the device is using the global sensitivity setting or is being overridden at the device level.

Enum"override""global"
devices[].​sensitivitynumber

Current sensitivity of the device

Only valid when sensitivity_mode = override, otherwise an error will be returned.

devices[].​sounding_modestring

Controls if the device can be used for sounding.

Enum"allow""deny"
Example: "allow"
devices[].​sounding_meshstring

Applicable only to nodes. Controls if the node will accept or reject sounding on mesh links.

Enum"allow""deny"
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/sounding/clients?update=true' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "devices": [
      {
        "id": 0,
        "location": "LocationA"
      },
      {
        "mac": "00:11:22:33:44:55",
        "sensitivity": 1,
        "sounding_mode": "allow"
      }
    ]
  }'

Responses

Bodyapplication/json
statusinteger

0 failure

1 full success

2 some changes failed

3 an IoT update was requested but network has not yet started up

successinteger

1 if the operation was successful, 0 otherwise

detailsobject(Root Type for WarningErrors)
Example: {"warnings":[],"errors":[]}
Response
application/json
{
  "status": 0,
  "success": 0,
  "details": {
    "warnings": [],
    "errors": []
  }
}

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations