Home Assistant Integrations

https://www.home-assistant.io/integrations/
Admin
Home Assistant Integrations is a comprehensive directory listing all available components and...
Tokens:946,795
Snippets:7,233
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Symlinking examples for Raspberry Pi manual install

Source: https://www.home-assistant.io/integrations/hdmi_cec

Example symlink commands for the default virtual environment of a Manual install for Raspberry Pi.

```bash
ln -s /usr/local/lib/python*/dist-packages/cec.py /srv/homeassistant/lib/python*/site-packages
ln -s /usr/local/lib/python*/dist-packages/_cec.so /srv/homeassistant/lib/python*/site-packages
```

--------------------------------

### State-based template update configuration

Source: https://www.home-assistant.io/integrations/template

Example configuration.yaml entry for a template update entity that uses the current states of sensors for installed and latest versions, with an install action that calls a script.

```yaml
# Example state-based configuration.yaml entry
template:
  - update:
      - name: Frigate
        installed_version: "{{ states('sensor.installed_version') }}"
        latest_version: "{{ states('sensor.latest_version') }}"
        install:
          action: script.update_frigate
```

--------------------------------

### Example configuration.yaml entry for assist_pipeline

Source: https://www.home-assistant.io/integrations/assist_pipeline

Add this to your configuration.yaml if you are not using the default configuration. After changing the file, restart Home Assistant to apply the changes.

```yaml
# Example configuration.yaml entry
assist_pipeline:
```

--------------------------------

### Default schema configuration example

Source: https://www.home-assistant.io/integrations/light.mqtt

Example configuration.yaml entry for setting up an MQTT light with the default schema. Requires restarting Home Assistant after changing the file.

```yaml
# Example configuration.yaml entry
mqtt:
  - light:
      command_topic: "office/rgb1/light/switch"
```

--------------------------------

### GET /api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}

Source: https://www.home-assistant.io/integrations/unifiprotect

Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end times must be in ISO 8601 format.

```APIDOC
## GET /api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}

### Description
Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end times must be in ISO 8601 format.

### Method
GET

### Endpoint
/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}

### Parameters
#### Path Parameters
- **nvr_id** (string) - Required - The UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect integration.
- **camera_id** (string) - Required - The UniFi Protect ID of your camera or an entity ID of any entity provided by the UniFi Protect integration that can be reversed to a UniFi Protect camera.
- **start** (string) - Required - Start time in ISO 8601 format.
- **end** (string) - Required - End time in ISO 8601 format.

### Response
#### Success Response (200)
MP4 video data.

```

--------------------------------

### Example old-style groups YAML configuration

Source: https://www.home-assistant.io/integrations/group

Example configuration.yaml entry for old-style groups. Defines multiple groups with names and entity lists. This is the only way to configure old-style groups; they are not recommended for new setups.

```yaml
# Example configuration.yaml entry
group:
  kitchen:
    name: "Kitchen Group"
    entities:
      - switch.kitchen_pin_3
  climate:
    name: "Climate Group"
    entities:
      - sensor.bedroom_temp
      - sensor.porch_temp
  awesome_people:
    name: "Awesome People"
    entities:
      - device_tracker.dad_smith
      - device_tracker.mom_smith
```

--------------------------------

### Full Yeelight configuration example

Source: https://www.home-assistant.io/integrations/yeelight

Example configuration.yaml entry showing optional configuration options for devices and custom_effects. Includes a custom effect 'Fire Flicker' with temperature and sleep transitions.

```yaml
# Example configuration.yaml entry
yeelight:
  devices:
    192.168.1.25:
      name: Living Room
      transition: 1000
      use_music_mode: true
      save_on_change: true
  custom_effects:
    - name: 'Fire Flicker'
      flow_params:
        count: 0
        transitions:
          - TemperatureTransition: [1900, 1000, 80]
          - TemperatureTransition: [1900, 2000, 60]
          - SleepTransition:       [1000]
```

--------------------------------

### Debug message when learning starts

Source: https://www.home-assistant.io/integrations/broadlink

Example debug message shown when the RM device is ready to learn a code.

```text
3/23/2019, 9:56:53 AMnode: RM_Mini1
msg : string[47]
"Please tap the remote button within 30 seconds."
```

--------------------------------

### Example configuration.yaml for custom media directories

Source: https://www.home-assistant.io/integrations/media_source

Configures two media directories, 'local' and 'recording', under the homeassistant.media_dirs key. The 'local' directory is the default media_dir.

