FanControl.HomeAssistant

FanControl-Plugin for HomeAssistant sensors.

• Integrates HomeAssistant temperature sensors into FanControl
• HomeAssistant for example provides Philips Hue Ambient temperature sensors or HomeMatic thermostat data as temperature sensors
• Initial use case: Implemented to be used as an ambient temperature sensor for a custom loop.

<p float="left"> <a href="./doc/assets/FanControl.HomeAssistant_AmbientMixSensorExample.png"> <img src="./doc/assets/FanControl.HomeAssistant_AmbientMixSensorExample.png" width="300" /> </a> <a href="./doc/assets/FanControl.HomeAssistant_AmbientMixSensorExample2.png"><img src="./doc/assets/FanControl.HomeAssistant_AmbientMixSensorExample2.png" width="300" /></a> </p> <p float="left"> <a href="./doc/assets/FanControl.HomeAssistant_Settings1.png"><img src="./doc/assets/FanControl.HomeAssistant_Settings1.png" width="300" /></a> <a href="./doc/assets/FanControl.HomeAssistant_Settings2.png"><img src="./doc/assets/FanControl.HomeAssistant_Settings2.png" width="300" /></a> </p>

Installation

Download the latest release and drop the .dll- files into FanControl's Plugins folder. Make sure to have the latest FanControl release installed.

<p float="left"> <a href="./doc/assets/FanControl.HomeAssistant_plugin_install.gif"> <img src="./doc/assets/FanControl.HomeAssistant_plugin_install.gif" width="600" /> </a> </p>

Configuration

The Plugin Expects a file FanControl.HomeAssistant.json within FanControl's Configurations directory (next to your default userConfig.json). If this file is not found, a non-working default configuration file will be created. Check the error log (accessible from the FanControl menu). The default configuration file will look like this

{
    "HomeAssistantAuthToken": "your_long_lived_access_token_created_from_home_assistants_user_configuration",
    "HomeAssistantURL": "http://example.com:8123",
    "sensors": [
        {
            "EntityId": "sensors.your_temp_sensor_entity_id",
            "PollingInterval": 10,
            "InitialFallbackValue": 10.0
        }
    ]
}

After each configuration change, you have to restart FanControl for your changes to have any effect.

|Config entry|Description| |-|-| |HomeAssistantAuthToken (mandatory)|The auth token used to retrieve sensor data. Create one from the HomeAssistant UI| |HomeAssistantURL (mandatory)|The Home Assistant URL of your installation including protocol and port.| |sensors|A list of home assistant (temperature) sensors that you want to have accessible within FanControl. Check how to define a sensors below.|

Sensors can be configured with these attribtues

|Sensor Config entry|Description|Default| |-|-|-| |EntityId (mandatory)|The home assistant entity id to resolve. Must be a tempearture sensor.|-| |PollingInterval (optional)|The interval in seconds to poll data from HomeAssistant.|30| |InitialFallbackValue (optional)|An initial value that is used to initialize the sensor. Will be overridden on first successful retrieval from HomeAssistant. Note that this value is used when home assistant is down or can't be reached initially.|20|

Troubleshooting

|Error|Solution|| |-|-|-| |Failed to load plugin FanControl.HomeAssistant.dll. Make sure the plugin's dll is unblocked in its properties.<br/><br/> <img src="./doc/assets/FanControl.HomeAssistant_Trouble_DLL1.png" width="300" /> | <img src="./doc/assets/FanControl.HomeAssistant_Trouble_DLL2.png" width="300" />| Right click all DLL's in FanControl's Plugins-directory and allow access by checking the box visible in the screenshot to the left | |My sensor is not updating.| <img src="./doc/assets/FanControl.HomeAssistant_Trouble_Entities.png" width="300" /> | Make sure you have configured the Auth Token and sensors in the FanControl.HomeAssistant.json file within FanControl's Configurations directory according to the documentation above. Check FanControl's error log for hints. | |I edited the FanControl.HomeAssistat.json without effect. ||After each change, you have to restart FanControl for your changes to have any effect.|

Development

See development docs