Modul Astro
Astro | |
---|---|
Zweck / Funktion | |
Das Modul stellt astronomische Daten zur Verfügung (etwa Sonnenauf- und Untergänge) | |
Allgemein | |
Typ | Hilfsmodul |
Details | |
Dokumentation | EN / DE |
Support (Forum) | Unterstuetzende Dienste |
Modulname | 95_Astro.pm |
Ersteller | Prof. Dr. Peter A. Henning |
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref! |
Diese Seite beschreibt die Konfiguration und Verwendung des Moduls 95_Astro.pm.
Allgemeines
Das Modul 95_Astro.pm stellt astronomische Daten zur Verfügung (etwa Sonnenauf- und Untergänge).
Definition
Das Astro-Device wird definiert durch
define <name> Astro
Es verwendet verschiedene Attribute zur Bestimmung der Beobachterdefinition, die im global-Device von FHEM abgelegt sein sollten:
attr global longitude <value> attr global latitude <value> attr global altitude <value>
Die beiden ersten Angaben erfolgen in Dezimalgrad, die dritte Angabe ist die Höhe in Metern über dem Meeresspiegel. Globale Definitionen dieser Werte werden nur verwendet, wenn keine lokalen Attribute mit diesen Namen vorhanden sind (siehe unten).
Bedienung
Get
Achtung: Die Ergebnisse von Get-Aufrufen werden nicht in die Readings geschrieben, sondern nur die Ergebnisse zyklischer Updates. Das dient dazu, schnell und ohne Readings spezielle Datenwerte (etwa für andere Zeiten oder Orte) zu generieren. Möglichkeiten für Aufrufe:
get <name> json [<reading>] get <name> json [<reading>] YYYY-MM-DD get <name> json [<reading>] YYYY-MM-DD HH:MM:[SS]
liefert JSON-Code für den kompletten Datensatz oder nur einen Datenwert der astronomischen Daten entweder für die gegenwärtige Zeit, oder für ein Datum und eine Zeit im Argument.
get <name> text [<reading>] get <name> text [<reading>] YYYY-MM-DD get <name> text [<reading>] YYYY-MM-DD HH:MM:[SS]
liefert Text für den kompletten Datensatz oder nur einen Datenwert der astronomischen Daten entweder für die gegenwärtige Zeit, oder für ein Datum und eine Zeit im Argument.
get <name> version
zeigt die aktuelle Modulversion an.
It is not necessary to define an Astro device to use the data provided by this module
To use its data in any other module, you just need to putrequire "95_Astro.pm";
at the start of your own code, and then may call, for example, the function
Astro_Get( SOME_HASH_REFERENCE,"dummy","text", "SunRise","2019-12-24");
to acquire the sunrise on Christmas Eve 2019
Attribute
attr lt;name> <interval>00
Update-Interval in seconds. Default sind 3600 Sekunden, ein Wert 0 verhindert das periodische Update
attr <name> longitude <value>
attr <name> latitude <value>
attr <name> altitude <value>
(in m above sea level)
attr <name> horizon <value>
custom horizon angle in degrees, default 0
These definitions take precedence over global attribute settings.
Verwendung ohne Astro-Device
Die Funktion [code]Astro_Get[/code] bekommt im ersten Argument eine hash-Referenz übergeben. Und holt sich die Attribute aus diesem hash - das muss also kein hash eines Astro-Devices sein.
Es müsste also folgendes gehen:
1.) Ein beliebiges Device (sagen wir mit Namen "Bla") bekommt ein User Attribute mit Namen "horizon", dessen Wert der gewünschte Horizontwinkel ist.
2.) Der Funktionsaufruf müsste dann lauten
Code: [Auswählen]
{Astro_Get($defs{"Bla"},"Bla","text", "CustomTwilightEvening")}
und den Sonnenuntergang für diesen Horizontwinkel liefern.