Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Home Assistant Driver #3089

Merged
merged 78 commits into from
Oct 18, 2023
Merged

Home Assistant Driver #3089

merged 78 commits into from
Oct 18, 2023

Conversation

riley206
Copy link
Contributor

@riley206 riley206 commented Jun 6, 2023

Description

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

Type of change

  • New feature (non-breaking change which adds functionality)
  • 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:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • 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
Copy link
Contributor

craig8 commented Jun 6, 2023

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.

@riley206 riley206 changed the base branch from main to develop June 6, 2023 17:32
craig8
craig8 requested changes Jun 6, 2023
View reviewed changes
Copy link
Contributor

@craig8 craig8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good job starting out @riley206. I have taken to add some additions/modifications that should help it be better

HomeAssistant_Driver/home_assistant.config Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
craig8
craig8 reviewed Sep 7, 2023
View reviewed changes
Copy link
Contributor

@craig8 craig8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document all of your functions in rst format. Especially the public ones (the ones the platform driver will call).

services/core/PlatformDriverAgent/HomeAssistantDriver.md Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/HomeAssistantDriver.md Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/HomeAssistantDriver.md Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/HomeAssistantDriver.md Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/HomeAssistantDriver.md Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
services/core/PlatformDriverAgent/platform_driver/interfaces/home_assistant.py Outdated Show resolved Hide resolved
@schandrika
Copy link
Contributor

@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

riley206 and others added 20 commits September 29, 2023 12:57
@riley206 @schandrika
First git push to new repo using ssh
f01872b
@riley206 @schandrika
Control multiple thermostats and convert F to C to change temps
13f0bd0
@riley206 @schandrika
Testing to make sure I can comit and push from vs
a014ae3
@riley206 @schandrika
Updated registers file and removed comments
8757959
@riley206 @schandrika
Cleaned up code
3d32f41
@riley206 @schandrika
Create HomeAssistantDriver.md
0de1673
@riley206 @schandrika
Update HomeAssistantDriver.md
01c8095
@riley206 @schandrika
Updated documentaion, added strip for entity IDs
4dd3ffb
@riley206 @schandrika
Driver responds to changes from other agents
f9cfba4
@riley206 @schandrika
Fixed get_point function and updated the Readme file to reflect recen…
ebd3384 
…t changes
@riley206 @schandrika
Updated config file and readme
a73293e
@riley206 @schandrika
Expirimenting with different ways of publishing data
eb9c7e6
@riley206 @schandrika
Changed publish mechanism for individual devices
e478699
@riley206 @schandrika
Changed keys when publishing state
e8c0707
@riley206 @schandrika
replaced entity_id with register.point_name to simplify
8fa2d2d
@riley206 @schandrika
Added functionality to control lights correctly in set_point
9ed92ac
@riley206 @schandrika
Removed subscription function
5445d47
@riley206 @schandrika
added light on/off functionality in _set_point
0d9de41
@riley206 @schandrika
brightness being treated like state, brightness control
1edc80c
@riley206 @schandrika
Seperated attributes from points
b66cfb0
@schandrika
Copy link
Contributor

@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

riley206 and others added 25 commits October 6, 2023 11:42
@riley206
Added configuration variable checks
79f8e08
@riley206
Added better error checking and ValueErrors for brightness
e0ead39
@riley206
fixed typo
de30824
@riley206
More error checking
0749c5e
@riley206
even more error checking
d701260
@riley206
More more error checking
e001131
@schandrika
info for single config entry for multiple devices
58c76ea
@riley206
Made reference image locally accessible
be1d755
@schandrika
fixed reference to image
1aefb54
@schandrika
info for single config entry for multiple devices
71a3979
@schandrika
documentation updates to support sequence diagram generation using me…
37d1086 
…rmaid.
@schandrika
minor cleanup
5cd4bee
@schandrika
minor extension error fix
fa2e03a
@schandrika
pep8 clean up
1408db3
@schandrika
raising exception instead of only logging
37c3671
@schandrika
minor pep8 cleanup
95eb4d9
@schandrika
refactored post operation into a method - avoids code repetition and …
d88f847 
…copy and paste errors in error strings
@schandrika
Merge remote-tracking branch 'origin/home_assitant' into home_assitant
81615fd 
# Conflicts:
#	docs/source/agent-framework/driver-framework/home-assistant/HomeAssistantDriver.rst
#	services/core/PlatformDriverAgent/tests/test_home_assistant.py
@riley206
Merge pull request #2 from schandrika/home_assitant
8472916 
Home assistant updates
@riley206
Allow for any attribute name
dca5bd0
@riley206
Added entity_point to allow for control of volttron point name
94fcd33
@riley206
Adjusted test_home_assistant to match new registry
b52d68a
@riley206
minor adjustments
808ee2c
@riley206
Updated readme to match
147d22a
@schandrika
minor text changes
4fb6a26
@craig8 craig8 merged commit 089c53a into VOLTTRON:develop Oct 18, 2023
13 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@craig8 craig8 craig8 requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@riley206 @craig8 @schandrika