[blockly] persistence documentation update #2427
Conversation
Signed-off-by: Mark Herwege <[email protected]>
✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -34,40 +34,49 @@ More about that topic can be viewed at  | |||
|
|
|||
| _Function:_ computes any of the below functions for the given item since the time provided by _ZonedDateTime_-Block | |||
| _Function:_ computes any of the below functions for the given item since the time provided by _ZonedDateTime_-Block, until the time provided by _ZonedDateTime_-Block, or between 2 timepoints provided by _ZonedDateTime_-Blocks. | |||
There was a problem hiding this comment.
Can you add an image like this that demonstrates "between"?
| - String: output as a string value | ||
| - Quantity: output as a quantity type with unit | ||
| - Number: output as a number | ||
| - Timestamp: time of the persisted value (when applicable) |
There was a problem hiding this comment.
Also here (I am bit behind, so it misses one entry)
There was a problem hiding this comment.
True, although not all functions have it, but I will replace it.
There was a problem hiding this comment.
Ah OK, thought I had an image in for that, but didn't. The point is: Timestamp is only relevant for some of the analytic actions. E.g., it is not for sum, average, medium..., but it is for getting a persisted state, getting the last update, next update, minimum, maximum... as these results are at a specific point in time. Only when Timestamp is relevant, it is shown in the list. I didn't want to explicitely document this, is the UI should be very much self explaining. And Timestamp will be there when it is relevant. I can put in an image, but not sure it adds much.
| Following options are not supported by all persistence services (for example the standard rrd4j does _not_ support this). | ||
|
|
||
| - state (at specific time): persist given State at given time | ||
| - list of states (adding): persist list of States, not replacing the already persisted States |
There was a problem hiding this comment.
Do you mind giving a example where this needed or helpful of if explained somewhere else link to it? I don't even know what that is for (sorry 😬)
There was a problem hiding this comment.
It looks like documentation to link to is meager at best. This has been introduced in the context of the forecast persistence strategy, where it became useful to persist/retrieve a series of persisted values, not just one. I will try to formulate something to make it clearer.
Signed-off-by: Mark Herwege <[email protected]>
|
@stefan-hoehn I believe I addressed your comments. |
|
@stefan-hoehn Yes, but I don´t understand the error in the log. Do you have any idea? |
|
Yep, I checked your PR and could see that at least the one image name misses the s 
which is why the build fails to find the image. |
Signed-off-by: Mark Herwege <[email protected]>
@stefan-hoehn Thanks for the tip. It should be better now. |
Related to openhab/openhab-webui#2732
This PR updates the Blockly persistence documentation with enhancements available in OH4.3:
@stefan-hoehn FYI