Modul Astro

Aus FHEMWiki
Version vom 15. September 2018, 03:29 Uhr von Pahenning (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „{{ Infobox Modul |ModPurpose=Das Modul stellt astronomische Daten zur Verfügung (etwa Sonnenauf- und Untergänge) |ModType=h <!-- |ModCategory= (noch?) nicht…“)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
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 Astro 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 Attributdefinitionen dieser Namen vorhanden sind


       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 put require "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

       <a name="Astroget"></a>

Get

       Attention: Get-calls are NOT written into the readings of the device ! Readings change only through periodic updates !
  • <a name="astro_json"></a> get <name> json [<reading>]
    get <name> json [<reading>] YYYY-MM-DD
    get <name> json [<reading>] YYYY-MM-DD HH:MM:[SS]
    returns the complete set or an individual reading of astronomical data either for the current time, or for a day and time given in the argument.
  • <a name="astro_text"></a> get <name> text [<reading>]
    get <name> text [<reading>] YYYY-MM-DD
    get <name> text [<reading>] YYYY-MM-DD HH:MM:[SS]
    returns the complete set or an individual reading of astronomical data either for the current time, or for a day and time given in the argument.
  • <a name="astro_version"></a> get <name> version
    Display the version of the module
       <a name="Astroattr"></a>

Attributes

  • <a name="astro_interval"> <interval>
    Update interval in seconds. The default is 3600 seconds, a value of 0 disables the automatic update.
  • Some definitions determining the observer position:
    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.
  • Standard attributes <a href="#alias">alias</a>, <a href="#comment">comment</a>, <a href="#event-on-update-reading">event-on-update-reading</a>, <a href="#event-on-change-reading">event-on-change-reading</a>, <a href="#room" >room</a>, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>, <a href="#webCmd">webCmd</a>

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.