doc: document use cases for device-level power constraints as sensors #937
Conversation
lady-thee
changed the title
|
@victorgarcia98 I have documented the use cases of the feature from issue #926 . It is ready for reviewing. |
lady-thee
changed the title
Signed-off-by: lady-thee <onuhtheolam6@gmail.com>
lady-thee
force-pushed
the
document-usecase-sensors
branch
from
9394296
to
390ea99
Compare
victorgarcia98
added
documentation
There was a problem hiding this comment.
Hi @lady-thee
First of all, I would like to thank you for your contribution! 😄
I've left some comments on the documentation only covering the first use-case. Nonetheless, It should be similar for the others. I feel this page would be much richer with more FlexMeasures specific things like:
- a
flex-model - a reference to an API endpoint
- the use of CLI commands
| @@ -0,0 +1,68 @@ | |||
| ## Implementing Device-Level Power Constraints as Sensors | |||
|
|
|||
| The new feature introduced in PR #897 allows the definition of device-level power constraints as sensors. This section outlines practical implementation steps for applying this feature to various use cases: | |||
There was a problem hiding this comment.
We should add a link to PR #897 here.
There was a problem hiding this comment.
Thank you for this correction! I must have missed it but I can't tell which is actually the API endpoint. I went through the page and couldn't tell which was it. I would love it if you specifically point me to the actual API endpoint so I can do a better job that suits the needs for this documentation. @victorgarcia98
There was a problem hiding this comment.
I have updated the documentation, and have linked the issue, but I would still appreciate it if I had the direct link to the API endpoint. So i properly reference it and do a very detailed flex-model.
|
|
||
| ### Use Case 1: Modeling Device Availability | ||
|
|
||
| #### Scenario: |
There was a problem hiding this comment.
I would remove the Scenario header.
| ### Use Case 1: Modeling Device Availability | ||
|
|
||
| #### Scenario: | ||
| We want to model the availability of a device, such as an industrial process or an Electric Vehicle (EV), based on its power constraints. |
There was a problem hiding this comment.
Here I would follow with a more concrete simple example where this feature could be used.
For example, we can say that in some cases we know the EV charging sessions in advanced, i.e. when the Electric vehicles are going to connect and disconnect. Let's say the maximum power of the charger is 5kW. We can create a 15min resolution Sensor with kW units that take the value 5 when the car is expected to be plugged and 0 otherwise.
There was a problem hiding this comment.
Okay got it. If I could just be pointed to the actual API endpoint for better understanding, that would be very helpful.
|
|
||
| #### Implementation Steps: | ||
| 1. **Identify Power Constraints:** | ||
| - Define the specific power constraints that affect the availability of the device. These could include maximum and minimum power limits. |
There was a problem hiding this comment.
I would extend this with the example describe above.
| - Define the specific power constraints that affect the availability of the device. These could include maximum and minimum power limits. | ||
|
|
||
| 2. **Configure Power Constraints as Sensors:** | ||
| - Within the system, define these power constraints as sensors associated with the device. |
There was a problem hiding this comment.
Here we can show how to do this with the CLI:
flexmeasures add sensor --name "Availability" --unit kW --event-resolution PT15M --timezone Europe/Amsterdam --asset-id 2
This assumes the asset ID is 2.
| - Within the system, define these power constraints as sensors associated with the device. | ||
| - Establish a mechanism to monitor and interpret these sensor values to determine device availability based on the defined constraints. | ||
|
|
||
| 3. **Usage Example:** |
There was a problem hiding this comment.
I would remove this subsection, perhaps.
There was a problem hiding this comment.
I have done this. Thank you for the feedback.
Description
Mention if this PR closes an Issue or Project.
This PR closes an Issue