From 1e571062e9823916a8f38bca30e2419b4f248a9d Mon Sep 17 00:00:00 2001 From: William Le Date: Tue, 14 Mar 2023 17:18:45 +0800 Subject: [PATCH 1/5] Update graph-api.md --- reference/drivers/microsoft/graph-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/drivers/microsoft/graph-api.md b/reference/drivers/microsoft/graph-api.md index e36d6ef..11bb698 100644 --- a/reference/drivers/microsoft/graph-api.md +++ b/reference/drivers/microsoft/graph-api.md @@ -4,7 +4,7 @@ description: Communicates with the Microsoft Graph API to share information with --- # PlaceOS Microsoft Graph API Driver -* Type: Logic Driver +* Type: Service Driver * Dependencies: PlaceOS Calendar Driver * Source: https://github.com/PlaceOS/drivers/blob/master/drivers/microsoft/graph_api.cr From 6e2185e4aff840cbcc1cd4edea3e0eeb7bbe1a13 Mon Sep 17 00:00:00 2001 From: KesterJJ <95241742+KesterJJ@users.noreply.github.com> Date: Thu, 23 Mar 2023 17:51:01 +0000 Subject: [PATCH 2/5] Update area_management.md --- reference/drivers/placeos/area_management.md | 83 ++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/reference/drivers/placeos/area_management.md b/reference/drivers/placeos/area_management.md index e69de29..70558e2 100644 --- a/reference/drivers/placeos/area_management.md +++ b/reference/drivers/placeos/area_management.md @@ -0,0 +1,83 @@ +--- +title: PlaceOS Area Management +description: Counts trackable objects, such as laptops, in building areas +--- + +# PlaceOS Area Management Driver +* Type: Logic Driver +* Dependencies: PlaceOS Driver +* Source: https://github.com/PlaceOS/drivers/blob/master/drivers/place/area_management.cr + +## Functions + +* +* +* + + +## Settings + +| Key | Type | Default value | Description | +| --- | --- | --- | --- | +|`poll_rate`| | 60 | time in seconds | +|`rounding_precision`| | 2 | How many decimal places area summaries should be rounded to | + + + +## Status Variables + +### `variable` +Description +#### Schema/Type +Boolean + + + + + +### `vaiable` +Description + +#### Schema/Type + +See also: https://github.com/PlaceOS/ +``` +[ + +] +``` + +#### Examples + +##### 1. No events +``` +[] +``` + + + + + + + + + +## Commands + +### `get_building_id` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| None | | | | | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` From 6faa6ece454ecf13014713c494c1065668e22b62 Mon Sep 17 00:00:00 2001 From: KesterJJ <95241742+KesterJJ@users.noreply.github.com> Date: Tue, 28 Mar 2023 18:15:58 +0100 Subject: [PATCH 3/5] Update area_management.md --- reference/drivers/placeos/area_management.md | 168 ++++++++++++++++++- 1 file changed, 166 insertions(+), 2 deletions(-) diff --git a/reference/drivers/placeos/area_management.md b/reference/drivers/placeos/area_management.md index 70558e2..26528f2 100644 --- a/reference/drivers/placeos/area_management.md +++ b/reference/drivers/placeos/area_management.md @@ -21,7 +21,11 @@ description: Counts trackable objects, such as laptops, in building areas | --- | --- | --- | --- | |`poll_rate`| | 60 | time in seconds | |`rounding_precision`| | 2 | How many decimal places area summaries should be rounded to | - +|`duplication_factor`| | 0.8 | | +|`location_service`| String | LocationServices | | +|`include_sensors`| Bool | true | | +|`areas`| | 2 | | +|`units`| | 2 | | ## Status Variables @@ -64,7 +68,167 @@ See also: https://github.com/PlaceOS/ ## Commands -### `get_building_id` +### `write_sensor_discovery` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| None | | | | | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + +### `sensor_locations` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| level_id | false | String | nil | The floor to search for locations of sensors | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + + + +### `request_sensor_data` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| level_id | false | String | nil | The floor to receive sensor data from | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + + + + + +### `request_locations` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| sensor_data | false | | nil | | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + + + +### `request_level_locations` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| level_id | false | String | nil | The floor to receive sensor data from | +| sensor_data | false | | nil | | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + + + +### `is_inside?` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| x | true | | | | +| y | true | | | | +| area_id | true | | | | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + + + + +### `update_available` +Description + +#### Parameters +| Name | Required? | Type | Default | Description | +| --- | --- | --- | --- | --- | +| level_ids | | | | | + +#### Response Schema +``` +``` + +#### Example Responses +##### 1. +``` + +``` + + + + + + + +### `synchronize_all_levels` Description #### Parameters From 5a3f6e28feda43fafdc5a6918d99c5e9d6356121 Mon Sep 17 00:00:00 2001 From: KesterJJ <95241742+KesterJJ@users.noreply.github.com> Date: Fri, 31 Mar 2023 16:42:12 +0100 Subject: [PATCH 4/5] Update area_management.md --- reference/drivers/placeos/area_management.md | 35 ++++++++++++++++---- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/reference/drivers/placeos/area_management.md b/reference/drivers/placeos/area_management.md index 26528f2..9d56a62 100644 --- a/reference/drivers/placeos/area_management.md +++ b/reference/drivers/placeos/area_management.md @@ -140,7 +140,7 @@ Description #### Parameters | Name | Required? | Type | Default | Description | | --- | --- | --- | --- | --- | -| sensor_data | false | | nil | | +| sensor_data | false | Hash(String, Array(SensorDetail) | nil | | #### Response Schema ``` @@ -149,7 +149,28 @@ Description #### Example Responses ##### 1. ``` - +{ + "zone-Cd-1qEb18O": { + "measurement": "level_summary", + "desk_count": 116, + "desk_usage": 0, + "device_capacity": 0, + "device_count": 0, + "estimated_people": 0, + "percentage_use": 100, + "recommendation": 0 + }, + "zone-Cd-25eIppQ": { + "measurement": "level_summary", + "desk_count": 120, + "desk_usage": 0, + "device_capacity": 0, + "device_count": 0, + "estimated_people": 0, + "percentage_use": 100, + "recommendation": 0 + } +} ``` @@ -163,7 +184,7 @@ Description | Name | Required? | Type | Default | Description | | --- | --- | --- | --- | --- | | level_id | false | String | nil | The floor to receive sensor data from | -| sensor_data | false | | nil | | +| sensor_data | false | Hash(String, Array(SensorDetail) | nil | | #### Response Schema ``` @@ -172,7 +193,7 @@ Description #### Example Responses ##### 1. ``` - +null ``` @@ -185,9 +206,9 @@ Description #### Parameters | Name | Required? | Type | Default | Description | | --- | --- | --- | --- | --- | -| x | true | | | | -| y | true | | | | -| area_id | true | | | | +| x | true | | N/A | | +| y | true | | N/A | | +| area_id | true | | N/A | | #### Response Schema ``` From fe4f3b6865e92d13992d2eb4bde6e8150c5bced3 Mon Sep 17 00:00:00 2001 From: KesterJJ <95241742+KesterJJ@users.noreply.github.com> Date: Tue, 16 May 2023 17:35:00 +0100 Subject: [PATCH 5/5] Update area_management.md --- reference/drivers/placeos/area_management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/drivers/placeos/area_management.md b/reference/drivers/placeos/area_management.md index 9d56a62..77accc7 100644 --- a/reference/drivers/placeos/area_management.md +++ b/reference/drivers/placeos/area_management.md @@ -10,7 +10,7 @@ description: Counts trackable objects, such as laptops, in building areas ## Functions -* +* Used as the top level of a stack including location services and Staff API, which handles all tracking and location services for user devices. * *