Überarbeitung der Dokumentation

IP-Symcon
162

Hi Pio :slight_smile:

Schön mal wieder was von dir zu hören :slight_smile: Auch wenn leider nichts von meinen Wünschen dabei ist :wink:

Archive Control — IP-Symcon :: Automatisierungssoftware
> die Checkbox „Alle Variablenveränderungen aufzeichnen“ ausgewählt
>> die Checkbox „Alle Variablenänderungen aufzeichnen“ ausgewählt
…ist sogar noch im Screenshot abgebildet :wink: :stuck_out_tongue:

> Es können alle Werte betrachtet und manipuliert werden.
>> Es können alle Werte betrachtet und bearbeitet werden.
…manipuliert klingt so „falsch“/„schlecht“ :smiley:

  • Ansonsten ist diese Seite gut und verständlich geschrieben. Top :slight_smile:

WebHook Control — IP-Symcon :: Automatisierungssoftware

  • Nichts auffälliges. Gut lesbar und verständlich. Leider hab ich noch IPS 3.4…die WebHooks sind echt eine praktische Angelegenheit!

Calendar Control — IP-Symcon :: Automatisierungssoftware
> wird automatisch die Heizung gedrosselt um Energie zu sparen.
>> wird automatisch die Heizung gedrosselt, um Energie zu sparen.

> kann dies verhindert werden ohne eingerichteten Skripte oder Wochenpläne abzuändern oder manuell auszuschalten.
>> kann dies verhindert werden, ohne eingerichtete Skripte oder Wochenpläne abzuändern oder manuell auszuschalten.

Datenfluss — IP-Symcon :: Automatisierungssoftware
> (Die Optionen „Braces“, „Uppcase“ und „Hyphens“ müssen aktiviert sein).
>> Uppcase ODER Upcase ?! Weiß ich nicht, poste es deshalb einfach so :wink:

> In der Tabelle „Datenpakettypen der IPS I/O“ >> Virtiual I/O
>> Virtual I/O

Grüße,
Chris

163

Moin

Alles klar. Die Typos vertreibe ich dann demnächst.

Bei dem Thema „Uppcase“ ist es richtig geschrieben.
Es kommt ja von Upper Case und nicht von Up/Down :wink:

Vielen Dank aber fürs lesen und korrigieren.

164

https://www.symcon.de/forum/threads/29487-Doku-zu-Experteneinstellung-vom-Heatingcontrol?p=271669#post271669

165

Vergesst es, das waren selbst gebaute Funktionen :smiley:

166

Als Anregung hätte ich noch das mal alle IPS-Funktionen die es gibt auch in der Doku auftauchen. Ich geb zu manchmal bin ich auch zu Blind aber in letzter Zeit sind mir immer mehr Funktionen über den Weg gelaufen die zwar von der CodeCompletion vorgeschlagen werden aber im Handbuch nicht einmal erwähnt werden.

Eben las ich in diesem Thread das es sogar schon „externe“ Sammlungen von undokumentierten Befehlen gibt:
Thread Liste auslesbar?

Ich glaube da wäre sogar eher Handlungsbedarf als die „Formulierungen“ der existierenden Doku anzupassen…

167

Instanz „FS20 Sender“ in Version 3.4 nicht mehr vorhanden?

168

@Pio: Das könnte was für dich sein :slight_smile:
Kategorieauswahl im WebFront-Konfigurator nicht möglich

Grüße,
Chris

169

PHP-Befehl vom ImageGrabber fehlt in der Doku unterhalb Modulreferenz/ImageGrabber.
Michael

170

Moin!

Nach langer Zeit mal wieder ein Bericht meinerseits.
Es hat sich ziemlich viel getan in der Doku und vieles wurde schon auf die Version 4.0 vorbereitet.
Hier sei schonmal gesagt, dass es einige Stellen gibt, bei denen sich kleine Handgriffe im Vergleich zur 3.4 geändert haben. Leider sind wegen Fehlerhaftigkeit, Alterschwäche oder schlichtweg schlechte Formulierung diese Teile nicht erhalten geblieben.

Es wurden wieder an einigen Stellen Rechtschreibfehler korrigiert und Updates auf Version 4.0 hinzugefügt, welche ich hier nicht aufführen werde.

Archive Control:
Seite wurde überarbeitet und genauer beschrieben.
[AC_GetAggregatedValues — IP-Symcon :: Automatisierungssoftware](AC_GetAggregatedValues — IP-Symcon :: Automatisierungssoftware)

MBus:
Geräteliste aktualisiert.
https://www.symcon.de/service/dokumentation/modulreferenz/mbus/geraeteliste/

Programminformationen:
IPS_GetKernelStarttime und GetKernelRunlevel hinzugefügt.
https://www.symcon.de/service/dokumentation/befehlsreferenz/programminformationen/

WebServer:
Hauptseite auf aktuellen Stand gebracht.
https://www.symcon.de/service/dokumentation/modulreferenz/webserver/

