Modul Astro: Unterschied zwischen den Versionen

Aus FHEMWiki
Keine Bearbeitungszusammenfassung
(→‎Mondphasen: https://forum.fhem.de/index.php/topic,73951.msg1106308.html#msg1106308)
 
(11 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 12: Zeile 12:


=Allgemeines=
=Allgemeines=
Das Modul ''95_Astro.pm'' stellt astronomische Daten zur Verfügung (etwa Sonnenauf- und Untergänge).
Das Modul ''95_Astro.pm'' stellt astronomische Daten zur Verfügung (etwa Sonnenauf- und Untergänge). Die Berechungen sind für den Zeitraum 1900 - 2100 gültig.


Ein SVG-Bild der gegenwärtigen Mondphase gibt es unter dem Link
  <ip addresse von fhem>/fhem/Astro_moonwidget?name='<device name>'
Optionale Web-Parameter sind
[&size='<width>x<height>']
[&mooncolor=<color>]
[&moonshadow=<color>]
        <li>Calculations are only valid between the years 1900 and 2100</li>
        <li>Attention: Timezone is taken from the local Perl settings, NOT automatically defined for a location</li>
        <li>This module uses the global attribute <code>language</code> to determine its output data<br/>
        (default: EN=english). For German output set <code>attr global language DE</code>.</li>
        <li>The time zone is determined automatically from the local settings of the <br/>
        operating system. If geocordinates from a different time zone are used, the results are<br/>
        not corrected automatically.
==Definition==
==Definition==
Das Astro-Device wird definiert durch  
Ein Astro-Device wird definiert durch  
  define <name> Astro
  define <name> Astro
Es verwendet verschiedene Attribute zur Bestimmung der Beobachterdefinition, die im ''global''-Device von FHEM abgelegt sein sollten:
Dieses Modul verwendet das globale Attribut language zur Bestimmung der Anzeigedaten (Standard: EN=english). Für deutsche Ausgabedaten muss in FHEM das Attribut
  attr global language DE
gesetzt werden.
==Position des Beobachters==
Das Modul verwendet verschiedene Attribute zur Bestimmung der Beobachterdefinition, die im ''global''-Device von FHEM abgelegt sein sollten:
   attr global longitude &lt;value&gt;  
   attr global longitude &lt;value&gt;  
   attr global latitude &lt;value&gt;  
   attr global latitude &lt;value&gt;  
   attr global altitude &lt;value&gt;
   attr global altitude &lt;value&gt;
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
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).
 
Die Zeitzone wird nicht automatisch eingestellt, sondern aus der lokalen Perl-Installation bezogen.
 
==Ausgabedaten==
Readings mit dem Präfix <i>Sun</i> beziehen sich auf die Sonne, solche mit dem Präfix <i>Moon</i> auf den Mond.
*<i>Age</i> = Winkel (in Dezimalgrad) des Körpers auf seiner Bahn
*<i>Az,Alt</i> = Azimuth und Höhe (in Dezimalgrad) des Körpers über dem Horizont
*<i>Dec,Ra</i> = Deklination und Rektaszension (in HH:MM) der Position des Körpers
*<i>Lat,Lon</i> = geografische Breite und Länge der Position des Körpers
*<i>Diameter</i> = Virtueller Durchmesser des Körpers in Bogenminuten
*<i>Distance,DistanceObserver</i> = Entfernung (in km) des Körpers zum Erdmittelpunkt oder zum Beobachter
*<i>PhaseN,PhaseS</i> = Nummerischer Wert und Stringwert für die Phase des Körpers</li>
*<i>Sign</i> = Tierkreiszeichen des Körpers auf seiner Bahn
*<i>Rise,Transit,Set</i> = Zeiten (in HH:MM) für Aufgang, höchsten Punkt (Transit) und Untergang des Körpers
Readings mit dem Präfix <i>Obs</i> beziehen sich auf den Beobachter
 
Weitere Readings umfassen
*<i>Date,Dayofyear</i> = Datum
*<i>JD</i> = Julianisches Datum
*<i>Season,SeasonN</i> = Stringwert und nummerischer Wert für die Jahreszeit
*<i>Time,Timezone</i> raten Sie mal...
*<i>IsDST</i> = 1 wenn Sommerzeit gilt, 0 sonst
*<i>GMST,LMST</i> = Greenwich und Local Mean Sidereal Time (in HH:MM)


=Bedienung=
=Bedienung=
Zeile 37: Zeile 79:
zeigt die aktuelle Modulversion an.
zeigt die aktuelle Modulversion an.


        It is not necessary to define an Astro device to use the data provided by this module<br/>
        To use its data in any other module, you just need to put <code>require "95_Astro.pm";</code> <br/>
        at the start of your own code, and then may call, for example, the function<br/>
        <code>Astro_Get( SOME_HASH_REFERENCE,"dummy","text", "SunRise","2019-12-24");</code><br/>
        to acquire the sunrise on Christmas Eve 2019</li>
        </ul>
==Attribute==     
==Attribute==     
   attr lt;name&gt; &lt;interval&gt;00
   attr &lt;name&gt; interval &lt;interval&gt;
Update-Interval in seconds. Default sind 3600 Sekunden, ein Wert 0 verhindert das periodische Update  
Update-Interval in Sekunden. Default sind 3600 Sekunden, ein Wert 0 verhindert das periodische Update.
Das Astro-Module verwendet verschiedene Attribute zur Bestimmung der Beobachterdefinition, die entweder im ''global''-Device von FHEM abgelegt sein sollten (siehe oben), oder als lokale Attribute gespeichert sind:
  attr &lt;name&gt; longitude &lt;value&gt;
  attr &lt;name&gt; latitude &lt;value&gt;
  attr &lt;name&gt; altitude &lt;value&gt;
Die beiden ersten Angaben erfolgen in Dezimalgrad, die dritte Angabe ist die Höhe in Metern über dem Meeresspiegel.
  attr  &lt;name&gt;  horizon &lt;value&gt;
Nutzerdefinierter Horizontwinkel in Dezimalgrad, Defaulwert 0°
 
==Readings Mondphasen==   
Die Readings zu den Mondphasen
  MoonPhaseI 5 2020-12-01 17:56:32
  MoonPhaseN 0.96 2020-12-02 10:00:20
sind wie folgt zu lesen. PhaseN gibt das Mondalter in Radians an,  Vollmond entspricht Pi (3,14). PhaseI entspricht einer Ganzzahl von 0 bis 7 für das Mondalter.


        <code>attr  &lt;name&gt;  longitude &lt;value&gt;</code><br/>
        <code>attr  &lt;name&gt;  latitude &lt;value&gt;</code><br/>
        <code>attr  &lt;name&gt;  altitude &lt;value&gt;</code> (in m above sea level)<br/>
        <code>attr  &lt;name&gt;  horizon &lt;value&gt;</code> custom horizon angle in degrees, default 0<br/> 
        These definitions take precedence over global attribute settings.
        </li>
            <li>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></li>
        </ul>
=Verwendung ohne Astro-Device=
=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 ist nicht notwendig, für die gelegentliche Verwendung der astronomischen Daten ein Device zu definieren. Es muss lediglich das Modul geladen werden, z.B. durch den Perl-Code
 
  LoadModule("Astro");
Es müsste also folgendes gehen:
Die Verwendung von ''require'' wird nicht empfohlen, da je nach Konstellation dabei Warnmeldungen im Logfile ausgegeben werden können.
 
Dann kann man z.B. durch den Code
1.) Ein beliebiges Device (sagen wir mit Namen "Bla") bekommt ein User Attribute mit Namen "horizon", dessen Wert  der gewünschte Horizontwinkel ist.
  my $somehash
 
  Astro_Get( $somehash,"somehash","text", "SunRise","2019-12-24");
