Skip to content

Latest commit

 

History

History
199 lines (160 loc) · 10.8 KB

FAN.md

File metadata and controls

199 lines (160 loc) · 10.8 KB
Raw

SmartIR Fan

For this platform to work, we need a .json file containing all the necessary IR or RF commands. Find your device's brand code here and add the number in the device_code field. If your device is not working, you will need to learn your own codes and place the .json file in smartir/custom_codes/fan/ subfolders. Please note that the device_code field only accepts positive numbers. The .json extension is not required.

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.
delay number optional Adjusts the delay in seconds between multiple commands. The default is 0.5
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 (using broadlink controller)

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

fan:
  - platform: smartir
    name: Bedroom fan
    unique_id: bedroom_fan
    device_code: 1000
    controller_data: remote.bedroom_remote
    power_sensor: binary_sensor.fan_power

Example (using xiaomi controller)

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

fan:
  - platform: smartir
    name: Bedroom fan
    unique_id: bedroom_fan
    device_code: 2000
    controller_data: remote.xiaomi_miio_192_168_10_10
    power_sensor: binary_sensor.fan_power

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

fan:
  - platform: smartir
    name: Bedroom fan
    unique_id: bedroom_fan
    device_code: 3000
    controller_data: home-assistant/bedroom-fan/command
    power_sensor: binary_sensor.fan_power

Example (using LOOKin controller)

fan:
  - platform: smartir
    name: Bedroom fan
    unique_id: bedroom_fan
    device_code: 4000
    controller_data: 192.168.10.10
    power_sensor: binary_sensor.fan_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:

fan:
  - platform: smartir
    name: Bedroom fan
    unique_id: bedroom_fan
    device_code: 4000
    controller_data: my_espir_send_raw_command
    power_sensor: binary_sensor.fan_power

Example (using ZHA controller and a TuYa ZS06):

fan:
  - platform: smartir
    name: Bedroom fan
    unique_id: bedroom_fan
    device_code: 5000
    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"
    }'
    power_sensor: binary_sensor.fan_power

Available codes for Fan devices

The following are the code files created by the amazing people in the community. Before you start creating your own code file, try if one of them works for your device. Please open an issue if your device is working and not included in the supported models. Contributing to your own code files is welcome. However, we do not accept incomplete files as well as files related to MQTT controllers.

Kaze

Code Supported Models Controller
1000 Unknown Broadlink

Acorn

Code Supported Models Controller
1020 Unknown Broadlink

Atomberg

Code Supported Models Notes Controller
1160 Efficio Broadlink
1170 Renesa Speeds 1,2,3,4,5 is mapped to 2,3,4,5,Boost on the remote Broadlink

Lucci Air

Code Supported Models Controller
1040 Aria Broadlink
1041 Whitehaven DC Broadlink
7040 Aria ESPHome

Super Fan

Code Supported Models Controller
1060 A1 Broadlink

Harbor Breeze

Code Supported Models Controller
1080 A25-TX001-R1 Broadlink
1081 A25-TX025 Broadlink

Pacific

Code Supported Models Controller
1100 Unknown Broadlink

Europace

Code Supported Models Controller
1120 Unknown Broadlink

SMC

Code Supported Models Controller
1140 SP486, SP483 Broadlink

Argo

Code Supported Models Controller
1180 Standy Broadlink

DCG

Code Supported Models Controller
1200 Unknown Broadlink

Mitsubishi

Code Supported Models Controller
1220 C56-RW5 Broadlink