#Homey-Integration: Compound device definition for Home-Assistant

HowTo use the compounds component in HA to create entity groups.

Install the component in HomeAssistant

1. Install this component in HACS... or copy the folder "homey" to your HomeAssistant custom_components folder (/config/custom_components/homey).
2. Restart HomeAssistant to activate the component

Prepare the YAML file

Copy an example into your configuration.yaml. Or copy the include into the file "homey.yaml" and add this line to your configuration.yaml:

homey: !include homey.yaml

Restart HomeAssistant after YAML changes.

Customize the YAML file to define entity groups

Example for usage in configuration.yaml. Start with the homey element followed by the compound element:

homey:
  livingroom_compound:
    name: Livingroom environment
    capabilities:
      measure_temperature: sensor.livingroom_temperature
      measure_temperature.temp1: sensor.livingroom_temperature_1
      measure_temperature.temp3: sensor.livingroom_temperature_2

Example for usage in homey.yaml. Start with the compound element:

livingroom_compound:
  name: Livingroom environment
  capabilities:
    measure_temperature: sensor.livingroom_temperature
    measure_temperature.temp1: sensor.livingroom_temperature_1
    measure_temperature.temp3: sensor.livingroom_temperature_2

Set up a compound with entities

The "livingroom_compound" will be the compound that gets importes to Homey. You can set a name that is used as device name. You can rename it in Homey. Add the capabilities. If you want to add more than one capability of the same type, you can use subcapabilities (capability.sub).

In addition you can set a title for each capability (optional) using "capabilitiesTitles":

    capabilitiesTitles:
      measure_temperature: "Temperature title"
      measure_temperature.temp1: "Temperature subcapability 1 title"
      measure_temperature.temp2: "Temperature subcapability 2 title"

Example for a plug with measurement sensors:

plug:
  name: Plug (Example for plug with power measurement)
  capabilities:
    onoff: switch.plug_on
    meter_power: sensor.plug_power
    measure_power: sensor.plug_power_current
  capabilitiesTitles:
    onoff: Switch
    meter_power: Power meter
    measure_power: Power current

Set up a compound with entity attributes

In addition to entities, you can use attributes, too. Just add the attribute to the entity id separated with a dot.

my_device_tracker:
  name: Device Name
  capabilities:
    measure_generic: device_tracker.entity_id
    measure_generic.ip: device_tracker.entity_id.ip
    measure_generic.mac: device_tracker.entity_id.mac
    measure_generic.wired: device_tracker.entity_id.is_wired
  capabilitiesTitles:
    measure_generic: State
    measure_generic.ip: IP
    measure_generic.mac: MAC

This example creates a device tracker device. The first capability ist the entity itself. As value, the entity state is used. In addition, some entity attributes are added as subcapability. Please ensure, that every defined capability is unique in the YAML. Use subcapabilities to define several string capabilities using the measure_generic capability.

Use a slider for number input entities

You can use a Homey DIM capability to create a slider. This slider can control a HA number input entity. A dim slider uses a range from 0 (0%) to 1 (100%). To adjust the slider value according to your wished input number value range, you can define a converter calculation.

my_number_device:
  name: Nubmer in
  capabilities:
      dim: input_number.test_slider
  capabilitiesConverters:
    dim: 
      from: (state) => { return parseFloat(state) * 0.01; }
      to: (value) => { return value * 100; }

Possible capabilities:

• onoff - Homey switch
• button - Homey button
• locked - lock state
• dim (as slider for input_number.set_value
• alarm_battery - all alarm capabilities are boolean values
• alarm_co
• alarm_co2
• alarm_contact
• alarm_fire
• alarm_generic
• alarm_heat
• alarm_motion
• alarm_pm25
• alarm_smoke
• alarm_tamper
• alarm_water
• measure_generic - string value
• measure_numeric - all other measure* and meas* capabilities are using numeric values
• measure_battery
• measure_co
• measure_co2
• measure_current
• measure_gust_angle
• measure_gust_strength
• measure_humidity
• measure_luminance
• measure_noise
• measure_pm25
• measure_power
• measure_pressure
• measure_rain
• measure_temperature
• measure_ultraviolet
• measure_voltage
• measure_water
• measure_wind_angle
• measure_wind_strength
• meter_gas
• meter_water
• meter_power
• meter_rain

Use Icons

You can set an icon for your compound device (optional):

livingroom_compound:
  name: Livingroom environment
  icon: measure_temperature

Possible icons:

• alarm_contact
• alarm_generic
• alarm_heat
• alarm_motion
• alarm_pressure
• alarm_smoke
• alarm_tamper
• alarm_water
• measure_battery
• measure_co2
• measure_current
• measure_generic
• measure_humidity
• measure_luminance
• measure_noise
• measure_numeric
• measure_power
• measure_pressure
• measure_temperature
• measure_voltage
• meter_power

Use Units

You can set an unit for every capability (optional) using "capabilitiesUnits":

temperature:
  name: Outside temperature
  icon: measure_temperature
  capabilities:
    measure_temperature.temp1: your entity
    measure_temperature.temp2: your entity
  capabilitiesTitles:
    measure_temperature.temp1: "Temperature 1 title"
    measure_temperature.temp2: "Temperature 2 title"
  capabilitiesUnits:
    measure_temperature.temp1: "°C"
    measure_temperature.temp2: "°C"

This overwrites the unit which can be present in the HA entity. You can use this unit settings to define units for attributes, too.

References

Homey app: https://homey.app/a/io.home-assistant.community/

Homey community with app description and examples: https://community.homey.app/t/app-pro-home-assistant-community-app/71477