]> git.basschouten.com Git - openhab-addons.git/commitdiff
[astro] Update README.md (#15648)
authoruqs <uspoerlein@gmail.com>
Fri, 3 Nov 2023 19:55:20 +0000 (20:55 +0100)
committerGitHub <noreply@github.com>
Fri, 3 Nov 2023 19:55:20 +0000 (20:55 +0100)
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<Intensity>

Signed-off-by: Ulrich Spörlein <uspoerlein@gmail.com>
bundles/org.openhab.binding.astro/README.md

index c1559911694a97192a037a066bc8e6ae64a586db..e20ecf2c913ad5f1b890f364a4982e3501fb451e 100644 (file)
@@ -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<Angle>) of the sun at the requested instant.
+Retrieves the elevation (QuantityType\<Angle\>) 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<Angle>) of the sun at the requested instant.
+Retrieves the azimuth (QuantityType\<Angle\>) 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<Intensity>) of the sun at the requested instant.
+Retrieves the total radiation (QuantityType\<Intensity\>) of the sun at the requested instant.
 Thing method only applies to Sun thing type.
 
 ```java