Modul ConvertTimeZone (CTZ): Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung |
||
(2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 36: | Zeile 36: | ||
<pre> | <pre> | ||
use FHEM::Utility::CTZ qw(convertTimeZone getTZNames); | use FHEM::Utility::CTZ qw(convertTimeZone getTZNames reqModFail); | ||
</pre> | </pre> | ||
Das Modul stellt nachfolgend beschriebene Funktionen bereit. | Das Modul stellt nachfolgend beschriebene Funktionen bereit. | ||
=reqModFail= | |||
Die Funktion prüft, ob die vorausgesetzten Perl Module installiert sind und gibt im Fehlerfall das/die fehlenden Perl Module zurück. | |||
Sind alle benötigten Perl Module installiert wird <code>undef</code> zurück gegeben. | |||
Aufruf: | |||
:<syntaxhighlight lang="perl"> | |||
my $rmf = reqModFail(); | |||
if ($rmf) { | |||
# Fehlerbehandlung | |||
} | |||
</syntaxhighlight> | |||
= getTZNames = | = getTZNames = | ||
Zeile 115: | Zeile 130: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Parameter !! Optional !! Beispiel !! Beschreibung | !Parameter!!Optional!!Beispiel!!Beschreibung | ||
|- | |- | ||
| '''<code>name</code>''' || nein || | |'''<code>name</code>'''||nein||'LogDB'||Der Name des aufrufenden Device. | ||
|- | |- | ||
| '''<code>dtstring</code>''' || nein || '2022-03-09 22:17:45' || Der Original-Zeitstring der umgewandelt werden soll. Der Zeitstring kann auch Millisekunden enthalten. Die Form ist diesem Fall YYYY-MM-DD hh:mm:ss.xxx | |'''<code>dtstring</code>'''||nein||'2022-03-09 22:17:45'||Der Original-Zeitstring der umgewandelt werden soll. Der Zeitstring kann auch Millisekunden enthalten. Die Form ist diesem Fall YYYY-MM-DD hh:mm:ss.xxx | ||
|- | |- | ||
| '''<code> | |'''<code>pattern</code>'''||ja||'%Y-%m-%dT%H%M%S'||Das Pattern Format von 'dtstring'. Standard ist '%Y-%m-%d %H:%M:%S'. Weitere mögliche Pattern Muster sind unter [https://metacpan.org/pod/DateTime::Format::Strptime#STRPTIME-PATTERN-TOKENS DateTime::Format::Strptime] angegeben. | ||
|- | |- | ||
| '''<code> | |'''<code>tzcurrent</code>'''||ja||'Europe/Berlin'||Die Zeitzone des Original-Zeitstrings (dtstring). Es kann 'local' angegeben werden. In diesem Fall wird die Zeitzone des Systems versucht automatisch zu ermitteln. Das gilt ebenso wenn tzcurrent nicht angegeben ist. | ||
|- | |- | ||
| '''<code>writelog</code>''' || ja || 1 || 1 - der originale und der konvertierte Zeitstring werden mit der (ermittelten) Zeitzone (Abkürzung) im Log ausgegeben<br> 0 - es erfolgt keine Ausgabe im Log | |'''<code>tzconv</code>'''|| ja||'Asia/Singapore'||Die Zeitzone in welche der übergebene Zeitstring konvertiert werden soll. Ist tzconv nicht angegeben, wird 'UTC' verwendet. | ||
|- | |||
|'''<code>writelog</code>'''||ja||1||1 - der originale und der konvertierte Zeitstring werden mit der (ermittelten) Zeitzone (Abkürzung) im Log ausgegeben<br> 0 - es erfolgt keine Ausgabe im Log | |||
|} | |} | ||
Zeile 173: | Zeile 190: | ||
tzcurrent => 'UTC', | tzcurrent => 'UTC', | ||
tzconv => 'Europe/Berlin', # oder 'local' | tzconv => 'Europe/Berlin', # oder 'local' | ||
writelog => 0 | |||
}; | |||
my ($err, $dtconv) = convertTimeZone ($params); | |||
</syntaxhighlight> | |||
Ein weiteres Beispiel zur Umwandlung des erweiterten UTC Formats in die lokale Zeit: | |||
:<syntaxhighlight lang="perl"> | |||
my $name = "xxx"; | |||
... | |||
my $params = { | |||
name => $name, | |||
pattern => '%Y-%m-%dT%H%M%S', | |||
dtstring => '2022-09-09T173000.0000000Z', | |||
tzcurrent => 'UTC', | |||
tzconv => 'local', | |||
writelog => 0 | writelog => 0 | ||
}; | }; |
Aktuelle Version vom 10. September 2022, 08:23 Uhr
CTZ | |
---|---|
Zweck / Funktion | |
Zeitzonenumrechnung | |
Allgemein | |
Typ | Inoffiziell |
Details | |
Dokumentation | Thema |
Support (Forum) | Sonstiges |
Modulname | CTZ.pm |
Ersteller | DS_Starter (Forum /Wiki) |
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref! |
Das Modul CTZ.pm konvertiert Zeitstrings von einer Zeitzone in eine andere Zeitzone. So können zum Beispiel lokale Zeitangaben in UTC bzw. von UTC in lokale Zeit konvertiert werden. Das Modul ist sowohl zur Verwendung in FHEM-Modulen als auch in eigenen Routinen (99_myUtils) geeignet.
Auf dem System müssen die Perl-Module
DateTime DateTime::Format::Strptime
installiert sein. Sind diese Module nicht vorhanden, können sie leicht mit dem FHEM Installer bzw. mit folgenden Befehlen installiert werden:
sudo apt-get install libdatetime-perl sudo apt-get install libdatetime-format-strptime-perl
Das Modul muß vor der Verwendung eingebunden werden mit
use FHEM::Utility::CTZ qw(:all);
bzw. mit
use FHEM::Utility::CTZ qw(convertTimeZone getTZNames reqModFail);
Das Modul stellt nachfolgend beschriebene Funktionen bereit.
reqModFail
Die Funktion prüft, ob die vorausgesetzten Perl Module installiert sind und gibt im Fehlerfall das/die fehlenden Perl Module zurück.
Sind alle benötigten Perl Module installiert wird undef
zurück gegeben.
Aufruf:
my $rmf = reqModFail(); if ($rmf) { # Fehlerbehandlung }
getTZNames
Die Funktion getTZNames liefert eine Array Referenz zu einer Liste aller Zeitzonen, die mit diesem Modul verwendet werden können.
my $list = getTZNames ();
Mit einem get-Befehl kann zum Beipiel die komplette Liste abgerufen werden:
sub XXX_Get { my ($hash, @a) = @_; my $name = $a[0]; my $opt = $a[1]; my $getlist = "Unknown argument $opt, choose one of ". "tzg " ; if ($opt eq 'tzg') { my $atz = getTZNames (); return join "\n", @{$atz}; } else { return "$getlist"; } return; }
Es erscheint die Liste der verwendbaren Zeitzonen:
... Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belgrade Europe/Berlin Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Helsinki Europe/Istanbul ...
Die Notation der möglichen Zeitzonen wird in der Funktion convertTimeZone verwendet.
convertTimeZone
Mit der Funktion convertTimeZone wird ein übergebener Zeitstring in die Zeit der gewünschten Zeitzone konvertiert. Dieser Funktion wird eine Hashreferenz mit allen Funktionsparametern übergeben. Dieser Hash enthält sämtliche Parameter inkl. Werten. Zurück gegeben werden ein Error-Wert und der konvertierte Zeitstring.
Aufruf:
my ($err, $dtconv) = convertTimeZone ($params);
Der Parameter $params ist eine Referenz auf eine Hash-Struktur, welche die einzelnen Parameter enthält. Der Hash $params kann folgende Optionen beinhalten:
Parameter | Optional | Beispiel | Beschreibung |
---|---|---|---|
name |
nein | 'LogDB' | Der Name des aufrufenden Device. |
dtstring |
nein | '2022-03-09 22:17:45' | Der Original-Zeitstring der umgewandelt werden soll. Der Zeitstring kann auch Millisekunden enthalten. Die Form ist diesem Fall YYYY-MM-DD hh:mm:ss.xxx |
pattern |
ja | '%Y-%m-%dT%H%M%S' | Das Pattern Format von 'dtstring'. Standard ist '%Y-%m-%d %H:%M:%S'. Weitere mögliche Pattern Muster sind unter DateTime::Format::Strptime angegeben. |
tzcurrent |
ja | 'Europe/Berlin' | Die Zeitzone des Original-Zeitstrings (dtstring). Es kann 'local' angegeben werden. In diesem Fall wird die Zeitzone des Systems versucht automatisch zu ermitteln. Das gilt ebenso wenn tzcurrent nicht angegeben ist. |
tzconv |
ja | 'Asia/Singapore' | Die Zeitzone in welche der übergebene Zeitstring konvertiert werden soll. Ist tzconv nicht angegeben, wird 'UTC' verwendet. |
writelog |
ja | 1 | 1 - der originale und der konvertierte Zeitstring werden mit der (ermittelten) Zeitzone (Abkürzung) im Log ausgegeben 0 - es erfolgt keine Ausgabe im Log |
Als Rückgabewert wird ein Array mit zwei Rückgabewerten zurückgegeben.
Rückgabewert | Bedeutung |
---|---|
$err |
Falls bei der Konvertierung ein Fehler aufgetreten ist, enthält die Variable einen Text zum aufgetretenen Fehler. Ansonsten ist dieser Wert mit einem Leerstring gefüllt ($err = "" ).
|
$dtconv |
Wenn kein Konvertierungsfehler aufgetreten ist enthält die Variable den umgewandelten Zeitstring, ansonsten undef .
|
Beispiel zur Umwandlung eines Zeitstrings der lokalen Zeitzone in die koordinierte Weltzeit UTC mit Ausgabe im Log:
my $name = "xxx"; ... my $params = { name => $name, dtstring => '2022-03-09 22:17:45', tzcurrent => 'local', tzconv => 'UTC', writelog => 1 }; my ($err, $dtconv) = convertTimeZone ($params);
Im Log wird ausgegeben:
2022.03.11 21:12:52 1: FHEM::Utility::CTZ - original timestring: 2022-03-09 22:17:45 CET 2022.03.11 21:12:52 1: FHEM::Utility::CTZ - converted timestring: 2022-03-09 21:17:45 UTC
Die Konvertierung eines UTC-Zeitstrings in eine beliebige Zeitzone (siehe Funktion 'getTZNames') geschieht identisch, wobei in diesem Fall der Parameter tzcurrent den Wert 'UTC' enthalten muß:
my $name = "xxx"; ... my $params = { name => $name, dtstring => '2022-03-09 21:17:45', tzcurrent => 'UTC', tzconv => 'Europe/Berlin', # oder 'local' writelog => 0 }; my ($err, $dtconv) = convertTimeZone ($params);
Ein weiteres Beispiel zur Umwandlung des erweiterten UTC Formats in die lokale Zeit:
my $name = "xxx"; ... my $params = { name => $name, pattern => '%Y-%m-%dT%H%M%S', dtstring => '2022-09-09T173000.0000000Z', tzcurrent => 'UTC', tzconv => 'local', writelog => 0 }; my ($err, $dtconv) = convertTimeZone ($params);