Skip to content

Latest commit

 

History

History
121 lines (77 loc) · 2.59 KB

DOCS.md

File metadata and controls

121 lines (77 loc) · 2.59 KB
Raw

Home Assistant Add-on: SomfyProtect2MQTT-dev

Installation

Follow these steps to get the add-on installed on your system:

  1. Navigate in your Home Assistant frontend to Supervisor -> Add-on Store.
  2. Find the "SomfyProtect2MQTT" add-on and click it.
  3. Click on the "INSTALL" button.

How to use

  1. Perform the SomfyProtect2MQTT add-on configuration (see below)
  2. Save the add-on configuration by clicking the "SAVE" button.
  3. Start the add-on.

Configuration

Add-on configuration:

somfy_protect:
  username: mail@example.org
  password: iliketurtles
  sites:
    - Maison

homeassistant_config:
  code: 1234
  code_arm_required: false
  code_disarm_required: true

mqtt:
  host: 192.168.1.1
  port: "1883"
  ssl: false
  username: homeassistant
  password: homeassistant
  client-id: somfy-protect
  topic_prefix: somfyProtect2mqtt
  ha_discover_prefix: homeassistant
delay_site: "10"
delay_device: "60"
manual_snapshot: false
streaming: mqtt
debug: false

Option group somfy_protect

The following options are for the option group: somfy_protect.

Options username and password

Username and password to use to authenticate to Somfy account.

Option sites

A list of sites to retrieve datas.

Option group homeassistant_config

The following options are for the option group: homeassistant_config.

Option code

A code to arm/desarm in HA. Set to 0 to disable.

Option code_arm_required

Set to false if you want to arm without code

Option code_disarm_required

Set to false if you want to disarm without code

Option group mqtt

The following options are for the option group: mqtt.

Options host, port, ssl, username and password

Host and credentials to use to authenticate to MQTT broker.

Option client-id

MQTT client identifier.

Option topic_prefix

MQTT prefix to use for data topic.

Option ha_discover_prefix

MQTT prefix to use for Home-Assistant discovery.

Option delay_site

Define delay in seconds to update sites.

Option delay_device

Define delay in seconds to update devices.

Option manual_snapshot

Enable/Disable manual_snapshot. false: Only update snapshot when switch 'snapshot' is triggered true: snapshot auto update every 1min.

Option streaming

Streaming Mode. mqtt: Send image by image to MQTT camera in HA go2rtc: write the url in /config/somfyprotect2mqtt/streamurl<device_id> to be read with echo source: https://github.com/AlexxIT/go2rtc#source-echo and WebRTC Camera:https://github.com/AlexxIT/WebRTC

Option debug

Enable/Disable debug mode.