Überarbeitung der Dokumentation

Und weiter gehts! :D:p
Noch nicht Live aber sicherlich heute oder Morgen in der Doku:

Screenshots dazu und Beispiele angepasst.
https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/konfigurationsformulare/

Momentan noch nicht erreichbar aber wenn online hier zu finden.
Der Image Grabber!
https://www.symcon.de/service/dokumentation/modulreferenz/image-grabber/

Und noch ein paar kleinere Typos und Menüreihenfolgen etc. nichts Nennenswertes.

Grüße von der Doku Front. :cool::loveips:
Pio

Eine gaanz große Bitte habe ich zur Überarbeitung (ich glaub ich hab sie schon mal geäußert):

Ich habt eine „Modulreferenz“, die aber keine ist. Es werden Systeme und grundsätzlich im System verwendbare Befehle aufgezählt, manchmal noch unterstütze Module.

Aber weder wenn man einen Befehl anklickt steht bei welchem Modul (ich verstehe als Modul einen Aktor/Sender/Sensor/etc.) er verwendet werden kann.

Noch kann man ein Modul anklicken und die zu diesem Modul verwendbaren Befehle sehen.
Beispiel: Bei EnOcean stehen unterstütze Module, da findet man auch z.B. FSB14, welchen Befehl der Enocean-Befehle ich beim FSB14 verwenden kann steht nirgends, das kann man höchstens aus den Befehl-Bezeichnungen ableiten/erahnen.

Noch etwas schlimmer ist es bei HM, wo Befehle als „STRING“ mitgegeben werden, aber es findet sich keine Liste der erlaubten Strings…

… kurz gesagt es gibt keine API für die Hardware-Unterstützung, höchstens eine API zur IPS-Nutzung, mehr leider nicht, ersteres ist aber unabdingbar wenn man von einem „unterstützen System“ sprechen will.

Das mit HM ist auch unwichtig.
Diese Daten werden nicht vom IPS-Team festgelegt, sondern vom Hersteller EQ-3.
Darum wird immer auf die Datenpunktliste vom Hersteller verwiesen.
Außerdem kannst du diese Datenpunkte im Debug der jeweiligen HM-Instanz sehen.
Es macht auch meinen Sinn hier etwas eigenes zu Dokumentieren, weil jedes neues Gerät wieder andere Datenpunkte hat.
Michael

Also den Hinweis auf die HM-Doku findet man ausschliesslich in der Anleitung der Einrichtung unter Tipps/Tricks und wie das mit den Befehlen in Beziehung steht kann ich daraus auch nicht ableiten.

Und guck dir mal beispielhaft diese Seite an: HM_WriteValueString — IP-Symcon :: Automatisierungssoftware

Du kannst mir doch nicht sagen das diese Anleitung für jemanden der nicht schon Stunden im Forum verbracht, zig Seiten HM-Doku geblättert hat und bestenfalls noch HM-Scripte geschrieben hat verständlich ist.

Selbst jetzt verstehe ich den Text im organgenen Kasten nicht, von fehlenden Beispielen und unvollständiger Beschreibung der Parameter oben mal ganz abgesehen.

Aus meiner Sicht muss eine Software die sich damit rühmt ein System zu unterstützen auch die dafür notwendige Dokumentation mitliefern oder, wenn schon nicht selber erstellt, an allen notwendigen Stellen auf die Quellen verweisen, vor allem in einer Art das man nicht schon Profi sein muss um die Verbindung herzustellen.

Es wird viel zu häufig vergessen WER in solche Dokumentationen guckt, nicht die versierten Benutzer die mal nen Befehl vergessen haben, sondern die Neueinsteiger in so ein System und denen ist damit im Moment leider nicht geholfen.

Will sagen: Die Einstiegshürde in IPS ist schon extrem hoch, mit so einer Doku wird sie aber noch höher.

Sorry mal, aber wenn du den Text in der Orangen Box nicht verstehst; hast du die IPS Grundlagen nicht verstanden.
Man muss nicht auf jeder Seite der Doku die Grundlagen neu vermitteln.

Außerdem sollte sich schon der User welcher das System xyz einsetzt die dazugehörigen Grundlagen aneignen. Auch dies kann nicht Aufgabe der IPS-Doku sein. Hinweise zur Einrichtung der Schnittstellen zur Anbindung an IPS aber sehr wohl.

Sonst gibt es bald noch 50 Seiten mit Geräten wofür es nur 4 Befehle aber 34 Parameter gibt. Welche dann noch gepflegt werden muss, obwohl IPS sie immer sofort ohne Update unterstützt ? Das ist imho Unfug.
Was ist dann der nächste Schritt? Auch noch die Anschaltungen der Hardware in der IPS-Doku ?
Das kann es doch nicht sein.

