Autor Thema: Dokumentation update required  (Gelesen 934 mal)

Offline martinp876

  • Developer
  • Hero Member
  • ****
  • Beiträge: 11023
Dokumentation update required
« am: 27 Juni 2021, 10:42:31 »
ich beantrage, dass die Beschreibung insbesondere der Zerntralen Funktionen sauber und verständlich dokumentiert werden.
Zentrale Attribute sollten in einem Block zu finden sein, die Bedeutung dorteinheitlich und unmissvertändlich nachzulesen sein.
Mich ärgert es ständig, wenn ich etwas einauen will und jedes mal nicht 100% erkennen kann, wie das Kommando funktioniert. So schwer ist eine korrekte Doku nun auch wieder nicht. Ich will hier nicht den Code also Doku heranziehen müssen.

Nun Konkret:
gerade wollte ich für HMCCU (egal) STATE korrekt setzen (was hier eine kleine Kathastrophe ist). Also Attr stateFormat. Beschreibung gelesen:
Findet man ganz unten in readingFNAttributes - weiss man.
Zitat
Modifies the STATE of the device, shown by the list command or in the room overview in FHEMWEB.
==> Modifies the internalVal STATE. Period.
Zitat
If not set, its value is taken from the state reading.
==>Default is the reading "state". => könnte man bei einer Beschreinung von STATE unterbringen. U.a. gibt es hier unschöne Einschränkungen bei Notifies - das ist einen eigenen Absatz wert.
Zitat
If set, then every word in the argument is replaced by the value of the reading if such a reading for the current device exists.
If set (eh klar)
Jedes Wort im Argument wird mit den Wert des Readings ersetzt, wenn so ein Reading existiert. Hä?
Also "stateFormat <readingName>" setzt internal STATE auf den Wert des Readings "readingName". Werden nun einzelne Worter des Attributs geparsed? Wird der Defautl gesetzt, wenn das Reading nicht existiert?
Ist das Kommando (ReadingsVal($NAME,<readingName>,ReadingsVal($NAME,"state",'undef'))?
Zitat
If the value of this attribute is enclosed in {}, then it is evaluated.
Perfekt. Warum ist $NAME nicht zulässig?



Zitat
statevals <text>:<text>[,...]
Define substitution for values of set commands. The parameters text are available as set commands.
Example:
attr my_switch statevals on:true,off:false
set my_switch on

Wir lese ich das ? Können wir die Worte sauber definieren.
values of set commands: Das sind also  nicht die Komamdos sondern die parameter (so werden sie glaube ich immer bezeichnet - nicht values). Wir reden also nicht von Kommandos sondern von den Parametern eines Kommandos.
Text wird also mit text ersetzt. herrlich. <set_text>:<exec_text> ist möglich?
set my_switch on  macht nun was? wird das eingegeben oder ausgeführt?

statevals <cmd_text>:<exec_text>[,...]
Define substitution for set-command parameter-string. In the parameter-string of each set command <cmd_text> will be sibstituted by <exec_text>.
set <entity> <cmd> <paramlist> (param list is the complete list of all parameter given
foreach (stateVals-pair){
  exec_param =~ s/cmd_text/exec_text/;
}
Replacement will be cumulativ. replacement order:  left side pair will be replaced first.

Example:
attr my_switch statevals on:true,off:false
set my_switch on
will issue the command
set my_switch true

Findet das Replacement nun statt nachdem der Parameter-string in parameter zerlegt wurde oder vorher? Wird die Schleife also einmal für ParameterString ausgeführt oder je Parameter?
Muss ich das nun im Code nachsehen? oder alles expermentell ermitteln?






Offline yoda_gh

  • Developer
  • Full Member
  • ****
  • Beiträge: 116
Antw:Dokumentation update required
« Antwort #1 am: 27 Juni 2021, 12:03:17 »
Hast Du Patches dazu?

Offline martinp876

  • Developer
  • Hero Member
  • ****
  • Beiträge: 11023
Antw:Dokumentation update required
« Antwort #2 am: 27 Juni 2021, 13:03:57 »
unklar.
ich will nicht die Doku für den Entwickler schreiben - insbesondere des Kernals. Auf Commandref level macht das doch der Entwickler.
Das sind 2 Beispiele - da müsste man einmal drüber schauen
Wichtiger - Ich könnte bestenfalls dokumentieren, wie es gerade geht. Bei Stateformat vermute ich, dass $NAME im {} expression funktionieren sollte und es nur ein Bug ist. Muss der Entwickler beurteilen und klarstellen.

Offline Otto123

  • Tester
  • Hero Member
  • ****
  • Beiträge: 19530
  • schon mal restore trainiert?
    • Otto's Technik Blog
Antw:Dokumentation update required
« Antwort #3 am: 27 Juni 2021, 14:55:31 »
Wird der Defautl gesetzt, wenn das Reading nicht existiert?
...
Perfekt. Warum ist $NAME nicht zulässig?
wenn das reading nicht existiert wird nichts ersetzt - > Sonst werden alle Wörter im Wert des Attributes durch das entsprechende Reading des Gerätes ersetzt (soweit vorhanden).
...
weil es an der Stelle $name ist ;) mMn deshalb weil es der Name des Gerätes selbst ist. Bei notify ist $NAME der Name des auslösenden Gerätes und nicht des Geräte selbst.
« Letzte Änderung: 27 Juni 2021, 22:30:00 von Otto123 »
Viele Grüße aus Leipzig
RaspberryPi B B+ B2 B3 B3+ ZeroW,HMLAN,HMUART,Homematic,Fritz!Box 7490+7412,WRT1900ACS-OpenWrt,Sonos,VU+,Arduino nano,ESP8266

Offline zap

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3872
    • HMCCU
Antw:Dokumentation update required
« Antwort #4 am: 27 Juni 2021, 22:09:40 »
Eigentlich dachte ich, dass die Doku von HMCCU ganz gut ist, aber die Beschreibung von statevals ist tatsächlich irreführend. Insofern danke für den Hinweis, v.a. auch deshalb, weil statevals ab Version 4.4 eigentlich nur noch aus Kompatibilitätsgründen existiert und nur noch eine untergeordnete Rolle spielt.
Ich passe die Beschreibung an.
2xCCU3, diverse Komponenten (Fenster, Rolladen, Themostate, Stromzähler, Steckdosen ...)
FHEM mit Raspi für CCU Integration.
IOBroker für UI (VIS), Hue, Sonos usw.
Maintainer der Module FULLY, Meteohub und HMCCU (Schnittstelle CCU-FHEM = best of both worlds approach

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 24524
Antw:Dokumentation update required
« Antwort #5 am: 28 Juni 2021, 08:32:09 »
Zitat
ich beantrage, dass die Beschreibung insbesondere der Zerntralen Funktionen sauber und verständlich dokumentiert werden.
Da diese Anforderung subjektiv ist, kann ich es nicht objektiv erfuellen.

Ich kann aber zusagen, dass ich die in fhem.pl verarbeiteten Attribute, die hier angebotenen Funktionen, bzw. die aus fhem.pl angesprochenen Funktionen beschreibe. Ich setzte das auf meine Aufgabenliste.

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 24524
Antw:Dokumentation update required
« Antwort #6 am: 11 Juli 2021, 16:56:53 »
Ich habe damit angefangen, und habe schonmal die globalen Variablen dokumentiert in docs/fhem_api.txt.

Bin inzwischen nicht mehr der Ansicht, dass eine Dokumentation in dieser Form eine Gute Idee ist:
- alle Aenderungen muessen in der Doku nachgezogen werden, was dazu fuehren wird, dass Doku und Code nicht immer synchron sein werden.
- diese Doku erwaehnt nur kurz, wozu die Variablen da sind, im Form eines Manuals bzw. Command-Reference. Es wird nicht reichen, um damit sinnvolle Module zu schreiben, dafuer waeren (je nach Anspruch und Vorwissen) mehrere Buecher notwendig.

Ich finde es viel sinnvoller auf konkrete Fragen im Forum eine Beschreibung oder gar eine Code-Anpassung zu liefern.

Da ich aber zugesagt habe, werde ich dieses Dokument fertigstellen.

 

decade-submarginal