home-assistant.io/source/_integrations/lutron_caseta.markdown
2020-06-10 16:49:28 +02:00

8.0 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_codeowners
title description ha_category ha_release ha_iot_class ha_domain ha_codeowners
Lutron Caséta Instructions on how to use Lutron Caseta devices with Home Assistant.
Hub
Cover
Light
Scene
Switch
Fan
Binary Sensor
0.41 Local Push lutron_caseta
@swails

Lutron is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The lutron_caseta integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the Caseta product line of dimmers, switches, shades, and sensors. It will also communicate with the Lutron Radio RA2 Main Repeater for the RA2 Select product line of dimmers, switches, shades, and sensors.

This integration only supports the Caseta line of products. The Smart Bridge (L-BDG2-WH), Smart Bridge PRO (L-BDGPRO2-WH), and RA2 Select (RR-SEL-REP2-BL) models are supported. For the RadioRA 2 and HomeWorks QS product lines, see the Lutron component.

The currently supported Caseta and RA2 Select devices are:

When configured, the lutron_caseta integration will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the entity_id used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes light.bedroom_lamp in Home Assistant.

To use Lutron Caseta devices in your installation, you must first log in to your Lutron account and generate a certificate that allows Home Assistant to connect to your bridge. This can be accomplished by downloading and executing get_lutron_cert.py, which will generate three files: caseta.key, caseta.crt, caseta-bridge.crt when you run it. See the instructions at the top of the script for more information.

Once you have the three necessary files, place them in your configuration directory and add the following to your configuration.yaml:

# Example configuration.yaml entry
lutron_caseta:
  - host: IP_ADDRESS
    keyfile: caseta.key
    certfile: caseta.crt
    ca_certs: caseta-bridge.crt

Note that multiple hubs can be specified by using multiple configuration blocks, but each of them requires its own keyfile, certfile, and ca_certs to be generated and specified.

{% configuration %} host: required: true description: The IP address of the Lutron Smart Bridge. type: string keyfile: required: true description: The private key that Home Assistant will use to authenticate to the bridge. type: string certfile: required: true description: The certificate chain that Home Assistant will use to authenticate to the bridge. type: string ca_certs: required: true description: The list of certificate authorities (usually only one) that Home Assistant will expect when connecting to the bridge. type: string {% endconfiguration %}

It is recommended to assign a static IP address to your Lutron Smart Bridge. This ensures that it won't change IP address, so you won't have to change the host if it reboots and comes up with a different IP address.
Use a DHCP reservation on your router to reserve the address or in the PRO model of the Smart Bridge, set the IP address under Network Settings in the Advanced / Integration menu in the mobile app.

To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta integration above.

Cover

After setup, shades will appear in Home Assistant using an entity_id based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as cover.living_room_window.

For more information on working with shades in Home Assistant, see the Covers component.

Available services: cover.open_cover, cover.close_cover and cover.set_cover_position. Cover position ranges from 0 for fully closed to 100 for fully open.

Light

After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an entity_id based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as light.bedroom_lamp.

For non-dimmable lights or switched loads, see the switch section on this page.

For more information on working with lights in Home Assistant, see the Lights component.

Available services: light.turn_on, light.turn_off and light.toggle. The light.turn_on service supports attributes brightness and brightness_pct.

Scene

The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes that are created in the Lutron mobile app.

After setup, scenes will appear in Home Assistant using an entity_id based on the name used in the Lutron mobile app. For example, a scene called 'Entertain' will appear in Home Assistant as scene.entertain.

For more information on working with scenes in Home Assistant, see the Scenes component.

Available services: scene.turn_on.

Switch

After setup, switches will appear in Home Assistant using an entity_id based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as switch.master_bathroom_vanity.

For dimmable lights including wall and plug-in dimmers, see the light section on this page.

For more information on working with switches in Home Assistant, see the Switches component.

Available services: switch.turn_on and switch.turn_off.

Fan

After setup, fans will appear in Home Assistant using an entity_id based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as fan.master_bedroom_ceiling_fan.

For more information on working with fans in Home Assistant, see the Fans component.

Available services: fan.turn_on, fan.turn_off, and fan.set_speed.

Sensor

Occupancy sensors can be added to a Lutron Caseta system to trigger events when an area becomes vacant and, optionally, occupied. However, Lutron systems report occupancy and vacancy statuses only in occupancy groups -- that is, groups of one or more sensors.

Occupancy groups will appear in Home Assistant using an entity_id based on the area name in which the first sensor of the group is located. For example, one or more sensors in the Master Bathroom will appear in Home Assistant as binary_sensor.master_bathroom_occupancy.

An occupancy group is considered occupied if any of the sensors in the group are currently in an "occupied" state. Specifically, this means that motion has been detected more recently than that sensor's particular timeout setting. Only after all sensors in an occupancy group report being vacant does the occupancy group itself report being vacant.

Lutron Caseta occupancy sensors support 4 different timeouts and 3 different sensitivity levels, but those are only controllable from the devices themselves and cannot be set from either Home Assistant or even the Caseta mobile app.

Because Lutron Caseta devices automatically report state to Home Assistant (rather than relying on polling), occupancy status updates occur almost instantaneously.

For more information on working with binary sensors in Home Assistant, see the Binary Sensors Component