From a618d39f32b998bfb44fdfc90bd1220d058b3ff2 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Wed, 25 Oct 2023 18:20:16 +0200 Subject: [PATCH 01/26] Update doorman Checked against the current implementation --- device_services/specific/doorman.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 63d8fcc..b0ab10e 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -13,17 +13,17 @@ Yale Doorman custom service definition. Type | Interface | Value Type | Description | Example -----|-------------------------------|------------|------------------------| -------- out | evt.doorman_session.report | null | Integration required | -in | cmd.doorman.integration | str_map | Start lock integration | {"slot_number":"0", "code_type":"pin", "code":"123456"} +in | cmd.doorman.integration | str_map | Start lock integration | {"name":"Jon", "slot_number":"0", "code_type":"pin", "code":"123456"} in | cmd.doorman_param.set | str_map | | {"parameter_id":"5", "value":"5"} in | cmd.doorman_param.get_report | null | | out | evt.doorman_param.report | str_map | Response to get_report | -in | cmd.doorman_user.set | str_map | Set pin or tag | {"name":"Jon", “slot_number”:”1”, ”code”:”123456”} +in | cmd.doorman_user.set | str_map | Set pin or tag | {"name":"Jon", “slot_number”:”1”, "code_type":"pin", ”code”:”123456”} in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below in | cmd.doorman_user.clear | str_map | | {“slot_number”:”1”} out | evt.doorman_activity.report | str_map | Sent after an activity | {“event_type”:”id”, “status”:”0”, “error_code”:”0”, “user_status”:”added”, “slot_number”:”0”, “alarm_type”:”0”, “alarm_level”:”0”, “arming_parameter”:”0”, “sequence_number”:”0”, ”card_uid_data”:”12345678”} in | cmd.doorman.arm_confirm | str_map | | {“sequence_number”:”0”, “operating_parameter”:”0”} -out | evt.op.ack | string | Command sent to lock. Applies to `cmd.doorman_param.set` | Value can be "ack" or "nack" +out | evt.doorman_tag.report | str_map | | {“type”:”unrecognized_tag”, "tag_id": "123456789ABC"} More details and examples can be found on [Notion](https://www.notion.so/Assa-Abloy-Yale-doorman-v2-Zigbee-c94f3164a74f4035bf2d47d29ec9c9c0). From 60e0978fa6363cba6ec2c197fad56626c51a3454 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Mon, 30 Oct 2023 20:06:32 +0100 Subject: [PATCH 02/26] Update doorman.md --- device_services/specific/doorman.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index b0ab10e..ad7752b 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -77,7 +77,15 @@ Topic example: - cmd.doorman_param.set - Sets Doorman's parameters. For the valid `parameter_id` values and what they mean, check the delivery PDF above. + Sets Doorman's parameters. For the valid `parameter_id` values and what they mean, check with corresponding version of Doorman cluster implementation. Some examplary parameters are: + + DoormanSilentMode = 0x01 + DoormanAutoRelock = 0x02 + DoormanLanguage = 0x05 + DoormanSystemArmHoldTime = 0x10 + DoormanHomeAwayAlarmMode = 0x11 + DoormanPartAlarmSystem = 0x12 + DoormanUserCodeBlockingEnable = 0x13 ```jsx { From d260e2f22fbccb665ac19b439ff217bcbda7d233 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Mon, 30 Oct 2023 20:08:31 +0100 Subject: [PATCH 03/26] Rmove notion.so futurehome link --- device_services/specific/doorman.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index ad7752b..e616343 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -25,8 +25,6 @@ out | evt.doorman_activity.report | str_map | Sent after an activity | { in | cmd.doorman.arm_confirm | str_map | | {“sequence_number”:”0”, “operating_parameter”:”0”} out | evt.doorman_tag.report | str_map | | {“type”:”unrecognized_tag”, "tag_id": "123456789ABC"} -More details and examples can be found on [Notion](https://www.notion.so/Assa-Abloy-Yale-doorman-v2-Zigbee-c94f3164a74f4035bf2d47d29ec9c9c0). - ### Interface props Name | Value | Description From 2efdb56c97c428f6c9dbcba22ca54e13511f16bc Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Thu, 9 Nov 2023 02:38:30 +0100 Subject: [PATCH 04/26] remove card_uid_data --- device_services/specific/doorman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index e616343..725d847 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -21,7 +21,7 @@ in | cmd.doorman_user.set | str_map | Set pin or tag | {"n in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below in | cmd.doorman_user.clear | str_map | | {“slot_number”:”1”} -out | evt.doorman_activity.report | str_map | Sent after an activity | {“event_type”:”id”, “status”:”0”, “error_code”:”0”, “user_status”:”added”, “slot_number”:”0”, “alarm_type”:”0”, “alarm_level”:”0”, “arming_parameter”:”0”, “sequence_number”:”0”, ”card_uid_data”:”12345678”} +out | evt.doorman_activity.report | str_map | Sent after an activity | {“event_type”:”id”, “status”:”0”, “error_code”:”0”, “user_status”:”added”, “slot_number”:”0”, “alarm_type”:”0”, “alarm_level”:”0”, “arming_parameter”:”0”, “sequence_number”:”0”} in | cmd.doorman.arm_confirm | str_map | | {“sequence_number”:”0”, “operating_parameter”:”0”} out | evt.doorman_tag.report | str_map | | {“type”:”unrecognized_tag”, "tag_id": "123456789ABC"} From 9bb5b340b5c29087efca5f6baa6b332b1fc8656f Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Thu, 9 Nov 2023 02:39:53 +0100 Subject: [PATCH 05/26] revert --- device_services/specific/doorman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 725d847..e616343 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -21,7 +21,7 @@ in | cmd.doorman_user.set | str_map | Set pin or tag | {"n in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below in | cmd.doorman_user.clear | str_map | | {“slot_number”:”1”} -out | evt.doorman_activity.report | str_map | Sent after an activity | {“event_type”:”id”, “status”:”0”, “error_code”:”0”, “user_status”:”added”, “slot_number”:”0”, “alarm_type”:”0”, “alarm_level”:”0”, “arming_parameter”:”0”, “sequence_number”:”0”} +out | evt.doorman_activity.report | str_map | Sent after an activity | {“event_type”:”id”, “status”:”0”, “error_code”:”0”, “user_status”:”added”, “slot_number”:”0”, “alarm_type”:”0”, “alarm_level”:”0”, “arming_parameter”:”0”, “sequence_number”:”0”, ”card_uid_data”:”12345678”} in | cmd.doorman.arm_confirm | str_map | | {“sequence_number”:”0”, “operating_parameter”:”0”} out | evt.doorman_tag.report | str_map | | {“type”:”unrecognized_tag”, "tag_id": "123456789ABC"} From 53bd5a75714efc89589fdab755635795e6ec727d Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Thu, 9 Nov 2023 03:02:40 +0100 Subject: [PATCH 06/26] Update door_lock.md --- device_services/generic/door_lock.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/device_services/generic/door_lock.md b/device_services/generic/door_lock.md index 70e5eb9..f34ad61 100644 --- a/device_services/generic/door_lock.md +++ b/device_services/generic/door_lock.md @@ -13,7 +13,7 @@ Door lock service is used to control door locks. It is used to lock and unlock d | Type | Interface | Value type | Properties | Description | |------|-------------------------------|------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| | in | cmd.lock.get_report | null | | Requests the lock status. | -| in | cmd.lock.set | bool | `mode_op` | **Secures** the lock if the provided value is `true` and unlocks it if the value is `false`. | +| in | cmd.lock.set | bool | `mode_op` `firstname`, `uuid` | **Secures** the lock if the provided value is `true` and unlocks it if the value is `false`. | | out | evt.lock.report | bool_map | `timeout_m`, `timeout_s`, `lock_type` | Returns the lock status as a boolean map of components defined in [`sup_components`](#service-properties) property. | | - | | | | | | in | cmd.auto_lock.set | bool | | Enables/disables the auto-lock feature. | @@ -33,6 +33,8 @@ Door lock service is used to control door locks. It is used to lock and unlock d | Name | Example | Required | Description | |-------------|----------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `mode_op` | `"unsecured_with_timeout"` | No | Optionally defines mode of an unlock operation. Possible values are an applicable sub-set of [`sup_modes`](#service-properties): `unsecured_with_timeout`, `unsecured_for_inside_door_handles`, `unsecured_for_inside_door_handles_with_timeout`, `unsecured_for_outside_door_handles`,`unsecured_for_outside_door_handles_with_timeout`. | +| `firstname` | `Bjarne` | No | Name of the user who issued the message | +| `uuid` | `Bjarne` | No | A Universally Unique Identifier (UUID) - 128-bit label of a user | | `lock_type` | `"key"` | No | How lock was activated, it can take values such as `key`, `pin`, `rfid`. | | `timeout_s` | `"30"` | No | Remaining time in seconds before the lock will be automatically secured again. | | `timeout_m` | `"2"` | No | Remaining time in minutes before the lock will be automatically secured again. | @@ -177,4 +179,20 @@ Door lock service is used to control door locks. It is used to lock and unlock d "uid": "49b60210-5374-11ed-b6d0-33d4305f427b", "topic": "pt:j1/mt:cmd/rt:dev/rn:zw/ad:1/sv:door_lock/ad:59_0" } -``` \ No newline at end of file +``` + +* Example of a command locking the lock with user's details: +```json +{ + "serv": "door_lock", + "type": "cmd.lock.set", + "val_t": "bool", + "val": true, + "props": { + "firstname": "Bjarne", + "uuid": "f3bb49a9-80de-4831-a45f-5af5143d0c53" + }, + "tags": null, + "ver": "1" +} +``` From c936c86bf1e50a927de78f1b782954922d1ba681 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Thu, 9 Nov 2023 03:03:33 +0100 Subject: [PATCH 07/26] Update door_lock.md --- device_services/generic/door_lock.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/device_services/generic/door_lock.md b/device_services/generic/door_lock.md index f34ad61..59dcec7 100644 --- a/device_services/generic/door_lock.md +++ b/device_services/generic/door_lock.md @@ -34,7 +34,7 @@ Door lock service is used to control door locks. It is used to lock and unlock d |-------------|----------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `mode_op` | `"unsecured_with_timeout"` | No | Optionally defines mode of an unlock operation. Possible values are an applicable sub-set of [`sup_modes`](#service-properties): `unsecured_with_timeout`, `unsecured_for_inside_door_handles`, `unsecured_for_inside_door_handles_with_timeout`, `unsecured_for_outside_door_handles`,`unsecured_for_outside_door_handles_with_timeout`. | | `firstname` | `Bjarne` | No | Name of the user who issued the message | -| `uuid` | `Bjarne` | No | A Universally Unique Identifier (UUID) - 128-bit label of a user | +| `uuid` | `"f3bb49a9-80de-4831-a45f-5af5143d0c53"` | No | A Universally Unique Identifier (UUID) - 128-bit label of a user | | `lock_type` | `"key"` | No | How lock was activated, it can take values such as `key`, `pin`, `rfid`. | | `timeout_s` | `"30"` | No | Remaining time in seconds before the lock will be automatically secured again. | | `timeout_m` | `"2"` | No | Remaining time in minutes before the lock will be automatically secured again. | From 10c695c39c82086ca6638a5fe9e07cc7ccffd9f2 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Fri, 10 Nov 2023 04:19:57 +0100 Subject: [PATCH 08/26] Update doorman.md --- device_services/specific/doorman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index e616343..1644bec 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -219,7 +219,7 @@ Topic example: ```jsx { "type": "evt.open.report", - "serv": "doorlock", + "serv": "door_lock", "val_t": "bool", "val": false, "tags": null, From c4ac20065d17bb3e9e470e321b2d45da8f477125 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Fri, 10 Nov 2023 04:28:22 +0100 Subject: [PATCH 09/26] Added evt.open.report used by Doorman --- device_services/generic/door_lock.md | 1 + 1 file changed, 1 insertion(+) diff --git a/device_services/generic/door_lock.md b/device_services/generic/door_lock.md index 59dcec7..f828156 100644 --- a/device_services/generic/door_lock.md +++ b/device_services/generic/door_lock.md @@ -12,6 +12,7 @@ Door lock service is used to control door locks. It is used to lock and unlock d | Type | Interface | Value type | Properties | Description | |------|-------------------------------|------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| out | evt.open.report | bool | | Simple lock status - true if open, false if closed | in | cmd.lock.get_report | null | | Requests the lock status. | | in | cmd.lock.set | bool | `mode_op` `firstname`, `uuid` | **Secures** the lock if the provided value is `true` and unlocks it if the value is `false`. | | out | evt.lock.report | bool_map | `timeout_m`, `timeout_s`, `lock_type` | Returns the lock status as a boolean map of components defined in [`sup_components`](#service-properties) property. | From f14b0d7b900568db8ecee1be1ba198d7780eec3a Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 00:38:16 +0100 Subject: [PATCH 10/26] Editorial - paranthesis --- device_services/specific/doorman.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 1644bec..b80dfae 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -17,13 +17,13 @@ in | cmd.doorman.integration | str_map | Start lock integration | {"n in | cmd.doorman_param.set | str_map | | {"parameter_id":"5", "value":"5"} in | cmd.doorman_param.get_report | null | | out | evt.doorman_param.report | str_map | Response to get_report | -in | cmd.doorman_user.set | str_map | Set pin or tag | {"name":"Jon", “slot_number”:”1”, "code_type":"pin", ”code”:”123456”} +in | cmd.doorman_user.set | str_map | Set pin or tag | {"name":"Jon", "slot_number":"1", "code_type":"pin", "code":"123456"} in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below -in | cmd.doorman_user.clear | str_map | | {“slot_number”:”1”} -out | evt.doorman_activity.report | str_map | Sent after an activity | {“event_type”:”id”, “status”:”0”, “error_code”:”0”, “user_status”:”added”, “slot_number”:”0”, “alarm_type”:”0”, “alarm_level”:”0”, “arming_parameter”:”0”, “sequence_number”:”0”, ”card_uid_data”:”12345678”} -in | cmd.doorman.arm_confirm | str_map | | {“sequence_number”:”0”, “operating_parameter”:”0”} -out | evt.doorman_tag.report | str_map | | {“type”:”unrecognized_tag”, "tag_id": "123456789ABC"} +in | cmd.doorman_user.clear | str_map | | {"slot_number":"1"} +out | evt.doorman_activity.report | str_map | Sent after an activity | {"event_type":"id", "status":"0", "error_code":"0", "user_status":"added", "slot_number":"0", "alarm_type":"0", "alarm_level":"0", "arming_parameter":"0", "sequence_number":"0", "card_uid_data":"12345678"} +in | cmd.doorman.arm_confirm | str_map | | {"sequence_number":"0", "operating_parameter":"0"} +out | evt.doorman_tag.report | str_map | | {"type":"unrecognized_tag", "tag_id": "123456789ABC"} ### Interface props @@ -33,7 +33,7 @@ Name | Value | Descrip `code_type` | "pin", "tag", "tag+pin", "24h", "s4+pin", "s8+pin" | List of supported code types Valid length for specified slots `pin_code_length` | 6 (For slot number 0-19), 4 - For slot number 20 | Valid length for specified slots `card_uid_data` | | The Hex format of the TAG UID -`user_status` | “added”, “removed” | Determines whether a user was successfully added or removed from the system. +`user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system. ### Configuration parameters From ca1bd48acb8186bd5d720ded0c794edf673d6f05 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 00:56:45 +0100 Subject: [PATCH 11/26] Extend activity evts examples --- device_services/specific/doorman.md | 80 +++++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 5 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index b80dfae..6f0a9a1 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -286,9 +286,9 @@ Topic example: } ``` -- evt.doorman_activity.report +- evt.doorman_activity.report - Sent by the lock when an event happens + Sent by the lock when an alarm event happens (event_type=0) ```jsx { @@ -296,11 +296,81 @@ Topic example: "serv": "doorman", "val_t": "str_map", "val": { - "alarm_level": "1", + "event_type": "0", + "error_code": "0", + "status": "53" "alarm_type": "21", + "alarm_level": "1", + "secure_mode": "true", // sent only when secure mode has changed + }, + "tags": null, + "props": null, + "ver": "1", + "corid": "", + "ctime": "2020-04-24T17:12:50.659+02:00", + "uid": "58a915ee-afdf-4769-b819-123d5979154b" + } + ``` + + Sent by the lock when a user event happens (event_type=1) + + ```jsx + { + "type": "evt.doorman_activity.report", + "serv": "doorman", + "val_t": "str_map", + "val": { + "event_type": "1", "error_code": "0", - "event_type": "0", - "status": "53" + "slot_number": "0" + "status": "53", + "user_status": "added", //or "removed" + }, + "tags": null, + "props": null, + "ver": "1", + "corid": "", + "ctime": "2020-04-24T17:12:50.659+02:00", + "uid": "58a915ee-afdf-4769-b819-123d5979154b" + } + ``` + + Sent by the lock when an arm event happens (event_type=2) + + ```jsx + { + "type": "evt.doorman_activity.report", + "serv": "doorman", + "val_t": "str_map", + "val": { + "event_type": "2", + "error_code": "0", + "slot_number": "0" + "status": "53", + "arming_parameter": "0", // 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action + }, + "tags": null, + "props": null, + "ver": "1", + "corid": "", + "ctime": "2020-04-24T17:12:50.659+02:00", + "uid": "58a915ee-afdf-4769-b819-123d5979154b" + } + ``` + + Sent by the lock when an unlock event happens (event_type=3) + + ```jsx + { + "type": "evt.doorman_activity.report", + "serv": "doorman", + "val_t": "str_map", + "val": { + "event_type": "3", + "error_code": "0", + "slot_number": "0" + "status": "53", + "card_uid_data": "AACDEF12", // 8 bytes string }, "tags": null, "props": null, From 03a4bf464b3b4bcf1dbab96dc5c59e92cd69acba Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:11:37 +0100 Subject: [PATCH 12/26] Add missing interface parameters --- device_services/specific/doorman.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 6f0a9a1..1b8fe14 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -21,19 +21,22 @@ in | cmd.doorman_user.set | str_map | Set pin or tag | {"n in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below in | cmd.doorman_user.clear | str_map | | {"slot_number":"1"} -out | evt.doorman_activity.report | str_map | Sent after an activity | {"event_type":"id", "status":"0", "error_code":"0", "user_status":"added", "slot_number":"0", "alarm_type":"0", "alarm_level":"0", "arming_parameter":"0", "sequence_number":"0", "card_uid_data":"12345678"} +out | evt.doorman_activity.report | str_map | Triggered by an event from the device | Each of 4 types has a different format, see examples below | in | cmd.doorman.arm_confirm | str_map | | {"sequence_number":"0", "operating_parameter":"0"} -out | evt.doorman_tag.report | str_map | | {"type":"unrecognized_tag", "tag_id": "123456789ABC"} +out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "123456ABC"} ### Interface props -Name | Value | Description -------------------|----------------------------------------------------|------------- -`slot_number` | 0-19 | 0-9 (PIN codes), 10-19 (RFID tags), 20 (24h codes) -`code_type` | "pin", "tag", "tag+pin", "24h", "s4+pin", "s8+pin" | List of supported code types Valid length for specified slots -`pin_code_length` | 6 (For slot number 0-19), 4 - For slot number 20 | Valid length for specified slots -`card_uid_data` | | The Hex format of the TAG UID -`user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system. +Name | Value | Description +--------------------|----------------------------------------------------------|------------- +`slot_number` | 0-9 for PIN codes, 10-19 for RFID tags, 20 for 24h code | ID assigned to each user. +`code_type` | "pin", "tag", "tag+pin", "24h", "s4+pin", "s8+pin" | List of supported code types Valid length for specified slots +`card_uid_data` | | The Hex format of the TAG UID used in evt.doorman_activity.report event_type=3 +`arming_parameter` | 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action | Used in evt.doorman_activity_report as a corresponding field to `operating_parameter` from cmd.doorman.arm_config. +`user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system. +`secure_mode` | "true", "false" | Determines whether the device is in the secure mode +`alarm_type` | Enum value - alarm code | Determines the alarm type in evt.doorman_activity_report event_type=0 +`alarm_level` | Enum value - value with reference to `alarm_type` | Parameter value of the alarm type from evt.doorman_activity_report event_type=0 ### Configuration parameters @@ -347,7 +350,7 @@ Topic example: "error_code": "0", "slot_number": "0" "status": "53", - "arming_parameter": "0", // 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action + "arming_parameter": "0", }, "tags": null, "props": null, From da75666fe690cd09f84acea0ddb3477a807fe421 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:12:52 +0100 Subject: [PATCH 13/26] Editorial --- device_services/specific/doorman.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 1b8fe14..4341d2d 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -35,8 +35,8 @@ Name | Value | `arming_parameter` | 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action | Used in evt.doorman_activity_report as a corresponding field to `operating_parameter` from cmd.doorman.arm_config. `user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system. `secure_mode` | "true", "false" | Determines whether the device is in the secure mode -`alarm_type` | Enum value - alarm code | Determines the alarm type in evt.doorman_activity_report event_type=0 -`alarm_level` | Enum value - value with reference to `alarm_type` | Parameter value of the alarm type from evt.doorman_activity_report event_type=0 +`alarm_type` | <0-255> | Enum value indicating the alarm type in evt.doorman_activity_report event_type=0 +`alarm_level` | <0-255> | Enum value parameter for the alarm type from evt.doorman_activity_report event_type=0 ### Configuration parameters From 4bbe581061f8b6e657d659a1dc35b8d83884b90f Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:19:18 +0100 Subject: [PATCH 14/26] Extend parameters evt --- device_services/specific/doorman.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 4341d2d..86af6cd 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -15,8 +15,8 @@ Type | Interface | Value Type | Description | Exa out | evt.doorman_session.report | null | Integration required | in | cmd.doorman.integration | str_map | Start lock integration | {"name":"Jon", "slot_number":"0", "code_type":"pin", "code":"123456"} in | cmd.doorman_param.set | str_map | | {"parameter_id":"5", "value":"5"} -in | cmd.doorman_param.get_report | null | | -out | evt.doorman_param.report | str_map | Response to get_report | +in | cmd.doorman_param.get_report | null | | +out | evt.doorman_param.report | str_map | Response to get_report | List of all available [parameters](#configuration-parameters) in format {"key":"value"} in | cmd.doorman_user.set | str_map | Set pin or tag | {"name":"Jon", "slot_number":"1", "code_type":"pin", "code":"123456"} in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below From 18bce12f046eaa4f790e446109ce9ed1f6fe7853 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:20:09 +0100 Subject: [PATCH 15/26] Editorial --- device_services/specific/doorman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 86af6cd..e9be527 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -16,7 +16,7 @@ out | evt.doorman_session.report | null | Integration required | in | cmd.doorman.integration | str_map | Start lock integration | {"name":"Jon", "slot_number":"0", "code_type":"pin", "code":"123456"} in | cmd.doorman_param.set | str_map | | {"parameter_id":"5", "value":"5"} in | cmd.doorman_param.get_report | null | | -out | evt.doorman_param.report | str_map | Response to get_report | List of all available [parameters](#configuration-parameters) in format {"key":"value"} +out | evt.doorman_param.report | str_map | Response to get_report | List of all available [parameters](#configuration-parameters) in format {"ID":"_value_"} in | cmd.doorman_user.set | str_map | Set pin or tag | {"name":"Jon", "slot_number":"1", "code_type":"pin", "code":"123456"} in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below From b0bd92947785c6aaa285a95abc0259eed462d055 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:21:54 +0100 Subject: [PATCH 16/26] Extend interface description --- device_services/specific/doorman.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index e9be527..54efa5b 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -32,9 +32,9 @@ Name | Value | `slot_number` | 0-9 for PIN codes, 10-19 for RFID tags, 20 for 24h code | ID assigned to each user. `code_type` | "pin", "tag", "tag+pin", "24h", "s4+pin", "s8+pin" | List of supported code types Valid length for specified slots `card_uid_data` | | The Hex format of the TAG UID used in evt.doorman_activity.report event_type=3 -`arming_parameter` | 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action | Used in evt.doorman_activity_report as a corresponding field to `operating_parameter` from cmd.doorman.arm_config. -`user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system. -`secure_mode` | "true", "false" | Determines whether the device is in the secure mode +`arming_parameter` | 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action | Used in evt.doorman_activity_report event_type=2 to correspond with `operating_parameter` from cmd.doorman.arm_config +`user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system in evt.doorman_activity_report event_type=1 +`secure_mode` | "true", "false" | Determines whether the device is in the secure mode in evt.doorman_activity_report event_type=0 `alarm_type` | <0-255> | Enum value indicating the alarm type in evt.doorman_activity_report event_type=0 `alarm_level` | <0-255> | Enum value parameter for the alarm type from evt.doorman_activity_report event_type=0 From 0ec87d39f4703aa3bfbaf94b5585d17361cb6090 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:22:50 +0100 Subject: [PATCH 17/26] Typo --- device_services/specific/doorman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 54efa5b..2dda5b3 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -23,7 +23,7 @@ out | evt.doorman_user.report | object | Response to get_all | See in | cmd.doorman_user.clear | str_map | | {"slot_number":"1"} out | evt.doorman_activity.report | str_map | Triggered by an event from the device | Each of 4 types has a different format, see examples below | in | cmd.doorman.arm_confirm | str_map | | {"sequence_number":"0", "operating_parameter":"0"} -out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "123456ABC"} +out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "123456AB"} ### Interface props From 8d819a10e542d73a81e721346f74752e773716df Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:28:27 +0100 Subject: [PATCH 18/26] Fix example --- device_services/specific/doorman.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 2dda5b3..3d78549 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -132,7 +132,8 @@ Topic example: "val": { "name": "Jon" "slot_number": "1", - "code": "111111" + "code": "111111", + "code_type":"pin" }, "props": null, "tags": null, @@ -188,7 +189,7 @@ Topic example: "slots": [ { "id": 3, - "name": "Jon", + "name": "Jon", "created_at": "2020-04-22T16:05:03.48677828+02:00" } ] From d9eb662e0607c513bc222f3340a5ef756c6c4f84 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:28:53 +0100 Subject: [PATCH 19/26] Remove unexisting example --- device_services/specific/doorman.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 3d78549..16205d6 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -199,23 +199,6 @@ Topic example: } ``` -- evt.op.ack - - Sent by the adapter as an Ack for some commands - - ```jsx - { - "type": "evt.op.ack", - "serv": "doorman", - "val_t": "string", - "val": "ack", - "ver": "1", - "corid": "08d2da8b-0d2c-4a2c-a0d7-8facc48b302", - "ctime": "2019-09-13T11:12:51.597+09:00", - "uid": "08d2da8b-0d2c-4a2c-a0d7-8facc48b3026" - } - ``` - - evt.open.report Sent by the adapter when the door opens/closes. From 45384ea5776a1ecb9cd593e28e9b4686db1d6b69 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:31:06 +0100 Subject: [PATCH 20/26] Remove unrelated examples --- device_services/specific/doorman.md | 74 ----------------------------- 1 file changed, 74 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 16205d6..344a2d0 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -199,80 +199,6 @@ Topic example: } ``` -- evt.open.report - - Sent by the adapter when the door opens/closes. - - ```jsx - { - "type": "evt.open.report", - "serv": "door_lock", - "val_t": "bool", - "val": false, - "tags": null, - "props": null, - "ver": "1", - "corid": "", - "ctime": "2020-05-06T11:55:21.02+02:00", - "uid": "8ed699b1-86bc-47ae-9c88-03ecc4b5c132" - } - ``` - -- evt.alarm.report - - Sent by the adapter upon certain events - - ```jsx - { - "type": "evt.alarm.report", - "serv": "alarm_lock", - "val_t": "str_map", - "val": { - "event": "manual_lock", - "status": "active" - }, - "tags": null, - "props": null, - "ver": "1", - "corid": "", - "ctime": "2020-04-24T17:12:50.686+02:00", - "uid": "aeae3ebd-9db9-4cad-a9db-23ee493f5f83" - } - ``` - - Event types: - - ```jsx - serviceName: "alarm_lock" - eventTypes: { - "jammed", - "manual_unlock", - "manual_lock", - "rf_unlock", - "rf_lock", - "keypad_unlock", - "keypad_lock", - "tag_unlock", - "tag_lock", - "auto_locked", - "lock_failed", - "door_opened", - "door_closed" - } - - serviceName: "alarm_burglar" - eventTypes: { - "tamper_invalid_code", - "tamper_removed_cover", - "tamper_force_open" - } - - serviceName: "alarm_power" - eventTypes: { - "replace_soon" - } - ``` - - evt.doorman_activity.report Sent by the lock when an alarm event happens (event_type=0) From d301eb58f1d97edffad1acab37805884b118e814 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:32:33 +0100 Subject: [PATCH 21/26] Editorial --- device_services/specific/doorman.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 344a2d0..d7c4cfe 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -199,9 +199,7 @@ Topic example: } ``` -- evt.doorman_activity.report - - Sent by the lock when an alarm event happens (event_type=0) +- evt.doorman_activity.report sent by the device upon alarm event (event_type=0) ```jsx { @@ -225,7 +223,7 @@ Topic example: } ``` - Sent by the lock when a user event happens (event_type=1) +- evt.doorman_activity.report sent by the device upon user event (event_type=1) ```jsx { @@ -248,7 +246,7 @@ Topic example: } ``` - Sent by the lock when an arm event happens (event_type=2) +- evt.doorman_activity.report sent by the device upon arm event (event_type=2) ```jsx { @@ -271,7 +269,7 @@ Topic example: } ``` - Sent by the lock when an unlock event happens (event_type=3) +- evt.doorman_activity.report sent by the device upon unlock event (event_type=3) ```jsx { From d3cb9e645d97790b1c468a2ded35191f9b3edf55 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:37:35 +0100 Subject: [PATCH 22/26] Editorial --- device_services/specific/doorman.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index d7c4cfe..9e4d730 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -56,8 +56,6 @@ Topic example: `pt:j1/mt:cmd/rt:dev/rn:zigbee/ad:1/sv:doorman/ad:2_1` -*Note: number `2` at the end of the topic is the device address. Change it to the actual address when sending the commands.* - - cmd.doorman.integration Sent automatically from the hub upon reception of `evt.doorman.session_report` @@ -67,8 +65,7 @@ Topic example: "serv": "doorman", "type": "cmd.doorman.integration", "val_t": "str_map", - "val": {"slot_number":"0", "code_type":"pin", - "code":"123456"}, + "val": {"slot_number":"0", "code_type":"pin", "code":"123456", "name": "Jon"}, "props": null, "tags": null, "src": "thingsplex-ui", @@ -78,15 +75,7 @@ Topic example: - cmd.doorman_param.set - Sets Doorman's parameters. For the valid `parameter_id` values and what they mean, check with corresponding version of Doorman cluster implementation. Some examplary parameters are: - - DoormanSilentMode = 0x01 - DoormanAutoRelock = 0x02 - DoormanLanguage = 0x05 - DoormanSystemArmHoldTime = 0x10 - DoormanHomeAwayAlarmMode = 0x11 - DoormanPartAlarmSystem = 0x12 - DoormanUserCodeBlockingEnable = 0x13 + Sets configuration parameter from the [list](#configuration-parameters). For the valid `parameter_id` values and what they mean, check with corresponding version of Doorman cluster implementation ```jsx { @@ -101,8 +90,6 @@ Topic example: } ``` - [Configuration parameters](https://www.notion.so/3de70e7b58d1489482f2115a2e486866) - - cmd.doorman_param.get_report Returns the values of all the parameters in an `evt.doorman_param.report` message. From d4df8dcc46c857c1d634e0d60c7b992b70c5a7dc Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:39:07 +0100 Subject: [PATCH 23/26] Formating --- device_services/specific/doorman.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 9e4d730..8487a80 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -196,10 +196,10 @@ Topic example: "val": { "event_type": "0", "error_code": "0", - "status": "53" + "status": "53" "alarm_type": "21", "alarm_level": "1", - "secure_mode": "true", // sent only when secure mode has changed + "secure_mode": "true", // sent only when secure mode has changed }, "tags": null, "props": null, @@ -220,7 +220,7 @@ Topic example: "val": { "event_type": "1", "error_code": "0", - "slot_number": "0" + "slot_number": "0" "status": "53", "user_status": "added", //or "removed" }, @@ -243,7 +243,7 @@ Topic example: "val": { "event_type": "2", "error_code": "0", - "slot_number": "0" + "slot_number": "0" "status": "53", "arming_parameter": "0", }, @@ -266,9 +266,9 @@ Topic example: "val": { "event_type": "3", "error_code": "0", - "slot_number": "0" + "slot_number": "0" "status": "53", - "card_uid_data": "AACDEF12", // 8 bytes string + "card_uid_data": "AACDEF12", }, "tags": null, "props": null, From 165a39bc3343c1cb9fd96c63224f2acbef40d0d2 Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Sun, 12 Nov 2023 01:56:57 +0100 Subject: [PATCH 24/26] Fix arming --- device_services/specific/doorman.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 8487a80..d97db26 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -22,17 +22,17 @@ in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below in | cmd.doorman_user.clear | str_map | | {"slot_number":"1"} out | evt.doorman_activity.report | str_map | Triggered by an event from the device | Each of 4 types has a different format, see examples below | -in | cmd.doorman.arm_confirm | str_map | | {"sequence_number":"0", "operating_parameter":"0"} +in | cmd.doorman.arm_confirm | str_map | Sets arming setting | {"operating_parameter":"0"} out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "123456AB"} ### Interface props Name | Value | Description --------------------|----------------------------------------------------------|------------- -`slot_number` | 0-9 for PIN codes, 10-19 for RFID tags, 20 for 24h code | ID assigned to each user. +`slot_number` | 0-9 for PIN codes, 10-19 for RFID tags, 20 for 24h code | ID assigned to each user. `code_type` | "pin", "tag", "tag+pin", "24h", "s4+pin", "s8+pin" | List of supported code types Valid length for specified slots `card_uid_data` | | The Hex format of the TAG UID used in evt.doorman_activity.report event_type=3 -`arming_parameter` | 0 - unlock, 1 - unlock with relock, 2 - lock, 255 - no action | Used in evt.doorman_activity_report event_type=2 to correspond with `operating_parameter` from cmd.doorman.arm_config +`arming_parameter` | 0 - disarming, 1 - arming | Determines disarming/arming setting on the device `user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system in evt.doorman_activity_report event_type=1 `secure_mode` | "true", "false" | Determines whether the device is in the secure mode in evt.doorman_activity_report event_type=0 `alarm_type` | <0-255> | Enum value indicating the alarm type in evt.doorman_activity_report event_type=0 From 406955824ca5213e24505bdfffae38301b4403ac Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Mon, 13 Nov 2023 04:20:15 +0100 Subject: [PATCH 25/26] Fix tag ID example --- device_services/specific/doorman.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index d97db26..31cc9f6 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -23,7 +23,7 @@ out | evt.doorman_user.report | object | Response to get_all | See in | cmd.doorman_user.clear | str_map | | {"slot_number":"1"} out | evt.doorman_activity.report | str_map | Triggered by an event from the device | Each of 4 types has a different format, see examples below | in | cmd.doorman.arm_confirm | str_map | Sets arming setting | {"operating_parameter":"0"} -out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "123456AB"} +out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "12345678AABBCCDD"} ### Interface props @@ -268,7 +268,7 @@ Topic example: "error_code": "0", "slot_number": "0" "status": "53", - "card_uid_data": "AACDEF12", + "card_uid_data": "12345678AABBCCDD", }, "tags": null, "props": null, From 51faa9b018a22b6672a0018efde3cf405436b1dd Mon Sep 17 00:00:00 2001 From: Michal Budzon <98946120+BudzikM@users.noreply.github.com> Date: Fri, 13 Sep 2024 19:25:11 +0200 Subject: [PATCH 26/26] Update doorman.md Modify activity.report --- device_services/specific/doorman.md | 87 ++--------------------------- 1 file changed, 6 insertions(+), 81 deletions(-) diff --git a/device_services/specific/doorman.md b/device_services/specific/doorman.md index 31cc9f6..53e4cb6 100644 --- a/device_services/specific/doorman.md +++ b/device_services/specific/doorman.md @@ -21,7 +21,7 @@ in | cmd.doorman_user.set | str_map | Set pin or tag | {"n in | cmd.doorman_user.get_all | null | Get all user slots | out | evt.doorman_user.report | object | Response to get_all | See below in | cmd.doorman_user.clear | str_map | | {"slot_number":"1"} -out | evt.doorman_activity.report | str_map | Triggered by an event from the device | Each of 4 types has a different format, see examples below | +out | evt.doorman_activity.report | str_map | Modes settings | {"secure_mode": "true", "auto_lock": "true", "three_min_lock": "false"} in | cmd.doorman.arm_confirm | str_map | Sets arming setting | {"operating_parameter":"0"} out | evt.doorman_tag.report | str_map | tag_id is 8-byte long | {"type":"unrecognized_tag", "tag_id": "12345678AABBCCDD"} @@ -33,10 +33,9 @@ Name | Value | `code_type` | "pin", "tag", "tag+pin", "24h", "s4+pin", "s8+pin" | List of supported code types Valid length for specified slots `card_uid_data` | | The Hex format of the TAG UID used in evt.doorman_activity.report event_type=3 `arming_parameter` | 0 - disarming, 1 - arming | Determines disarming/arming setting on the device -`user_status` | "added", "removed" | Determines whether a user was successfully added or removed from the system in evt.doorman_activity_report event_type=1 -`secure_mode` | "true", "false" | Determines whether the device is in the secure mode in evt.doorman_activity_report event_type=0 -`alarm_type` | <0-255> | Enum value indicating the alarm type in evt.doorman_activity_report event_type=0 -`alarm_level` | <0-255> | Enum value parameter for the alarm type from evt.doorman_activity_report event_type=0 +`secure_mode` | "true", "false" | Determines whether the device is in the secure mode in evt.doorman_activity_report. Sent only when changed. +`auto_lock` | "true", "false" | Determines whether the device is in the auto mode in evt.doorman_activity_report. Sent only when changed. +`secure_mode` | "true", "false" | Determines whether the device is in the 3 min lock mode in evt.doorman_activity_report. Sent only when changed. ### Configuration parameters @@ -186,7 +185,7 @@ Topic example: } ``` -- evt.doorman_activity.report sent by the device upon alarm event (event_type=0) +- evt.doorman_activity.report sent by the device upon secure mode change ```jsx { @@ -194,81 +193,7 @@ Topic example: "serv": "doorman", "val_t": "str_map", "val": { - "event_type": "0", - "error_code": "0", - "status": "53" - "alarm_type": "21", - "alarm_level": "1", - "secure_mode": "true", // sent only when secure mode has changed - }, - "tags": null, - "props": null, - "ver": "1", - "corid": "", - "ctime": "2020-04-24T17:12:50.659+02:00", - "uid": "58a915ee-afdf-4769-b819-123d5979154b" - } - ``` - -- evt.doorman_activity.report sent by the device upon user event (event_type=1) - - ```jsx - { - "type": "evt.doorman_activity.report", - "serv": "doorman", - "val_t": "str_map", - "val": { - "event_type": "1", - "error_code": "0", - "slot_number": "0" - "status": "53", - "user_status": "added", //or "removed" - }, - "tags": null, - "props": null, - "ver": "1", - "corid": "", - "ctime": "2020-04-24T17:12:50.659+02:00", - "uid": "58a915ee-afdf-4769-b819-123d5979154b" - } - ``` - -- evt.doorman_activity.report sent by the device upon arm event (event_type=2) - - ```jsx - { - "type": "evt.doorman_activity.report", - "serv": "doorman", - "val_t": "str_map", - "val": { - "event_type": "2", - "error_code": "0", - "slot_number": "0" - "status": "53", - "arming_parameter": "0", - }, - "tags": null, - "props": null, - "ver": "1", - "corid": "", - "ctime": "2020-04-24T17:12:50.659+02:00", - "uid": "58a915ee-afdf-4769-b819-123d5979154b" - } - ``` - -- evt.doorman_activity.report sent by the device upon unlock event (event_type=3) - - ```jsx - { - "type": "evt.doorman_activity.report", - "serv": "doorman", - "val_t": "str_map", - "val": { - "event_type": "3", - "error_code": "0", - "slot_number": "0" - "status": "53", - "card_uid_data": "12345678AABBCCDD", + "secure_mode": "true", }, "tags": null, "props": null,