2.) Der Funktionsaufruf müsste dann lauten
den Sonnenuntergang an Heiligabend 2019 berechnen.
Code: [Auswählen]
 
{Astro_Get($defs{"Bla"},"Bla","text", "CustomTwilightEvening")}
 


und den Sonnenuntergang für diesen Horizontwinkel liefern.
Die Funktion ''Astro_Get'' bekommt im ersten Argument eine hash-Referenz übergeben, die auch leer sein kann. Wenn sie aber nicht leer ist, versucht das Modul, sich die notwendigen Attribute aus diesem Hash zu holen (etwa geografische Länge und Beite). Es kann z.B. ein beliebiges Dummy-Device angelegt werden, sagen wir mit dem Namen "Blabla". Gibt man diesem als Attribut einen Horizontwinkel, oder andere Geodaten, kann man mit
  Astro_Get( $defs{"Blabla"},"Blabla","text", "CustomTwilightEvening","2019-12-24");
den Sonnenuntergang für diesen Horizontwinkel erhalten. Natürlich geht auch
  Astro_Get( $defs{"global"},"global","text", <reading>,<datum> );

Aktuelle Version vom 2. Dezember 2020, 16:58 Uhr

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). Die Berechungen sind für den Zeitraum 1900 - 2100 gültig.

Ein SVG-Bild der gegenwärtigen Mondphase gibt es unter dem Link 

 <ip addresse von fhem>/fhem/Astro_moonwidget?name='<device name>'

Optionale Web-Parameter sind 

