From c6423120c903c4ad538146420ff43b7d5f412156 Mon Sep 17 00:00:00 2001 From: Michael Wodniok Date: Sat, 13 Mar 2021 20:18:37 +0100 Subject: [PATCH] [icalendar] Fixes #10303: small changes to docs (#10304) Signed-off-by: Michael Wodniok --- .../org.openhab.binding.icalendar/README.md | 27 ++++++++----------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/bundles/org.openhab.binding.icalendar/README.md b/bundles/org.openhab.binding.icalendar/README.md index 66fc2b830..7a6c3db68 100644 --- a/bundles/org.openhab.binding.icalendar/README.md +++ b/bundles/org.openhab.binding.icalendar/README.md @@ -31,17 +31,17 @@ Each `calendar` thing requires the following configuration parameters: Each `eventfilter` thing requires a bridge of type `calendar` and has following configuration options: -| parameter name | description | optional | -|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| -| `maxEvents` | The count of expected results. | mandatory | -| `refreshTime` | The frequency in minutes the channels get refreshed. | mandatory (default available) | -| `datetimeUnit` | A unit for time settings in this filter. Valid values: `MINUTE`, `HOUR`, `DAY` and `WEEK`. | optional (required for time-based filtering) | -| `datetimeStart` | The start of the time frame where to search for events relative to current time. Combined with `datetimeUnit`. | optional | -| `datetimeEnd` | The end of the time frame where to search for events relative to current time. Combined with `datetimeUnit`. The value must be greater than `datetimeStart` to get results. | optional | -| `datetimeRound` | Whether to round the datetimes of start and end down to the earlier time unit. Example if set: current time is 13:00, timeunit is set to `DAY`. Resulting search will start and end at 0:00. | optional | -| `textEventField` | A field to filter the events text-based. Valid values: `SUMMARY`, `DESCRIPTION`, `COMMENT`, `CONTACT` and `LOCATION` (as described in RFC 5545). | optional/required for text-based filtering | -| `textEventValue` | The text to filter events with. | optional | -| `textValueType` | The type of the text to filter with. Valid values: `TEXT` (field must contain value), `REGEX` (field must match value, completely, dot matches all, case insensetive). | optional/required for text-based filtering | +| parameter name | description | optional | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| `maxEvents` | The count of expected results. | mandatory | +| `refreshTime` | The frequency in minutes the channels get refreshed. | mandatory (default available) | +| `datetimeUnit` | A unit for time settings in this filter. Valid values: `MINUTE`, `HOUR`, `DAY` and `WEEK`. | optional (required for time-based filtering) | +| `datetimeStart` | The start of the time frame where to search for events relative to current time. Combined with `datetimeUnit`. | optional | +| `datetimeEnd` | The end of the time frame where to search for events relative to current time. Combined with `datetimeUnit`. The value must be greater than `datetimeStart` to get results. | optional | +| `datetimeRound` | Whether to round the datetimes of start and end down to the earlier time unit. Example if set: current time is 13:00, timeunit is set to `DAY`. Resulting search will start and end at 0:00. | optional | +| `textEventField` | A field to filter the events text-based. Valid values: `SUMMARY`, `DESCRIPTION`, `COMMENT`, `CONTACT` and `LOCATION` (as described in RFC 5545). | optional/required for text-based filtering | +| `textEventValue` | The text to filter events with. | optional | +| `textValueType` | The type of the text to filter with. Valid values: `TEXT` (field must contain value, case insensitive), `REGEX` (field must match value, completely, dot matches all, usually case sensitive). | optional/required for text-based filtering | ## Channels @@ -167,11 +167,6 @@ BEGIN:Calendar_Test_Switch:ON END:Calendar_Test_Switch:OFF ``` -### Notes for Nextcloud - -The `url` should be: `https:///remote.php/dav/calendars//?export`, so the `?export` is important to get an `ical` file from the calendar. -Username and password for the nextcloud account have to be set as well. - ## Breaking changes In OH3 `calendar` was changed from Thing to Bridge. You need to recreate calendars (or replace `Thing` by `Bridge` in your `.things` file).