Überarbeitung der Dokumentation

Am Wichtigsten :
In der Betriebsanleitung ist die Codierung der Adressbrücken falsch. Bei meinem RGB868 12/24V neueste Generation (mit IPS Zeichen unten rechts) ist „1“ also ID145 oben in der Ecke des Gehäuses. In der Anleitung beginnt oben mit „8“

Die Allgemeine Doku ist jetzt nur für die neue Generation mit interner gelber LED. Sie glimmt nicht mehr. Sie wechselt nach jedem senden den Zustand. Das gesamte Stripe blitzt glücklicherweise beim Anschalten nicht mehr auf.
Ist auch unwichtig. Nur sollte besser auf die verschiedenen Versionen aufmerksam gemacht werden. Es muss in der Zwischenzeit 4 Versionen existieren.

Nachdem ich auch wieder in der Module Entwicklung und Übersetzung geackert habe, gab es dennoch wieder kleinere Updates für die Doku.

Neben vielen kleinen Typos und Korrekturen haben sich 1-2 Kapitel doch stark geändert und Neue sind hinzugekommen.

Die Einführung.
Diese wurde vom bisherigen „Verkaufstext“ in eine Einleitung für den Aufbau und Funktionalität von IP-Symcon umstrukturiert. Ist für die Alteingesessenen vielleicht auch interessant.
https://www.symcon.de/service/dokumentation/einfuehrung/

IPS-868
Einführung des NetworkConfigurationTools für die neuen LAN-Gateways
https://www.symcon.de/service/dokumentation/modulreferenz/ips-868/

LCN
Die Geräteliste wurde eingefügt.
https://www.symcon.de/service/dokumentation/modulreferenz/lcn/

Mobile
Zusammenlegung der Dokumentationsseiten für Android und iOS.
Einhergehend Erklärung der neuen „symcon://…“ und „symcons://…“ Links.
https://www.symcon.de/service/dokumentation/komponenten/visualisierungen/mobile/#WebFront_Freigabelink

Connect Control
Erstellen des Eintrags in der Dokumentation.
https://www.symcon.de/service/dokumentation/modulreferenz/connect-control/

Verbindungsassistent
Erstellen des Eintrags in der Dokumentation.
https://www.symcon.de/service/dokumentation/komponenten/verwaltungskonsole/verbindungsassistent/

EnOcean
Tipps & Tricks: BaseIDTool zum einfachen Wechseln der BaseID eines EnOcean Geräts
https://www.symcon.de/service/dokumentation/modulreferenz/enocean/#Tipps_&_Tricks

1-Wire
Umbenennung der veralteten TMEX_ Befehlen zu OW_.
https://www.symcon.de/service/dokumentation/modulreferenz/1-wire/

Und wie gesagt kam es an vielen Stellen zu Korrekturen von kleinere Typos, Umbenennungen, Verbesserung der Leserlichkeit und Konsistenzarbeit bei der Formatierung und einheitlichen Namensgebung. Ebenso sollten nun alle Befehle der Modulreferenz in alphabetischer Reihenfolge sein.

Danke nochmal an alle, die sich hier im Thread, via PN oder über das „Feedback senden“ gemeldet haben. Eure Mithilfe hilft mir ungemein.

Grüße Pio

Moin Pio :slight_smile:

Schön mal wieder was von dir zu hören :slight_smile:

Bin nebenbei noch was am Basteln, aber die 1. Seite hab ich mir schon mal angeschaut :slight_smile:

Einführung — IP-Symcon :: Automatisierungssoftware
> Was IP-Symcon ist, ist auf der Produktseite beschrieben.
>> Was IP-Symcon ist, wird/wurde auf der Produktseite beschrieben.
?!?! ist ist liest sich „komisch“

> IP-Symcon verknüpft verschiedenste Geräte von verschiedenen Herstellern unter einem Dach und macht diese nach einem einheitlichen Schema innerhalb der Software zugänglich.
>> IP-Symcon verknüpft verschiedenste Geräte, von verschiedenen Herstellern, unter einem Dach und macht diese, nach einem einheitlichen Schema, innerhalb der Software zugänglich.

