Skip to content

Cognitive Systems App Core API

The WiFi Motion Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. Additionally, it offers interfaces for accessing topologies, events, and motion data. The only difference is that the Core APIs do not specifically reference a user, and instead provide you with the ability to query the data from any network that is available in the environment.

Download OpenAPI description
core.json
core.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/api/core/

Network Settings

Operations

Retrieve Global Settings

Request

Retrieve global network configurations.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 - OK

Bodyapplication/json
zone_priority_listArray of strings

Locations the device selection algorithm will prioritize.

Example: ["Kitchen"]
motion_events_enabledinteger

Enable motion events. On detected motion, the network emits a MotionDetectedEvent.

Enum01
Example: 1
device_eventsinteger

Enable Device Connection Events.

Requires global sounding_mode to equal deny and individual devices' sounding_mode to equal allow. When the connection state of device changes, an event is emitted. Possible events are: DeviceConnectedEvent, DeviceDisconnectedEvent and DeviceTimedOutEvent

Enum01
motion_history_enablednumber

Enable historical motion data from the network. The data can be queried through the Motion History APIs.

Enum01
Example: 1
mesh_auto_disableinteger

Disable motion detection on all current and added mesh nodes.

Enum01
mesh_sounding_disabledArray of strings

Mesh nodes that are disabled for motion detection. To alter this array, set sounding_mesh on the clients API or enable mesh_auto_disable

Example: []
motion_events_armedinteger

Enable storage of motion events. Requires motion_events_enabled to be enabled. The stored events can be queried through the Events APIs.

Enum01
Example: 1
motion_pausedinteger

Pauses all motion detection. While paused, the network can't receive setting changes.

Enum01
leafblower_cutoffnumber(float)[ -1.1 .. 1 ]

Advanced - Minimum score for device selection algorithm. -1.1 ignores the device's quality, and always uses them for motion detection. This feature should be used in conjunction with the sounding_mode features.

link_limitnumber[ 0 .. 10 ]

Maximum number of motion-detecting devices per access point or mesh node

pet_modeinteger

When enabled, pet motion is less likely to generate a MotionDetectedEvent. Is expected to be used when global sensitivity is set to high (1.0). While it is possible to bypass this configuration, alterations to individual client devices or to other global values may yield reduced event performance.

  • 0 - Disable Pet-mode

  • 1 - Enable Pet-mode

Enum01
cooldowninteger(seconds)

Represents the duration of inactivity following a MotionDetectedEvent, that the network keeps monitoring for motion. Once inactivity is observed, the network emits a MotionStoppedEvent and concludes the event window.

Example: 120
sensitivitynumber(float)

Global motion detection sensitivity (1.0 - high, 2.0 - medium, 3.0 - low, 7.0 - very-low)

Example: 1
sounding_modestring

This parameter controls the default device selection policy for the network, the two policy modes are allow and deny.

Allow mode: devices will be selected as best determined by the device selection algorithm. Devices can be blocked from selection by setting txenble=0 for that leaf(s).

Deny mode: devices that are not explicitly listed via a whitelist will be disallowed from sounding.

Note switching this mode will clear any existing device device availability settings and all devices will revert to available for allow mode or unavailable for deny mode.

Enum"allow""deny"
Example: "allow"
Response
application/json
{
  "motion_paused": 0,
  "motion_events_enabled": 1,
  "motion_events_armed": 1,
  "motion_history_enabled": 1,
  "mesh_auto_disable": 0,
  "mesh_sounding_disabled": [],
  "sounding_mode": "allow",
  "leafblower_cutoff": 0,
  "zone_priority_list": [
    "Kitchen"
  ],
  "sensitivity": 1,
  "pet_mode": 0,
  "cooldown": 120
}

Update Global Settings

Request

Update global network configurations.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Query
updateboolean

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.

Default false
Bodyapplication/json
zone_priority_listArray of strings

Locations the device selection algorithm will prioritize. Setting this parameter to [] will turn off prioritization. Updates require the complete array to be included in the request.

motion_events_enabledinteger

Enable motion events. On detected motion, the network emits a MotionDetectedEvent.

Enum01
device_eventsinteger

Enable Device Connection Events.

Requires global sounding_mode to equal deny and individual devices' sounding_mode to equal allow. When the connection state of device changes, an event is emitted. Possible events are: DeviceConnectedEvent, DeviceDisconnectedEvent and DeviceTimedOutEvent

Enum01
motion_history_enablednumber

Enable historical motion data from the network. The data can be queried through the Motion History APIs.

Enum01
mesh_auto_disableinteger

Disable motion detection on all current and added mesh nodes.

Enum01
motion_events_armedinteger

Enable storage of motion events. Requires motion_events_enabled to be enabled. The stored events can be queried through the Events APIs.

Enum01
motion_pausedinteger

Pauses all motion detection. While paused, the network can't receive setting changes.

Enum01
leafblower_cutoffnumber(float)[ -1.1 .. 1 ]

Advanced - Minimum score for device selection algorithm. Set to -1.1 to ignore device quality, and always use them for motion detection. This feature should be used in conjunction with the sounding_mode features.

link_limitnumber[ 0 .. 10 ]

Maximum number of motion-detecting devices per access point or mesh node

pet_modeinteger

When enabled, pet motion is less likely to generate a MotionDetectedEvent. Can only be used when global sensitivity is set to high (1.0) and all clients' sensitivity_mode is global.

Enum01
cooldowninteger(seconds)

Represents the duration of inactivity following a MotionDetectedEvent, that the network keeps monitoring for motion. Once inactivity is observed, the network emits a MotionStoppedEvent and concludes the event window.

sensitivitynumber(float)

Global motion detection sensitivity (1.0 - high, 2.0 - medium, 3.0 - low, 7.0 - very-low)

sounding_modestring

This parameter controls the default leaf selection policy for the network, the two policy modes are allow and deny.

Allow mode: leafs will be selected as best determined by leaf blower. Leaf(s) can be blocked from selection by setting txenble=0 for that leaf(s).

Deny mode: leafs that are not explicitly listed via a whitelist will be disallowed from sounding.

Note switching this mode will clear any existing device device availability settings and all devices will revert to available for allow mode or unavailable for deny mode.

Enum"allow""deny"
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/settings?update=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "cooldown": 20,
    "leafblower_cutoff": -1.1
  }'

Responses

200 - OK

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(WarningErrors)

The list of warnings or errors that occurred during processing of this request.

Response
application/json
{
  "status": 0,
  "success": 0,
  "details": {
    "warnings": [],
    "errors": []
  }
}

Retrieve Client Configuration

Request

Retrieve sounding clients and configurations. Note: Multi-Link Operation (MLO) devices with Peer 2 will not be displayed.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/clients' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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

Motion History

Operations

Live Motion

Operations

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations