Home Assistant Driver

[riley206]

Description

This is a pull request to add the Home Assistant Driver to the VOLTTRON repository.

Type of change

• [x] New feature (non-breaking change which adds functionality)
• [x] This change requires a documentation update

How Has This Been Tested?

This has been tested by running the driver on the same network as our Home Assistant instance with real devices such as thermostats and lights connected to Home Assistant.

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [ ] My changes generate no new warnings
• [ ] I have added tests that prove my fix is effective or that my feature works
• [ ] New and existing unit tests pass locally with my changes
• [ ] Any dependent changes have been merged and published in downstream modules

[craig8]

This should be against the develop branch not main. @riley206 you can modify the branch by changing the branch at the top of the pr and clicking edit.

[schandrika]

@riley206 Update documentation to rst and move it to docs under docs/source/agent-framework/driver-framework/home_assistant directory and also make sure there is a link to this document from docs/source/agent-framework/driver-framework/drivers-overview.rst

Also other documentation updates that would be useful:

Mention how to see the list of devices - i.e. specify device = entity and home assistant prefixes thermostats with climate. and light with light. Mention any limitations - i.e. this driver can scrape data from all devices but can only control light and thermostat

[schandrika]

@riley206 Could you make errors to raise exceptions instead of suppressing it with just _log.error. Warnings are okay to just log, but when there are actual errors such as writing to a read-only point or writing a wrong value the error should get propagated to the calling agent/user. So raise the exception or custom IOError or ValueError in addition to _log.error