> Wenn die Verbindung steht, können Variablen und Zustände der Geräte von IP-Symocn ausgelesen und gesetzt werden. Das Gerät steht bereit zur Steuerung.
>> Wenn die Verbindung steht, können Variablen und Zustände der Geräte von IP-Symcon ausgelesen und gesetzt werden. Das Gerät steht zur Steuerung bereit.

> Über das technische Nervenzentrum die Verwaltungskonsole können die an den PC angeschlossenen und eingerichteten Geräte angesteuert werden.
>> Über das technische Nervenzentrum, die Verwaltungskonsole, können die an den Computer/Server/…!? angeschlossenen und eingerichteten Geräte angesteuert werden.

> IP-Symcon stellt anschließend auch die Visualisierung der eingerichteten Geräte zur Verfügung und über das WebFront werden Funktionen und Daten anschaulich zur Verfügung gestellt. Auch ist ein Steuern über die Visualisierung kein Problem.
>>>> IP-Symcon stellt anschließend („auch“ weg) die Visualisierung der eingerichteten Geräte zur Verfügung. Über das WebFront werden Funktionen und Daten angezeigt. Natürlich kann über die Visualisierung auch alles gesteuert werden.

> Viele Grundlagen können über die im Schnelleinstieg befindlichen Links erklärt werden.
>> Viele Grundlagen werden über die im Schnelleinstieg befindlichen Links erklärt.
…„können“ klingt so „unselbstbewusst“ und „komisch“ :slight_smile:

Später geht es weiter, muss jetzt erstmal die Terrarium-Lüfter-Steuerung austesten und automatisieren :smiley:

Danke und Grüße,
Chris

Wenn man schon „korrigiert“, könnte man ein Satzmonster auch verschwinden lassen. :wink: :smiley:

z.B.:
IP-Symcon verknüpft verschiedenste Geräte unterschiedlicher Herstellern unter einem Dach. Ein einheitliches Schema macht diese dann innerhalb der Software zugänglich.

Das Gerät ist zur Steuerung bereit.

Das technische Nervenzentrum ist die Verwaltungskonsole. Über sie können die an den Computer/Server/…!? angeschlossenen und eingerichteten Geräte angesteuert werden.

Wie bei I… entdecke die Möglichkeiten

PS: Nein, ich habe die neue Doku (noch) nicht gelesen.

Gruß
Bruno

Lieber Bruno :slight_smile:

Meine Korrekturen/Verbesserungsvorschläge sind nicht DIE PERFEKTE LÖSUNG für alles, sondern VORSCHLÄGE :slight_smile: Gerne darf sich jeder andere aus dem Forum daran beteiligen und seine Ideen/Meinungen mit Pio teilen :slight_smile:

Am Ende entscheidet Pio/IPS, wie wo was in der Doku steht. Ich/wir bringen nur Vorschläge. Keine Vorschläge = keine Verbesserung der Doku! Und wenn man 10 Leute diese paar Zeilen schreiben lassen würde, dann gäbe es vmtl. mindestens 9 verschiedene Vorschläge :slight_smile:

>> Und wenn man schon Verbesserungen kritisiert, dann sollte man es besser machen und nicht auch noch ein paar Fehler zusätzlich einbauen (Wörter vergessen, Rechtschreibfehler, …) :wink: :stuck_out_tongue:

Also nicht lang schnacken oder meckern, sondern lieber MACHEN :slight_smile:

Grüße,
Chris

Hi Chris,

habe das auch nicht als „DIE PERFEKTE LÖSUNG“ sondern als „VORSCHLÄGE“ angesehen. Daher gibt es von mir eben andere „VORSCHLÄGE“. Damit solltest Du eigentlich umgehen können. :cool:

Die Fehler sind Teil eines Suchspiels, oder, wie es auch so schön heisst: „Wer einen Fehler findet, darf ihn behalten“.

Schönen Abend
Bruno

Bevor ich mich hier auf Spielchen einlasse, nutze ich die Zeit lieber sinnvoll und mache weiter im Text… :wink:

