Gültige Reading- u. Devicenamen

[dev0]

Da ich immer wieder nach den gültigen Zeichen für automatisch angelegte Readings/Devices suche, habe ich das jetzt mal in zwei Subs verpackt:

Code Auswählen Erweitern


sub validDeviceName($;$) {
  my ($name, $repl) = @_;
  $name =~ s/:/_/g;                                #replace ":" by "_"
  $name =~ s/[^A-Za-z\d_\.]/$repl?$repl:""/eg;     #remove or replace with $repl
  return $name;
}

sub validReadingName($;$) {
  my ($name, $repl) = @_;
  $name =~ s/:/_/g;                                #replace ":" by "_"
  $name =~ s/[^a-zA-Z0-9\.\/_-]/$repl?$repl:""/eg; #remove or replace with $repl
  return $name;
}


Vielleicht ist das ja von allgemeinen Interesse und könnte in 99_Utils.pm/fhem.pl so oder ähnlich aufgenommen werden...
Einen Wiki Eintrag in https://wiki.fhem.de/wiki/DevelopmentModuleAPI würde ich dann ergänzen.

[rudolfkoenig]

Wozu ist $repl gut?
Mit einem falschen Inhalt (wie "?") kann man damit ungueltige Namen generieren.

[Markus Bloch]

Ich würde hier 2 Ansätze vorschlagen:

1. Eine einheitliche Funktion die prüft ob überhaupt ein übergebene Parameter ein gültiger Device-Name / Reading-Name ist. Es gibt mittlerweile mehrere Stellen in fhem.pl und auch ausserhalb wo Regexp definiert sind zur Prüfung auf gültigen Zeichen. Das würde ich mir wünschen zu vereinheitlichen und Funktionen zur Prüfung in fhem.pl bereitstellen wo die Gültigkeit an einer einzigen Stelle geprüft wird.

Dies ist insbesondere bei der Prüfung von manuell eingegebenen Definitionsnamen notwendig.

2. Wie von dev0 vorgeschlagen, eine Konvertierungsfunktion anzubieten für Readings-Namen die man dynamisch aus externen Content generieren möchte, wo alle unerwünschten Zeichen entfernt oder durch "_" ersetzt werden.

Gruß
Markus

[dev0]

Wozu ist $repl gut?

Individualität Ist aber verspielt und nicht wichtig, kann also weg. Mir geht es bei dem Vorschlag um einen einheitlich Weg, der zentral verwaltet wird, damit ich mich nicht mehr darum kümmern/nachdenken muß.

[rudolfkoenig]

Ich habe die Funktionen

goodDeviceName
makeDeviceName
goodReadingName
makeReadingName

zu fhem.pl hinzugefuegt.

[dev0]

Danke! Auch für die Ergänzung des Wikis.

[igami]

Ich habe für mich auch so eine sub, allerdings ersetze ich noch die Umlaute:

Code Auswählen Erweitern


sub string2name($) {
  my %mutated_vowelmap = ("ä" => "ae", "Ä" => "Ae", "ü" => "ue", "Ü" => "Ue", "ö" => "oe", "Ö" => "Oe", "ß" => "ss");
  my $mutated_vowelkeys = join ("|", keys(%mutated_vowelmap));
  my $string = shift;
  $string =~ s/($mutated_vowelkeys)/$mutated_vowelmap{$1}/g;
  $string =~ s/[^A-Za-z0-9\.\_]/./g;
  return $string;
}

Ich nutze das um Gerätenamen aus Raumnamen abzuleiten (z.B. Küche).

[Markus Bloch]

Hier noch ein kleiner Patch:

Code Auswählen Erweitern

Index: fhem.pl
===================================================================
--- fhem.pl     (revision 14931)
+++ fhem.pl     (working copy)
@@ -2475,7 +2475,7 @@
   return "Please define $old first" if(!defined($defs{$old}));
   return "$new already defined" if(defined($defs{$new}));
   return "Invalid characters in name (not A-Za-z0-9.:_): $new"
-                        if($new !~ m/^[a-z0-9.:_]*$/i);
+                        if(!goodDeviceName($new));
   return "Cannot rename global" if($old eq "global");

   %ntfyHash = ();


[rudolfkoenig]

Danke, eingecheckt, und aus der rename Fehlermeldung das : entfernt, ist ja nicht mehr zulaessig.

[zap]

Ich habe für mich auch so eine sub, allerdings ersetze ich noch die Umlaute:

Funktioniert halt nur innerhalb FHEM bzw. ggf. auf dem gleichen System. Sobald man Daten von einem externen System unter anderer Plattform abholt, muss man natürlich den dort eingestellten Zeichensatz berücksichtigen. Das kann dann beliebig komplex werden.

[Markus Bloch]

Funktioniert halt nur innerhalb FHEM bzw. ggf. auf dem gleichen System. Sobald man Daten von einem externen System unter anderer Plattform abholt, muss man natürlich den dort eingestellten Zeichensatz berücksichtigen. Das kann dann beliebig komplex werden.

Das ist aber Aufgabe des entsprechenden Moduls den Zeichensatz der Hardware zu berücksichtigen und ggf. zu konvertieren, bevor man aus den Daten Readingsnamen oder Devicenamen ableitet.

Gruß
Markus

[igami]

Wenn der Zeichensatz falsch ist wird es doch auch nicht als Umlaut erkannt. Ich benutze das nur innerhalb von FHEM, da sollten der Zeichensatz passen.

[RichardCZ]

Code Auswählen Erweitern

sub
goodDeviceName($)
{
    my ($name) = @_;
    return ($name && $name =~ m/^[a-z0-9._]*$/i);
}

habe ich in meinem Code in etwa geändert zu

Code Auswählen Erweitern

sub goodDeviceName {
    my $name = shift // return;

    return ($name =~ m/^[a-z0-9_][a-z0-9._]*$/i);
}


Leider ist ja der Programmcode nicht dokumentiert, aber in https://wiki.fhem.de/wiki/Erste_Schritte_in_FHEM steht ja, dass ein Punkt nicht an erster Stelle stehen darf. Das fängt mein Code ab, siehe beigefügtes Testfile.

[rudolfkoenig]

Punkt an ersten Stelle dient (wie im Unix) zum Verstecken.
Siehe auch https://fhem.de/commandref_modular.html#showInternalValues

[RichardCZ]

Punkt an ersten Stelle dient (wie im Unix) zum Verstecken.
Siehe auch https://fhem.de/commandref_modular.html#showInternalValues

Ok.

Dann wäre ich fast wieder bei

Code Auswählen Erweitern

sub goodDeviceName_new {
    my $name = shift // return;

    return ($name =~ m{\A[a-z0-9._]*\z}xmsi);
}

Dank meiner Microtestsuite sehe ich aber einen Unterschied: Der alte Code betrachtet den Namen '0' (Null) als nicht valide, der neue schon.
Wie ist da das gewünschte Verhalten? Will man führende Zahlen in Namen haben oder nicht?

Edith:

Will man "einen einzelnen Punkt" als validen Namen haben oder nicht?