The Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. It offers interfaces for accessing topologies, events, motion data, and more.
Cognitive Systems App Core API
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/clients
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/clients' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "devices": [ { … } ] }
Bodyapplication/json
Example: [{"id":0,"location":"LocationA"},{"mac":"00:11:22:33:44:55","sensitivity":1,"sounding_mode":"allow"}]
The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as Bedroom rather than the mac address of the device that is located in the bedroom.
Example: "name"
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"
Indicates whether the device is using the global sensitivity setting or is being overridden at the device level.
Enum"override""global"
Below is a chart that provides a description of the different Sensitivity Levels that are available:
| Sensitivity Level | Description | Numerical Representation |
|---|---|---|
| High | Motion levels of all sizes will trigger detection. Provides optimal coverage for most single family / detached dwellings. | 1 |
| Medium | Motion levels that are moderate or greater will trigger detection. Provides optimal coverage for most dwellings that share one or more walls with a neighbor. | 2 |
| Low | Only motion levels that are large to intense will trigger detection. Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting. | 3 |
| Very Low | Only motion levels that are large to intense will trigger detection. This setting is typically only used in scenarios such as a small accommodation with shared walls. Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting. | 7 |
Controls if the device can be used for sounding.
Enum"allow""deny"
Example: "allow"
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/clients
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/sounding/clients?update=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"devices": [
{
"mac": "01:2a:b3:45:c6:78",
"friendly_name": "Apple TV"
}
]
}'Response
application/json
{ "status": 0, "success": 0, "details": { "warnings": [], "errors": [] } }
Device
A wireless client refers to any device that connects to a network using WiFi technology. For optimal performance with WiFi Sensing, stationary devices such as voice assistants (like Amazon Echo or Google Nest), smart plugs, smart displays, and powered wireless speakers are ideal choices. Wireless clients that are mobile can move around and generally have aggressive sleep modes, less reliable Channel State Information (CSI) data, and are not able to be used to help identify localization, all of which can impact the WiFi Motion performance.
Guardian
Guardian is the name of the application that runs on a device, such as an Access Point, WiFi Extender, or IoT device, within a WiFi Network. It's primary functions are to store configuration settings, communicate with WiFi devices within a network, and communicate with the WiFi Motion infrastructure.
Generic
A webhook is an automated message sent from one app to another when a specific event occurs, like a payment or a code commit. It works by sending an HTTP request containing data (a "payload") to a unique URL provided by the receiving application. This allows for real-time data sharing and communication between applications without constant polling.