public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[astro] Update README.md (#15648) 

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>
This commit is contained in:
uqs 2023-11-03 20:55:20 +01:00 committed by GitHub
parent 538a455bfd
commit 3daede06e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
bundles/org.openhab.binding.astro/README.md
View File

@ -94,6 +94,8 @@ This is done by setting `useMeteorologicalSeason` to true in the advanced settin
### Trigger Channels ### 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` - **thing** `sun`
- **group** `rise, set, noon, night, morningNight, astroDawn, nauticDawn, civilDawn, astroDusk, nauticDusk, civilDusk, eveningNight, daylight` - **group** `rise, set, noon, night, morningNight, astroDawn, nauticDawn, civilDawn, astroDusk, nauticDusk, civilDusk, eveningNight, daylight`
- **event** `START, END` - **event** `START, END`
@ -245,14 +247,14 @@ Example :
### getElevation(timeStamp) ### 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. Thing method applies to Sun and Moon.
- `timeStamp` (ZonedDateTime) - defaulted to now() if null. - `timeStamp` (ZonedDateTime) - defaulted to now() if null.
### getAzimuth(timeStamp) ### 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. Thing method applies to Sun and Moon.
- `timeStamp` (ZonedDateTime) - defaulted to now() if null. - `timeStamp` (ZonedDateTime) - defaulted to now() if null.
@ -267,7 +269,7 @@ Example :
### getTotalRadiation(timeStamp) ### 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. Thing method only applies to Sun thing type.
```java ```java