Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smarthomehub/smartir
Home Assistant integration to manage climate systems, TVs, fans and lights using IR/RF controllers. Compatible with Broadlink, Xiaomi, MQTT, LOOKin and ESPHome
https://github.com/smarthomehub/smartir
broadlink chuangmiir esphome homeassistant iot lookin smarthome
Last synced: 2 days ago
JSON representation
Home Assistant integration to manage climate systems, TVs, fans and lights using IR/RF controllers. Compatible with Broadlink, Xiaomi, MQTT, LOOKin and ESPHome
- Host: GitHub
- URL: https://github.com/smarthomehub/smartir
- Owner: smartHomeHub
- License: mit
- Created: 2019-02-17T12:48:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-19T08:35:51.000Z (12 days ago)
- Last Synced: 2025-01-28T18:57:58.008Z (2 days ago)
- Topics: broadlink, chuangmiir, esphome, homeassistant, iot, lookin, smarthome
- Language: Python
- Homepage:
- Size: 10.2 MB
- Stars: 2,158
- Watchers: 50
- Forks: 1,035
- Open Issues: 75
-
Metadata Files:
- Readme: docs/README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/smartHomeHub/SmartIR/releases/latest) [](https://github.com/custom-components/hacs)
> ### ⚠️ Warning
> You are free to fork, modify, and use the code in this repository in accordance with the applicable open-source license.
>
> **However, the name "SmartIR" must not be used in any capacity**, especially for promoting, rebranding, or distributing your own fork or derivative works.
>
> Please respect this guideline to preserve the original project's identity.
## Overview
SmartIR is a custom integration for controlling **climate devices**, **media players**, **fans** and **lights** via infrared controllers.
SmartIR currently supports the following controllers:
* [Broadlink](https://www.home-assistant.io/integrations/broadlink/)
* [Xiaomi IR Remote (ChuangmiIr)](https://www.home-assistant.io/integrations/remote.xiaomi_miio/)
* [LOOK.in Remote](http://look-in.club/devices/remote)
* [ESPHome User-defined service for remote transmitter](https://esphome.io/components/api.html#user-defined-services)
* [MQTT Publish service](https://www.home-assistant.io/docs/mqtt/service/)
More than 120 climate devices are currently supported out-of-the-box, mainly for the Broadlink controller, thanks to our awesome community.
Don't forget to **star** the repository if you had fun!
## Installation
### *Manual*
**(1)** Place the `custom_components` folder in your configuration directory (or add its contents to an existing `custom_components` folder).
It should look similar to this:
```
/
|-- custom_components/
| |-- smartir/
| |-- __init__.py
| |-- climate.py
| |-- fan.py
| |-- light.py
| |-- media_player.py
| |-- etc...
```
**(2)** Add the following to your configuration.yaml file.
```yaml
smartir:
```
SmartIR automatically detects updates after each HA startup and asks you to install them. It also has a mechanism that prevents you from updating if the last SmartIR version is incompatible with your HA instance. You can disable this feature by setting SmartIR as follows:
```yaml
smartir:
check_updates: false
```
If you would like to get updates from the rc branch (Release Candidate), configure SmartIR as follows:
```yaml
smartir:
update_branch: rc
```
**(3)** Configure a platform.
### *HACS*
If you want HACS to handle installation and updates, add SmartIR as a [custom repository](https://hacs.xyz/docs/faq/custom_repositories/). In this case, it is recommended that you turn off automatic updates, as above.
## Platform setup instructions
Click on the links below for instructions on how to configure each platform.
* [Climate platform](/docs/CLIMATE.md)
* [Media Player platform](/docs/MEDIA_PLAYER.md)
* [Fan platform](/docs/FAN.md)
* [Light platform](/docs/LIGHT.md)
## See also
* [Discussion about SmartIR Climate (Home Assistant Community)](https://community.home-assistant.io/t/smartir-control-your-climate-tv-and-fan-devices-via-ir-rf-controllers/)