Adapter-Entwicklung Dokumentation

smiling_Jack

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

Eisbaeeer

Ich wollte auch mal nachfragen, ob schon jemand in Hinsicht auf Dokumentation weitergekommen ist.

Ich hatte mir heute vorgenommen, mal das Howto von https://github.com/ioBroker/ioBroker/wi … nvironment anzugehen. Ubuntu schon in einer VM installiert und schon beim 1. Schritt steht da Webstorm herunterladen. Bam! Das kostet ja Geld, ausser man nutzt die Evaluierung. Was ist aber nach 30 Tagen? 129 Öggen im ersten Jahr?

Geht das nicht ohne kostenpflichtige Tools? Ich meine ja nur, wenn wir schon kostenlos coden, dann bestimmt nicht mit Hilfsmitteln, welche Geld kosten!?

Wie habt ihr Eure Adapter gebaut? In CCU.IO ging das noch mit nem PS Pad Editor. Ich versuch mich heute Abend mal weiter einzulesen. Ich würde mich immer noch über eine Anleitung für Einsteiger freuen.

Gruß Eisbaeeer

Jey Cee

Hi eisbaeeer, kannst auch mit notepad arbeiten. Das hab ich anfangs auch, dann hab ich mir doch webstorm installiert, um es zu testen. Und was soll ich sagen, damit geht die Entwicklung 10 mal schneller weil man mit einem klick testen kann und auch fehlerausgaben bekommt.

Webstorm lizenz gibts für um die 50€ oder für open source projekte kostenlos.

Bisher hab ich mich noch nicht entschieden ob ich die paar euros für webstorm ausgeb weil das echt sehr gut ist.

Eclipse ist eine Alternative, aber ich weiss nicht ob die noch immer kostenlos ist.

Bezüglich der Doku ist zu sagen das die Installation von js-controller falsch/veraltet ist. Das hab ich daran gemerkt das ein update des js-controller nicht möglich war. Es Empfiehlt sich der Anwenderanleitung für iobroker zu folgen um iobroker zu installieren.

Edit: Das Paket für die Entwicklung mit Nodejs von Eclipse nennt sich Nodeclipse und ist nicht auf der Eclipse seite zu finden sondern unter http://www.nodeclipse.org.

Gesendet von meinem Jolla mit Tapatalk

Bluefox

http://codecondo.com/best-ide-for-node-js/

Ich weiß noch, dass es VS+Node.JS Tools geht.

Atom sollte auch nicht schlecht sein.

Und https://github.com/node-inspector/node-inspector.

hometm

Zu Webstorm:

Ich habe mich vor ca. 4 Wochen auf der Seite von Webstorm um eine Gratis-Lizenz (open source license) beworben. Um die Kriterien für eine Gratis zu erfüllen reicht ein simpler Adapter (oder anderes Projekt), welcher unter eigenem Namen auf Github veröffentlicht ist.

Also:

Bei Webstorm das Formular ausfüllen, dann 3 Wochen warten, und schon bekommt man eine Gratis-Lizens mit einem Jahr Gültigkeit

Tobias

Gesendet von meinem VT10416-2 mit Tapatalk

Bluefox

~~@hometm:~~

Zu Webstorm:

Bei Webstorm das Formular ausfüllen, dann 3 Wochen warten, und schon bekommt man eine Gratis-Lizens mit einem Jahr Gültigkeit `
Man kann dann Lizenz jedes Jahr verlängern lassen.

Eisbaeeer

~~@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 `

Hi Stefan,

Ich habe jetzt alles nach deiner Anleitung in einer VM installiert. Läuft Super deine Anleitung. Ich hab keinen einzigen Fehler gefunden und die Umgebung läuft ohne Fehler auf Anhieb. Was mir jetzt noch fehlt 8-)

How to create the first own Adapter like HMM (Homematic Manager Integration?)

leider hört dort deine Anleitung hier auf ;-)

@all

Ich hab mir jetzt im Webstorm mal verschiedene Adapter angeschaut. Sicher macht es Sinn, einen bestehenden Adatper zu kopieren, um nicht die ganze Struktur selbst anlegen zu müssen!?

Ist es richtig, dass ich das meiste, funktionale des Adapters in der main.js finde?

Welche Dateien muss ich jetzt anfassen?

Was übernimmt Webstorm für mich?

Wo hilft mir hier Webstorm ausser beim debuggen und beim code highlight?

Wie integriere ich die node_module? Also wenn ich schon ein fertiges node_module vorliegen habe? Einfach reinkopieren?

Für was ist der versteckte Ordner .idea? Wird der von Webstorm erstellt?

Viele Fragen und ich freue mich schon auf die Antworten.

Ich muss schon sagen, das ganze ist um viele Stufen professioneller als ccu.io.

Ich hoffe nur, dass ich da noch mithalten kann ;-)

Grüße Eisbaeeer

kleinerDrache

So hab mich auch mal an die Adapter Entwicklung gesetzt. Webstorm free Lizens ist beantragt also mal warten.

Geht bei der Anleitung noch was ? Was auf Git steht iss ja eigentlich schon von anno Tabak :-) . Komme damit gar nicht klar da schon ioBroker selber mittlerweile ganz anders aussieht und eine Installation von vorhandenem Adapter zum debugen laut Anleitung scheitert (npm läuft durch aber der Adapter wir im Admin nicht angezeigt)

Wie nutze ich z.B. Git innerhalb von WebStorm ohne alles in zwei bis drei Ordnern unterzubringen ?
geht auch uploaden (auf Git) per Webstorm oder muss ich das extra machen ?
Ist die Installation von ioBroker immer noch so wie unter dev beschrieben oder muss ich eine voll Installation machen wie für Raspbian/Cubian ?
kann ich auch mein live System zum entwickeln hernehmen ? (Server per SSH oder lieber per Samba)
usw.

Community Forum

NEWS

Adapter-Entwicklung Dokumentation

Support us

819

32.4k

81.5k

1.3m