Wer so etwas haben möchte kann sein Wissen gerne im Wiki teilen.

Wenn ich Z-Wave haben will, muss ich mich damit befassen; möchte ich 1-Wire sollte ich mich in die Verkabelung einlesen, etc…
Das kann nicht Aufgabe der IPS-Doku sein.

Auch andere Dokumentationen die ich tagtäglich in die Hand bekomme (egal ob Hardware oder Software), bauen aufeinander auf und setzen bestimmte Grundlagen an Wissen voraus.

Michael

Guten Morgen Doku Freunde.

Einmal ein Generalwort.
Mein/unser Ziel ist es die Dokumentation in einen Wortlaut und Format zu bringen.
Erster Schritt dafür war es die Einleitung und Grundlagen zu überarbeiten, damit alle Begriffe die folgend in der Dokumentation fallen auch beschrieben sind. Diese Begriffe sollten sich durch die Dokumentation ziehen wie ein roter Faden.
Was nicht Sinn der Doku sein soll ist es andere Systeme im kleinsten Detail zu Beschreiben. Dafür haben die Hersteller hoffentlich ihre eigene Dokumentation. Ein „Wie schalte ich mein Aktor ein“ wird somit in dieser Doku nicht zu finden sein, bzw. nur in sehr problematischen Fällen oder sehr generalisierend beschrieben.

Das noch nicht alle Artikel überarbeitet/vorhanden sind ist eine Tatsache und ich gebe mein Bestes dieses nachzuholen, aber bitte ich da um Geduld. Es gibt viele Baustellen und ich bin über jeden Hinweis glücklich.

Einhergehend sind die HM Befehle und auch die HM Hauptseite auf meiner ToDo-Liste.
Sowas wie leere Tabellen in der Parameterliste ist ein „No-Go“.
Auch das Fehlen des Links auf die Datenpunktliste wird sicherlich nachgeholt.
Der gelbe Kasten hat aber seine Gültigkeit nicht verloren und beschreibt korrekt die Funktion.

Die Erklärung was ein Modul ist, ist ebenfalls auf der ToDo gelandet (Ist noch nirgends explizit beschrieben).
Denn ein Modul in Bezug auf IP-Symcon beschreibt nicht das Gerät selbst, sondern in diesem Kontext einzig ein Software-Modul.

Ich hoffe ich konnte aufzeigen, was das Ziel dieser Doku sein soll. (und was nicht ;))
Ich freu mich immer über eure Mithilfe.

Grüße von der DokuFront
Pio

Mit der Erklärung des Moduls wäre schon mal ein Anfang, wobei dies natürlich in deiner Ausprägung für den Anwender schwer nachvollziehbar ist.

Ein Link zu den Datenpunkten an den Stellen wo man sie verwenden kann, gefüllte Parameterlisten und ein paar Beispiele würden mir ja schon genügen, das System zu erklären muss nicht umbedingt sein (wobei solche „Eigenarten“ wie das man Jalousien über Dimmwerte steuern kann könnte man ggf. auch erwähnen, aber das wäre mit der Befehl-Gerät-Zuordnung ja schon fast erschlagen)

Bei dem Link auf die HM-Doku wäre es super toll, wenn man einen Link auf die Doku und nicht einfach auf die Homepage hätte. Die Gefahr das der Link mal ein Dead-Link wird ist zwar höher, aber da die HM-Seite alles andere als Übersichtlich ist und man die Doku wirklich suchen muss und die richtigen Stichworte kennen muss, da glaube ich wäre es von Vorteil.

Bzgl. des Kasten: Ich sag nicht das er falsch ist, aber total unverständlich. Was meint „Ident“, der Begriff findet sich sonst nirgends, ich als Softwareentwickler kann mir gerade was ableiten, aber das wäre von der Bezeichnung her noch falsch, wenn überhaupt wäre Typ die richtige Bezeichnung (Typ = z.B. Boolean, Ident = Identifier, also ID, also Variablen-ID…das passt nicht)

IPS-868 — IP-Symcon :: Automatisierungssoftware

Um das System zu testen, muss das Kontaktkabel am Energiekontrollmodul und klicken auf “Werte auslesen”, danach auf “OK”.
Bei korrekter Einstellung kann im WebFront nun das Ergebnis gesichtet werden. Die Einbindung der anderen Geräte des IP-Symcon Funksystems 868 kann über die Geräteliste gefunden werden.

> Was ist mit dem Kontaktkabel? Einstecken?
> Auch der 2. Satz ist irgendwie…hmmm…naja :slight_smile:

Edit: @Hagbard: Ident = Identifier … finde ich jetzt nicht schwer zu verstehen. Variablen ID = Objekt ID — Aber „Ident“ ist ein EXTRA Identifier" für egal was … Kann in einer DummyInstanz oder einer Variable stehen und danach kann man suchen usw… Manchmal ganz praktisch.

Grüße,
Chris

Es ist aber trotzdem semantisch falsch, weil ein Identifier eine Variable eine Variable eindeutig identifiziert, was gemeint ist ist aber eine typisierung, was etwas anderes ist. Hier ist ja gemeint: Wenn die Variable vom Typ „String“ ist, dann verwende bitte HM_WriteValueString und wenn sie vom Typ „Boolean“ ist dann verwende bitte HM_WriteValueBoolean. Da ist Ident einfach der falsche Begriff.

Der Ident wird für den $Parameter benötigt. Das ist korrekt. Der Variablentyp für die korrekte Funktion. Auch das ist korrekt.

Dass wir an dieser Stelle den Ident besser erklären oder korrekt verweisen werden, wurde ja schon angesprochen.

paresy

Nein mit Ident ist der Ident der Statusvariable gemeint NICHT der Typ und auch nicht der Name!
Ist wichtig für $Parameter und die Funktion kümmert sich um den jeweiligen Typ.

Schau mal in den Reiter Statusvariablen deiner HM Instanz.
Dort findest du Ident und Name der Statusvariablen.

Aber danke dafür, der Begriff ist so auch noch nicht gefallen.
Ist auf der ToDo.

Ich habe heute ein paar Sachen in der Onlinedoku nachgeschaut und mir ist aufgefallen, dass bei den farblich hervogehobenen Boxen mit weißer Schrift auf orangem oder hellblauem Hintergrund die Helligkeitsdifferenz extrem schlecht ist. Aus der Sicht barrierefreies Webdesign ist dieser schwache Kontrast ein echter Makel.

Magst du mal einen Screenshot machen? Normalerweise hat die Schrift einen schwarzen Schatten, welche dem Kontrast sehr zweckdienlich ist. Siehst du den?

paresy

Ich sehe einen zarten Schatten aber den Kontrast Schriftfarbe zu Hintergrund finde ich extrem gering. Ich hab das mal mit verschiedenen Monitoren getestet und schon wenig vertikaler Blickwinkelwechsel macht das ganze schon schwieriger. Dabei liegt meine persönliche Sehschärfe korrigiert deutlich über 100%, habe ein einwandfreies Farbsehen und 3D ebenfalls topp. Frisch getestet. Wenn ich mir nun einen eingeschränkt Sehfähigen vorstelle, hat der wahrscheinlich ein Problem.
Weiße Schrift auf hellem Blau ist aber auch wirklich ne Herausforderung.

Hallo Boui,

ich sehe die von dir beschriebene Problematik. Wir werden uns dazu Gedanken machen. Der Schatten war unser erster Versuch das Problem zu lösen, aber wir können sicherlich noch mehr schaffen.

Gruß,
gucky

Hallo!

Ich vermisse eine Übersichtsgrafik:
Da könnte man darstellen wie z. B. KNX-Sensor (Temperatur) zum IPS-PC „geht“, in IPS-PC verarbeitet wird. (Visualisiert und geloggt)
Dann wieder Ausgang auf Homematic - Aktor oder…usw.
Einfache Beispiele…Das ist zwar ein bisschen beschrieben aber mit Bild doch viel übersichtlicher.

Hab einige Bekannte denen war nicht klar dass das alles kreuz und quer verknüpft werden kann.

Schönen Gruß:)
Egon

Guten Morgen an die Doku-Fanatiker :wink:

Es hat sich einiges getan.

Hier mal ein paar wesentliche Änderungen die „Sichtbar sind“ :cool:

Der komplette Bereich von IPS-868 wurde überarbeitet. Auch ist der LuftGüteSensor mit dazu gekommen.
https://www.symcon.de/service/dokumentation/modulreferenz/ips-868/

Auf Anregung hin Vebesserung der FunctionCode-Tabelle (ich find leider nicht mehr den Urheber)
https://www.symcon.de/service/dokumentation/modulreferenz/modbus-rtu-tcp/

Ebenfalls auf Anregung hin (hier in diesem Thread ein Posts vorher)
Weitere Überarbeitung der HomeMatic Seite und auch der Befehle. Sollte nun etwas klarer und eindeutiger sein.
Ebenfalls Auftrennung -> BidCos Service seperat als Unterseite.
https://www.symcon.de/service/dokumentation/modulreferenz/homematic/

