Skip to content

Commit

Permalink
v4.15.1.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjdhjd committed Sep 30, 2024
1 parent 1ba3d63 commit f558ef8
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 11 deletions.
4 changes: 4 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All notable changes to this project will be documented in this file. This project uses [semantic versioning](https://semver.org/).

## 4.15.1 (2024-09-29)
* Minor updates to the Protect JSON descriptions.
* Housekeeping.

## 4.15.0 (2024-09-26)
* New feature: added the `isThrottled` as a publicly accessible readonly property that returns whether the API connection is currently throttled due to connectivity issues.
* Housekeeping.
Expand Down
14 changes: 14 additions & 0 deletions docs/ProtectTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ A semi-complete description of the UniFi Protect camera JSON.
| `isRestoring` | `boolean` |
| `isSmartDetected` | `boolean` |
| `isSshEnabled` | `boolean` |
| `isThirdPartyCamera` | `boolean` |
| `isUpdating` | `boolean` |
| `isWaterproofCaseAttached` | `boolean` |
| `isWirelessUplinkEnabled` | `boolean` |
Expand Down Expand Up @@ -279,10 +280,19 @@ A semi-complete description of the UniFi Protect camera JSON.
| `talkbackSettings.samplingRate` | `number` |
| `talkbackSettings.typeFmt` | `string` |
| `talkbackSettings.typeIn` | `string` |
| `thirdPartyCameraInfo` | \{ `port`: `number`; `rtspUrl`: `string`; `rtspUrlLQ`: `string`; `snapshotUrl`: `string`; \} |
| `thirdPartyCameraInfo.port` | `number` |
| `thirdPartyCameraInfo.rtspUrl` | `string` |
| `thirdPartyCameraInfo.rtspUrlLQ` | `string` |
| `thirdPartyCameraInfo.snapshotUrl` | `string` |
| `tiltLimitsOfPrivacyZones` | \{ `limit`: `number`; `side`: `string`; \} |
| `tiltLimitsOfPrivacyZones.limit` | `number` |
| `tiltLimitsOfPrivacyZones.side` | `string` |
| `type` | `string` |
| `upSince` | `number` |
| `videoCodec` | `string` |
| `videoMode` | `string` |
| `voltage` | `number` |
| `wifiConnectionState` | \{ `channel`: `number`; `frequency`: `number`; `phyRate`: `number`; `signalQuality`: `number`; `signalStrength`: `number`; \} |
| `wifiConnectionState.channel` | `number` |
| `wifiConnectionState.frequency` | `number` |
Expand Down Expand Up @@ -354,6 +364,7 @@ A semi-complete description of the UniFi Protect chime JSON.
| `marketName` | `string` |
| `modelKey` | `string` |
| `name` | `string` |
| `nvrMac` | `string` |
| `platform` | `string` |
| `repeatTimes` | `number` |
| `ringSettings` | \{ `cameraId`: `string`; `repeatTimes`: `number`; `ringtoneId`: `string`; `volume`: `number`; \}[] |
Expand Down Expand Up @@ -479,6 +490,7 @@ A semi-complete description of the UniFi Protect light JSON.
| `marketName` | `string` |
| `modelKey` | `string` |
| `name` | `string` |
| `nvrMac` | `string` |
| `state` | `string` |
| `type` | `string` |
| `upSince` | `number` |
Expand Down Expand Up @@ -919,6 +931,7 @@ A semi-complete description of the UniFi Protect sensor JSON.
| `motionSettings.sensitivity` | `number` |
| `mountType` | `string` |
| `name` | `string` |
| `nvrMac` | `string` |
| `openStatusChangedAt` | `number` |
| `state` | `string` |
| `stats` | \{ `humidity`: \{ `status`: `string`; `value`: `null` \| `number`; \}; `light`: \{ `status`: `string`; `value`: `null` \| `number`; \}; `temperature`: \{ `status`: `string`; `value`: `null` \| `number`; \}; \} |
Expand Down Expand Up @@ -977,6 +990,7 @@ A semi-complete description of the UniFi Protect viewer JSON.
| `marketName` | `string` |
| `modelKey` | `string` |
| `name` | `string` |
| `nvrMac` | `string` |
| `softwareVersion` | `string` |
| `state` | `string` |
| `streamLimit` | `number` |
Expand Down
18 changes: 9 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "unifi-protect",
"type": "module",
"version": "4.15.0",
"version": "4.15.1",
"displayName": "UniFi Protect API",
"description": "A complete implementation of the UniFi Protect API.",
"author": {
Expand Down Expand Up @@ -62,7 +62,7 @@
},
"devDependencies": {
"@stylistic/eslint-plugin": "2.8.0",
"@types/node": "22.7.2",
"@types/node": "22.7.4",
"@types/ws": "8.5.12",
"eslint": "9.11.1",
"homebridge": "1.8.4",
Expand Down
18 changes: 18 additions & 0 deletions src/protect-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,7 @@ export interface ProtectCameraConfigInterface {
isRestoring: boolean,
isSmartDetected: boolean,
isSshEnabled: boolean,
isThirdPartyCamera: boolean,
isUpdating: boolean,
isWaterproofCaseAttached: boolean,
isWirelessUplinkEnabled: boolean,
Expand Down Expand Up @@ -548,10 +549,23 @@ export interface ProtectCameraConfigInterface {
quality: number,
samplingRate: number
},
thirdPartyCameraInfo: {

port: number,
rtspUrl: string,
rtspUrlLQ: string,
snapshotUrl: string
},
tiltLimitsOfPrivacyZones: {

limit: number,
side: string
},
type: string,
upSince: number,
videoCodec: string,
videoMode: string,
voltage: number,
wifiConnectionState: {

channel: number,
Expand Down Expand Up @@ -644,6 +658,7 @@ export interface ProtectChimeConfigInterface {
marketName: string,
modelKey: string,
name: string,
nvrMac: string,
platform: string,
repeatTimes: number,
ringSettings: {
Expand Down Expand Up @@ -741,6 +756,7 @@ export interface ProtectLightConfigInterface {
marketName: string,
modelKey: string,
name: string,
nvrMac: string,
state: string,
type: string,
upSince: number,
Expand Down Expand Up @@ -966,6 +982,7 @@ export interface ProtectSensorConfigInterface {
},
mountType: string,
name: string,
nvrMac: string,
openStatusChangedAt: number,
state: string,
stats: {
Expand Down Expand Up @@ -1032,6 +1049,7 @@ export interface ProtectViewerConfigInterface {
marketName: string,
modelKey: string,
name: string,
nvrMac: string,
softwareVersion: string,
state: string,
streamLimit: number,
Expand Down

0 comments on commit f558ef8

Please sign in to comment.