Adapter-Entwicklung Dokumentation
-
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
-
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. -
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
-
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.
-
-
Hallo kleiner Drache, ja die Anleitung ist alt, dennoch taugt sie zum Entwickeln.
Die Installation sollte nur zum Entwickeln genutzt werden. Installatieren würde ich nach der regulären Anleitung.
Sonst sollte das mit der Doku passen, musst halt nur die pfade entsprechend deiner installstion ändern und berücksichtigen das sich die Struktur der ordner geändert hat. Der Template Adapter wurde überarbeitet, kann sein das du die Alte version instsllierst aufgrund der Anleitung. Schau mal auf GitHub nach iobroker-template, da ist auch eine Anleitung zur Installation dabei.
Webstorm kann direkt mit Git genutzt werden, kann sein das man git händisch installieren muss. Für eine Anleitung am besten google nutzen.
Gesendet von meinem Jolla mit Tapatalk
-
Klar Pfade müssen angepasst werden.
Github auch klar aber was clone ich da ? ioBroker, iobBroker.js-controller oder was?
Einen Adapter nach Anleitung installieren funktioniert nicht weder mit z.B. iobroker.hmm noch mit dem iobroker.template also bleib ich beim Debuggen hängen !?!
Unter Windows muss ich da als Administrator ran ?
Sorry ich hoffe ich nerve mit so vielen Fragen Net
-
Nein du nervst nicht, ich finde es gut wenn jemand sich an die Entwicklung wagt. Leider ist der einstieg nicht ganz einfach und ich hab das bisher erst einmal gemacht.
Du clonest gar nichts, du erstellst ein neues projekt in github. Danach holst du dir den template Adapter und passt ihn an wie es in der Readme beschrieben ist. Wenn das erledigt ist lädst du das ganze in dein Projekt hoch. Von dort installierst du es dann in iobroker. Das geht auf der Admin seite von iobroker. Dort ist auf der Adapter übersicht links oben ein symbol, das dritte von links, dort drauf klicken. Im nächsten Fenster gibst du den link zu deinem projekt auf github ein, dann wird der Adapter installiert. Auf der instanzen übersicht muss der Adapter deaktiviert sein.
Wie du webstorm mit dem git repository verknüpfst kann ich dir nicht erklären, das ist zu lange her. Dafür finden sich tutorials im internet.
Wie man Webstorm dann Konfiguriert ist in der Developer Dokumentation sehr gut beschrieben.
Gibt es beim versuch Adapter zu installieren fehler? Bitte log anhängen wenn dem so ist.
Adminrechte sind bei der installation von iobroker und Adaptern nötig. Bei der Arbeit mit Webstorm geht es ohne.
Gesendet von meinem Jolla mit Tapatalk
-
Also das mit Git und WebStorm hab ich begriffen.
Adapter installieren zum Debuggen geht in der aktuellen Version von Js-Controller nur wenn ich sie aus der Repo oder per link im Admin Panel installiere.
Installiere ich den Adapter wie in der Anleitung beschrieben per npm im ordner ".. /iobroker/node_modules/" tauchen sie im Controller nicht auf.
Installiere ich den Adapter im Ordner ".. /iobroker/node_modules/iobroker.js-controller/" (Steht irgendwo in der Adapter Entwicklung wäre zum Debuggen) ist er zwar nachher im Controller vorhanden es lässt sich aber keine Instanz hinzufügen.
Naja funktioniert jetzt erstmal. Wenn ich noch Unterschiede zur Anleitung finde poste ich sie.
-
ich muss hier nochmal was nachfragen.
Irgendwie vermisse ich ein paar Erklärungen in der Anleitung:
1. Wie Debuge ich z.B. das Admin zu meinem Adapter ?
2. auf welche events reagiert Adapter.0n('message'…...?
3. wie genau funktioniert das mit "getForeignObjects"?
-
1. Wie Debuge ich z.B. das Admin zu meinem Adapter ? `
Nach jeder Änderung "iobroker upload adapterName" aufrufen.Und dann im admin F5 zu drucken. (Wichtig)
Ich benutze Chrome fürs debuggen.
2. auf welche events reagiert Adapter.0n('message'…...? `
auf alle die mit sendTo('adapterName.0', …) gesendet werden. Z.B. aus javascript Adapter (aus admin Seite, oder aus anderen Adapter)3. wie genau funktioniert das mit "getForeignObjects"? `
Wenn du getForeignObjects('')* aufrufst, dann bekommst du nur die Objekte für alle Adapter (kann SEHR viel sein)Die Objekte sehen dann wie folgt aus:
getForeignObjects(adapter.namespace + '.*', function (err, objs) { console.log(JSON.stringify(objs, null, 2)); }); => { "sonos.0.root.192_168_1_55.state_simple": { "type": "state", "common": { "def": "false", "type": "boolean", "read": "true", "write": "true", "role": "media.state", "desc": "Play or pause", "name": "state_simple", "mobile": { "visible": true, "admin": {} } }, "native": { "topic": "sonos/0/root/192_168_1_55/state_simple" }, "_id": "sonos.0.root.192_168_1_55.state_simple", "enums": {}, "children": [] }, "sonos.0.root.192_168_1_55.state": { "type": "state", "common": { "def": "stop", "type": "string", "read": "true", "write": "true", "values": "stop,play,pause,next,previous,mute,unmute", "role": "media.state", "desc": "Play, stop, or pause, next, previous, mute, unmute", "name": "state", "mobile": { "visible": true, "admin": {} } }, "native": { "topic": "sonos/0/root/192_168_1_55/state" }, "_id": "sonos.0.root.192_168_1_55.state", "enums": {}, "children": [] }, ... }Normalerweise muss ein Adapter auf die andere Objekte nicht zugreifen.
Ich empfehle die Funktion getStatesOf zu nutzen:
adapter.getStatesOf(function (err, _states) { console.log(JSON.stringify(_states, null, 2)); });Zurück kommt ein Array mit der Liste von allen Objekten, die zu dieser Instanz gehören:
[ { "type": "state", "common": { "name": "Sensor1", "def": 0, "type": "number", "read": true, "write": false, "role": "level.temperature", "desc": "1wire sensor", "unit": "°C" }, "native": { "id": "10.C8F148010800", "property": "temperature" }, "_id": "owfs.0.wires.Sensor1" }, { "type": "state", "common": { "name": "Sensor2", "def": 0, "type": "number", "read": true, "write": false, "role": "level.temperature", "desc": "1wire sensor", "unit": "°C" }, "native": { "id": "10.040349010801", "property": "temperature" }, "_id": "owfs.0.wires.Sensor2" } ] -
Danke damit komme ich erstmal weiter hoffe ich
-
Danke damit komme ich erstmal weiter hoffe ich
`Das hoffe ich auch [emoji12][emoji23]
Gesendet von meinem iPhone mit Tapatalk
-
hmpf
Ich denke ich werds wohl aufgeben. Ich kapiere einfach die Struktur von ioBroker nicht (iss ja auch nirgends beschreiben) welche Funktionen gibt es überhaupt ??
Gibt es irgendwo ne KOMPLETTE Funktionsliste von ioBroker ? (mit Parametern bitte)
Bin leider nur Javascript Anfänger.
Sorry ioBroker ist ein erstklassiges Projekt aber ohne vernünftige Doku ist jeder der nicht mindestens Studiert hat aufgeschmissen. Und ich hab weder Lust noch Zeit den ganzen Code erst zu durchforsten (wer macht was) um einen Adapter zu bauen den Ihr als Profis wahrscheinlich in 20 Minuten dahinklatscht.
Soll jetzt keine Abwertung eurer Arbeit sein. Der Broker ist allemal besser als z.B. Fhem oder Openhab aber ohne Doku geht mal gar nicht.
Trotz allem meine Hochachtung an die Programmierer von ioBroker ich bin dafür anscheinend zu blöde
-
Ohh nein …... [emoji22][emoji25][emoji21]
Gesendet von meinem iPhone mit Tapatalk
-
Bin leider nur Javascript Anfänger. `
Da bist du schon mal 100fach weiter als ich. Leider bin ich immer noch js-Legastheniker.Bitte nicht aufgeben. Ich weiss, dass du hier alle nötige Unterstützung bekommen wirst!
Meines Wissens gab es mal einen default Adapter oder so ähnlich, an dem.man sich hätte orientieren können.
Du hast das Pech, dass genau zu der Zeit in der du angefangen hast alle die dir hätten helfen können anscheinend in Urlaub waren. Von Bluefox weiss ich es, von ruhr70 und pix nehme ich es an. Auch weitere Adapterentwickler waren die letzte Zeit ziemlich ruhig.
Was brauchst du denn vorrangig für Unterstützung?
Seinem posting entnehme ich, Fass du gerne ein Telefonbuch mit Rezepten hättest, durch das du dich in einem stillen kämmerlein durcharbeiten willst.
Ich glauve nicht, dass es do ezwas gibt und denke, Fass der Lernprozess mit "interaktiver" Hilfe besser sein würde.
Gruß
Rainer
-
Na ein Kochbuch muss es nicht gerade sein lach aber so ein paar grundlegende Infos wären schon schön.
Ein gut mit Kommentaren durchsetzter Demo-Adapter wäre ein Traum. Hab jetzt gefühlte 1000 Adapter in meine Dev Umgebung installiert und die laufen auch alle. Nur Dumm das jeder anders aufgebaut ist, (nicht was das Programmieren an sich angeht ist klar das die alle anders sind) aber irgendwie fehlt ne saubere Grundstruktur. Im Template sind z.B. ein Paar Funktionen angegeben die immer vorhanden sein sollen aber gefunden hab ich die nur im Template in fast jedem anderen Adapter fehlen sie entweder ganz oder teilweise. Stehe gerade da wie Ochs vorm Berg.
Ein Teil der Funktionen die aufgerufen werden, haben irgendwie gar keinen Bezug zur Aktuellen JS Datei, da mir die Beschreibungen zu diesen Funktionen fehlen kann ich nicht nachvollziehen was die überhaupt machen. Ich will halt nicht nur irgendwas halbes zusammenkopieren das Irgendwie funktioniert (siehe LaCrosse Adapter). Ich will auch verstehen und meine JavaScript Kenntnise erweitern (komme ja von Python).
Und nochmal zum Kochbuch gg in C/C++ gibt es z.B. Doxygen womit ich wenigstens ne liste mit vorhandenen Funktionen und deren Parametern bekomme. Sowas wäre halt schon mal Endgeil.
Und nein werde wohl nicht aufgeben war nur der Frust das nicht einmal die einfachsten Sachen Die ICH in JavaScript kenne hier für mich verwendbar sind.
-
Na ein Kochbuch muss es nicht gerade sein lach aber so ein paar grundlegende Infos wären schon schön.
Ein gut mit Kommentaren durchsetzter Demo-Adapter wäre ein Traum. Hab jetzt gefühlte 1000 Adapter in meine Dev Umgebung installiert und die laufen auch alle. Nur Dumm das jeder anders aufgebaut ist, (nicht was das Programmieren an sich angeht ist klar das die alle anders sind) aber irgendwie fehlt ne saubere Grundstruktur. Im Template sind z.B. ein Paar Funktionen angegeben die immer vorhanden sein sollen aber gefunden hab ich die nur im Template in fast jedem anderen Adapter fehlen sie entweder ganz oder teilweise. Stehe gerade da wie Ochs vorm Berg.
Ein Teil der Funktionen die aufgerufen werden, haben irgendwie gar keinen Bezug zur Aktuellen JS Datei, da mir die Beschreibungen zu diesen Funktionen fehlen kann ich nicht nachvollziehen was die überhaupt machen. Ich will halt nicht nur irgendwas halbes zusammenkopieren das Irgendwie funktioniert (siehe LaCrosse Adapter). Ich will auch verstehen und meine JavaScript Kenntnise erweitern (komme ja von Python).
Und nochmal zum Kochbuch gg in C/C++ gibt es z.B. Doxygen womit ich wenigstens ne liste mit vorhandenen Funktionen und deren Parametern bekomme. Sowas wäre halt schon mal Endgeil.
Und nein werde wohl nicht aufgeben war nur der Frust das nicht einmal die einfachsten Sachen Die ICH in JavaScript kenne hier für mich verwendbar sind. `
Frage gezielt was du machen willst. Dann werde ich auch versuchen alles zu erklären.Natürlich Doku ist ein Manko. Ich kann aber nichts machen. Wurde aber an der Stelle letzte Zeit SEHR viel gemacht. Nur aber Anwenderdoku.
Ich will Javadoc einsetzten. …. Irgendwann.
-
ok das hört sich schon mal gut an grins
im Moment erstmal lernen wie ioBroker im Grunde funktioniert.
States anlegen lassen und automatisch löschen ,
wiederkehrende Datenpunkte als Templates anlegen und z.B. nur die ID ändern,
wie prüfen ob ein Datenpunkt schon existiert und weiter nutzen,
wie Dropdown Auswahl im Admin für z.B. USB Port (wie in MYSensors als Beispiel),
und natürlich die ganzen zusammenhänge welche JS ist für was zuständig.
Du hast mir ja schon mal nen Tip gegeben mit der on('Message'… Funktion . Da hab ich auch nicht durchgeblickt. Hast ja geschrieben die reagiert auf 'sendTo' nur find ich in MySensors nix mit 'sendTo' ausser in der Funktion die ja mit 'sendTo' erst ausgelösst werden soll verwirrtbin.
JavaDoc hört sich gut an. Dann musst Du ja überall erstmal die ganzen Kommentare anlegen zu JEDER Funktion!!! OMG das dürfte ein ziemlicher Aufwand werden.
-
States anlegen lassen und automatisch löschen , `
Das kann man bei ping, mysensors, sonos, owfs uswhttps://github.com/ioBroker/ioBroker.ow … in.js#L258
wiederkehrende Datenpunkte als Templates anlegen und z.B. nur die ID ändern, `
So?https://github.com/ioBroker/ioBroker.ow … in.js#L208
wie prüfen ob ein Datenpunkt schon existiert und weiter nutzen, `
Sehe erstes Linkwie Dropdown Auswahl im Admin für z.B. USB Port (wie in MYSensors als Beispiel),
Du hast mir ja schon mal nen Tip gegeben mit der on('Message'… Funktion . Da hab ich auch nicht durchgeblickt. Hast ja geschrieben die reagiert auf 'sendTo' nur find ich in MySensors nix mit 'sendTo' ausser in der Funktion die ja mit 'sendTo' erst ausgelösst werden soll verwirrtbin. `
https://github.com/ioBroker/ioBroker.my … .html#L118JavaDoc hört sich gut an. Dann musst Du ja überall erstmal die ganzen Kommentare anlegen zu JEDER Funktion!!! OMG das dürfte ein ziemlicher Aufwand werden. `
OMG.
-
OMG "OhMeinGOTT" in sinne von das iss aber ne menge arbeit
die ersten paar schau ich mir an danke.
Das mit dem sendTo iss ja genau die Funktion die ich meine hab sie übernommen und wird nicht ausgeführt. "sendTo(NULL" heißt ja in endefeckt sende an nix und das reicht ?
