feat: rename the project to Infrarize
This commit is contained in:
+12
-12
@@ -1,9 +1,9 @@
|
||||
<p align="center">
|
||||
<a href="#"><img src="assets/smartir_climate.png" width="350" alt="SmartIR Climate"></a>
|
||||
<a href="#"><img src="assets/infrarize_climate.png" width="350" alt="Infrarize Climate"></a>
|
||||
</p>
|
||||
|
||||
For this platform to work, we need a .json file containing all the necessary IR commands.
|
||||
Find your device's brand code [here](CLIMATE.md#available-codes-for-climate-devices) 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/codes/climate` subfolders. ~~[Keite Trần](https://github.com/keitetran/BroadlinkIRTools) developed [an amazing web-based app](https://keitetran.github.io/BroadlinkIRTools/) for this job.~~
|
||||
Find your device's brand code [here](CLIMATE.md#available-codes-for-climate-devices) 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 `infrarize/codes/climate` subfolders. ~~[Keite Trần](https://github.com/keitetran/BroadlinkIRTools) developed [an amazing web-based app](https://keitetran.github.io/BroadlinkIRTools/) for this job.~~
|
||||
_Please note that the device_code field only accepts positive numbers. The .json extension is not required._
|
||||
|
||||
## Configuration variables:
|
||||
@@ -23,10 +23,10 @@ _Please note that the device_code field only accepts positive numbers. The .json
|
||||
Add a Broadlink RM device named "Bedroom" via config flow (read the [docs](https://www.home-assistant.io/integrations/broadlink/)).
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
climate:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Office AC
|
||||
unique_id: office_ac
|
||||
device_code: 1000
|
||||
@@ -38,7 +38,7 @@ climate:
|
||||
|
||||
## Example (using xiaomi controller):
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
remote:
|
||||
- platform: xiaomi_miio
|
||||
@@ -46,7 +46,7 @@ remote:
|
||||
token: YOUR_TOKEN
|
||||
|
||||
climate:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Office AC
|
||||
unique_id: office_ac
|
||||
device_code: 2000
|
||||
@@ -58,10 +58,10 @@ climate:
|
||||
|
||||
## Example (using mqtt controller):
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
climate:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Office AC
|
||||
unique_id: office_ac
|
||||
device_code: 3000
|
||||
@@ -74,10 +74,10 @@ climate:
|
||||
|
||||
## Example (using LOOKin controller):
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
climate:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Office AC
|
||||
unique_id: office_ac
|
||||
device_code: 4000
|
||||
@@ -110,10 +110,10 @@ remote_transmitter:
|
||||
```
|
||||
HA configuration.yaml:
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
climate:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Office AC
|
||||
unique_id: office_ac
|
||||
device_code: 8000
|
||||
|
||||
+12
-12
@@ -1,9 +1,9 @@
|
||||
<p align="center">
|
||||
<a href="#"><img src="assets/smartir_fan.png" width="350" alt="SmartIR Media Player"></a>
|
||||
<a href="#"><img src="assets/infrarize_fan.png" width="350" alt="Infrarize Media Player"></a>
|
||||
</p>
|
||||
|
||||
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](FAN.md#available-codes-for-fan-devices) and add the number in the `device_code` field. The compoenent will download it to the correct folder. If your device is not working, you will need to learn your own codes and place the .json file in `smartir/codes/fan/` subfolders. Please note that the `device_code` field only accepts positive numbers. The .json extension is not required.
|
||||
Find your device's brand code [here](FAN.md#available-codes-for-fan-devices) and add the number in the `device_code` field. The compoenent will download it to the correct folder. If your device is not working, you will need to learn your own codes and place the .json file in `infrarize/codes/fan/` subfolders. Please note that the `device_code` field only accepts positive numbers. The .json extension is not required.
|
||||
|
||||
## Configuration variables
|
||||
|
||||
@@ -19,10 +19,10 @@ Find your device's brand code [here](FAN.md#available-codes-for-fan-devices) and
|
||||
Add a Broadlink RM device named "Bedroom" via config flow (read the [docs](https://www.home-assistant.io/integrations/broadlink/)).
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
fan:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Bedroom fan
|
||||
unique_id: bedroom_fan
|
||||
device_code: 1000
|
||||
@@ -33,7 +33,7 @@ fan:
|
||||
## Example (using xiaomi controller)
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
remote:
|
||||
- platform: xiaomi_miio
|
||||
@@ -41,7 +41,7 @@ remote:
|
||||
token: YOUR_TOKEN
|
||||
|
||||
fan:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Bedroom fan
|
||||
unique_id: bedroom_fan
|
||||
device_code: 2000
|
||||
@@ -52,10 +52,10 @@ fan:
|
||||
## Example (using mqtt controller)
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
fan:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Bedroom fan
|
||||
unique_id: bedroom_fan
|
||||
device_code: 3000
|
||||
@@ -66,10 +66,10 @@ fan:
|
||||
## Example (using LOOKin controller)
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
fan:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Bedroom fan
|
||||
unique_id: bedroom_fan
|
||||
device_code: 4000
|
||||
@@ -104,10 +104,10 @@ remote_transmitter:
|
||||
HA configuration.yaml:
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
fan:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Bedroom fan
|
||||
unique_id: bedroom_fan
|
||||
device_code: 4000
|
||||
|
||||
+4
-4
@@ -1,9 +1,9 @@
|
||||
<p align="center">
|
||||
<a href="#"><img src="assets/smartir_light.png" width="350" alt="SmartIR light"></a>
|
||||
<a href="#"><img src="assets/infrarize_light.png" width="350" alt="Infrarize light"></a>
|
||||
</p>
|
||||
|
||||
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](LIGHT.md#available-codes-for-light-devices) and add the number in the `device_code` field. The component will download it to the correct folder. If your device is not working, you will need to learn your own codes and place the .json file in `smartir/codes/light` subfolders. Please note that the `device_code` field only accepts positive numbers. The .json extension is not required.
|
||||
Find your device's brand code [here](LIGHT.md#available-codes-for-light-devices) and add the number in the `device_code` field. The component will download it to the correct folder. If your device is not working, you will need to learn your own codes and place the .json file in `infrarize/codes/light` subfolders. Please note that the `device_code` field only accepts positive numbers. The .json extension is not required.
|
||||
|
||||
## Configuration variables
|
||||
|
||||
@@ -19,10 +19,10 @@ Find your device's brand code [here](LIGHT.md#available-codes-for-light-devices)
|
||||
Add a Broadlink RM device named "Bedroom" via config flow (read the [docs](https://www.homeassistant.io/integrations/broadlink/)).
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
light:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Bedroom Ceiling Light
|
||||
unique_id: bedroom_ceiling_light
|
||||
device_code: 1000
|
||||
|
||||
+14
-14
@@ -1,9 +1,9 @@
|
||||
<p align="center">
|
||||
<a href="#"><img src="assets/smartir_mediaplayer.png" width="350" alt="SmartIR Media Player"></a>
|
||||
<a href="#"><img src="assets/infrarize_mediaplayer.png" width="350" alt="Infrarize Media Player"></a>
|
||||
</p>
|
||||
|
||||
For this platform to work, we need a .json file containing all the necessary IR commands.
|
||||
Find your device's brand code [here](MEDIA_PLAYER.md#available-codes-for-tv-devices) and add the number in the `device_code` field. The component will download it to the correct folder. If your device is not working, you will need to learn your own codes and place the .json file in `smartir/codes/media_player/` subfolders. Please note that the `device_code` field only accepts positive numbers. The .json extension is not required.
|
||||
Find your device's brand code [here](MEDIA_PLAYER.md#available-codes-for-tv-devices) and add the number in the `device_code` field. The component will download it to the correct folder. If your device is not working, you will need to learn your own codes and place the .json file in `infrarize/codes/media_player/` subfolders. Please note that the `device_code` field only accepts positive numbers. The .json extension is not required.
|
||||
|
||||
## Configuration variables:
|
||||
**name** (Optional): The name of the device<br />
|
||||
@@ -18,10 +18,10 @@ Find your device's brand code [here](MEDIA_PLAYER.md#available-codes-for-tv-devi
|
||||
Add a Broadlink RM device named "Bedroom" via config flow (read the [docs](https://www.home-assistant.io/integrations/broadlink/)).
|
||||
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
media_player:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Living room TV
|
||||
unique_id: living_room_tv
|
||||
device_code: 1000
|
||||
@@ -31,7 +31,7 @@ media_player:
|
||||
|
||||
## Example (using xiaomi controller):
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
remote:
|
||||
- platform: xiaomi_miio
|
||||
@@ -39,7 +39,7 @@ remote:
|
||||
token: YOUR_TOKEN
|
||||
|
||||
media_player:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Living room TV
|
||||
unique_id: living_room_tv
|
||||
device_code: 2000
|
||||
@@ -49,10 +49,10 @@ media_player:
|
||||
|
||||
## Example (using mqtt controller):
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
media_player:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Living room TV
|
||||
unique_id: living_room_tv
|
||||
device_code: 3000
|
||||
@@ -62,10 +62,10 @@ media_player:
|
||||
|
||||
## Example (using LOOKin controller):
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
media_player:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Living room TV
|
||||
unique_id: living_room_tv
|
||||
device_code: 4000
|
||||
@@ -96,10 +96,10 @@ remote_transmitter:
|
||||
```
|
||||
HA configuration.yaml:
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
|
||||
media_player:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Living room TV
|
||||
unique_id: living_room_tv
|
||||
device_code: 2000
|
||||
@@ -112,7 +112,7 @@ Source names in device files are usually set to the name that the media player u
|
||||
|
||||
```yaml
|
||||
media_player:
|
||||
- platform: smartir
|
||||
- platform: infrarize
|
||||
name: Living room TV
|
||||
unique_id: living_room_tv
|
||||
device_code: 1000
|
||||
@@ -124,7 +124,7 @@ media_player:
|
||||
```
|
||||
|
||||
### Changing channels
|
||||
Most IR remotes can only send one key at a time (0 to 9) to change your TV channel, changing to other channels requires pressing 2 consecutive keys. SmartIR handles any channel for you with the standard Home Assistant service interface. Here is an example that changes your Kitchen TV to channel 51:
|
||||
Most IR remotes can only send one key at a time (0 to 9) to change your TV channel, changing to other channels requires pressing 2 consecutive keys. Infrarize handles any channel for you with the standard Home Assistant service interface. Here is an example that changes your Kitchen TV to channel 51:
|
||||
|
||||
```yaml
|
||||
service: media_player.play_media
|
||||
|
||||
+15
-17
@@ -1,15 +1,13 @@
|
||||
[](https://github.com/kobimx/SmartIR/releases/latest) [](https://github.com/custom-components/hacs)
|
||||
[](https://github.com/kobimx/Infrarize/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.
|
||||
> ### ⚠️ Notice
|
||||
> This project is a fork of [SmartIR](https://github.com/smartHomeHub/SmartIR), rebranded as **Infrarize** in compliance with the original project's guideline that its name not be used for forks or derivative works.
|
||||
>
|
||||
> Full credit to the original SmartIR authors and community for the underlying design and device code database.
|
||||
|
||||
## Overview
|
||||
SmartIR is a custom integration for controlling **climate devices**, **media players**, **fans** and **lights** via infrared controllers.<br>
|
||||
SmartIR currently supports the following controllers:
|
||||
Infrarize is a custom integration for controlling **climate devices**, **media players**, **fans** and **lights** via infrared controllers.<br>
|
||||
Infrarize 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)
|
||||
@@ -27,7 +25,7 @@ It should look similar to this:
|
||||
```
|
||||
<config directory>/
|
||||
|-- custom_components/
|
||||
| |-- smartir/
|
||||
| |-- infrarize/
|
||||
| |-- __init__.py
|
||||
| |-- climate.py
|
||||
| |-- fan.py
|
||||
@@ -37,25 +35,25 @@ It should look similar to this:
|
||||
```
|
||||
**(2)** Add the following to your configuration.yaml file.
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
```
|
||||
|
||||
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:
|
||||
Infrarize 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 Infrarize version is incompatible with your HA instance. You can disable this feature by setting Infrarize as follows:
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
check_updates: false
|
||||
```
|
||||
|
||||
If you would like to get updates from the rc branch (Release Candidate), configure SmartIR as follows:
|
||||
If you would like to get updates from the rc branch (Release Candidate), configure Infrarize as follows:
|
||||
```yaml
|
||||
smartir:
|
||||
infrarize:
|
||||
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.
|
||||
If you want HACS to handle installation and updates, add Infrarize 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.
|
||||
<br><br>
|
||||
|
||||
|
||||
@@ -68,4 +66,4 @@ Click on the links below for instructions on how to configure each platform.
|
||||
<br><br>
|
||||
|
||||
## 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/)
|
||||
* [Discussion about the original SmartIR project (Home Assistant Community)](https://community.home-assistant.io/t/smartir-control-your-climate-tv-and-fan-devices-via-ir-rf-controllers/) — useful background on climate/TV/fan IR control patterns; not specific to this fork.
|
||||
|
||||
Reference in New Issue
Block a user