Integration for Home Assistant for the Crestron XSIG symbol
Currently supported devices:
crestron directory to config/custom_componentsconfiguration.yaml (see below)crestron: block to the root of your configuration.yaml
port: parameter.port: in configuration.yamlConnect signal of your TCP/IP client (or just set it to 1 to have it connected all the time)Caution: Join numbers can be confusing when mixing analog/serials and digtals on the same XSIG symbol. Even though the symbol starts numbering the digitals at "1", the XSIG will actually send the join number corresponding to where the signal appears sequentially in the entire list of signals. For example, if you have 25 analog signals followed by 10 digital signals attached to the same XSIG, the digitals will be sent as 26-35, even though they are labeled 1 - 10 on the symbol. You can either account for this in your configuration on the HA side, or just use one symbol for Analogs and another for Digitals. Since the XSIG lets you combine Analog/Serial joins on the same symbol, you can have one XSIG for Analog/Serial joins and another for digitals. This keeps the join numbering simple.
The crestron: entry is mandatory as is the port: definition under it. So at a minimum, you will need:
crestron:
port: 16384Then, if you want to make use of the control surface (touchpanels/kepads) syncing capability, you will need to add either a to_joins, a from_joins section, or both (see below).
Finally, add entries for each HA component/platform type to your configuration.yaml for the appropriate entity type in Home Assistant:
| Crestron Device | Home Assistant component type |
|---|---|
| Light | light |
| Thermostat | climate |
| Shades | cover |
| read-only Digital Join | binary_sensor |
| read-only Analog Join | sensor |
| read-write Digital Join | switch |
| Audio/Video Switcher | media_player |
To be clear: if you configure multiple platforms (light, cover, climate, ...) plus synchronization in both directions, your configuration.yaml will look something like:
crestron:
port: 32768
to_joins:
...
from_joins:
...
light:
- platform: crestron
...
climate:
- platform: crestron
...
cover:
- platform: crestron
...
binary_sensor:
- platform: crestron
...
sensor:
- platform: crestron
...
switch:
- platform: crestron
...
media_player:
- platform: crestron
...This platform supports monochromatic "brightness" type lights (basically, anything that can have its brightness represented by an analog join on the control system). I tested this with a CLX-1DIM8 panel and multiple CLW-DIMEX switches.
light:
- platform: crestron
name: "Dummy Light"
brightness_join: 9
type: brightnessThis platform should work with anything that looks like a CHV-TSTAT/THSTAT (analog joins for heat, cooling setpoints, digital joins for modes, fan modes, and relay states). I tested this with multiple CHV-TSTAT and CHV-THSTATs.
TODO: Add support for humidity control on CHV_THSTAT.
climate:
- platform: crestron
name: "Upstairs Thermostat"
heat_sp_join: 2
cool_sp_join: 3
reg_temp_join: 4
mode_heat_join: 1
mode_cool_join: 2
mode_auto_join: 3
mode_off_join: 4
fan_on_join: 5
fan_auto_join: 6
h1_join: 7
h2_join: 8
c1_join: 9
fa_join: 10This should work with any shade that uses an analog join for position plus digital joins for is_opening/closing, is_closed and stop. I tested with CSM-QMTDC shades.
cover:
- platform: crestron
name: "Living Room Shades"
type: shade
pos_join: 26
is_opening_join: 41
is_closing_join: 42
stop_join: 43
is_closed_join: 44This can represent any read-only digital signal on the control system. I typically comment out the "in" signals on the XSIG symbol to keep the "in" and "out" signals lined up.
binary_sensor:
- platform: crestron
name: "Air Compressor"
is_on_join: 57
device_class: powerThis can represent any read-only analog signal on the control system. I typically comment out the "in" signals on the XSIG symbol to keep the "in" and "out" signals lined up. Remember that an analog join on the control system is a 16-bit value that can range from 0-65535. So for many symbol types (especially those representing a brightness or percent) you will need to make use of the divisor: parameter.
Example divisors:
sensor:
- platform: crestron
name: "Outside Temperature"
value_join: 1
device_class: "temperature"
unit_of_measurement: "F"
divisor: 10This could represent any digital signal on the contol system that you want to be able to control/view from HA.
switch:
- platform: crestron
name: "Dummy Switch"
switch_join: 65Use media_player to represent the output of a multi-zone switcher. For example a PAD-8A is an 8x8 (8 inputs x 8 outputs) audio switcher. This can be represented by 8 media player components (one for each output). The component supports source selection (input selection) and volume + mute control. So it is modeled as a "speaker" media player type in Home Assistant.
This works rather nicely with the template media player integration to allow intuitive control of source devices connected to a multi-zone switcher like the PAD8A.
media_player:
- platform: crestron
name: "Kitchen Speakers"
mute_join: 27
volume_join: 19
source_number_join: 13
sources:
1: "Android TV"
2: "Roku"
3: "Apple TV"
4: "Chromecast"
7: "Volumio"
8: "Crestron Streamer"If you have Crestron touch panels or keypads, it can be useful to keep certain feedback/display joins in sync with Home Assistant state and to be able to invoke Home Assistant functionality (via a script) when a button is pressed or a join changes. This functionality was added with v0.2. There are two directions to sync: from HA states to control system joins and from control system joins to HA (using scripts).
There are two sections in configuration.yaml under the root crestron: key:
to_joins for syncing HA state to control system joinsfrom_joins for invoking HA scripts when control system joins changecrestron:
port: 5555
to_joins:
...
from_joins:
...The to_joins section will list all the joins you want to map HA state changes to. For each join, you list either:
entity_id with optional attribute to map entity state directly to a join.value_template that lets you map almost any combination of state values (including the full power of template logic) to the listed join.crestron:
port: 12345
...
to_joins:
- join: d12
entity_id: switch.compressor
- join: a35
value_template: "{{value|int * 10}}"
- join: s4
value_template: "Current weather conditions: {{state('weather.home')}}"
- join: a2
entity_id: media_player.kitchen
attribute: volume_level
- join: s4
value_template: "http://homeassistant:8123{{ state_attr('media_player.volumio', 'entity_picture') }}"_tojoins: begins the section
join: for each join, list the join type and number. The type prefix is 'a' for analog joins, 'd' for digital joins and 's' for serial joins. So s32 would be serial join #32. The value of this join will be set to either the state/attribute of the configured entity ID or the output of the configured template.
_entityid: the entity ID to sync this join to. If no attribute is listed the join will be set to entity's state value whenever the state changes.
attribute: use the listed attribute value for the join value instead of the entity's state.
_valuetemplate: used instead of _entityid/attribute if you need more flexibility on how to set the value (prefix/suffix or math operations) or even to set the join value based on multiple entity IDs/state values. You have the full power of HA templating to work with here.
Note that when you specify an
entity_id, all changes to that entity_id will result in a join update being sent to the control system. When you specify avalue_templatea change to any referenced entity will trigger a join update.
The from_joins section will list all the joins you want to track from the control system. When each join changes the configured functionality will be invoked.
crestron:
port: 54321
...
from_joins:
- join: a2
script:
service: input_text.set_value
data:
entity_id: input_text.test
value: "Master BR temperature is {{value|int / 10}}"
- join: d35
script:
service: media_player.media_previous_track
data:
entity_id: media_player.volumio
- join: d36
script:
service: media_player.media_play_pause
data:
entity_id: media_player.volumio
- join: d37
script:
service: media_player.media_next_track
data:
entity_id: media_player.volumio
- join: d74
script:
service: media_player.select_source
data:
entity_id: media_player.volumio
source: "{{state_attr('media_player.volumio', 'source_list')[0]}}"
- join: d75
script:
service: media_player.select_source
data:
entity_id: media_player.volumio
source: "{{state_attr('media_player.volumio', 'source_list')[1]}}"
- join: d76
script:
service: media_player.select_source
data:
entity_id: media_player.volumio
source: "{{state_attr('media_player.volumio', 'source_list')[2]}}"_fromjoins: begins the section
join: for each join, list the join type and number. The type prefix is 'a' for analog joins, 'd' for digital joins and 's' for serial joins. So s32 would be serial join #32. Any change in the listed join will invoke the configured behavior.
script: This is a standard HA script. It follows the HA scripting sytax.