[&size='<width>x<height>']
[&mooncolor=<color>]
[&moonshadow=<color>]
  • Calculations are only valid between the years 1900 and 2100
  • Attention: Timezone is taken from the local Perl settings, NOT automatically defined for a location
  • This module uses the global attribute language to determine its output data
    (default: EN=english). For German output set attr global language DE.
  • The time zone is determined automatically from the local settings of the
    operating system. If geocordinates from a different time zone are used, the results are
    not corrected automatically.

    Definition

    Ein Astro-Device wird definiert durch 

    define <name> Astro

    Dieses Modul verwendet das globale Attribut language zur Bestimmung der Anzeigedaten (Standard: EN=english). Für deutsche Ausgabedaten muss in FHEM das Attribut 

     attr global language DE

    gesetzt werden.

    Position des Beobachters

    Das Modul 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).

    Die Zeitzone wird nicht automatisch eingestellt, sondern aus der lokalen Perl-Installation bezogen.

    Ausgabedaten

    Readings mit dem Präfix Sun beziehen sich auf die Sonne, solche mit dem Präfix Moon auf den Mond.

    • Age = Winkel (in Dezimalgrad) des Körpers auf seiner Bahn
    • Az,Alt = Azimuth und Höhe (in Dezimalgrad) des Körpers über dem Horizont
    • Dec,Ra = Deklination und Rektaszension (in HH:MM) der Position des Körpers
    • Lat,Lon = geografische Breite und Länge der Position des Körpers
    • Diameter = Virtueller Durchmesser des Körpers in Bogenminuten
    • Distance,DistanceObserver = Entfernung (in km) des Körpers zum Erdmittelpunkt oder zum Beobachter
    • PhaseN,PhaseS = Nummerischer Wert und Stringwert für die Phase des Körpers
    • Sign = Tierkreiszeichen des Körpers auf seiner Bahn
    • Rise,Transit,Set = Zeiten (in HH:MM) für Aufgang, höchsten Punkt (Transit) und Untergang des Körpers

    Readings mit dem Präfix Obs beziehen sich auf den Beobachter

    Weitere Readings umfassen

    • Date,Dayofyear = Datum
    • JD = Julianisches Datum
    • Season,SeasonN = Stringwert und nummerischer Wert für die Jahreszeit
    • Time,Timezone raten Sie mal...
    • IsDST = 1 wenn Sommerzeit gilt, 0 sonst
    • GMST,LMST = Greenwich und Local Mean Sidereal Time (in HH:MM)

    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.

    Attribute

     attr <name> interval <interval>

    Update-Interval in Sekunden. Default sind 3600 Sekunden, ein Wert 0 verhindert das periodische Update. Das Astro-Module verwendet verschiedene Attribute zur Bestimmung der Beobachterdefinition, die entweder im global-Device von FHEM abgelegt sein sollten (siehe oben), oder als lokale Attribute gespeichert sind: 

     attr <name> longitude <value> 
 attr <name> latitude <value> 
 attr <name> altitude <value>

    Die beiden ersten Angaben erfolgen in Dezimalgrad, die dritte Angabe ist die Höhe in Metern über dem Meeresspiegel. 

     attr  <name>  horizon <value>

    Nutzerdefinierter Horizontwinkel in Dezimalgrad, Defaulwert 0°

    Readings Mondphasen

    Die Readings zu den Mondphasen 

     MoonPhaseI 5 2020-12-01 17:56:32
 MoonPhaseN 0.96 2020-12-02 10:00:20

    sind wie folgt zu lesen. PhaseN gibt das Mondalter in Radians an, Vollmond entspricht Pi (3,14). PhaseI entspricht einer Ganzzahl von 0 bis 7 für das Mondalter.

    Verwendung ohne Astro-Device

    Es ist nicht notwendig, für die gelegentliche Verwendung der astronomischen Daten ein Device zu definieren. Es muss lediglich das Modul geladen werden, z.B. durch den Perl-Code 

     LoadModule("Astro");

    Die Verwendung von require wird nicht empfohlen, da je nach Konstellation dabei Warnmeldungen im Logfile ausgegeben werden können. Dann kann man z.B. durch den Code 

     my $somehash
 Astro_Get( $somehash,"somehash","text", "SunRise","2019-12-24");

    den Sonnenuntergang an Heiligabend 2019 berechnen.

    Die Funktion Astro_Get bekommt im ersten Argument eine hash-Referenz übergeben, die auch leer sein kann. Wenn sie aber nicht leer ist, versucht das Modul, sich die notwendigen Attribute aus diesem Hash zu holen (etwa geografische Länge und Beite). Es kann z.B. ein beliebiges Dummy-Device angelegt werden, sagen wir mit dem Namen "Blabla". Gibt man diesem als Attribut einen Horizontwinkel, oder andere Geodaten, kann man mit 

     Astro_Get( $defs{"Blabla"},"Blabla","text", "CustomTwilightEvening","2019-12-24");

    den Sonnenuntergang für diesen Horizontwinkel erhalten. Natürlich geht auch 

     Astro_Get( $defs{"global"},"global","text", <reading>,<datum> );
    • Abgerufen von „http://wiki.fhem.de/w/index.php?title=Modul_Astro&oldid=34324“