OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add between methods to PersistenceExtension docs (#1835) 

* Add between methods to PersistenceExtension docs

Signed-Off-by: Jan N. Klug <github@klug.nrw>

* Update configuration/persistence.md

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Update configuration/persistence.md

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Co-authored-by: Jerome Luckenbach <email@jerome-luckenbach.de>
pull/1837/head
J-N-K 2022-06-08 17:59:42 +02:00 committed by GitHub
parent 4b4266b021
commit 913925531d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
configuration/persistence.md
View File

@ -184,18 +184,28 @@ Here is the full list of available persistence extensions:
| `<item>.persist` | Persists the current State of the Item | | `<item>.persist` | Persists the current State of the Item |
| `<item>.lastUpdate` | Queries for the last update timestamp of a given Item | | `<item>.lastUpdate` | Queries for the last update timestamp of a given Item |
| `<item>.historicState(ZonedDateTime)` | Retrieves the State of an Item at a certain point in time (returns HistoricItem) | | `<item>.historicState(ZonedDateTime)` | Retrieves the State of an Item at a certain point in time (returns HistoricItem) |
| `<item>.changedSince(ZonedDateTime)` | Checks if the State of the Item has (ever) changed since a certain point in time | | `<item>.changedSince(ZonedDateTime)` | Checks if the State of the Item has (ever) changed since a certain point in time |
| `<item>.changedBetween(ZonedDateTime, ZonedDateTime)` | Checks if the State of the Item has (ever) changed between certain points in time |
| `<item>.updatedSince(ZonedDateTime)` | Checks if the state of the Item has been updated since a certain point in time | | `<item>.updatedSince(ZonedDateTime)` | Checks if the state of the Item has been updated since a certain point in time |
| `<item>.updatedBetween(ZonedDateTime, ZonedDateTime)` | Checks if the state of the Item has been updated between certain points in time |
| `<item>.maximumSince(ZonedDateTime)` | Gets the maximum value of the State of a persisted Item since a certain point in time (returns HistoricItem) | | `<item>.maximumSince(ZonedDateTime)` | Gets the maximum value of the State of a persisted Item since a certain point in time (returns HistoricItem) |
| `<item>.maximumBetween(ZonedDateTime ZonedDateTime)` | Gets the maximum value of the State of a persisted Item between certain points in time (returns HistoricItem) |
| `<item>.minimumSince(ZonedDateTime)` | Gets the minimum value of the State of a persisted Item since a certain point in time (returns HistoricItem) | | `<item>.minimumSince(ZonedDateTime)` | Gets the minimum value of the State of a persisted Item since a certain point in time (returns HistoricItem) |
| `<item>.minimumBetween(ZonedDateTime, ZonedDateTime)` | Gets the minimum value of the State of a persisted Item between certain points in time (returns HistoricItem) |
| `<item>.averageSince(ZonedDateTime)` | Gets the average value of the State of a persisted Item since a certain point in time. This method uses a time-weighted average calculation (see example below) | | `<item>.averageSince(ZonedDateTime)` | Gets the average value of the State of a persisted Item since a certain point in time. This method uses a time-weighted average calculation (see example below) |
| `<item>.averageBetween(ZonedDateTime, ZonedDateTime)` | Gets the average value of the State of a persisted Item betwen certain points in time. This method uses a time-weighted average calculation (see example below) |
| `<item>.deltaSince(ZonedDateTime)` | Gets the difference in value of the State of a given Item since a certain point in time | | `<item>.deltaSince(ZonedDateTime)` | Gets the difference in value of the State of a given Item since a certain point in time |
| `<item>.evolutionRate(ZonedDateTime)` | Gets the evolution rate of the state of a given {@link Item} since a certain point in time (returns DecimalType) | | `<item>.deltaBetween(ZonedDateTime, ZonedDateTime)` | Gets the difference in value of the State of a given Item between certain points in time |
| `<item>.evolutionRate(ZonedDateTime)` | Gets the evolution rate of the state of a given Item since a certain point in time (returns DecimalType) |
| `<item>.evolutionRate(ZonedDateTime, ZonedDateTime)` | Gets the evolution rate of the state of a given Item between certain points in time (returns DecimalType) |
| `<item>.deviationSince(ZonedDateTime)` | Gets the standard deviation of the state of the given Item since a certain point in time (returns DecimalType) | | `<item>.deviationSince(ZonedDateTime)` | Gets the standard deviation of the state of the given Item since a certain point in time (returns DecimalType) |
| `<item>.deviationBetween(ZonedDateTime, ZonedDateTime)` | Gets the standard deviation of the state of the given Item between certain points in time (returns DecimalType) |
| `<item>.varianceSince(ZonedDateTime)` | Gets the variance of the state of the given Item since a certain point in time (returns DecimalType) | | `<item>.varianceSince(ZonedDateTime)` | Gets the variance of the state of the given Item since a certain point in time (returns DecimalType) |
| `<item>.varianceBetween(ZonedDateTime, ZonedDateTime)` | Gets the variance of the state of the given Item between certain point sin time (returns DecimalType) |
| `<item>.previousState()` | Gets the previous State of a persisted Item (returns HistoricItem) | | `<item>.previousState()` | Gets the previous State of a persisted Item (returns HistoricItem) |
| `<item>.previousState(true)` | Gets the previous State of a persisted Item, skips Items with equal State values and searches the first Item with State not equal the current State (returns HistoricItem) | | `<item>.previousState(true)` | Gets the previous State of a persisted Item, skips Items with equal State values and searches the first Item with State not equal the current State (returns HistoricItem) |
| `<item>.sumSince(ZonedDateTime)` | Gets the sum of the previous States of a persisted Item since a certain point in time | | `<item>.sumSince(ZonedDateTime)` | Gets the sum of the previous States of a persisted Item since a certain point in time |
| `<item>.sumBetween(ZonedDateTime, ZonedDateTime)` | Gets the sum of the previous States of a persisted Item between certain points in time |
These extensions use the default persistence service. These extensions use the default persistence service.
(Refer to 'Default Persistence Service' above to configure this.) (Refer to 'Default Persistence Service' above to configure this.)