Skip to content

Commit

Permalink
Add description
Browse files Browse the repository at this point in the history
  • Loading branch information
kopiro committed Oct 3, 2024
1 parent ae5cac9 commit eac419f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Make your TP-Link TAPO security camera compatible with Homekit through Homebridg

The plugin exposes the camera RTSP video feed, and toggle accessories to configure your automations.

If your video feed is not working, try to check if any of the parameters at the video config can be tuned. You can use [https://sunoo.github.io/homebridge-camera-ffmpeg/configs](https://sunoo.github.io/homebridge-camera-ffmpeg/configs) to check if someone has already found the right values for your camera.

### Toggle accessories

- _"Eyes"_ controls the privacy mode; when it's on it means that the camera is able to see
Expand Down
9 changes: 5 additions & 4 deletions config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"pluginAlias": "tapo-camera",
"pluginType": "platform",
"singular": true,
"headerDisplay": "Homebridge plugin for TP-Link TAPO security cameras",
"footerDisplay": null,
"headerDisplay": "Homebridge plugin for TP-Link TAPO security cameras.",
"footerDisplay": "If your video feed is not working, try to check if any of the parameters at the video config can be tuned. You can use https://sunoo.github.io/homebridge-camera-ffmpeg/configs to check if someone has already found the right values for your camera.",
"form": null,
"display": null,
"schema": {
Expand Down Expand Up @@ -100,7 +100,7 @@
"lowQuality": {
"title": "Low Quality",
"type": "boolean",
"description": "Video stream will be requested in low-quality (640x480) instead of HQ (1920x1080)"
"description": "Video stream will be requested in low-quality instead of high-quality"
},
"eyesToggleAccessoryName": {
"title": "Eyes (privacy mode) toggle Name",
Expand Down Expand Up @@ -132,6 +132,7 @@
"description": "Name of the LED toggle",
"placeholder": "LED"
},

"videoMaxWidth": {
"title": "Video Max Width",
"type": "integer",
Expand Down Expand Up @@ -165,7 +166,7 @@
"videoForceMax": {
"title": "Force Max Video",
"type": "boolean",
"description": "Force the video stream to use the maximum values"
"description": "Force the video stream to use the maximum values, instead of the one provided by the Homekit request. Most likely you don't want this"
}
}
}
Expand Down
3 changes: 3 additions & 0 deletions src/cameraAccessory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ export class CameraAccessory {
forceMax: this.config.videoForceMax,
...(this.config.videoConfig || {}),
};

return config;
}

Expand All @@ -204,6 +205,8 @@ export class CameraAccessory {
);

this.accessory.configureController(delegate.controller);

this.log.debug("Camera streaming setup done");
} catch (err) {
this.log.error("Error setting up camera streaming:", err);
}
Expand Down

0 comments on commit eac419f

Please sign in to comment.