Incremented schema version to 16

Added new property `picture` to Device Removed property `pictureUrl`from Device Added new command `downloadImage` to Station Added new Station event `image downloaded` Fixed some minor issues Updated dependency eufy-security-client to 2.5.1 Updated dependency commander to 10.0.1 Updated dev dependencies Updated docs
bropat · May 7, 2023 · cbac5b9 · cbac5b9
1 parent 0f6ffe1
commit cbac5b9
Show file tree

Hide file tree

Showing 15 changed files with 384 additions and 243 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.3.5</small>
+# eufy-security-ws <small>1.4.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
@@ -522,6 +522,19 @@ interface {
 }
 ```
 
+### Download image
+
+[compatible with schema version: 17+]
+
+```ts
+interface {
+    messageId: string;
+    command: "station.download_image";
+    serialNumber: string;
+    file: string;
+}
+```
+
 ## Device level commands
 
 ### Get properties metadata

diff --git a/docs/api_events.md b/docs/api_events.md
@@ -473,6 +473,25 @@ interface {
 }
 ```
 
+### `image downloaded`
+
+[compatible with schema version: 17+]
+
+This event is sent whenever an image was successfully downloaded.
+
+```ts
+interface {
+  type: "event";
+  event: {
+    source: "station";
+    event: "image downloaded";
+    serialNumber: string;
+    file: string;
+    image: Picture;
+  }
+}
+```
+
 ## Device level events
 
 ### `device added`

diff --git a/docs/api_schema_versions.md b/docs/api_schema_versions.md
@@ -2,6 +2,13 @@
 
 This document describes the changes that are introduced with each schema version.
 
+## Schema 17
+
+* Added new property `picture` to Device
+* Removed property `pictureUrl`from Device
+* Added new command `downloadImage` to Station
+* Added new Station event `image downloaded`
+
 ## Schema 16
 
 * Added new property `cellularRSSI`, `cellularSignalLevel`, `cellularSignal`, `cellularBand`, `cellularIMEI` and `cellularICCID` to Device