Update itach remote component configuration (#7416)

This commit is contained in:
Klaas Schoute 2018-11-08 09:29:19 +01:00 committed by Fabian Affolter
parent 1d2c1118a0
commit eb19c4a934

View File

@ -13,7 +13,6 @@ ha_iot_class: "Assumed State"
ha_release: 0.39
---
The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page.
In order to utilize the digital input (binary sensor) and relay (switch) features of your Global Cache device you will need to use the [gc100 component](/components/gc100) and associated platforms.
@ -36,22 +35,58 @@ remote:
data: "0000 006D 0000 0022 00AC 00AC 0015 0040 0015 0040 0015 0040 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0040 0015 0040 0015 0040 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0040 0015 0040 0015 0015 0015 0015 0015 0040 0015 0040 0015 0040 0015 0040 0015 0015 0015 0015 0015 0040 0015 0040 0015 0015 0015 0689"
```
Configuration variables:
- **name** (*Optional*): The iTach's name to display in the front end.
- **host** (*Required*): The iTach's IP address.
- **port** (*Optional*): The iTach's port. 4998 is default.
- **devices** array (*Required*): Devices controlled by the iTach.
- **name** (*Required*): Name of the device.
- **modaddr** (*Optional*): iTach module address for the IR emitter. 1 is default.
- **connaddr** (*Required*): iTach connection location for the IR emitter. (Note connaddr is a misleading label. Do not put the connection address here. Technically the connection address is the combination of the module address plus the connection location).
- **commands** array (*Required*): Commands available to send to the device.
- **name** (*Required*): Command name.
- **data** (*Required*): Hex command data.
{% configuration %}
name:
description: The iTach's name to display in the front end.
required: false
type: string
host:
description: The iTach's IP address.
required: true
type: string
port:
description: The iTach's port.
required: false
default: 4998
type: integer
devices:
description: Devices controlled by the iTach.
required: true
type: list
keys:
name:
description: Name of the device.
required: true
type: string
modaddr:
description: iTach module address for the IR emitter.
required: false
default: 1
type: integer
connaddr:
description: iTach connection location for the IR emitter. (Note connaddr is a misleading label. Do not put the connection address here. Technically the connection address is the combination of the module address plus the connection location).
required: true
type: integer
commands:
description: Commands available to send to the device.
required: true
type: list
keys:
name:
description: Command name.
required: true
type: string
data:
description: Hex command data.
required: true
type: string
{% endconfiguration %}
An example to call the component from developer tools using the `remote.send_command` service: `{ "entity_id":"remote.tv", "command":"menu" }`
Note: Global Cache devices expect data in their own format of "sendir...". This component converts hex code to Global Cache IR form.
API Docs:
- [iTach](https://www.globalcache.com/files/docs/API-iTach.pdf)
- [GC-100](http://www.globalcache.com/files/docs/API-GC-100.pdf)