Adapter-Entwicklung Dokumentation

versteckt

Eh klar, kann dir nur beipflichten.

Wenn über Weihnachten nicht viel los ist, werde ich mal meine Erkenntnisse bei der Adapter Entwicklung

zusammenfassen.

Eisbaeeer

Ich hab mir eben mal deinen Post mit rpi angesehen. Auch den Link von Bluefox zu der Adapterbeschreibung. Das Problem ist ja nicht, dass man sich dann die Zeit nimmt. Wer mal angefangen hat, den packt dann auch meist das Fieber, zumindest bei mir ist das so. Aber bis ich mich hinsetze und mir das selbst erarbeite, schreibe ich dann lieber einen neuen Adapter für ccu.io, weil ich schon weiß wie er funktioniert. Das kann doch nicht sein [emoji16]. Mein Ziel ist der Umstieg zu io.broker. Dafür schau ich mir auch gerne ein Tutorial an [emoji41]

Ich Supporte keine Anfragen per PM. Bitte immer im Forum Fragen stellen, eventuell hilft es auch den anderen!

https://github.com/Eisbaeeer

Headroom68

Hallo,

genau das ist auch mein Problem. Unter ccu.io war ein Adapter schnell gemacht.

Bei ioBroker mit Entwicklungsumgebung und Konfiguration von Github, npm, …. Alles Sachen, was ich eigentlich nicht machen möchte. Ich möchte einen Adapter schreiben. Ein Template kopieren, mit vi etwas tippern, Neustart der Applikation ... fertig :-)

Nun denn... iobroker hat auch Vorteile und missen möchte ich es nicht mehr (meine Frau ist anderer Ansicht)

Daher ist das neue Template schonmal ein guter Anfang (hoffe ich :) . Ich werde mich einarbeiten und versuchen die Doku zu erweitern.

Ein Video wird es von mir sicher nicht geben, dass darf gern ein anderer machen :D

Eine gute Doku und ein paar Beispiele (die dann hoffentlich noch einfach sind) wird dann auch andere ermutigen von ccu.io auf iobroker umzusteigen.

IMHO: Doku und Bugfix vor Features.

Bluefox

~~@Eisbaeeer:~~

JWas mich auch stark interessieren würde, wie ihr Eure Adapter debuggt? `
Ich hoffe, dass das du noch nicht gesehen hast:

https://github.com/ioBroker/ioBroker/wi … nvironment

Sonst weiß ich nicht, wie man noch es erklären kann. :)

versteckt

Naja, sooo schwierig ist ein Adapter nicht, habe erst heute einen neuen entwickelt.

Für mich sind immer die Fragen, was soll er können, global, multiple, dynamisch/statisch?!

Verwende auch eigentlich immer das gleiche Grundgerüst.

Gesendet von meinem iPhone mit Tapatalk

Eisbaeeer

~~@Bluefox:~~

~~@Eisbaeeer:~~

JWas mich auch stark interessieren würde, wie ihr Eure Adapter debuggt? `
Ich hoffe, dass das du noch nicht gesehen hast:

https://github.com/ioBroker/ioBroker/wi … nvironment

