The WiFi Motion Core Cloud 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. This documentation outlines the endpoints for engaging with the WiFi Motion cloud and includes specifications for the following APIs:
The live motion API opens a web socket and triggers the network to emit recorded motion at a 500ms interval.
High-level APIs for retrieving the network's topology, last status message, or to view or modify the network's metadata.
The location data APIs expose localized motion data. Localization happens on a per mac, or custom location name base.
A set of APIs to find a network in the WiFi Motion Cloud. Individual, or groups of networks can be queried by their primary identifiers or by MAC.
APIs of the internal Home Insights Microservice. Used for motion-based activity and sleep insights.
Fine-grained network configuration. These APIs give full access to the underlying motion detection controls, but have no safeguards to prevent unwanted side effects. For friendlier configuration management, see the Network Settings APIs.
Interface to manage the access point or mesh nodes of a network. Provides APIs to find, delete or alter the configuration of nodes.
Endpoint used by WiFi Motion agent for the initial cloud connection. This API returns credentials for connecting to the MQTT broker and stores the initial network configuration. We don't recommend using this API directly.
Execute commands directly on the network's access point, or on a mesh node. We recommend using the NOC Management Page for these actions.
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/api/v1/universal-alert/{uuid}
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/api/v1/universal-alert/{uuid}?network_id=0'OK
{ "uuid": "Unique alert identifier", "enabled": true, "target": "2021-12-13T16:00:00.000+00:00", "timezone": "America/New_York", "alert_name": "client decided label", "rrule": "DTSTART;TZID=America/New_York:20211201T163000\nRRULE:FREQ=WEEKLY;COUNT=30;INTERVAL=1;WKST=MO", "monitor": { "monitor_mode": "INACTIVITY", "duration_minutes": 10, "inactive_minutes": 2, "repeat_monitoring": true }, "meta": { "anything": "client controlled writable space" }, "analytics_tag": "caregiver_alert_trace", "no_motion_actions": [ { … } ], "motion_actions": [ { … } ], "unknown_actions": [], "error_actions": [], "id": 2255 }
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/api/v1/universal-alert/{uuid}
curl -i -X DELETE \
'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/api/v1/universal-alert/{uuid}?network_id=0'201 - Created
{ "uuid": "a93a9c7d-ce5e-4ec7-be6f-8795c68c1930", "enabled": true, "alert_name": "Outing", "external_id": 14, "rrule": "DTSTART;TZID=America/New_York:20220318T200000\nRRULE:FREQ=WEEKLY;COUNT=1;INTERVAL=1;WKST=MO", "monitor": { "monitor_mode": "SIMPLE", "duration_minutes": 120 }, "meta": { "alert_type": "OUTING_PRESET" }, "analytics_tag": "outingsPreset", "no_motion_actions": [ { … }, { … } ], "motion_actions": [ { … }, { … } ], "unknown_actions": [ { … }, { … } ], "error_actions": [], "timezone": "America/New_York", "target": "3/18/2022, 8:00:00 PM - America/New_York", "window_end": 1647648000000 }
Update a single alert
If an alert has been switched into an "enabled": false state because the alert has completed every possible recurrence, the mutation must include a new RRULE that has at least one occurrence in the future.
Under the hood, PATCH is a get job, delete job, and create a job.
Note that the following parameters cannot be mutated via the PATCH:
path parameter can only be the uuid
The RRULE string which can be generated here: https://jakubroztocil.github.io/rrule/
Note that new lines must be explicitly escaped with \n. COUNT will always internally converted to 1 since computing every possible alert is not required. The cloud needs only to know when the single next alert is.
Example: DTSTART;TZID=America/New_York:20211201T163000\nRRULE:FREQ=WEEKLY;COUNT=30;INTERVAL=1;WKST=MO
Default: "" Any string that can be used for analytics tracing. Defaults to "" if the field is not included.
This object defines the conditions and type of the motion monitor.
The length of time in minutes of the monitored duration. The cloud will determine the start time per the timezone in the rrule field by subtracting this from the targeted time of the monitor completion (in which the result is sent).
If the monitor_mode is "INACTIVITY", this boolean determines if the alert should continue monitoring if inactivity is detected.
The contents of this object is fully decided by the client and will not persist anywhere if the alert is deleted.
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/api/v1/universal-alert/{uuid}
curl -i -X PATCH \
'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/api/v1/universal-alert/{uuid}?network_id=0' \
-H 'Content-Type: application/json' \
-d '{
"alert_name": "Change",
"enabled": false,
"rrule": "DTSTART;TZID=Europe/London:20220101T080000\r\nRRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU\r\n",
"analytics_tag": "riseAndShinePreset",
"monitor": {
"monitor_mode": "SIMPLE",
"duration_minutes": 120
},
"meta": {
"alert_type": "RISE_AND_SHINE_PRESET"
},
"motion_actions": [
{
"user_ids": [],
"action": "fcm_push",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Your loved one has begun their day",
"click_action": "CustomAlertEvent",
"sound": "Aura_Push_Final.wav"
},
"apns": {
"headers": {
"apns-push-type": "alert",
"apns-topic": "com.csc.HaloHome"
},
"payload": {
"aps": {
"alert": {
"title": "Rise and Shine",
"body": "Your loved one has begun their day"
},
"sound": "Aura_Push_Final.wav",
"category": "CustomAlertEvent"
}
}
}
}
},
{
"user_ids": [],
"action": "custom_event",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Your loved one has begun their day"
}
}
}
],
"no_motion_actions": [
{
"user_ids": [],
"action": "fcm_push",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Your loved one has not begun their day",
"click_action": "CustomAlertEvent",
"sound": "Aura_Push_Final.wav"
},
"apns": {
"headers": {
"apns-push-type": "alert",
"apns-topic": "com.csc.HaloHome"
},
"payload": {
"aps": {
"alert": {
"title": "Rise and Shine",
"body": "Your loved one has not begun their day"
},
"sound": "Aura_Push_Final.wav",
"category": "CustomAlertEvent"
}
}
}
}
},
{
"action": "custom_event",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Your loved one has not begun their day"
}
}
}
],
"unknown_actions": [
{
"user_ids": [],
"action": "fcm_push",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Caregiver Aware could not determine motion in your home",
"click_action": "CustomAlertEvent",
"sound": "Aura_Push_Final.wav"
},
"apns": {
"headers": {
"apns-push-type": "alert",
"apns-topic": "com.csc.HaloHome"
},
"payload": {
"aps": {
"alert": {
"title": "Rise and Shine",
"body": "Caregiver Aware could not determine motion in your home"
},
"sound": "Aura_Push_Final.wav",
"category": "CustomAlertEvent"
}
}
}
}
},
{
"action": "custom_event",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Caregiver Aware could not determine motion in your home"
}
}
}
],
"error_actions": {
"type": "Array",
"Items": {
"user_ids": [],
"action": "fcm_push",
"payload": {
"data": {
"title": "Rise and Shine",
"body": "Caregiver Aware could not determine motion in your home",
"click_action": "CustomAlertEvent",
"sound": "Aura_Push_Final.wav"
},
"apns": {
"headers": {
"apns-push-type": "alert",
"apns-topic": "com.csc.HaloHome"
},
"payload": {
"aps": {
"alert": {
"title": "Rise and Shine",
"body": "Caregiver Aware could not determine motion in your home"
},
"sound": "Aura_Push_Final.wav",
"category": "CustomAlertEvent"
}
}
}
}
}
}
}'