Unverified Commit 55d4f624 authored by Vassilis Panos's avatar Vassilis Panos Committed by GitHub
Browse files

Add Docs

parent 86b1f60f

Docs/CLIMATE.md

0 → 100644
+163 −0
Original line number Diff line number Diff line 
<p align="center">

  <a href="#"><img src="http://www.tooltip.gr/github_assets/smartir_climate.png" width="350" alt="SmartIR Climate"></a>

</p>



## Installation:

Create a new folder into the Home Assistant's `custom_components` folder and name it `smartir`. Copy `__init__.py` and `climate.py` into the `smartir` folder. Create the subfolders `codes/climate` into the `smartir` folder and copy the code file for your AC device.



## Configuration variables:

**name** (Optional): Name to use in the frontend<br />

**device_code** (Required): ...... (Accepts only positive numbers)<br />

**controller_send_service** (Required): The service that will be used to send the commands. Only `broadlink_send_packet` (Broadlink controller) is currently supported.<br />

**temperature_sensor** (Optional): *entity_id* for a temperature sensor<br />

**humidity_sensor** (Optional): *entity_id* for a humidity sensor<br />

**power_sensor** (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)<br />



## Example (using broadlink controller):

```yaml

switch:

  - platform: broadlink

    host: 192.168.10.10

    mac: '00:00:00:00:00:00'

    

climate:

  - platform: smartir

    name: Office AC

    device_code: 1000

    controller_send_service: switch.broadlink_send_packet_192_168_10_10

    temperature_sensor: sensor.temperature

    humidity_sensor: sensor.humidity

    power_sensor: binary_sensor.ac_power

```

## Create your own codes:

ToDo... I'm developing a windows tool to easily create your code files. Please be patient!



## Convert your old INI files:

To convert your old INI files, please download the SmartIR INI Converter app (only for windows) from the [Tools](Tools/) folder.



## Available codes for climate devices:

Below are the code files created by the 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.**



#### Toyotomi

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1000|AKIRA GAN/GAG-A128 VL|Broadlink



#### Panasonic

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1020|CS-CE7HKEW<br>CS-CE9HKEW<br>CS-CE12HKEW|Broadlink

1021|CS-RE9GKE<br>CS-RE12GKE|Broadlink

1022|CS-Z25TK|Broadlink

1023|CS-HE9JKE<br>CS-HE12JKE|Broadlink



#### General Electric

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1040|Unknown model|Broadlink



#### LG

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1060|R09AWN<br>R24AWN<br>E09EK|Broadlink

1061|Unknown model|Broadlink



#### Hitachi

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1080|Unknown model|Broadlink

1081|RAS-10EH3|Broadlink



#### Daikin

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1100|Unknown model|Broadlink

1101|FTXS20LVMA<br>FTXS25LVMA<br>FTXS35LVMA<br>FTXS46LVMA<br>FTXS50LVMA<br>FTXS60LVMA<br>FTXS71LVMA<br>FTXS85LVMA<br>FTXS95LVMA|Broadlink



#### Mitsubishi Electric

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1120|MSZ-GL25VGD<br>MSZ-GL35VGD<br>MSZ-GL42VGD<br>MSZ-GL50VG<br>MSZ-GL60VGD<br>MSZ-GL71VGD<br>MSZ-GL80VGD|Broadlink

1121|Unknown model|Broadlink



#### Actron

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1140|Unknown model|Broadlink



#### Carrier

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1160|Unknown model|Broadlink



#### Gree

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1180|Unknown model|Broadlink

1181|Unknown model|Broadlink



#### Tosot

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1200|Unknown model|Broadlink



#### Sungold

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1220|Unknown model|Broadlink



#### Consul

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1240|Unknown model|Broadlink



#### Toshiba

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1260|RAS-13NKV-E / RAS-13NAV-E<br>RAS-13NKV-A / RAS-13NAV-A<br>RAS-16NKV-E / RAS-16NAV-E<br>RAS-16NKV-A / RAS-16NAV-A|Broadlink



#### Fujitsu

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1280|AR-RBE1E|Broadlink

1281|Unknown model|Broadlink



#### Sharp

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1300|Unknown model|Broadlink



#### Haier

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1320|Unknown model|Broadlink



#### Tadiran

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1340|Unknown model|Broadlink



#### Springer

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1360|Split Hi Wall Maxiflex|Broadlink



#### Midea

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1380|Unknown model|Broadlink



#### Samsung

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1400|Unknown model|Broadlink



#### Sintech

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1420|KFR-34GW|Broadlink



#### Akai

| Code | Supported Models | Controller |

| ------------- | -------------------------- | ------------- |

1440|Unknown model|Broadlink

Docs/MEDIA_PLAYER.md

0 → 100644
+30 −0
Original line number Diff line number Diff line 
<p align="center">

  <a href="#"><img src="http://www.tooltip.gr/github_assets/smartir_mediaplayer.png" width="350" alt="SmartIR Media Player"></a>

</p>



## Installation:

Create a new folder into the Home Assistant's `custom_components` folder and name it `smartir`. Copy `__init__.py` and `media_player.py` into the `smartir` folder. Create the subfolders `codes/media_player` into the `smartir` folder and copy the code file for your device.



## Configuration variables:

**name** (Optional): Name to use in the frontend<br />

**device_code** (Required): ...... (Accepts only positive numbers)<br />

**controller_send_service** (Required): The service that will be used to send the commands. Only `broadlink_send_packet` (Broadlink controller) is currently supported.<br />

**power_sensor** (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)<br />



## Example (using broadlink controller):

```yaml

switch:

  - platform: broadlink

    host: 192.168.10.10

    mac: '00:00:00:00:00:00'

    

climate:

  - platform: smartir

    name: Living room TV

    device_code: 1000

    controller_send_service: switch.broadlink_send_packet_192_168_10_10

    power_sensor: binary_sensor.tv_power

```



## Create your own codes:

ToDo... I'm developing a windows tool to easily create your code files. Please be patient!