Skip to content

Commit

Permalink
Incremented schema version to 11
Browse files Browse the repository at this point in the history
Added new property `imageMirrored` to Device
Added new Station events `alarmDelayEvent` and `alarmArmedEvent`
Updated dependency eufy-security-client to 2.1.0
Updated dependency commander to 9.3.0
Updated dependency ws to 8.8.0
Updated dependency ansi-colors to 4.1.3
Updated dev dependencies
  • Loading branch information
bropat committed Jun 12, 2022
1 parent df25474 commit d08424e
Show file tree
Hide file tree
Showing 9 changed files with 564 additions and 363 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>0.9.1</small>
# eufy-security-ws <small>0.9.2</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
38 changes: 38 additions & 0 deletions docs/api_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,42 @@ interface {
}
```

### `alarm delay event`

[compatible with schema version: 11+]

This event is sent whenever an alarm delay event occurred.

```ts
interface {
type: "event";
event: {
source: "station";
event: "alarm delay event";
serialNumber: string;
alarmDelayEvent: AlarmEvent;
alarmDelay: number;
}
}
```

### `alarm armed event`

[compatible with schema version: 11+]

This event is sent whenever an alarm armed event occurred.

```ts
interface {
type: "event";
event: {
source: "station";
event: "alarm armed event";
serialNumber: string;
}
}
```

## Device level events

### `device added`
Expand Down Expand Up @@ -573,6 +609,7 @@ interface {
defaultAngle?: boolean; // [added with schema version: 10+]
defaultAngleIdleTime?: number; // [added with schema version: 10+]
soundDetectionRoundLook?: boolean; // [added with schema version: 10+]
imageMirrored?: boolean; // [added with schema version: 11+]
}
}
}
Expand Down Expand Up @@ -752,6 +789,7 @@ interface {
defaultAngle?: boolean; // [added with schema version: 10+]
defaultAngleIdleTime?: number; // [added with schema version: 10+]
soundDetectionRoundLook?: boolean; // [added with schema version: 10+]
imageMirrored?: boolean; // [added with schema version: 11+]
}
}
}
Expand Down
7 changes: 6 additions & 1 deletion docs/api_schema_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,9 @@ Base schema.
* Added new Server event `shutdown`
* Removed property `timestamp`from Station event `property changed`
* Removed property `timestamp`from Device event `property changed`
* Added new properties `notificationRadarDetector`, `continuousRecording`, `continuousRecordingType`, `loiteringDetection`, `loiteringDetectionRange`, `loiteringDetectionLength`, `motionDetectionSensitivityMode`, `motionDetectionSensitivityStandard`, `motionDetectionSensitivityAdvancedA`, `motionDetectionSensitivityAdvancedB`, `motionDetectionSensitivityAdvancedC`, `motionDetectionSensitivityAdvancedD`, `motionDetectionSensitivityAdvancedE`, `motionDetectionSensitivityAdvancedF`, `motionDetectionSensitivityAdvancedG`, `motionDetectionSensitivityAdvancedH`, `loiteringCustomResponsePhoneNotification`, `loiteringCustomResponseAutoVoiceResponse`, `loiteringCustomResponseAutoVoiceResponseVoice`, `loiteringCustomResponseHomeBaseNotification`, `loiteringCustomResponseTimeFrom`, `loiteringCustomResponseTimeTo`, `deliveryGuard`, `deliveryGuardPackageGuarding`, `deliveryGuardPackageGuardingVoiceResponseVoice`, `deliveryGuardPackageGuardingActivatedTimeFrom`, `deliveryGuardPackageGuardingActivatedTimeTo`, `deliveryGuardUncollectedPackageAlert`, `deliveryGuardUncollectedPackageAlertTimeToCheck`, `deliveryGuardPackageLiveCheckAssistance`, `dualCamWatchViewMode`, `ringAutoResponse`, `ringAutoResponseVoiceResponse`, `ringAutoResponseVoiceResponseVoice`, `ringAutoResponseTimeFrom`, `ringAutoResponseTimeTo`, `defaultAngle`, `defaultAngleIdleTime` and `soundDetectionRoundLook` to Device
* Added new properties `notificationRadarDetector`, `continuousRecording`, `continuousRecordingType`, `loiteringDetection`, `loiteringDetectionRange`, `loiteringDetectionLength`, `motionDetectionSensitivityMode`, `motionDetectionSensitivityStandard`, `motionDetectionSensitivityAdvancedA`, `motionDetectionSensitivityAdvancedB`, `motionDetectionSensitivityAdvancedC`, `motionDetectionSensitivityAdvancedD`, `motionDetectionSensitivityAdvancedE`, `motionDetectionSensitivityAdvancedF`, `motionDetectionSensitivityAdvancedG`, `motionDetectionSensitivityAdvancedH`, `loiteringCustomResponsePhoneNotification`, `loiteringCustomResponseAutoVoiceResponse`, `loiteringCustomResponseAutoVoiceResponseVoice`, `loiteringCustomResponseHomeBaseNotification`, `loiteringCustomResponseTimeFrom`, `loiteringCustomResponseTimeTo`, `deliveryGuard`, `deliveryGuardPackageGuarding`, `deliveryGuardPackageGuardingVoiceResponseVoice`, `deliveryGuardPackageGuardingActivatedTimeFrom`, `deliveryGuardPackageGuardingActivatedTimeTo`, `deliveryGuardUncollectedPackageAlert`, `deliveryGuardUncollectedPackageAlertTimeToCheck`, `deliveryGuardPackageLiveCheckAssistance`, `dualCamWatchViewMode`, `ringAutoResponse`, `ringAutoResponseVoiceResponse`, `ringAutoResponseVoiceResponseVoice`, `ringAutoResponseTimeFrom`, `ringAutoResponseTimeTo`, `defaultAngle`, `defaultAngleIdleTime` and `soundDetectionRoundLook` to Device

## Schema 11

* Added new property `imageMirrored` to Device
* Added new Station events `alarmDelayEvent` and `alarmArmedEvent`
Loading

0 comments on commit d08424e

Please sign in to comment.