The PHAL Plugin provides GUI interfaces and API for Home Assistant Instants.
NOTE: this plugin is roadmapped for merging with https://github.com/OpenVoiceOS/ovos-PHAL-plugin-commonIOT for ovos-core release 0.0.9, the UI will become IOT framework agnostic
Plugin Support Two Installation Methods:
Note: PIP install from URL will not install the .desktop file and icon if installing to a venv or virtual environment, so you need to manually install them to the system or user directory.
Note: PIP install will attempt to install the .desktop file and icon to the system directory, or user directory if the system directory is not writable. If this is not a virtual environemnt.
pip install git+https://github.com/OpenVoiceOS/ovos-PHAL-plugin-homeassistant
git clone https://github.com/OpenVoiceOS/ovos-PHAL-plugin-homeassistant
cd ovos-PHAL-plugin-homeassistant
cp -r res/desktop/ovos-phal-homeassistant.desktop ~/.local/share/applications/
cp -r res/icon/ovos-phal-homeassistant.png ~/.local/share/icons/
pip install .
Plugin Supports Two Configuration Methods:
Using the GUI
Manually Editing the Config File
"PHAL": {
"ovos-PHAL-plugin-homeassistant": {
"host": "https://someurl.toinstance",
"api_key": "api key from the instance"
}
}
The config also takes some optional properties:
brightness_increment
- the amount to increment/decrement the brightness of a light when the brightness up/down commands are sent. The default value is 10 and represents a percentage, e.g. 10%.
search_confidence_threshold
- the confidence threshold for the search skill to use when searching for devices. The default value is 0.5, or 50%. Must be a value between 0 and 1.
assist_only
- whether to pull down only entities exposed to Assist. Default True.
toggle_automations
- whether to allow the plugin to turn automations on and off. Default False.
Sample config:
"PHAL": {
"ovos-PHAL-plugin-homeassistant": {
"host": "https://someurl.toinstance",
"api_key": "api key from the instance",
"brightness_increment": 5,
"search_confidence_threshold": 0.6,
"toggle_automations": false,
}
}
The plugin provides a GUI interface for Home Assistant Instances. It also provides an API for other plugins or skills to user.
The plugin is in early development, so there are some features that are not yet implemented. It currently supports the following entities:
Depending on how the controller communicates with the host instance, the minimum required connector initialization properties are:
All devices are required to support the below minimal properties for device initialization.