EnOcean:
Update Geräteliste.
https://www.symcon.de/service/dokumentation/modulreferenz/enocean/geraeteliste/

Icons:
Neue Icons dokumentiert -> ToDo die adaptiven Icons hinzufügen und erklären
https://www.symcon.de/service/dokumentation/komponenten/icons/

FHZ:
FS20 - Das „Sie“ rausgeschmissen und Anpassung an 4.0.
https://www.symcon.de/service/dokumentation/modulreferenz/fhz1x00pc/fs20/

SDK-Module:
RegisterTimer und SetTimerInterval hinzugefügt.
https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/

Systeminformationen:
Fix von Sys_GetBattery und Sys_GetNetworkInfo
https://www.symcon.de/service/dokumentation/modulreferenz/system-informationen/

Instanzen - Konfiguratoren:
Farbtabelle hinzugefügt und generell überarbeitet
https://www.symcon.de/service/dokumentation/konzepte/instanzen/konfiguratoren/

digitalSTROM
Das „Sie“ entfernt und DS_RequestStatushinzugefügt
https://www.symcon.de/service/dokumentation/modulreferenz/digitalstrom/

IPS-868
PJ_DimServo hinzugefügt
https://www.symcon.de/service/dokumentation/modulreferenz/ips-868/servo-868/pj-dimservo/

Wiki:
Das Wiki wurde entfernt und eine vorläufige Zusammenfassung und ReDirects vom alten Wiki zu IPSView und den Artikeln eingerichtet.
https://www.symcon.de/wiki/

Systemvorraussetzung:
Die Systemvorraussetzungen haben sich ja durch die 4.0 wesentlich geändert.
Somit wurde diese auf 4.0 angepasst.
https://www.symcon.de/service/dokumentation/einfuehrung/systemvoraussetzungen/

Fernzugriff:
An Version 4.0 angepasst.
https://www.symcon.de/service/dokumentation/komponenten/tray/fernzugriff/

Installation:
Der komplette Installtionsbereich wurde bis auf „Datensicherung (ToDo)“ und die bisherigen Migrationen überarbeitet.
https://www.symcon.de/service/dokumentation/installation/

Der Leckerbissen zum Schluss. :smiley:
Verwaltungskonsole:
Die Verwaltungskonsole hat nun endlich Inhalt und zeigt nicht nur ein paar Screenshots.
Sicherlich ist es hier noch nicht vollständig, aber ein wesentlicher Überblick ist nun hier zu finden.
https://www.symcon.de/service/dokumentation/komponenten/verwaltungskonsole/

Ich möchte auch hier nochmal darauf hinweisen, dass auffallende Fehler, egal ob Rechtschreibfehler, fehlende Beiträge oder Wünsche bitte über „Feedback senden“ eingereicht werden. (Sehr gerne mit einer kleinen Beschreibung und/oder Link ins Forum zum dazugehörigen Beitrag etc.)
Dies erleichtert mir den Überblick zu wahren und die Sachen Stück für Stück zu verbessern.

Grüße
Pio :loveips:

171

-> geklärt, kein dokufehler, übernächstes update in der 4.0 korrigiert das.

-> done, nächstes Doku-Update sollte ne schöne Warningbox liefern auf
https://www.symcon.de/service/dokumentation/komponenten/visualisierungen/webfront/

-> done, nächstes Doku-Update bringt den Befehl auch in die Doku

172

EnOcean/Eltako Dimmer soll bestimmt FUD14 und nicht FUD12 heißen, oder?

173

Sehr gut! Der Fehler besteht scheinbar schon seit Ewigkeiten. Das hatte ich nur so übernommen.
Natürlich für EnOcean ist es der FUD14

Der FUD 12 kann natürlich über RS485 gebrückt werden auf EnOcean-Funk. aber das muss dann jeder selbst basteln.

Wird im nächsten Update angepasst.
Danke sehr.

174

Hinweis: die von IPS_GetModule() gelieferten ‚ModulName‘ wurden zu 4.0 geändert

Grüße,
Chris

175

Bitte bei der Verwaltungskonsole die Beschreibung ergänzen das man die IP vorgeben kann:

ips_console.exe /host[:port]

braucht man wegen „defektem“ autodiscovery leider immer häufiger und immer muss ich einen Forumsbeitrag suchen wo es mal erwähnt wurde :slight_smile:

176

Es hat sich wieder einiges in der Dokumentation getan.

Einige wichtige Änderungen der letzten Monate mal hier auf einen Blick.
Auf Typo Verbesserungen oder ähnliches gehe ich nicht ein.

Alle I/Os nun an einem Fleck beschrieben:
https://www.symcon.de/service/dokumentation/modulreferenz/io/

Im Entwicklerbereich hat sich sehr viel getan! Neue Funktionen, neues Excel/Android SDK.
https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/
Aber Hauptaugenmerk liegt natürlich auf der PHP-Modul Entwicklung
https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/

Die neuen adaptiven Icons sind dokumentiert
https://www.symcon.de/service/dokumentation/komponenten/icons/