Sonst weiß ich nicht, wie man noch es erklären kann. :) `
Hatte ich noch nicht gesehen. Das sieht sehr vernünftig aus.

Aber das meine ich. Man muss sich irgend wie alle Infos zusammensuchen. Mir war auch neu, dass es eine Entwicklungsumgebung gibt. Ubuntu als Grundlage ist ja auch kein Problem. Es wird halt bei allen Wiki davon ausgegangen, dass man das Konstrukt schon kennt. Mir fehlt im Wiki z.B. Noch, "Was brauche ich, um einen Adapter zu entwickeln". Ich benötige Programm A, B und C. Früher reichte pseditor und node. Ich hoffe nicht, dass ich den Eindruck vermittel, hier rumzumosern. Ganz im Gegenteil. Ich will auf io.broker umsteigen und es auch anderen ermöglichen. Denn das System lebt von Adaptern. Um so mehr Adapter, um so mehr User. Und daran hapert es in meinen Augen Moment. Die meisten Adapter wurden von ccu.io migriert, aber sehr viel neues gibt es noch nicht.

Die neue io.broker Struktur ist eine geniale Basis. Das muss ich schon sagen. Da habt ihr einen riesen Schritt gemacht. Und ich möchte nicht wissen, wie viele Stunden Arbeit da reingeflossen sind. Meine Hochachtung.

Grüsse Eisbaeeer

Gesendet von meinem Z30 mit Tapatalk

versteckt

Sollte meine Antwort negativ rübergekommen sein, war nicht so gemeint.

Ich komme auch von ccu.io und hab mich dann irgendwann hingesetzt und angefangen.

Aber ich gebe dir schon recht, es ist am Anfang etwas schwierig reinzukommen.

Wenn man dann aber mal alles hat, funktioniert es recht gut.

Gesendet von meinem iPhone mit Tapatalk

smiling_Jack

@Eisbaeeer

es währe schön wenn du deine adapter auch in iobroker zum laufen brings.

Ich kann ja mal ein Video machen wie man mit einem neuen Adapter anfängt und ihn debugt und wo man welche Infos finden kann. Hast du wünsche auf die ich speziell eingehen soll ?

Eisbaeeer

@smiling_Jack

Hey, das wäre super.

Ein einfacher Adapter, idealerweise der Beispieladapter, welcher schon oft angesprochen wurde. Wichtig wäre, wie man vom Beispiel zum fertigen Adapter mit npm Installation kommt. Früher war das so, Adapter geschrieben, wenn alles funktionierte, per Git zum Mergen bereitgestellt. Mir stellt sich zum Beispiel die Frage, wo die Adapter gehostet werden. Was muss ich Schritt für Schritt tun, um vom Konstrukt bzw. Von der Idee ( da kannst du auch gerne einfach eine Datei einlesen und einen Wert in die Datenbank schreiben, einen Wert aus der Datenbank lesen, etc. Einfache Sachen, es soll ja nicht um die Programmierung von Javascript gehen), bis zum fertig installierbaren Adapter. Ach ja, es wäre mir noch ganz wichtig, wie man die fertigen node-js Objekte (node modules) integriert, denn da verwende ich doch einige. Das wäre super cool, wenn du da ein Tutorial machst.

Gruß Eisbaeeer

Gesendet von meinem Z30 mit Tapatalk

StefSign

Hallo,

ich habe damals viel Zeit in die Dokumentation von https://github.com/ioBroker/ioBroker/wi … nvironment reingesteckt

und freue mich sehr wenn es jemand gebrauchen kann.

Da wären wir auch schon bei der Frage:

Was kann man noch verbessern?

Danke

Stefan

Communicate

Hallo Stefan, der Link funktioniert leider nicht :-(

von unterwegs gesendet

htrecksler

https://github.com/ioBroker/ioBroker/wiki

im Link fehlt am Ende ein"ki" für "wiki"

Eisbaeeer

Hallo zusammen.

Ich hab noch keine Zeit gefunden, mich da reinzuarbeiten.

Das Problem ist eben, dass das Wiki nicht wirklich ein Howto ist, an dem man sich durchangeln könnte.

Hoffe ja immer noch auf ein Video oder ein Howto.

Grüße Eisbaeeer

Bluefox

Kann man das als HowTo betrachten?

https://github.com/ioBroker/ioBroker.template

Und für Widgets: http://forum.iobroker.net/viewtopic.php … ate#p13205

htrecksler

Ich habe bereits einen eigenen Adapter der auch sehr zuverlässig läuft. Jetzt möchte ich einen weiteren Adapter entwickeln und diese Anleitung (Post von Bluefox) als Anleitung verwenden.

Ich werde mich genau an die Schritte halten und Fragen die sich mir stellen hier posten. Ich denke, wenn ich die Fragen habe, werden andere diese Fragen auch haben. Vielleicht kann man auf diese Weise die Anleitung optimieren.

Die Anleitung ist komplett in Englisch. Ich selber habe damit kein Problem, ich könnte mir aber vorstellen, das andere damit durchaus ihre Schwierigkeiten haben. Ich bin gerne bereit die Übersetzung zu übernehmen. Was muss ich dafür tun damit nicht irgendwer meine Übersetzung abtippen muss?

Gleich zu Beginn stellt sich mir die erste Frage:

unter Steps steht als erstes

download and unpack this packet from github https://github.com/ioBroker/ioBroker.template/archive/master.zip or clone git repository git clone https://github.com/ioBroker/ioBroker.template.git

Ich habe mich für die Download Variante entschieden und erhalte eine zip.Datei

ioBroker.template-master.zip

Wenn ich Sie "entpacken" will muss ich mich für ein Verzeichnis entscheiden in dem die Datei entpackt werden soll.

Welches Verzeichnis muss das sein? A. auf einem Windows-System B. auf einem Raspi

Auf einem Windows System vermute ich mal ist dieser Pfad der richtige?

C:\Program Files\iobroker\node_modules

Bluefox

~~@htrecksler:~~

Ich habe bereits einen eigenen Adapter der auch sehr zuverlässig läuft. Jetzt möchte ich einen weiteren Adapter entwickeln und diese Anleitung (Post von Bluefox) als Anleitung verwenden.

Ich werde mich genau an die Schritte halten und Fragen die sich mir stellen hier posten. Ich denke, wenn ich die Fragen habe, werden andere diese Fragen auch haben. Vielleicht kann man auf diese Weise die Anleitung optimieren.

Die Anleitung ist komplett in Englisch. Ich selber habe damit kein Problem, ich könnte mir aber vorstellen, das andere damit durchaus ihre Schwierigkeiten haben. Ich bin gerne bereit die Übersetzung zu übernehmen. Was muss ich dafür tun damit nicht irgendwer meine Übersetzung abtippen muss?

Gleich zu Beginn stellt sich mir die erste Frage:

unter Steps steht als erstes
download and unpack this packet from github https://github.com/ioBroker/ioBroker.template/archive/master.zip or clone git repository git clone https://github.com/ioBroker/ioBroker.template.git
Ich habe mich für die Download Variante entschieden und erhalte eine zip.Datei
ioBroker.template-master.zip
Wenn ich Sie "entpacken" will muss ich mich für ein Verzeichnis entscheiden in dem die Datei entpackt werden soll.

Welches Verzeichnis muss das sein? A. auf einem Windows-System B. auf einem Raspi

Auf einem Windows System vermute ich mal ist dieser Pfad der richtige?
C:\Program Files\iobroker\node_modules

```` `  

