mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 05:16:49 +00:00
Add Logi Circle component, camera and sensor platform documentation (#6249)
* Added documentation for the Logi component, camera platform and sensor platform. * Updated Logi Circle camera and sensor platforms based on feature changes. * Renamed `logi` component domain to `logi_circle`. * Bumped HA release version to 0.79. Renamed logi brand image to logi_circle. * Fixed typo. Removed redundant definition of last_activity_time sensor.
This commit is contained in:
parent
67514b8d69
commit
f857cea3bc
69
source/_components/camera.logi_circle.markdown
Normal file
69
source/_components/camera.logi_circle.markdown
Normal file
@ -0,0 +1,69 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Logi Circle Camera"
|
||||
description: "Instructions on how to integrate your Logi Circle cameras within Home Assistant."
|
||||
date: 2018-09-08 11:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: logi_circle.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.79
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `logi_circle` camera platform allows you to watch the still frames of your [Logi Circle](https://circle.logi.com/) camera's live stream in Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Logi Circle component](/components/logi_circle/) configured to use this camera platform.
|
||||
</p>
|
||||
|
||||
Logi Circle cameras support the `camera.turn_on` and `camera.turn_off` services. This will set the streaming mode property of your camera accordingly, controlling whether the live stream is available and activity recordings are captured.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Logi Circle component](/components/logi_circle), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: logi_circle
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **scan_interval**: (*Optional*): How frequently to query for new camera stills. Defaults to 60 seconds.
|
||||
|
||||
### {% linkable_title Service `camera.logi_circle_livestream_record` %}
|
||||
|
||||
Initiates a recording of the camera's live stream.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to initiate a recording for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
|
||||
| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.mp4`{% endraw %}. |
|
||||
| `duration` | no | Duration of recording, in seconds.
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
### {% linkable_title Service `camera.logi_circle_livestream_snapshot` %}
|
||||
|
||||
Take a snapshot from a camera's live stream. This differs from the generic [snapshot](/components/camera/#service-snapshot) service in that it sources the snapshot from the camera's live stream. For battery powered devices, this will wake your camera from sleep to perform this action.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to create a live stream snapshot from, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.jpg`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
### {% linkable_title Service `camera.logi_circle_set_config` %}
|
||||
|
||||
Sets an configuration property for your camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to set the operation mode for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
|
||||
| `mode` | no | Configuration property to set. Allowed values: `BATTERY_SAVING`, `LED`, `PRIVACY_MODE` |
|
||||
| `value` | no | Mode value. Allowed values: `true`, `false` |
|
40
source/_components/logi_circle.markdown
Normal file
40
source/_components/logi_circle.markdown
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Logi Circle"
|
||||
description: "Instructions on how to integrate your Logi Circle cameras within Home Assistant."
|
||||
date: 2018-09-08 11:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: logi_circle.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.79
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `logi_circle` implementation allows you to integrate your [Logi Circle](https://circle.logi.com/) cameras in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate cameras linked with your [Logi Circle](https://circle.logi.com/) account, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
logi_circle:
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username for accessing your Logi Circle account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your Logi Circle account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Finish its configuration by visiting the [Logi Circle camera](/components/camera.logi_circle/) or [Logi Circle sensor](/components/sensor.logi_circle/) documentation.
|
43
source/_components/sensor.logi_circle.markdown
Normal file
43
source/_components/sensor.logi_circle.markdown
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Logi Circle Sensor"
|
||||
description: "Instructions on how to integrate your Logi Circle cameras within Home Assistant."
|
||||
date: 2018-09-08 11:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: logi_circle.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.79
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Logi Circle component](/components/logi_circle/) configured to use this sensor platform.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Logi Circle component](/components/logi_circle), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: logi_circle
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions supported by your camera will be enabled.
|
||||
- **battery_level**: Return the battery level percentage from the camera.
|
||||
- **last_activity_time**: Return the timestamp from the last time the Logi Circle camera detected any activity.
|
||||
- **privacy_mode**: Return the privacy mode status from the camera.
|
||||
- **signal_strength_category**: Return the WiFi signal level from the camera.
|
||||
- **signal_strength_percentage**: Return the WiFi signal percentage from the camera.
|
||||
- **speaker_volume**: Return the relative speaker volume from the camera (0-100%).
|
||||
- **streaming_mode**: Return the streaming mode status from the camera.
|
||||
|
||||
Currently it supports all 1st and 2nd generation cameras. Cameras without an internal battery will not expose a `battery_level` sensor.
|
BIN
source/images/supported_brands/logi_circle.png
Normal file
BIN
source/images/supported_brands/logi_circle.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 10 KiB |
Loading…
x
Reference in New Issue
Block a user