-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Include Home Assistant demo documentation #14
base: main
Are you sure you want to change the base?
Conversation
Before we start, you are assumed to have the following working: | ||
1. A Hedera endpoint for which capacity profiles are published #todo link to Daniel | ||
2. A Hedera gateway to request capacity profiles (optional) #todo link to Daniel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
todo: add links from documentation from Daniel
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perhaps change phrasing such that Hedera is not absolutely necessary, but that this is a more general solution
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fhg-dw @JakobVogelsang this is where I would like to link to some other documentation. Can you help me with this?
If we need to change the phrasing to be more generic, that is okay. Please do a suggestion in that case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can check the review comments. They are optional.
|
||
https://github.com/alliander-opensource/ReLevENT/assets/58041016/8ab08547-4a0c-4b70-a9d6-2518d192b12d | ||
|
||
Please note these are *demo* instructions, as of February 2024 this solution is not in production. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can add: The documentation can be used as startingpoint for further development and/or to explore the concept.
</details> | ||
|
||
Note that this sensor takes the first value of the schedule as the schedule value for 'now', on which automations will be triggered. This works properly as long as the incoming messages are up-to-date. If the connection drops, the first message can actually regard 'the past' (instead of 'now'). | ||
For demo purposes, this is acceptable. In a real-world application, we would want to change this to be resilient against issues such as network failures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optional: create an Github issue to let others know that this is a known issue.
You can refer to these instructions in the readme.md to make them a bit more findable. |
This PR includes documentation on how to set up a demo environment. The documentation is almost finished, just needs some links to the parts which are out of scope for this document.
@Sander3003 could you do a review please?