Skip to content

Latest commit

 

History

History
151 lines (126 loc) · 9.44 KB

CLIMATE.md

File metadata and controls

151 lines (126 loc) · 9.44 KB
Raw

SmartIR Climate

Find your device's brand code here and add the number in the device_code field. If your device is not supported, you will need to learn your own IR codes and place them in the Json file in smartir/custom_codes/climate subfolder. Please refer to this guide to find a way how to do it. Once you have working device file please do not forgot to submit Pull Request so it could be inherited to this project for other users.

Configuration variables

Name Type Default Description
name string optional The name of the device
unique_id string optional An ID that uniquely identifies this device. If two devices have the same unique ID, Home Assistant will raise an exception.
device_code number required (Accepts only positive numbers)
controller_data string required The data required for the controller to function. Enter the entity_id of the Broadlink remote (must be an already configured device), or the entity id of the Xiaomi IR controller, or the MQTT topic on which to send commands, or the ZHA zigbee cluster to send commands to.
controller_params dict optional Dictionary containing list of additional key/values which will be passed to the remote.send_command service. For example delay_sec and num_repeats for Broadlink remote. For allowed key/values reffer to the HA documentation for remote.send_command service.
delay number optional Adjusts the delay in seconds between multiple commands. The default is 0.5
temperature_sensor string optional entity_id for a temperature sensor
humidity_sensor string optional entity_id for a humidity sensor
power_sensor string optional entity_id for a sensor that monitors whether your device is actually on or off. This may be a power monitor sensor. (Accepts only on/off states)
power_sensor_delay int optional Maximum delay in second in which power sensor is able to report back to HA changed state of the device, default is 10 seconds. If sensor reaction time is longer extend this time, otherwise you might get unwanted changes in the device state.
power_sensor_restore_state boolean optional If true than in case power sensor will report to HA that device is on without HA actually switching it on (device was switched on by remote, of device cycled, etc.), than HA will report last assumed state and attributes at the time when the device was on managed by HA. If set to false when device will be reported as on by the power sensors all device attributes will be reported as UNKNOWN. Default is true.

Example configurations

Example (using broadlink controller)

Add a Broadlink RM device named "Bedroom" via config flow (read the docs).

climate:
  - platform: smartir
    name: Office AC
    unique_id: office_ac
    device_code: 1000
    controller_data: remote.bedroom_remote
    controller_params:
      delay_secs: 0.5
      num_repeats: 3
    temperature_sensor: sensor.temperature
    humidity_sensor: sensor.humidity
    power_sensor: binary_sensor.ac_power

Example (using xiaomi controller)

remote:
  - platform: xiaomi_miio
    host: 192.168.10.10
    token: YOUR_TOKEN

climate:
  - platform: smartir
    name: Office AC
    unique_id: office_ac
    device_code: 2000
    controller_data: remote.xiaomi_miio_192_168_10_10
    temperature_sensor: sensor.temperature
    humidity_sensor: sensor.humidity
    power_sensor: binary_sensor.ac_power

Example (using mqtt/Z06/UFO-R11 controller)

climate:
  - platform: smartir
    name: Office AC
    unique_id: office_ac
    device_code: 3000
    controller_data: home-assistant/office-ac/command
    temperature_sensor: sensor.temperature
    humidity_sensor: sensor.humidity
    power_sensor: binary_sensor.ac_power
    power_sensor_restore_state: true

Example (using LOOKin controller)

climate:
  - platform: smartir
    name: Office AC
    unique_id: office_ac
    device_code: 4000
    controller_data: 192.168.10.10
    temperature_sensor: sensor.temperature
    humidity_sensor: sensor.humidity
    power_sensor: binary_sensor.ac_power

Example (using ZHA controller and a TuYa ZS06)

climate:
  - platform: smartir
    name: Office AC
    unique_id: office_ac
    device_code: 9000
    controller_data: '{
      "ieee":"XX:XX:XX:XX:XX:XX:XX:XX",
      "endpoint_id": 1,
      "cluster_id": 57348,
      "cluster_type": "in",
      "command": 2,
      "command_type": "server"
    }'
    temperature_sensor: sensor.temperature
    humidity_sensor: sensor.humidity
    power_sensor: binary_sensor.ac_power

Example (using ESPHome)

ESPHome configuration example:

esphome:
  name: my_espir
  platform: ESP8266
  board: esp01_1m

api:
  services:
    - service: send_raw_command
      variables:
        command: int[]
      then:
        - remote_transmitter.transmit_raw:
            code: !lambda "return command;"

remote_transmitter:
  pin: GPIO14
  carrier_duty_percent: 50%

HA configuration.yaml:

climate:
  - platform: smartir
    name: Office AC
    unique_id: office_ac
    device_code: 8000
    controller_data: my_espir_send_raw_command
    temperature_sensor: sensor.temperature
    humidity_sensor: sensor.humidity
    power_sensor: binary_sensor.ac_power

Available codes for Climate devices

Climate codes