diff --git a/docs/lights-tutorial/PCT14-Screenshot-FSR14.png b/docs/lights-tutorial/PCT14-Screenshot-FSR14.png new file mode 100644 index 00000000..f47fb85d Binary files /dev/null and b/docs/lights-tutorial/PCT14-Screenshot-FSR14.png differ diff --git a/docs/lights-tutorial/eo_amn-config-snippet-screenshot.png b/docs/lights-tutorial/eo_amn-config-snippet-screenshot.png new file mode 100644 index 00000000..64b9aba8 Binary files /dev/null and b/docs/lights-tutorial/eo_amn-config-snippet-screenshot.png differ diff --git a/docs/lights-tutorial/readme.md b/docs/lights-tutorial/readme.md index 882ebf9d..b855f61a 100644 --- a/docs/lights-tutorial/readme.md +++ b/docs/lights-tutorial/readme.md @@ -6,10 +6,9 @@ This tutorial describes how to configure a light so that its status updates will ## Configure Home Assistant (Eltako FSR14*, FUD14*, FSR61*, ...) -Every Eltako devices which shall be represented in Home Assistant needs to be entered into the Home Assistant configuration (`/config/configuration.yaml`). Find details about how to configure Home Assistant for this integration manually [here](../update_home_assistant_configuration.md). You can also auto-generate the confuguration by using [EnOcean Device Manager (eo_man)](https://github.com/grimmpp/enocean-device-manager) - -For lights you need to create an entries in the light section. You need to specify the id/address of the device so that Home Assistant knows when a status update/change comes by that it needs to react on it. In addition we need to specify the address of the sender button in Home Assistant. A good pattern for the sender id/address is to use a base id + the same local id of the light. EEPs define the type of telegram. In case of light and series 14 devices I wouldn't change this behavior. +Every Eltako devices which shall be represented in Home Assistant need to be entered into the Home Assistant configuration (`/config/configuration.yaml`). Find details about how to configure Home Assistant for this integration manually [here](../update_home_assistant_configuration.md). You can also auto-generate the confuguration by using [EnOcean Device Manager (eo_man)](https://github.com/grimmpp/enocean-device-manager) +For lights you need to create an entries in the light section. You need to specify the id/address of the device so that Home Assistant knows when a status update/change comes by and needs to react on it. In addition we need to specify the address of the sender button in Home Assistant. A good pattern for the sender id/address is to use a base id + the same local id of the light. EEPs define the type of telegram. In case of light and series 14 devices I wouldn't change this behavior. The configuration could look like the following for USB300 as a gateway. ``` @@ -49,4 +48,14 @@ eltako: ## Register Home Assistant Address in Actuators In the section before we made Home Assistant aware of what devices to be represented and on which telegram to react. Now, we need to tell the light to react on commands coming from Home Assistant. + How to program devices (teach-in switches) you can find in the tutorial [Teach-In Buttons](../teach_in_buttons/readme.md). + +Alternatively (advanced procedure) you can use [PCT14 software](https://www.eltako.com/en/software-pct14/) to register sender ids of the actuators. It show also a list of all existing and registered address the actuator is reacting to. + +**PCT14 - FSR14 View:**
+PCT14 Software - FSR14 View
+Depending on the gateway of the examples above the `sender id` must be registered in the actuator. You can also enter both and run both gateways in parallel. Important is to specify `Function` with 51 which means the FSR14 is controlled via software. Other actuator types like FUD14 do have different function ids. Just checkout the title of the function it must say something with controller. + +When using the auto-generation feature of eo_man to create the configuration it will tell you what function needs to be entered into PCT14. +![Auto-generated configuration snippet from eo_man](./eo_amn-config-snippet-screenshot.png) \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 00000000..308a8baa --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,43 @@ +# Home Assistant Eltako Integration Documentation + +## Content + +* [Landing Page](../README.md) + +* **Suppoted Devices** + * [Supported Messages Types (EEP) and Devices (on Landing Page)](../README.md) + * [Supported Gateways](./gateways/readme.md) + +* **Installation** + * [Basic Installation Instruction (on main page)](../README.md) + * [Manual Installation or Installation of a Specific Version/Git-Branch](./install-specific-version-or-branch.md) + * [Manual Installation Script `install_custom_component_eltako.sh`](../install_custom_component_eltako.sh) + +* **Home Assistant Eltako Integration Configuration** + * [Basic Configuration Explanation](./update_home_assistant_configuration.md) + * [Gateway Configuration](./gateway_usage/readme.md) (See how to use many gateways in parallel under features.) + * To auto-generate the configuration [EnOcean Device Manager (eo_man)](https://github.com/grimmpp/enocean-device-manager) can be used. + * [Example Configuration `ha.yaml`](../ha.yaml) + +* **Meta Information** + * [Metadata file/Manifest of Eltako Integration](../custom_components/eltako/manifest.json) + +* **Features and Use Cases** + * [Logging](./logging/readme.md) + * [Light Tutorial](./lights-tutorial/readme.md) + * [Window/Door Contacts or Classic Switches](./window_sensor_setup_FTS14EM.md) + * [Temperature and Humidity Sensors (FLGTF)](./flgtf_temp_humidity_air_quality/readme.md) + * [Heating and Cooling (Climate Devices)](./heating-and-cooling/readme.md) + * [Multi-Gateway Support](./gateway_usage/readme.md) + * [Automations triggered by Wall-Mounted EnOcean Switches](./rocker_switch/readme.md) + * [Teach-In Buttons](./teach_in_buttons/readme.md) + * [Sending Arbitrary EnOcean Messages](./service-send-message/readme.md) + * [Auto-generated List of EEP Parameters](./service-send-message/eep-params.md) + +* **Management of EnOcean Devices** + * To manage, inventory, and auto-generate the configuration you can use [EnOcean Device Manager (eo_man)](https://github.com/grimmpp/enocean-device-manager). + +* **Testing** + * [Testing (on Landing Page)](../README.md) + +* [**Change Log**](../changes.md) \ No newline at end of file