IPS-868 — IP-Symcon :: Automatisierungssoftware

> Zur Einrichtung wird das IP-Symcon „Network Configuration Tool“ benötigt. Dieses steht zum Download bereit.
>> Zur Einrichtung wird das IP-Symcon „Network Configuration Tool“ benötigt. Dieses steht hier zum Download bereit.

> (Dies ist nur bei erstmaliger Installation nötig.
>> (Dies ist nur bei erstmaliger Installation notwendig.
…finde ich liest sich „schöner“ und „nötig“ wurde im Absatz davor schon verwendet

Mobile — IP-Symcon :: Automatisierungssoftware

> Falls Text erforderlich sein sollte, müssen auf Integer-Variablen genutzt werden.
>> Falls im Schalter Text gewünscht ist, müssen Integer-Variablen, mit einem entsprechendem Variablen-Profil, verwendet werden.

> Für alle losen Skripte, Medien und Variablen können entsprechende DummyInstanzen erstellen werden,
>> Für alle losen Skripte, Medien und Variablen können entsprechende Dummy-Instanzen erstellt werden,

> Sollte dieses WebFront noch nicht vorhanden sein, wird automatisch ein Konfigurator eingerichtet.
>> Sollte dieses WebFront in der App noch nicht vorhanden sein, wird automatisch ein Konfigurator eingerichtet.

> Somit kann zum Beispiel der Besuch Zuhause oder gar der Tagungsteilnehmer der Zugriff schnell auf das lokale WebFront ermöglicht werden ohne das manuelle Einstellungen nötig werden.
>> Somit kann zum Beispiel dem Besuch Zuhause oder dem Tagungsteilnehmer ein schneller Zugriff auf das lokale WebFront ermöglicht werden, ohne dass manuelle Einstellungen notwendig sind.

> gibt dieses Thema im Forum entsprechende Antwort: Veränderbarkeit von unveränderlichen Variablen
…ins Forum verlinken an dieser Stelle…ich weiß ja nicht… :-\

> Falls beim Ladevorgang ein JSON-Fehler auftritt, überprüfen Sie bitte, ob sie mindestens IP-Symcon 3.1 #3367 installiert haben.
>> Falls beim Ladevorgang ein JSON-Fehler auftritt, muss/sollte überprüft werden, ob mindestens IP-Symcon 3.1 #3367 installiert ist.
…„Sie“ wolltest du doch nicht mehr haben :slight_smile:

Grüße,
Chris

Bis hierhin alle Korrekturen gesichtet und viele für Gut befunden :wink: :loveips:

Connect Control — IP-Symcon :: Automatisierungssoftware

> Um den Symcon Connect Dienst nutzen zu können, ist eine aktive Subskription nötig.
>> Voraussetzung um den Symcon Connect Dienst verwenden zu können, ist eine aktive Subskription.

> Es sind folgend 3 Zugriffsmethoden vorhanden:
>> Die 3 folgenden Zugriffsmethoden sind möglich/vorhanden:

> Über die in der Adressleiste angezeigte Adreese, kann ab sofort von überall auf das WebFront zugegriffen werden.
>> Über die in der Adressleiste angezeigte Adresse, kann ab sofort von überall auf das WebFront zugegriffen werden.

> Es wird folgend eine verschlüsselte Verbindung aufgebaut.
>> Die Verbindung erfolgt verschlüsselt. (bitte noch ein paar Details zur verwendeten Verschlüsselung!!! :slight_smile: )

> Es ist empfohlen das WebFront mit einem Passwort zu sichern.
>> Das WebFront muss/sollte in diesem Fall mit einem Passwort gesichert werden.

> Im QR-Code wird der Link in Form eines WebFront Freigabelinks formatiert und öffnet somit automatisch die benötigte IP-Symcon App inklusive dem gewählten WebFront.
>> Im QR-Code ist der Link, in Form eines WebFront Freigabelinks, enthalten und öffnet automatisch die benötigte IP-Symcon App, inklusive dem gewählten WebFront. (beim letzten Komma bin ich mir unsicher // auch könnte man 1/2 Empfehlungen für eine QR-Code Software erwähnen, gerade wenn ihr danach erwähnt, das manche Software damit nicht klar kommt)

> Das als Standard eingerichtete E-Mail Programm wird geöffnet und es muss nur noch die Adresse des Empfängers eingetragen werden. Somit kann der Link und das damit verknüpfte IP-Symcon Dritten zur Verfügung gestellt werden.
>> Das als Standard eingerichtete E-Mail Programm wird automatisch geöffnet und es muss nur noch die E-Mail Adresse des Empfängers eingetragen werden. Auf diesem Wege kann der Link, und das damit verknüpfte IP-Symcon, Dritten zur Verfügung gestellt werden.

> Über eine installierte Verwaltungskonsole und der Angabe der URL kann hier eine verschlüsselte Verbindung genutzt werden.
>> So recht fällt mir kein sinnvoller letzter Satz ein, aber der hier klingt irgendwie seltsam und ist nicht sonderlich eindeutig, was damit gemeint ist (aus Sicht eines Einsteigers). Es geht vmtl. darum, dass über eine Verwaltungskonsole, aus der Ferne, unter Angabe der URL, die verschlüsselte Verbindung des Connect Moduls verwendet werden kann?!

Verbindungsassistent — IP-Symcon :: Automatisierungssoftware

> Sofern beim Verbinden ein Benutzername und Passwort erfordert werden sollten, können diese optional dauerhaft gespeichert werden.
>> Sofern zum Verbinden ein Benutzername und Passwort erforderlich sind, können diese optional dauerhaft gespeichert werden.

> Über die Schaltfläche „Optionen“ können einmal gespeicherte Benutzernamen und Kennwörter durch Löschen den jeweiligen Servers entfernt werden.
>> Über die Schaltfläche „Optionen“ können einmal gespeicherte Benutzernamen und Kennwörter, durch Löschen des jeweiligen Servers, entfernt werden.

> IP-Symcon bietet die einfache Möglichkeit an, eine Connect-Adresse per mail zu verschicken, die muss zum hinzufügen nur angeklickt werden.
>> IP-Symcon bietet die einfache Möglichkeit, eine Connect-Adresse per E-Mail zu verschicken, diese muss zum Hinzufügen nur angeklickt werden.

> Bitte die Verwaltungskonsole am lokalen Server versuchen zu starten. Überprüfen, ob der Server korrekt angeschlossen und gestartet ist.
>> Bitte die Verwaltungskonsole am lokalen Server („versuchen zu“ weg) starten und überprüfen, ob der Server korrekt angeschlossen und gestartet ist.

> Für die Verbindung mit der Verwaltungskonsole muss zusätzlich im Normalfall Port 82/TCP bzw. 3777/TCP erlaubt sein.
>> Für die Verbindung mit der Verwaltungskonsole muss zusätzlich, im Normalfall, Port 82/TCP bzw. 3777/TCP erlaubt sein.

1-Wire — IP-Symcon :: Automatisierungssoftware

> Voraussetzung für den Betrieb mit IP-Symcon ist der aktuelle 1-Wire Treiber (TMEX),
>> Der Treiber wird doch nur bei USB-Gateways benötigt, oder? Bei eurem und dem eService Online Ding braucht man den doch gar nicht?!

> Die ordnungsgemäße Funktion des Busses und die daran angeschlossenen Komponenten sollte mit dem…
>> Die ordnungsgemäße Funktion des 1-Wire Bus und der daran angeschlossenen Komponenten kann/sollte mit dem…

> Das System wird dann 1:1 verkabelt (sternförmige Abzweigungen).
>> Das System wird dann 1:1 verkabelt (sternförmige Verkabelung).

> Wenn Sie mehrere Adapter verwenden, können diese unter “Übergeordnete Instanz” angewählt werden. Wie sie eine neue übergeordnete Instanz erstellen können, finden Sie hier.
>> Wenn mehrere Adapter verwendet werden, können diese unter „Übergeordnete Instanz“ ausgewählt werden. Wie eine neue übergeordnete Instanz erstellt wird, kann hier nachgelesen werden.
…Sie sie Sie :wink:

> Geräte sollte im Suchdialog sofort oder nach einer kurzen Verzögerung angezeigt werden.
>> Geräte sollten im Suchdialog sofort, oder nach einer kurzen Verzögerung, angezeigt werden.

> Leider versenden die angeschlossenen Bausteine am 1-Wire-Bus nicht automatisch ihre Werte – sie müssen angefragt werden. Wie oft dies geschehen soll, dass können Sie im Timer angeben:
>> Am 1-Wire Bus angeschlossene Geräte versenden nicht automatisch ihre Werte - sie müssen ab-/angefragt werden. Wie oft dies geschehen soll, kann mit dem Timer festgelegt werden.

> Jede Abfrage kosten Zeit und belegt den Bus.
>> Jede Abfrage kostet Zeit und belegt den Bus.

LCN — IP-Symcon :: Automatisierungssoftware

> Mit Übernehmen wird die Änderung gespeichert.
>> Mit einem Kick auf „Übernehmen“ wird die Änderung gespeichert.

> Nach erfolgreichem Einloggen kann nun im Konfigurator auf dem Bus nach Modulen gesucht, …
>> Nach dem erfolgreichen Einloggen kann („nun“ weg) im Konfigurator auf dem Bus nach Modulen gesucht, …

> Sobald im Konfigurator ein Modul erstellt und auf die Konfigurationstaste gedrückt wurde,
>> Sobald im Konfigurator ein Modul erstellt und auf den Konfigurationsbutton/-knopf gedrückt wurde,

> im Nachhinein auf die “Instanzen aktualisieren”-Taste gedrückt werden.
>> im Nachhinein auf den “Instanzen aktualisieren”-Button/Knopf gedrückt werden.

https://www.symcon.de/service/dokumentation/modulreferenz/enocean/

> Dieses steht zum Download bereit
>> Dieses steht hier zum Download bereit (und das „hier“ als Link-Text verwenden)

> Jede hat unterschiedliche Vorgehensweisen bei der Konfiguration. (siehe unten im jeweiligen Abschnitt)
>> Die verschiedenen Vorgehensweisen zur Konfiguration werden in den folgenden Abschnitten beschrieben.

> Eine Geräte-ID (0-127) darf nur ein einziges Mal vergeben werden.
>> Jede Geräte-ID (0-127) darf nur ein einziges Mal verwendet werden.

> Der Suchdialog zeigt ein Gerät erst an, wenn Daten empfangen wurden. Bei einem Taster können die Tasten gedrückt werden, um einen Sendevorgang aufzurufen.
>> Der Suchdialog zeigt ein Gerät erst an, wenn Daten empfangen wurden. Bei einem Taster können die Tasten gedrückt werden, um einen Sendevorgang auszulösen.

> Weitere Informationen über die verwendete Technologie und Bezugsquellen gibt es auf der Seite von EnOcean.
>> Weitere Informationen über die verwendete Technologie und Bezugsquellen gibt es auf der Internetseite von EnOcean.

Grüße,
Chris

Das passt gut in diesen Thread, also verlinke ich das mal hier :slight_smile: In der Hoffnung, dass sich jemand erbarmt und da etwas Hand anlegt :wink:

Bessere Dokumentation der JSON RPC Schnittstelle

Grüße,
Chris

Da hat sich doch wat gravierendes eingeschlichen :smiley:

„Wenn die Verbindung steht, … IP-Symocn …“

gefunden hier:
Einführung — IP-Symcon :: Automatisierungssoftware
Gerätestatus

Bis hier hin alles verbessert was nützlich erschien.

Danke sehr wie immer. :smiley:

P.S.

Miniüberarbeitung der Dokumentation.
Zukünftig werde ich, wenn es sinnvoll ist, die Versionsnummern mit in die Befehle einbauen.
Aber habt nachsicht, dass dies ein iterativer Prozess ist und sicherlich noch etwas dauern wird, bis die meisten Befehle nachgebessert werden.
https://www.symcon.de/service/dokumentation/befehlsreferenz/skriptverwaltung/ips-getscript/
https://www.symcon.de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariable/
https://www.symcon.de/service/dokumentation/befehlsreferenz/medienverwaltung/ips-getmedia/
https://www.symcon.de/service/dokumentation/befehlsreferenz/linkverwaltung/ips-getlink/

Ganz schön frech der Herr :smiley: :stuck_out_tongue:

Das mit den Versionsnummern wurde ja auch Zeit :stuck_out_tongue: :wink:

Moin!

Datenformat — IP-Symcon :: Automatisierungssoftware
>> Ist wohl veraltet. Windows hat ja mittlerweile auch eine Testversion mit CSV :wink:

AC_GetAggregatedValues — IP-Symcon :: Automatisierungssoftware
>> Hier könnte man noch die Erklärung der einzelnen Werte im Array mit einbauen und/oder einfach eine Übersicht, was für Werte man da jeweils zurück bekommt.
Beispielausgabe:

[Avg] => 0.015055467511886
[Duration] => 74458
[LastTime] => 1418240457
[Max] => 1
[MaxTime] => 1418187834
[Min] => 0
[MinTime] => 1418166000
[TimeStamp] => 1418166000

Grüße,
Chris

Es hat sich einiges getan bei den Betriebsanleitungen. Im Shop gibt es jetzt zu jedem Gerät eine. Sogar die Jumperbelegung des RGBW-868 stimmt jetzt. Allerdings werden jetzt die ACK Eingänge nicht mal erwähnt :confused:

Und die Verlinkungen in der Doku, z.B. in der Modulreferenz ist noch nicht nachgeführt.

Allerdings werden jetzt die ACK Eingänge nicht mal erwähnt

Die bewerben wir auch nicht mehr und sie können ggf. ein einer neuen Revision des Gerätes wegfallen.

paresy

Hi!

Gibt es in der Doku irgendwo 1-2 Sätze und/oder Screenshots, wie man am besten ein WebFront für die Apple Watch aufbaut? Soweit ich mich richtig erinnere war da irgendwas mit Kategorie, darunter nur Dummy Module und dann die Links zu den Variablen?!

Oder kann man noch unterteilen mit irgendwas in einem Dummy? Durch noch einen Dummy? Links rechts hoch runter wischen ist was? …?

…wenn ich nicht blind war, dann würden sich in der Doku 1-2 Sätze und ein paar Screenshots als sehr hilfreich erweisen :wink:

Grüße,
Chris

Hier gibt es noch etwas das überarbeitet werden müsste, bzw. um ausreichend Infos ergänzt werden muss :slight_smile:
…weil so kann man damit wenig anfangen :wink:

WWWReader_Update Page geht auf RPI nicht

Grüße,
Chris

Moin Moin
In den letzten 1,5 Monaten sind wieder ein paar Seiten in die Doku hinzugekommen.

Neben vielen kleineren Typo Korrekturen und Updates auf aktuelle Inhalte sind noch folgende umfangreichere Themen hinzugekommen.

Archive Control:
Es wurden einige Funktionen nachgepflegt.
Archive Control

Webhook:
Der Eintrag zum Webhook wurde eingepflegt.
Webhook Control

Calendar Control:
Der Eintrag zum Calendar Control wurde eingepflegt.
Calendar Control

Und im Rahmen der Modulentwicklung wurde der Bereich zum SDK stark erweitert/umstrukturiert.
Entwicklerbereich
Sicherlich Interessant ist auch im speziellen der Eintrag zum Datenfluss.
Datenfluss

Ich hoffe das sind ein paar sprechende Informationen.
Und ich hoffe die Doku wächst und gedeiht auch in eurem Sinne.
Wie geschrieben, es wurden viele viele kleine Verbesserungen gemacht, die ich nun hier nicht alle aufzählen möchte.
Aber die Doku wird stetig weiterentwickelt.

Grüße
Pio