Skip to content

info.md

Latest commit

 

History

History
79 lines (55 loc) · 4.23 KB

info.md

File metadata and controls

79 lines (55 loc) · 4.23 KB
Raw

Kuna Smart Home Security Custom Integration for Home Assistant

Custom integration supporting Kuna cameras.

For each camera in a Kuna account, the following devices will be created:

  • Binary Sensor with device class 'motion', and default name "[Camera Name] Motion".
  • Camera with default name "[Camera Name] Camera".
  • Switch with default name "[Camera Name] Switch", which controls the camera's light bulb.

Configuration

After installing via HACS, to enable the integration, add it from the Configuration - Integrations menu in Home Assistant. Click "+", then "Kuna Smart Home Security".

(Note: previous versions of this component were configured in configuration.yaml; now, all configuration is via the Integration menu.)

The following options can be configured when setting up the integration:

Parameter Optional/Required Default Description
email Required N/A The email address used to log into the Kuna app.
password Required N/A The password used to log into the Kuna app.
recording_interval Optional 7200 The frequency, in seconds, that the component checks for new recordings for each camera.
stream_interval Optional 5 The frequency, in seconds, that the camera's frontend streaming view will refresh its image.
update_interval Optional 15 The frequency, in seconds, that the component polls the Kuna server for updates.

Downloading Recordings

On Home Assistant start, and every recording_interval seconds thereafter, this component checks the Kuna API for new recordings for each camera in the Kuna account, and fires a Home Assistant event for each recording found. These events can be used in an automation to trigger a download of the video with the downloader Home Assistant component. The default recording_interval, 7200 seconds (2 hours) corresponds to the length of time that recordings remain in the Kuna system without a premium subscription.

To automatically download new recordings, you must first set up the downloader Home Assistant component and then set up an automation.

Configuring the Downloader Component

Add the following to your configuration.yaml:

downloader:
  download_dir: downloads

You must ensure that the directory exists before restarting Home Assistant. Given the above example, you would need to ensure that there is a "downloads" subdirectory in your Home Assistant configuration directory, and that the Home Assistant user has write permission to that directory.

Refer to https://www.home-assistant.io/components/downloader/ for further information on the downloader component.

Automatically Downloading Recordings via Automation

For each recording available in the Kuna API, this component fires a Home Assistant event with the following parameters:

  • event_type: "kuna_event"
  • event_data:
    • category: "recording"
    • serial_number: the serial number of the camera that generated the recording
    • label: a Kuna-assigned string that represents the timestamp of the recording in local time (e.g. "2019_03_18__16_20_06-0400")
    • timestamp: a Kuna-assigned string that represents the timestamp of the recording in UTC (e.g. "2019-03-18T20:20:06.986645Z")
    • duration: the length of the recording in seconds
    • url: the web address at which an mp4 file of the recording is available for download

You can use these parameters to build an automation using the event trigger and templates. To download all recordings, set up the following automation:

- alias: Download Kuna recordings
  trigger:
    platform: event
    event_type: kuna_event
    event_data:
      category: recording
  action:
    service: downloader.download_file
    data_template:
      url: '{{ trigger.event.data.url }}'
      filename: '{{ trigger.event.data.label }}.mp4'

If you want to limit downloads to only a specific camera, add the serial_number parameter under 'event_data' in the trigger.

Caveats

This custom integration retrieves data from the same private API used by the Kuna mobile app, as Kuna does not offer a public API. Be gentle to the API and use at your own risk!