Unter Vorgehensweise ist das Thema „Zweites WebFront erstellen“ rausgeflogen und dafür unter dem normalen WebFront eintrag eingebunden worden.
https://www.symcon.de/service/dokumentation/komponenten/visualisierungen/webfront/#Weiteres_WebFront_einrichten

Hinzugekommen ist ein neues Thema unter Vorgehensweise zum Thema PushNotifications und funktionsweise für „Benutzergruppen“.
https://www.symcon.de/service/dokumentation/vorgehensweisen/pushnotification-benutzergruppen/

Die Seite Text-To-Speech sowie Befehle wurden ebenfalls überarbeitet.
https://www.symcon.de/service/dokumentation/modulreferenz/text-to-speech/

  • Wie immer ein paar kleinere Typos, Screenshots aktualisierungen, welche aber weniger Interessant sind
    Wie immer bin ich offen für Kritik in jeglicher Form :smiley:

@egonkernien
Deine Anregung stimmt sehr wohl und der erste Schritt wird wohl eine Grafik werden, welche den Begriff „übergeordnete Instanzen“ aufgreift.

Grüße von der Doku-Front
Pio

Hi Pio,

da war aber jemand fleißig :slight_smile: Weiter so :slight_smile:

IPS-868 — IP-Symcon :: Automatisierungssoftware
> Das LAN-Gateway bekommt bei Anschluss ans Netzwerk und aktivierten DHCP eine IP-Adresse zugewiesen.
>> Das LAN-Gateway bekommt, bei Anschluss ans Netzwerk und aktivierten DHCP, eine IP-Adresse zugewiesen.

> Steht solch ein Router nicht zur Verfügung, so kann der Lantronix DeviceInstaller genutzt werden(Download).
>> Steht solch ein Router nicht zur Verfügung, [u]XXX[/u] kann der Lantronix DeviceInstaller genutzt werden[b] LEERZEICHEN /b.

> Nach der Auswahl des betreffenden XPort im Objektbaum kann die IP-Adresse abgelesen werden.
>> Nach der Auswahl des betreffenden XPort, im Objektbaum, kann die IP-Adresse abgelesen werden

> die zur eineindeutigen Identifizierung des Geräts in einem Netzwerk dient
>> die zur eineindeutigen Identifizierung, eines/des Gerätes, in einem Netzwerk dient

> Die MAC-Adresse des LAN-Gateways befindet sich unter der Plastikabdeckung des Geräte
>> Die MAC-Adresse des LAN-Gateways befindet sich unter der Plastikabdeckung des Gerätes

> Bei Eingabe der IP-Adresse in einen beliebigen Browser steht ein Lantronix-Web-Interface zur Verfügung
>> Bei Eingabe der IP-Adresse, in einen beliebigen Browser, steht ein Lantronix-Web-Interface zur Verfügung

> Nachdem jedes einzelne Geräte korrekt angeschlossen worden ist
>> Nachdem jedes einzelne Gerät korrekt angeschlossen wurde

> Das genaue Verfahren zum korrekten Anschließen kann der Dokumentation des jeweiligen Gerätes entnommen werden; ebenfalls die Geräte-ID. (Geräteliste]
>> Das genaue Verfahren, zum korrekten Anschließen, kann der Dokumentation des jeweiligen Gerätes entnommen werden; ebenfalls die Geräte-ID. (Geräteliste)

> Hier muss “Client Socket” ausgewählt und der Dialog abermals bestätigt werden.
>> Hier muss “Client Socket” ausgewählt und der Dialog bestätigt werden.

> Daraufhin muss die Checkbox vor “Socket öffnen” aktiviert werden
>> Warum ist hier „Checkbox…“ in FETT geschrieben?

> Die IP-Adresse des LAN-Transceivers (Näheres: siehe Installation) muss bei „Host“
>> Die IP-Adresse des LAN-Transceivers [u](siehe Abschnitt „Installation“)[/U] muss bei „Host“

>>>> Und allgemein wurde, besonders im letzten Absatz, sehr viel KANN verwendet :wink: Du scheinst das Wort zu lieben :smiley: :wink:

Grüße,
Chris

Um die IP-Adresse selbst zu vergeben (z.B. falls kein DHCP-Server vorhanden ist) müssen folgende Schritte beachtet werden.

Um die IP-Adresse selbst zu vergeben (z.B. falls kein DHCP-Server vorhanden ist), müssen folgende Schritte beachtet werden.

Den hast Du vergessen.

Schande über mein Haupt :smiley: Aber ich wollte nur testen, ob du noch brav aufpasst, was ich hier so für einen Mist verzapfe :wink: :stuck_out_tongue:

Grüße,
Chris