home-assistant.io/source/_components/camera.logi_circle.markdown
Jorim Tielemans db30e60a44 More various improvements (#6991)
Things starting with 'ca'
2018-10-21 17:03:41 +02:00

3.6 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page Logi Circle Camera Instructions on how to integrate your Logi Circle cameras within Home Assistant. 2018-09-08 11:00 true false true true logi_circle.png Camera 0.79 Cloud Polling

The logi_circle camera platform allows you to watch the still frames of your Logi Circle camera's live stream in Home Assistant.

You must have the [Logi Circle component](/components/logi_circle/) configured to use this camera platform.

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, add the following to your configuration.yaml file:

# Example configuration.yaml entry
camera:
  - platform: logi_circle

{% configuration %} scan_interval: description: How frequently to query for new camera stills, value are in seconds. required: false type: integer default: 60 {% endconfiguration %}

{% 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: 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 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: section of your configuration.yaml file.

{% linkable_title Service camera.logi_circle_set_config %}

Sets a 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