[!!! Das Project !!!] Einen Adapter bauen ist nicht schwer
-
Hi,
das Projekt von @Dutchman ist mega - danke hierfür
, aber wir sollten bitte unbedingt auch parallel die offizielle Adapter-Doku verbessern. Siehe hier mein Vorschlag. Denn sonst endet das schnell in Frustration für Neueinsteiger,....Ganz simples Beispiel: was nehme ich, um einen neuen State anzulegen oder wieder zu löschen? Das blickt wohl keiner in der Doku auf die schnelle, grad wenn man vom JS-Adapter kommt, oder auch so.
Hier übrigens eine Github-Doku von mir, hatte ich glaub ich oben schon mal erwähnt. Vieles fehlt noch, aber evtl. ein guter Start, zumal aktueller als viele Infos im www.
Ergänze und verbessere ich nach und nach halt wie ich dazu komme... -
@Mic sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
das Projekt von @Dutchman ist mega - danke hierfür , aber wir sollten bitte unbedingt auch parallel die offizielle Adapter-Doku verbessern. Siehe hier mein Vorschlag. Denn sonst endet das schnell in Frustration für Neueinsteiger,....
Ich wuerde mich SEHR freuen wen dieses project Anreiz gibt fuer anderen sich darin aktiv zu beteiligen (auch wen es nur ein par Zeilen sind!)
-
@OliverIO sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
hab zwar schon mal die Dokumentation gesehen, aber irgendwie kommt man durch suchen auch immer wieder auf eine veraltete Doku.
Hmm merkwürdig ich habe vor einigen Wochen in alle alten Dokumentation Seiten einen redirect zur neuen docu eingebaut.
Sollte ich dabei etwas übersehen kan ich das noch korrigieren, haste du Beispiele fuer mich? -
@Dutchman
weiß nicht ob du da etwas dafür kannst.
Folgende Usecases eines Anfängers-
Suche im Forum
Eingabe adapter entwicklung
Ergebnis mehrere Threads verschiedenster Problemstellungen.
Teilweise "Kilometerlange" Gespräche/Diskussionen einiger "halbwissenden"
->Verwirrt Anfänger -
Suche in Google
Eingabe Adapter Entwicklung
Ergebnis: Erster Sucheintrag ist das Forum, weiteres siehe 1)
dann diverse Artikel anderer Seiten zur Adapterentwicklung, die auf jeden Fall erst einmal so in Ordnung sind, aber selbst auf der 4.Googleseite noch kein Link zur eigentlichen iobroker Doku
https://www.iobroker.net/#de/documentation und ich weiß nicht wer da noch weiterklickt -
Einstieg über die Haupotseite und Klick auf den Link Dokumentation´
ja da sind einige Links, die ich letztes Jahr m,eines wissens nach noch nicht gefunden habe,
aber gleich der erste Link: Adapter Development Documentation: Dokumentation zur Adapter-Entwicklung auf GitHub (in Englisch) führ auf ein altes github repo, der dann erst wieder auf die eigentliche doku verweist, die für Anfänger leider nicht sehr verständlich ist. (wie gesagt Stand letztes Jahr, seit´dem hab ich auch nicht mehr gesucht)
Den Link könnte man eigentlich auch direkt setzen
Dann Verweis zum Adapterstudio, dessen Entwicklung gemäß github gestoppt ist, kann eigentlich dann raus? -
zu guter letzt noch ein Issue von Anfang Februar zur Doku
https://github.com/ioBroker/ioBroker.repositories/issues/605
Mittlerweile überlege ich mir, ob ich Issues noch einstelle, da ich nicht weiß ob die bearbeitet werden bzw. ob das in 6 Monaten noch relevant ist.
closed Some Links not working #605
-
-
@OliverIO sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Adapter-Entwicklung auf GitHub (in Englisch)
Eine große Bitte (wo ich das gerade lese...)
Doku auf Englisch ist ja vielleicht ganz schick und für alle "vom Fach" aus sicher OK.
Aber gerade Anfänger schreckt das meistens ab. -
@htrecksler sagte in [[!!! Das Project !!!] Einen Adapter bauen ist nicht schwer]> Eine große
Doku auf Englisch ist ja vielleicht ganz schick und für alle "vom Fach" aus sicher OK. Aber gerade Anfänger schreckt das meistens ab.
Hi,
eine sehr gute Anmerkung.Aber ich persönlich denke, das hat nichts mit "schick" zu tun:
Spätestens wenn auf Plattformen mehr als eine gesprochene Sprache für Entwickler erforderlich wird, wechselt man in der Entwicklungsdokumentation zur Weltsprache Englisch. Sämtliche Kommando-Namen etc. in Programmiersprachen sind in Englisch. Debugging von JavaScript usw. ebenso in Englisch.
Weiteres Beispiel: Welche API-Dokumentation eines Gerätes ist in Deutsch?Ebenso die Entwicklungsumgebungen, hier Auszug aus VS Code für JavaScript (ioBroker-Adapter):
Falls das Englisch etwas eingerostet ist, würde ich empfehlen, die offizielle Entwicklungs-Doku einfach auf Deutsch übersetzen zu lassen, am besten 2 Browser-Fenster nebeneinander (Englisch/Deutsch), um zu vergleichen und korrekte Kommandos zu übernehmen.
Die bestehenden Entwickler-Doku ist insgesamt ziemlich verbesserungswürdig.
Mein Vorschlag: bitte mithelfen, diese erst mal zu verbessern/erweitern. Danach dann kann ja wer die Doku noch in Deutsch übersetzen, falls benötigt und Google Translate / Deepl etc. nicht reicht. -
@Mic sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Die bestehenden Entwickler-Doku ist insgesamt ziemlich verbesserungswürdig.
Mein Vorschlag: bitte mithelfen, diese erst mal zu verbessern/erweitern. Danach dann kann ja wer die Doku noch in Deutsch übersetzen, falls benötigt und Google Translate / Deepl etc. nicht reicht.und wie sieht unser Beitrag aus? Wie kippen wir Änderungen ein?
-
Hi
Ich verstehe voll und ganz deine Kritik oben, und mir geht und ging es ähnlich
@OliverIO sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
zu guter letzt noch ein Issue von Anfang Februar zur Doku
https://github.com/ioBroker/ioBroker.repositories/issues/605
Mittlerweile überlege ich mir, ob ich Issues noch einstelle, da ich nicht weiß ob die bearbeitet werden bzw. ob das in 6 Monaten noch relevant ist.Mach am besten direkt einen Pull Request. Also auf den "Stift" auf Github klicken, und direkt die Änderungen eintragen. Ich denke über ein Issue zur Dokumentation passiert wenig, weil einfach ein anderer Fokus der Entwickler da ist (Weiterentwicklung, Bug Fixes, etc.). Aber über Pull Requests können wir mithelfen, und geht eh meist schneller, als zu beschreiben, was geändert werden soll.
-
@Mic
pull request geht nur wenn man den neuen link kennt -
@OliverIO sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
nur wenn man den neuen link kennt
Falls das auf Testing bezogen ist: Ich denke, den neuen Link kennt auch sonst keiner mehr, weil vom "alten" Forum.
You can find some help in this PDF (Only german) See Adapter Testing Section.
Würde ich also im Pull Request einfach streichen mit entsprechendem Kommentar, (toter Link) hilft ja nichts. Vermutlich ist dieses PDF gemeint, aber das ist eh veraltet.
-
Hallo dutch,
Ich finde die Idee super gerade Videos sind leicht zu verstehen und man kann es sehen und hören was passieren soll.
Wenn schon ein Adapter dann wäre es auch interessant zu erklären wie man einen Widget Adapter erstellt da habe ich bisher noch keine Ahnung und tu mir da ein wenig schwer. Auch hätte ich Interesse in die Telegramm Gruppe zu kommen. Da ich gerade auch an meinem ersten Adapter bin. -
@ThaBam sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Wenn schon ein Adapter dann wäre es auch interessant zu erklären wie man einen Widget Adapter erstellt
das müsste. Jagd anders mache da habe ich auch keine Ahnung
-
Hallo,
lange nichts mehr gehört, macht das Projekt denn Fortschritte?
-
Als kleine Ergänzung zum ersten Thema wo es um die Tooleinrichtung geht:
Welche Tools sind zu empfehlen, wenn es um die folgenden Themen geht: Adapter debuggen, Testing, Dokumentation, Veröffentlichung. Die Tools brauche man ja am Anfang noch nicht in ihrer ganzen Vielfalt vorstellen, aber ein kurzer Ausblick und wo man weitere Infos zu den Tools findet ist sicherlich hilfreich. Die eigentliche Anwendung sollte man dann während der Lehrserie zur Adapterentwicklung zeigen.
Beim ersten oder zweiten Tutorial könnte man auch kurz noch auf folgende Themen eingehen:
Welche typischen Dateien / Dokumente gehören zu einem Adapter, wie unterscheidet sich die Entwicklung eines Adapters von der Entwicklung eines Skripts. -
@fastfoot sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
lange nichts mehr gehört, macht das Projekt denn Fortschritte?
Ich musste leider einige zeit ein par Schritte zurück Namen von meinen Aktivitäten aber das project ist definitiv nicht tot und wird noch in 2020 starten.
Leider kan ich noch keinen genauen Zeitpunkt versprechen aber im September werden die ersten 1-2 anfangs tutorials ihren weg ins netz finden.Spiele gerade noch mit dem Gedanken ob alle video's tutorials werden, oder interaktiv (also YouTube life-stream mit chat).
Dan kennen wir naemlich auch life fragen und feedback verarbeiten, wie steht ihr dazu ?Dutch
-
Danke fuer deinen Anregungen !
@Feuersturm sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Welche Tools sind zu empfehlen, wenn es um die folgenden Themen geht: Adapter debuggen, Testing, Dokumentation, Veröffentlichung. Die Tools brauche man ja am Anfang noch nicht in ihrer ganzen Vielfalt vorstellen, aber ein kurzer Ausblick und wo man weitere Infos zu den Tools findet ist sicherlich hilfreich. Die eigentliche Anwendung sollte man dann während der Lehrserie zur Adapterentwicklung zeigen.
Werden wir behandeln im Teil : Wie setze ich meine entwickel Umgebung auf
@Feuersturm sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Welche typischen Dateien / Dokumente gehören zu einem Adapter, wie unterscheidet sich die Entwicklung eines Adapters von der Entwicklung eines Skripts.
Genau diese Elementen werden behandelt in : Das erste Grundgerüst eines adapters
-
@Dutchman Zur Frage Video oder Lifestream: Für mich fände ich es am hilfreichsten, wenn es ein Video gibt, an dem ich mich langhangeln kann und die Schritte in meiner Geschwindigkeit nachstellen kann. Jeder ist am Anfang verschieden schnell und wenn man dann auf 10 Leute warten möchte bzw. 10 verschiedene Einrichtungsprobleme lösen möchte wird sich das stark in die Länge ziehen.
Eine Live Session im Nachgang z.B. in Discord, um gezielt auf Fragen / Probleme einzugehen finde ich eine gute Idee. Ich halte es aber für zielführender, wenn man das Tutorial vom Livestream trennt.
-
@Feuersturm sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Eine Live Session im Nachgang z.B. in Discord, um gezielt auf Fragen / Probleme einzugehen finde ich eine gute Idee. Ich halte es aber für zielführender, wenn man das Tutorial vom Livestream trennt.
Sehr interessanter Ansatz, diese Gedanken unterstütze ich und kam auch bereits in mir hoch.
Dan werden ich sagen :- Wir machen die Aufnahme, gibt mir auch Möglichkeiten zur Nachbearbeitung etc
- zusätzlich einen Termin im ioBroker-Discord eine Woche später um fragen / troubleshooting stellen zu koennen
Denke mal life stream und danach fragen runde ist bissl schwierig den man wird eventuell mit Informationen erschlagen.
So hat jeder circa eine Woche die zeit sich die Informationen eigen zu machen und kommen wir zusammen.Cheers,
Dutch
-
@Dutchman sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
@fastfoot sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
lange nichts mehr gehört, macht das Projekt denn Fortschritte?
Ich musste leider einige zeit ein par Schritte zurück Namen von meinen Aktivitäten aber das project ist definitiv nicht tot und wird noch in 2020 starten.
Leider kan ich noch keinen genauen Zeitpunkt versprechen aber im September werden die ersten 1-2 anfangs tutorials ihren weg ins netz finden.das ist schön zu hören! ich bin schon sehr gespannt auf die erste Ausgabe
Spiele gerade noch mit dem Gedanken ob alle video's tutorials werden, oder interaktiv (also YouTube life-stream mit chat).
Dan kennen wir naemlich auch life fragen und feedback verarbeiten, wie steht ihr dazu ?Dutch
ich bin kein großer Fan von Live, habe in meinem Leben schon zu viele Videokonferenzen mitgemacht, sehr viele mit wenig outcome. Aber: your mileage may vary
was ich mir gut vorstellen könnte: Live events als Zusatzangebot zu den Lektionen, dann kann jeder in Ruhe seine Hausaufgaben machen, das zu Lernende verinnerlichen(oder auch nicht) und dann seine Fragen und/oder Lösungen beitragen. Hast du dir schon Gedanken darüber gemacht, den Source auch auf GitHub zu veröffentlichen, das wäre für viele sicherlich auch lehrreich und gehört ja zur iobroker-Adapterentwicklung auch irgendwie zwingend dazu. Ich bin da aber sehr offen und nehme es einfach so wie es kommt.
Auf jeden Fall freue ich mich dass es weitergeht! Bis bald...
-
@fastfoot sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
das ist schön zu hören! ich bin schon sehr gespannt auf die erste Ausgabe
Na und ich erst !@fastfoot sagte in [!!! Das Project !!!] Einen Adapter bauen ist nicht schwer:
Hast du dir schon Gedanken darüber gemacht, den Source auch auf GitHub zu veröffentlichen, das wäre für viele sicherlich auch lehrreich und gehört ja zur iobroker-Adapterentwicklung auch irgendwie zwingend dazu. Ich bin da aber sehr offen und nehme es einfach so wie es kommt.
selbstverstaendlich, alles was wir im video machen usw kommt auf git und jeder kann Forken und dergleichen.
Ziel ist ja im algemeinen Entwicklung zu verstehen, aber auch Zusammenarbeit git usw. (Teil 10 GitHub und version management) da kommen dan auch Sachen wie :- Forken
- Releasen
- Pull requests
- Commits
- Merging
etc
