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/gatekeeper/node
curl -i -X PUT \
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/gatekeeper/node \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"network_id": 0,
"shard_id": 0,
"created_at": 0.1,
"updated_at": 0.1,
"ap_bssid_2ghz": "string",
"ap_bssid_5ghz": "string",
"mesh_bssid": "string",
"gateway_bssid": "string",
"p2p_bssid": "string",
"deviceid": "string",
"devicetype": "string",
"token": "string",
"last_heard": 0.1,
"last_status": {},
"connection_status": "OFFLINE",
"connection_report": {
"ClientAddr": "string",
"Protocol": "mqtt4",
"Durable": true,
"ClientID": "string",
"Time": "string",
"Action": "Connect",
"Port": 0
},
"meta": {}
}'{ "id": 0, "network_id": 0, "shard_id": 0, "created_at": 0.1, "updated_at": 0.1, "ap_bssid_2ghz": "string", "ap_bssid_5ghz": "string", "mesh_bssid": "string", "gateway_bssid": "string", "p2p_bssid": "string", "deviceid": "string", "devicetype": "string", "token": "string", "last_heard": 0.1, "last_status": {}, "connection_status": "OFFLINE", "connection_report": { "ClientAddr": "string", "Protocol": "mqtt4", "Durable": true, "ClientID": "string", "Time": "string", "Action": "Connect", "Port": 0 }, "meta": {} }
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/socket/{deviceType}/{deviceId}/{eventType}
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/socket/{deviceType}/{deviceId}/{eventType}'Status report emitted by the network on a regular interval. Contains information on the network's topology, health and motion detection metrics.
When expandNodes=true or in a configuration update context, the nodes part of this network are returned in this array.
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/gatekeeper/network
curl -i -X PUT \
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/gatekeeper/network \
-H 'Content-Type: application/json' \
-d '{
"last_guardian_status": {
"leafblower": {
"property1": {
"leaf": {
"mac": "string",
"peer_type": "string",
"vht_capabilities": "string",
"ht_capabilities": "string",
"if_name": "string",
"if_index": 0,
"hostname": "string",
"ip": "string"
},
"is_static": "UNKNOWN",
"radar_stats": {
"is_static": "UNKNOWN",
"ap": {
"property1": 0.1,
"property2": 0.1
},
"device": "string",
"sounding": true,
"ping": true,
"is_sneaky": true,
"oldest": 0,
"states": {
"property1": 0.1,
"property2": 0.1
},
"age": 0,
"history": [
0
]
},
"is_sneaky": true,
"sounding": true,
"ap": {
"property1": 0.1,
"property2": 0.1
},
"age": 0,
"oldest": 0,
"history": [
0
],
"states": {
"property1": 0.1,
"property2": 0.1
},
"ping": true,
"device": "string"
},
"property2": {
"leaf": {
"mac": "string",
"peer_type": "string",
"vht_capabilities": "string",
"ht_capabilities": "string",
"if_name": "string",
"if_index": 0,
"hostname": "string",
"ip": "string"
},
"is_static": "UNKNOWN",
"radar_stats": {
"is_static": "UNKNOWN",
"ap": {
"property1": 0.1,
"property2": 0.1
},
"device": "string",
"sounding": true,
"ping": true,
"is_sneaky": true,
"oldest": 0,
"states": {
"property1": 0.1,
"property2": 0.1
},
"age": 0,
"history": [
0
]
},
"is_sneaky": true,
"sounding": true,
"ap": {
"property1": 0.1,
"property2": 0.1
},
"age": 0,
"oldest": 0,
"history": [
0
],
"states": {
"property1": 0.1,
"property2": 0.1
},
"ping": true,
"device": "string"
}
},
"network_id": 0,
"shard_id": "string",
"radars": {
"property1": {
"load": [
"string"
],
"bridge_uptime": 0,
"links": [
{
"ip": "string",
"ht_capabilities": "string",
"implicit_measurements": "string",
"serial_number": "string",
"connected_time": "string",
"vht_capabilities": "string",
"max_rx_streams": "string",
"uptime": "string",
"motion_state": "string",
"tx_bitrate": "string",
"tx_retries": "string",
"fw_rssi": 0,
"peer_type": "string",
"hostname": "string",
"tx_failed": "string",
"rx_bitrate": "string",
"motion_type": "MOTION_NONE",
"mac": "string",
"last_heard": "string",
"if_name": "string",
"ifname": "string",
"if_mac": "string",
"if_type": "MESH",
"if_ch": 0,
"aid": "string",
"tx_bytes": "string",
"rx_bytes": "string",
"wifi_protocol": "WIRED",
"sounding_rate": "string",
"node": "string",
"rssi": "string",
"rssi_db": "string",
"implicit_error_count": "string",
"csi_report_count": "string",
"v_matrix_report_count": "string",
"cv_matrix_report_count": "string",
"mconf_zero_count": 0,
"phy": "string",
"implicit_bw_downgrades": "string",
"implicit_dsss": "string",
"implicit_legacy_20": "string",
"implicit_legacy_40": "string",
"implicit_legacy_80_80": "string",
"implicit_legacy_80": "string",
"implicit_legacy_160": "string",
"implicit_cck": "string",
"dhcp_id": "string",
"dhcp_expire": "string",
"ht_supported": "string",
"vht_supported": "string",
"rate_ms": "string",
"wifi_txpwr": "string"
}
],
"p2p_bssid": "string",
"ap_bssid_5ghz": "string",
"fw_version": "string",
"root_mode": 0,
"hw_id": "string",
"uptime": "string",
"location_id": "string",
"mem_stats": {
"property1": "string",
"property2": "string"
},
"ts": 0.1,
"zmq_restart_count": 0,
"version": {},
"status_time": 0,
"gw_ip_change": true,
"ap_bssid_6ghz": "string",
"base_image_version": "string",
"updated": true,
"blower_time": 0,
"UdiStatsReport": {
"start_epoch_ms": 0,
"start_mac_tsf": 0,
"count": 0,
"bw": [
0.1
],
"downgrades": 0,
"invalid": 0,
"Tmax_ms": 0.1,
"Tmin_ms": 0.1,
"Tmean_ms": 0.1,
"Tstd_ms": 0.1,
"udi_error": 0.1,
"dbg_pe_cnt": [
0,
0,
0,
0,
0
]
},
"mem": {
"avail": "string",
"total": "string",
"free": "string"
},
"interfaces": [
{
"status": "NoMedia",
"mesh_paths": [
{
"expire_time": -1801651,
"metric": 90041760,
"next_hop_mac": "f",
"target_mac": "esse amet nulla eiusmod"
},
{
"expire_time": 69043633,
"metric": -61487094,
"next_hop_mac": "in",
"target_mac": "tempor"
}
],
"wifi_txpwr": 18535595,
"name": "minim",
"bridge_id": "sunt",
"ip": "fugiat",
"wifi_bw": -66349216,
"mac": "nisi cillum mollit magna voluptate",
"wifi_channel": -1399905,
"motion_enabled": false,
"type": "WIFI_CLIENT",
"wifi_ssid": "ut"
}
],
"node_id": "string",
"deviceId": "string",
"gateway_bssid": "string",
"_age": 0,
"cpu_stats": {
"property1": 0,
"property2": 0
},
"ap_bssid_2ghz": "string",
"hw_version": "string",
"mesh_bssid": "string",
"dhcp": {
"property1": {
"ip": "string",
"hostname": "string",
"expiry": "string",
"client_id": "string"
},
"property2": {
"ip": "string",
"hostname": "string",
"expiry": "string",
"client_id": "string"
}
},
"hw_variant": "string",
"meta_location_id": "string"
},
"property2": {
"load": [
"string"
],
"bridge_uptime": 0,
"links": [
{
"ip": "string",
"ht_capabilities": "string",
"implicit_measurements": "string",
"serial_number": "string",
"connected_time": "string",
"vht_capabilities": "string",
"max_rx_streams": "string",
"uptime": "string",
"motion_state": "string",
"tx_bitrate": "string",
"tx_retries": "string",
"fw_rssi": 0,
"peer_type": "string",
"hostname": "string",
"tx_failed": "string",
"rx_bitrate": "string",
"motion_type": "MOTION_NONE",
"mac": "string",
"last_heard": "string",
"if_name": "string",
"ifname": "string",
"if_mac": "string",
"if_type": "MESH",
"if_ch": 0,
"aid": "string",
"tx_bytes": "string",
"rx_bytes": "string",
"wifi_protocol": "WIRED",
"sounding_rate": "string",
"node": "string",
"rssi": "string",
"rssi_db": "string",
"implicit_error_count": "string",
"csi_report_count": "string",
"v_matrix_report_count": "string",
"cv_matrix_report_count": "string",
"mconf_zero_count": 0,
"phy": "string",
"implicit_bw_downgrades": "string",
"implicit_dsss": "string",
"implicit_legacy_20": "string",
"implicit_legacy_40": "string",
"implicit_legacy_80_80": "string",
"implicit_legacy_80": "string",
"implicit_legacy_160": "string",
"implicit_cck": "string",
"dhcp_id": "string",
"dhcp_expire": "string",
"ht_supported": "string",
"vht_supported": "string",
"rate_ms": "string",
"wifi_txpwr": "string"
}
],
"p2p_bssid": "string",
"ap_bssid_5ghz": "string",
"fw_version": "string",
"root_mode": 0,
"hw_id": "string",
"uptime": "string",
"location_id": "string",
"mem_stats": {
"property1": "string",
"property2": "string"
},
"ts": 0.1,
"zmq_restart_count": 0,
"version": {},
"status_time": 0,
"gw_ip_change": true,
"ap_bssid_6ghz": "string",
"base_image_version": "string",
"updated": true,
"blower_time": 0,
"UdiStatsReport": {
"start_epoch_ms": 0,
"start_mac_tsf": 0,
"count": 0,
"bw": [
0.1
],
"downgrades": 0,
"invalid": 0,
"Tmax_ms": 0.1,
"Tmin_ms": 0.1,
"Tmean_ms": 0.1,
"Tstd_ms": 0.1,
"udi_error": 0.1,
"dbg_pe_cnt": [
0,
0,
0,
0,
0
]
},
"mem": {
"avail": "string",
"total": "string",
"free": "string"
},
"interfaces": [
{
"status": "NoMedia",
"mesh_paths": [
{
"expire_time": -1801651,
"metric": 90041760,
"next_hop_mac": "f",
"target_mac": "esse amet nulla eiusmod"
},
{
"expire_time": 69043633,
"metric": -61487094,
"next_hop_mac": "in",
"target_mac": "tempor"
}
],
"wifi_txpwr": 18535595,
"name": "minim",
"bridge_id": "sunt",
"ip": "fugiat",
"wifi_bw": -66349216,
"mac": "nisi cillum mollit magna voluptate",
"wifi_channel": -1399905,
"motion_enabled": false,
"type": "WIFI_CLIENT",
"wifi_ssid": "ut"
}
],
"node_id": "string",
"deviceId": "string",
"gateway_bssid": "string",
"_age": 0,
"cpu_stats": {
"property1": 0,
"property2": 0
},
"ap_bssid_2ghz": "string",
"hw_version": "string",
"mesh_bssid": "string",
"dhcp": {
"property1": {
"ip": "string",
"hostname": "string",
"expiry": "string",
"client_id": "string"
},
"property2": {
"ip": "string",
"hostname": "string",
"expiry": "string",
"client_id": "string"
}
},
"hw_variant": "string",
"meta_location_id": "string"
}
},
"ts": 0.1,
"last_motion": 0.1,
"motion_tripped": 0,
"startup": true,
"version": {
"property1": "string",
"property2": "string"
},
"health": {
"nodes": {
"property1": 0,
"property2": 0
},
"network": 0
},
"capabilities": [
"string"
],
"coverage": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"guardian_id": "string",
"dhcp": {
"property1": {
"ip": "string",
"hostname": "string",
"expiry": "string",
"client_id": "string"
},
"property2": {
"ip": "string",
"hostname": "string",
"expiry": "string",
"client_id": "string"
}
},
"motion_enabled": 0,
"armed": 0
},
"radar_config": {
"dynamic_sensitivity": "string",
"bridge": {
"statusInterval": 60,
"zmqPort": 6969,
"loglevel": "debug",
"zmqHost": "127.0.0.1",
"linkExpiry": 120,
"debug": 1,
"debug_status": 0,
"vault": 0
},
"motion80211": {
"txEnable": {
"property1": 0,
"property2": 0
},
"linkSens": 1,
"hyperSensOverride": [
"string"
],
"noise_ctrl": 0,
"cfrMode": "o",
"period": 0,
"meshAutoDisable": 0,
"meshSoundingDisabled": [
"string"
],
"sens": 1,
"forceTxEnable": 0,
"pingerEnable": {
"property1": 0,
"property2": 0
},
"ping_rate": 100,
"optmode": {
"property1": 0,
"property2": 0
},
"mpdf_threshold": {
"property1": 0,
"property2": 0
}
}
},
"guardian_config": {
"history_motion": {
"count": 60,
"enable": 1,
"interval": 5000,
"flush_interval": 300
},
"device_events": {
"enable": 0
},
"live_motion": {
"enable": 1,
"force_enable": 0,
"interval": 500,
"loc_conf_enable": 0
},
"link_events": {
"enable": 0,
"throughput_threshold": 0,
"idle_link_timeout": 0,
"throughput_cooldown": 0,
"noise_duration": 0,
"noise_cooldown": 0,
"noise_threshold": 0,
"throughput_duration": 0
},
"leafblower": {
"cutoff": 0,
"blower_size": 60,
"log_debug": 0,
"link_expiry": 1008,
"sneaky_cutoff": -1.1,
"sneaky_link_limit": 0,
"whitelist": {
"property1": 0,
"property2": 0
},
"link_limit": 3,
"whitelist_enable": 0,
"cycle_count": 10,
"cycle_time": 0
},
"debug": {
"status": 0,
"leafblower": 0,
"gateway": 0,
"zilker": 0
},
"user_priority": [
"string"
],
"motion_events": {
"enable": 1,
"threshold": 0,
"pet_mode": 0,
"cooldown": 0,
"excessive_mins": 0,
"excessive_density": 0.7,
"armed": 1,
"override": {
"min_duration": 0,
"density_window": 0,
"density_thres": 0,
"intensity_thres": 0
},
"property1": 0,
"property2": 0
}
},
"created_at": 0.1,
"updated_at": 0.1,
"guardian_id": "string",
"last_heard": 0.1,
"meta": {
"dwm": {
"groupId": "string",
"systemName": "string",
"systemType": "string",
"systemOwner": "string",
"configurationType": "string"
},
"home": {
"sens": 0,
"cooldown": 0,
"sensitivity_level": "string"
},
"location": {
"property1": "string",
"property2": "string"
},
"neuron_env": "string",
"mqSecureRadarPort": 0,
"auto_segment": 0,
"guardian_env": "string",
"friendly_name": {
"property1": "string",
"property2": "string"
},
"new_network_id": 0,
"old_network_id": 0,
"new_guardian_id": "string",
"gatekeeper_redirect": "string",
"property1": "string",
"property2": "string"
},
"master_node_id": 0,
"shard_id": 0,
"guardian_type": "string",
"disconnected_at": 0.1,
"nodes": [
{
"id": 0,
"network_id": 0,
"shard_id": 0,
"created_at": 0.1,
"updated_at": 0.1,
"ap_bssid_2ghz": "string",
"ap_bssid_5ghz": "string",
"mesh_bssid": "string",
"gateway_bssid": "string",
"p2p_bssid": "string",
"deviceid": "string",
"devicetype": "string",
"token": "string",
"last_heard": 0.1,
"last_status": {},
"connection_status": "OFFLINE",
"connection_report": {
"ClientAddr": "string",
"Protocol": "mqtt4",
"Durable": true,
"ClientID": "string",
"Time": "string",
"Action": "Connect",
"Port": 0
},
"meta": {}
}
],
"id": 0,
"connection_status": true,
"connection_report": {
"_id": "string",
"category": "Link",
"loc": [
null
],
"detail": {
"property1": "string",
"property2": "string"
},
"link_dst_name": "string",
"network_id": 0,
"ts": 0.1,
"evt_detected_ts": 0.1,
"intensity_window": [
0.1
],
"link_id": "string",
"loc_name": "string",
"tag": "string",
"link_src_name": "string",
"guardian_id": "string",
"node_id": 0,
"deviceId": "string",
"node_name": "string",
"debug": {
"linkSens": {},
"msad": [
187.22
],
"links": [
"4C72900A6B.30894ab76326"
],
"mconf": [
80
],
"sens": 1
},
"armed": 0,
"event": "MotionDetectedEvent",
"_consumer": "string",
"data": {
"title": "string",
"uuid": "string",
"id": 0,
"first_name": "string",
"last_name": "string",
"sub": "string",
"user": {
"id": 0,
"first_name": "string",
"last_name": "string"
}
}
},
"device_info": {
"property1": {
"device_type": "Google Streaming Dongle Chromecast",
"hostname": "Google-Home-Mini",
"mac": "f0:ef:86:63:03:73"
},
"property2": {
"device_type": "Google Streaming Dongle Chromecast",
"hostname": "Google-Home-Mini",
"mac": "f0:ef:86:63:03:73"
}
}
}'{ "last_guardian_status": { "leafblower": { … }, "network_id": 0, "shard_id": "string", "radars": { … }, "ts": 0.1, "last_motion": 0.1, "motion_tripped": 0, "startup": true, "version": { … }, "health": { … }, "capabilities": [ … ], "coverage": { … }, "guardian_id": "string", "dhcp": { … }, "motion_enabled": 0, "armed": 0 }, "radar_config": { "dynamic_sensitivity": "string", "bridge": { … }, "motion80211": { … } }, "guardian_config": { "history_motion": { … }, "device_events": { … }, "live_motion": { … }, "link_events": { … }, "leafblower": { … }, "debug": { … }, "user_priority": [ … ], "motion_events": { … } }, "created_at": 0.1, "updated_at": 0.1, "guardian_id": "string", "last_heard": 0.1, "meta": { "dwm": { … }, "home": { … }, "location": { … }, "neuron_env": "string", "mqSecureRadarPort": 0, "auto_segment": 0, "guardian_env": "string", "friendly_name": { … }, "new_network_id": 0, "old_network_id": 0, "new_guardian_id": "string", "gatekeeper_redirect": "string", "property1": "string", "property2": "string" }, "master_node_id": 0, "shard_id": 0, "guardian_type": "string", "disconnected_at": 0.1, "nodes": [ { … } ], "id": 0, "connection_status": true, "connection_report": { "_id": "string", "category": "Link", "loc": [ … ], "detail": { … }, "link_dst_name": "string", "network_id": 0, "ts": 0.1, "evt_detected_ts": 0.1, "intensity_window": [ … ], "link_id": "string", "loc_name": "string", "tag": "string", "link_src_name": "string", "guardian_id": "string", "node_id": 0, "deviceId": "string", "node_name": "string", "debug": { … }, "armed": 0, "event": "MotionDetectedEvent", "_consumer": "string", "data": { … } }, "device_info": { "property1": { … }, "property2": { … } } }