Update docs

smartHomeHub · May 5, 2020 · 5e97195 · 5e97195
1 parent ebc1c4f
commit 5e97195
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 1 deletion.
diff --git a/custom_components/smartir/controller.py b/custom_components/smartir/controller.py
@@ -17,7 +17,7 @@
 
 ENC_BASE64 = 'Base64'
 ENC_HEX = 'Hex'
-ENC_PRONTO = 'Pronto'
+ENC_PRONTO = 'ProntoHex'
 ENC_RAW = 'Raw'
 
 BROADLINK_COMMANDS_ENCODING = [ENC_BASE64, ENC_HEX, ENC_PRONTO]

diff --git a/docs/CLIMATE.md b/docs/CLIMATE.md
@@ -70,6 +70,21 @@ climate:
     power_sensor: binary_sensor.ac_power
 ```
 
+## Example (using LOOKin controller):
+```yaml
+smartir:
+
+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
+```
+
 ## 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.**
 

diff --git a/docs/FAN.md b/docs/FAN.md
@@ -60,6 +60,19 @@ fan:
     power_sensor: binary_sensor.fan_power
 ```
 
+## Example (using LOOKin controller):
+```yaml
+smartir:
+
+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
+```
+
 ## Available codes for Fan 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.**
 

diff --git a/docs/MEDIA_PLAYER.md b/docs/MEDIA_PLAYER.md
@@ -62,6 +62,19 @@ media_player:
     power_sensor: binary_sensor.tv_power
 ```
 
+## Example (using LOOKin controller):
+```yaml
+smartir:
+
+media_player:
+  - platform: smartir
+    name: Living room TV
+    unique_id: living_room_tv
+    device_code: 4000
+    controller_data: 192.168.10.10
+    power_sensor: binary_sensor.tv_power
+```
+
 ### Overriding Source Names
 Source names in device files are usually set to the name that the media player uses. These often aren't very descriptive, so you can override these names in the configuration file. You can also remove a source by setting its name to `null`