Bei Z-Wave sind viele COMMAND_CLASSES hinzugefügt worden
Z-Wave — IP-Symcon :: Automatisierungssoftware

Die Beschreibung vom Archive Control und CSV-Struktur ist aktualisiert worden
https://www.symcon.de/service/dokumentation/modulreferenz/archive-control/datenformat/

Die Konfiguration der SPS Siemens S7 wurde hinzugefügt und wird in Zukunft noch erweitert
https://www.symcon.de/service/dokumentation/modulreferenz/sps-siemens-vipa-logo/

Eine allgemeine Beschreibung, wie man in IP-Symcon physikalisch defekte Geräte austauscht.
https://www.symcon.de/service/dokumentation/vorgehensweisen/geraete-austauschen/

Und der kleine Leckerbissen wie immer zum Schluss.
Die Darstellung von Objekten im WebFront und welche Vorraussetzungen wurde komplett überarbeitet.
https://www.symcon.de/service/dokumentation/komponenten/visualisierungen/objekt-darstellung/

Dies sind einzelne Stichpunkte welche in den letzten Monaten aktualisiert wurden.
Es sind gefühlt Massen an Typo-Korrekturen, Beispiele und neue Befehle an allen Ecken hinzugekommen.

Grüße
Pio

178

Wieder ein kleines Update:

Systemvariablen:
Lange wurde überlegt wie man dieses sehr unübersichtliche Thema verbessern kann.
Nun ist die zweite Version des Umbaus geschehen und die Tabellenstruktur wurde aufgebrochen und alle Objekte, welche Systemvariablen nutzen wurden verlinkt und von den Objekten selbst auf die Systemvariablen.
https://www.symcon.de/service/dokumentation/konzepte/skripte/systemvariablen/

Aktionsskripte:
Dieses Thema wurde komplett aufgebrochen und explizit erläutert, auch mit ein paar negativ Beispielen.
https://www.symcon.de/service/dokumentation/konzepte/skripte/aktionsskripte/
https://www.symcon.de/service/dokumentation/konzepte/variablen/variablenaktionen/
Variablenprofile — IP-Symcon :: Automatisierungssoftware

Popup- und Dummymodul:
PopupModul wurde hinzugefügt und die Objektdarstellung angepasst.
https://www.symcon.de/service/dokumentation/komponenten/visualisierungen/objekt-darstellung/
https://www.symcon.de/service/dokumentation/modulreferenz/dummy-modul/
Popup Modul — IP-Symcon :: Automatisierungssoftware

Sicherheit:
Aufgrund der Diskussion wurden alle schon dokumentierten Sicherheitsmaßnahmen an einem Ort dokumentiert und als Hauptthema zur Übersicht zusammengefügt.
Somit sollte es möglich sein, dass jeder sein System absichern und vor Zugriff von außen schützen kann.
https://www.symcon.de/service/dokumentation/sicherheit/

Und nochmals die Bitte:
Ich sehe an vielen Stellen immer wieder Anmerkungen oder Screenshots zu Dokumentation und möglichen Fehlern eben dieser.
Bitte nutzt die Feedback Funktion, die auf jeder Dokumentationsseite vorhanden ist! Das landet bei mir auf dem Schreibtisch.

feedback.jpg

179

Und wieder ein kleines Update der Dokumentation.

Wieder sind ein paar Typos den gnadenlosen Tod gestorben hier aber die etwas interessanteren Dinge:

Das WebFront und dessen Beschreibung der Unterpunkte Struktur/Darstellung/Mobile/Sicherheit/Benachrichtigung haben einen Overhaul bekommen und sollten nun wieder aktuell sein.
https://www.symcon.de/service/dokumentation/komponenten/visualisierungen/webfront/

Objekte und ihre Konfiguration wurden überarbeitet. Begriffe näher Erläutert.
https://www.symcon.de/service/dokumentation/konzepte/

Nachdem die Sicherheit ein extra Hauptpunkt geworden ist, ist nun auch die Datensicherung und das Backup erstellein/einspielen ein eigener Hauptpunkt geworden.
https://www.symcon.de/service/dokumentation/datensicherung/

Nach der Einführung zur Verbindungskonfiguration einer S7-1200 ist nun auch eine Beispielanwendung hinzugefügt worden.
https://www.symcon.de/service/dokumentation/modulreferenz/sps-siemens-vipa-logo/#Beispiel_mit_TIA_Portal

Die Systemvoraussetzungen haben nun eine Versionenübersicht bekommen, wo man nachsehen kann, welche IPS-Version mit welchem OS funktioniert.
https://www.symcon.de/service/dokumentation/einfuehrung/systemvoraussetzungen/

Eine erste Version des SDK für Skins ist online. Im wesentlichen wurden die Forum Informationen angepasst und nun in der Dokumentation festgehalten.
https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-skins/

Und wiedermal Danke für einige Typo-Meldungen und Verbesserungsvorschläge!

Grüße
Pio