Incremented schema version to 15

* Added new property `snoozeStartTime`, `snoozeHomebase`, `snoozeMotion` and `snoozeChime` to Device * Added new Device events `stranger person detected`, `dog detected`, `dog lick detected` and `dog poop detected` * Added new command `chime` to Station Updated dependency eufy-security-client to 2.3.0 Updated dev dependencies
bropat · Nov 26, 2022 · a6eb8eb · a6eb8eb
1 parent fed465d
commit a6eb8eb
Show file tree

Hide file tree

Showing 17 changed files with 577 additions and 148 deletions.
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -1,6 +1,6 @@
 ![logo](_media/eufy-security-ws.png)
 
-# eufy-security-ws <small>1.1.0</small>
+# eufy-security-ws <small>1.2.0</small>
 
 > A small server wrapper around [eufy-security-client](https://github.com/bropat/eufy-security-client) library to access it via a WebSocket
 

diff --git a/docs/api_cmds.md b/docs/api_cmds.md
@@ -507,6 +507,21 @@ interface {
 }
 ```
 
+### Chime
+
+[compatible with schema version: 15+]
+
+Only supported if no doorbell device is registered at the station where the chime is to be performed.
+
+```ts
+interface {
+    messageId: string;
+    command: "station.chime";
+    serialNumber: string;
+    ringtone?: number;
+}
+```
+
 ## Device level commands
 
 ### Get properties metadata

diff --git a/docs/api_events.md b/docs/api_events.md
@@ -874,6 +874,24 @@ interface {
 }
 ```
 
+### `stranger person detected`
+
+[compatible with schema version: 15+]
+
+This event is sent whenever a stranger person is detected on the device (the cooldown is determined by the `eventDurationSeconds` param).
+
+```ts
+interface {
+  type: "event";
+  event: {
+    source: "device";
+    event: "stranger person detected";
+    serialNumber: string;
+    state: boolean;
+  }
+}
+```
+
 ### `crying detected`
 
 [compatible with schema version: 0+]
@@ -946,6 +964,60 @@ interface {
 }
 ```
 
+### `dog detected`
+
+[compatible with schema version: 15+]
+
+This event is sent whenever a dog is detected on the device (the cooldown is determined by the `eventDurationSeconds` param).
+
+```ts
+interface {
+  type: "event";
+  event: {
+    source: "device";
+    event: "dog detected";
+    serialNumber: string;
+    state: boolean;
+  }
+}
+```
+
+### `dog lick detected`
+
+[compatible with schema version: 15+]
+
+This event is sent whenever a dog lick is detected on the device (the cooldown is determined by the `eventDurationSeconds` param).
+
+```ts
+interface {
+  type: "event";
+  event: {
+    source: "device";
+    event: "dog lick detected";
+    serialNumber: string;
+    state: boolean;
+  }
+}
+```
+
+### `dog poop detected`
+
+[compatible with schema version: 15+]
+
+This event is sent whenever a dog poop is detected on the device (the cooldown is determined by the `eventDurationSeconds` param).
+
+```ts
+interface {
+  type: "event";
+  event: {
+    source: "device";
+    event: "dog poop detected";
+    serialNumber: string;
+    state: boolean;
+  }
+}
+```
+
 ### `rings`
 
 [compatible with schema version: 0+]

diff --git a/docs/api_schema_versions.md b/docs/api_schema_versions.md
@@ -2,6 +2,12 @@
 
 This document describes the changes that are introduced with each schema version.
 
+## Schema 15
+
+* Added new property `snoozeStartTime`, `snoozeHomebase`, `snoozeMotion` and `snoozeChime` to Device
+* Added new Device events `stranger person detected`, `dog detected`, `dog lick detected` and `dog poop detected`
+* Added new command `chime` to Station
+
 ## Schema 14
 
 * Added new property `alarm`, `alarmType`, `alarmArmed`, `alarmArmDelay`, `alarmDelay` and `alarmDelayType` to Station