From 3daede06e438043c35455a03b0e6989c3fc83ee1 Mon Sep 17 00:00:00 2001 From: uqs Date: Fri, 3 Nov 2023 20:55:20 +0100 Subject: [PATCH] [astro] Update README.md (#15648) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Help users detangle #start, #end and #event trigger channels and their respective offsets. I was struggling with this and it took reading https://community.openhab.org/t/solved-open-rollershutters-based-on-astro-binding-with-offset-does-not-work/123336 to figure out where I went wrong. While here, maybe fix the Markdown rendering of QuantityType Signed-off-by: Ulrich Spörlein --- bundles/org.openhab.binding.astro/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/bundles/org.openhab.binding.astro/README.md b/bundles/org.openhab.binding.astro/README.md index c15599116..e20ecf2c9 100644 --- a/bundles/org.openhab.binding.astro/README.md +++ b/bundles/org.openhab.binding.astro/README.md @@ -94,6 +94,8 @@ This is done by setting `useMeteorologicalSeason` to true in the advanced settin ### Trigger Channels +Only these can be used in rule triggers as shown below. Note that they have their own offset configurations that are independent from offsets configured on the start or end times of e.g. the `rise` or `set` channels. + - **thing** `sun` - **group** `rise, set, noon, night, morningNight, astroDawn, nauticDawn, civilDawn, astroDusk, nauticDusk, civilDusk, eveningNight, daylight` - **event** `START, END` @@ -245,14 +247,14 @@ Example : ### getElevation(timeStamp) -Retrieves the elevation (QuantityType) of the sun at the requested instant. +Retrieves the elevation (QuantityType\) of the sun at the requested instant. Thing method applies to Sun and Moon. - `timeStamp` (ZonedDateTime) - defaulted to now() if null. ### getAzimuth(timeStamp) -Retrieves the azimuth (QuantityType) of the sun at the requested instant. +Retrieves the azimuth (QuantityType\) of the sun at the requested instant. Thing method applies to Sun and Moon. - `timeStamp` (ZonedDateTime) - defaulted to now() if null. @@ -267,7 +269,7 @@ Example : ### getTotalRadiation(timeStamp) -Retrieves the total radiation (QuantityType) of the sun at the requested instant. +Retrieves the total radiation (QuantityType\) of the sun at the requested instant. Thing method only applies to Sun thing type. ```java