Es ist schön wie du es angegangen bist. Ich denke am besten wäre die Anleitung auf github einfach erweitern, so dass eventuell keine Ungenauigkeiten bleiben.

Man darf das Paket irgendwo entpacken, dabei unter Punkt 5 steht
> 5\. to use this template you should copy it into …/iobroker/node_modules directory and then create an instance for it with iobroker.admin
Dabei dachte ich kann ich beide systeme abdecken (Win/Linux), aber falls es doch unklar ist, dann konnte man das erweitern.

` > Under linux this is normally /opt/iobroker/node_modules

and under windows C:\Program Files\ioBroker\node_modules (warning: you must be an administrator to copy files in this location) `

Wirst du pull requests auf github stellen?

Man konnte auch Readme.DE.md machen, ich bin nur froh.

htrecksler

Ahhh… als ich bei Punkt 5 angekommen bin war mir das Verzeichnis auch klar.

Erst komplett lesen und dann schreiben. :D :D

Ich würde die "Readme.DE.md" gerne machen. In welchem Format hättest Du die gerne? Dürfen Screenshots enthalten sein?

Ich bin gerade dabei einen neuen Adapter nach der Anleitung zu erstellen. Parallel dazu schreibe ich auf Basis Deiner Anleitung eine deutsche Übersetzung (allerdings etwas ausführlicher Schritt für Schritt - mit Hinweis auf eventuelle Fallen in die man tappen kann).

Derzeit mache ich das in OneNote (Windows Fan eben :D )

Aber ich nehme Dir gerne Arbeit ab. (Dann kannst Du Features machen)

Bluefox

~~@htrecksler:~~

Ahhh… als ich bei Punkt 5 angekommen bin war mir das Verzeichnis auch klar.

Erst komplett lesen und dann schreiben. :D :D

Ich würde die "Readme.DE.md" gerne machen. In welchem Format hättest Du die gerne? Dürfen Screenshots enthalten sein? `
Na ja. Git Hub kennt nur markdown (md). Am besten wäre in dem Format. Aber alle andere Formate auch mit Screenshots gehen auch. Muss dann konvertieren.

~~@htrecksler:~~

Ich bin gerade dabei einen neuen Adapter nach der Anleitung zu erstellen. Parallel dazu schreibe ich auf Basis Deiner Anleitung eine deutsche Übersetzung (allerdings etwas ausführlicher Schritt für Schritt - mit Hinweis auf eventuelle Fallen in die man tappen kann). `
Klingt sehr interessant. :) was genau?

Ich entwickele auch unter Windows nun mit Linux habe ich auch jetzt genug zu tun.

~~@htrecksler:~~

Derzeit mache ich das in OneNote (Windows Fan eben :D )

Aber ich nehme Dir gerne Arbeit ab. (Dann kannst Du Features machen) `

htrecksler

Ich hab mir heute mal ein paar Markdown Editoren angesehen. Im Laufe der Woche (oder kommendes Wochenende) schicke ich Dir eine Readme.de.md. Die Screenshots lasse ich erstmal weg. Im Prinzip geht es auch ohne Screenshots.

Erstmal mache ich die deutsche Übersetzung bis der Adapter im Admin sichtbar ist.

Dann wollte ich mich an die Funktionen im Adapter machen. (Settings, mynewadapter.js, index.html etc.)

Dort werde ich an der ein oder anderen Stelle sicher nochmal deine Hilfe in Anspruch nehmen.

Communicate

Hallo htrecksler,

bist Du schon weiter gekommen? Ich würde mich auch gerne an der Adapterentwicklung

versuchen - da käme mir ein How-To mit konkretem Beispiel natürlich genau recht :lol:

Würde ich freuen von Dir zu hören.

Grüße

Dominic

Community Forum

NEWS

Adapter-Entwicklung Dokumentation

Support us

775

32.5k

81.6k

1.3m