```yaml
# Example configuration.yaml
homeassistant:
  media_dirs:
    local: /media
    recording: /mnt/recordings
```

--------------------------------

### Multilevel Switch Command Class start level change event

Source: https://www.home-assistant.io/integrations/zwave_js

Example JSON payload for a zwave_js_notification event when a start level change occurs, typically from an external switch with a device like the Aeotec Nano Dimmer.

```json
{
    "domain": "zwave_js",
    "node_id": 1,
    "endpoint": 0,
    "home_id": 974823419,
    "device_id": "2f44f0d4152be3123f7ad40cf3abd095",
    "command_class": 38,
    "command_class_name": "Multilevel Switch",
    "event_type": 4,
    "event_type_label": "label 1",
    "direction": "up"
},
```

--------------------------------

### Example configuration.yaml entry for MQTT template light

Source: https://www.home-assistant.io/integrations/light.mqtt

Add this to your configuration.yaml file to set up an MQTT light with the template schema. After changing the file, restart Home Assistant to apply the changes.

```yaml
# Example configuration.yaml entry
mqtt:
  - light:
      schema: template
      command_topic: "home/rgb1/set"
      command_on_template: "on"
      command_off_template: "off"
```

--------------------------------

### Example scenes.yaml entry with id

Source: https://www.home-assistant.io/integrations/scene

Shows a single scene entry in scenes.yaml with an 'id' field, which is required for editing the scene in the scene editor. The scene is defined as a list item starting with '-'. This example is used when moving a scene from configuration.yaml to scenes.yaml.

```yaml
# Example scenes.yaml entry
- id: "romantic"
  name: "Romantic"
  entities:
    light.tv_back_light: "on"
    light.ceiling:
      state: "on"
      brightness: 200
      color_mode: "xy"
      xy_color:
        - 0.33
        - 0.66
```

--------------------------------

### Example configuration.yaml entry for Bluetooth

Source: https://www.home-assistant.io/integrations/bluetooth

Add this to your configuration.yaml to enable the Bluetooth integration. After changing the file, restart Home Assistant to apply the changes.

```yaml
# Example configuration.yaml entry
bluetooth:
```

--------------------------------

### Add database dependency to Home Assistant systemd unit

Source: https://www.home-assistant.io/integrations/recorder

Example systemd unit configuration to add a dependency on PostgreSQL, ensuring the database starts before Home Assistant.

```ini
[Unit]
Description=Home Assistant
After=network.target postgresql.service
```

--------------------------------

### MQTT lawn mower configuration.yaml example

Source: https://www.home-assistant.io/integrations/lawn_mower.mqtt

Add this to your configuration.yaml to set up an MQTT lawn mower. After changing the file, restart Home Assistant to apply the changes.

```yaml
# Example configuration.yaml entry
mqtt:
  - lawn_mower:
      start_mowing_command_topic: topic
      name: "Test Lawn Mower"
```

--------------------------------

### Example configuration.yaml entry for MQTT JSON light

Source: https://www.home-assistant.io/integrations/light.mqtt

Add this YAML to your configuration.yaml file to set up an MQTT JSON light. After changing the file, restart Home Assistant to apply the changes.

```yaml
# Example configuration.yaml entry
mqtt:
  - light:
      schema: json
      command_topic: "home/rgb1/set"
```

--------------------------------

### YAML: List multiple triggers under 'triggers'

Source: https://www.home-assistant.io/docs/automation/trigger/#webhook-trigger

Shows how to define an automation with multiple triggers in YAML. Any of the triggers can start the automation. The example uses a time_pattern trigger and a sun trigger.

```yaml
automation:
  triggers:
    - trigger: time_pattern
      minutes: 5
    - trigger: sun
      event: sunset
```

--------------------------------

### emulated_hue configuration.yaml example

Source: https://www.home-assistant.io/integrations/emulated_hue

Full configuration sample for the emulated_hue integration. Add this to your configuration.yaml file. Includes host_ip, listen_port, advertise_ip, advertise_port, off_maps_to_on_domains, expose_by_default, exposed_domains, and entities customization.

```yaml
# Example configuration.yaml entry
emulated_hue:
  host_ip: 192.168.1.186
  listen_port: 8300
  advertise_ip: 10.0.0.10
  advertise_port: 8080
  off_maps_to_on_domains:
    - script
    - scene
  expose_by_default: true
  exposed_domains:
    - light
  entities:
    light.bedroom_light:
      name: "Bedside Lamp"
    light.ceiling_lights:
      hidden: true
```
Tokens:
Raw