Skip to content

Commit

Permalink
Incremented schema version to 14
Browse files Browse the repository at this point in the history
Added new property `alarm`, `alarmType`, `alarmArmed`, `alarmArmDelay`, `alarmDelay` and `alarmDelayType` to Station
Added new Device event `vehicle detected`
Added new Driver event `connection error`
Updated dependency eufy-security-client to 2.2.3
Updated dependency ws to 8.11.0
Updated dev dependencies
  • Loading branch information
bropat committed Nov 12, 2022
1 parent e448fe3 commit fed465d
Show file tree
Hide file tree
Showing 10 changed files with 220 additions and 119 deletions.
2 changes: 1 addition & 1 deletion docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![logo](_media/eufy-security-ws.png)

# eufy-security-ws <small>1.0.2</small>
# eufy-security-ws <small>1.1.0</small>

> A small server wrapper around [eufy-security-client](https://github.com/bropat/eufy-security-client) library to access it via a WebSocket
Expand Down
35 changes: 35 additions & 0 deletions docs/api_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,23 @@ interface {
}
```

### `connection error`

[compatible with schema version: 14+]

This event is sent whenever a connection/authentication error to the cloud occurs.

```ts
interface {
type: "event";
event: {
source: "driver";
event: "connection error";
error: Error;
}
}
```

## Station level events

### `station added`
Expand Down Expand Up @@ -911,6 +928,24 @@ interface {
}
```

### `vehicle detected`

[compatible with schema version: 14+]

This event is sent whenever a vehicle is detected on the device (the cooldown is determined by the `eventDurationSeconds` param).

```ts
interface {
type: "event";
event: {
source: "device";
event: "vehicle detected";
serialNumber: string;
state: boolean;
}
}
```

### `rings`

[compatible with schema version: 0+]
Expand Down
6 changes: 6 additions & 0 deletions docs/api_schema_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This document describes the changes that are introduced with each schema version.

## Schema 14

* Added new property `alarm`, `alarmType`, `alarmArmed`, `alarmArmDelay`, `alarmDelay` and `alarmDelayType` to Station
* Added new Device event `vehicle detected`
* Added new Driver event `connection error`

## Schema 13

* Modified Station event `command result` adding custom data
Expand Down
Loading

0 comments on commit fed465d

Please sign in to comment.