Skip to content
  • Home
  • Aktuell
  • Tags
  • 0 Ungelesen 0
  • Kategorien
  • Unreplied
  • Beliebt
  • GitHub
  • Docu
  • Hilfe
Skins
  • Light
  • Brite
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Standard: (Kein Skin)
  • Kein Skin
Einklappen
ioBroker Logo

Community Forum

donate donate
  1. ioBroker Community Home
  2. Deutsch
  3. Entwicklung
  4. API Dokumentation

NEWS

  • Neuer Blogbeitrag: Monatsrückblick - Dezember 2025 🎄
    BluefoxB
    Bluefox
    10
    1
    173

  • Weihnachtsangebot 2025! 🎄
    BluefoxB
    Bluefox
    24
    1
    1.4k

  • UPDATE 31.10.: Amazon Alexa - ioBroker Skill läuft aus ?
    apollon77A
    apollon77
    48
    3
    9.4k

API Dokumentation

Geplant Angeheftet Gesperrt Verschoben Entwicklung
29 Beiträge 6 Kommentatoren 3.6k Aufrufe 4 Watching
  • Älteste zuerst
  • Neuste zuerst
  • Meiste Stimmen
Antworten
  • In einem neuen Thema antworten
Anmelden zum Antworten
Dieses Thema wurde gelöscht. Nur Nutzer mit entsprechenden Rechten können es sehen.
  • J Offline
    J Offline
    jobe451
    schrieb am zuletzt editiert von
    #10

    Ich hab dasselbe Problem. Ich krieg getChannelsOf einfach nicht zum laufen. Meine Struktur ist
    device/channelA/state1
    device/channelA/state2
    device/channelB/state1
    device/channelB/state2

    this.getDevices((error, result?: Array<any>) => {
    	result.forEach((item: ioBroker.BaseObject) => {
    		let id_alternative_1 = item._id.substr(this.namespace.length + 1);
    		let id_alternative_2 = item._id;
    		this.getChannelsOf(item.common.name, (error, channels?: Array<any>) => {
    

    item._id.substr(this.namespace.length + 1)
    getDevices liefert mir zwar die Liste der Devices. Aber getChannelsOf ergibt immer dasselbe. Egal ob ich als parent item.common.name, item._id oder item._id.substr(this.namespace.length + 1) angebe. Dabei wäre wohl item._id die elegante Variante.

    Auf Github finde ich auch kaum Projekte, welche diese Funktion einsetzen. Un dort wo die Funktion gebraucht wird, ist das ganze Inkonsistent.

    1 Antwort Letzte Antwort
    0
    • apollon77A Offline
      apollon77A Offline
      apollon77
      schrieb am zuletzt editiert von
      #11

      Hi,

      also der erste Parameter ist die ID des Device-Objekts von dem man die Channels will. Und es ist erwartet das das auf der obersten ebene liegt. Es sind als per Definition keine Punkte drin. Also unter der Annahme das bei Dir alles auf der ersten Ebene ist was Devices angeht dann sollter id_alternative_2 das sein was gehen sollte.

      Beitrag hat geholfen? Votet rechts unten im Beitrag :-) https://paypal.me/Apollon77 / https://github.com/sponsors/Apollon77

      • Debug-Log für Instanz einschalten? Admin -> Instanzen -> Expertenmodus -> Instanz aufklappen - Loglevel ändern
      • Logfiles auf Platte /opt/iobroker/log/… nutzen, Admin schneidet Zeilen ab
      1 Antwort Letzte Antwort
      0
      • J Offline
        J Offline
        jobe451
        schrieb am zuletzt editiert von
        #12

        Hi,
        Leider will das nicht so ganz.

        Hier ist ein Screenshot der Objekte:
        Bildschirmfoto von 2019-02-10 22-46-24.png
        "enocean_jobe.0" ist die Instanz meines Adapters. enocean_jobe_0_tv ist das erste von 4 Devices. Dann kommte jeweils Channel A und B und je zwei States. Entsprechend sind die devices auf der obersten Ebene des Adapters.

        On ready führe ich alles mögliche aus, was irgendwie sinnvoll sein könnte:

        this.getChannels("enocean_jobe_0_tv", (err, list) => {
        	this.log.info("channel list for enocean_jobe_0_tv: " + JSON.stringify(list));
        }) ;
        
        this.getChannels("tv", (err, list) => {
        	this.log.info("channel list for tv: " + JSON.stringify(list));
        }) ;
        
        this.getDevices((error, deviceList?: Array<any>) => {
        	if(deviceList) {
        		deviceList.forEach((item) => {
        			this.log.info("device id " + item._id);
        			this.getChannels(item._id, (err, list) => {
        				this.log.info("channel list for " + item._id + " is: " + JSON.stringify(list));
        			});
        			
        			let shortId = item._id.substr(this.namespace.length + 1);
        				this.getChannels(shortId, (err, list) => {
        				this.log.info("channel list for " + shortId + " is: " + JSON.stringify(list));
        			});
        			
        			let deviceId = item._id.substr(this.namespace.length + 1);
        			let ns_id = this.namespace.replace(/[.\s]/g, "_")
        			let longId = this.namespace + "." + ns_id + "_" + deviceId;
        			this.getChannels(longId, (err, list) => {
        				this.log.info("channel list for " + longId + " is: " + JSON.stringify(list));
        			});
        
        			let stateId = longId + "." +  ns_id  + "_" + deviceId + "_A.switch_A";
        			this.log.info("state is " + stateId);
        			this.getState(stateId, (error: string | null, obj: ioBroker.State | null | undefined) => {
        				this.log.info("state is for " + stateId + " is " + JSON.stringify(obj));
        			});
        
        		});
        	}
        });
        

        Das Resulat ist dann sehr ernüchternd:
        Bildschirmfoto von 2019-02-11 00-03-20.png

        Interessant dabei ist, dass ich zwar einen State abfragen kann, indem ich aus der deviceId eine
        StateId zusammenbaue. Aber die Channels kann ich nicht abfragen, auch wenn ich das analoge Schema wie für die Device-Id anwende. Auch alle anderen sinnvollen Varianten führen nicht zum Ziel.

        1 Antwort Letzte Antwort
        0
        • apollon77A Offline
          apollon77A Offline
          apollon77
          schrieb am zuletzt editiert von
          #13

          Und es sind wirklich objekte mit dem type "channel"? Sieht man in deinem Screenshot leider nicht.

          Beitrag hat geholfen? Votet rechts unten im Beitrag :-) https://paypal.me/Apollon77 / https://github.com/sponsors/Apollon77

          • Debug-Log für Instanz einschalten? Admin -> Instanzen -> Expertenmodus -> Instanz aufklappen - Loglevel ändern
          • Logfiles auf Platte /opt/iobroker/log/… nutzen, Admin schneidet Zeilen ab
          1 Antwort Letzte Antwort
          0
          • AlCalzoneA Offline
            AlCalzoneA Offline
            AlCalzone
            Developer
            schrieb am zuletzt editiert von
            #14

            @150d said in API Dokumentation:

            wie/wo finde ich heraus, wie eine bestimmte Funktion

            Noch eine Info am Rande:
            Wenn du VSCode oder einen ähnlichen Editor verwendest, der TypeScript versteht, bekommst du neuerdings Hilfe zu den Funktionen mitgeliefert.

            Dazu musst du das Paket @iobroker/adapter-core einbinden und deinen Adapter wie folgt instanziieren:

            const utils = require("@iobroker/adapter-core");
            const adapter = utils.adapter( ... );
            

            Dann siehst du einerseits, welche Methoden existieren
            a1376132-8846-45a1-9adf-6a326521e737-grafik.png

            und bekommst Infos zu den möglichen Aufrufsignaturen und Kontexthilfe:
            ae20b0cc-4d30-4b31-8934-f3e6fec1f4c7-grafik.png

            Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

            1 Antwort Letzte Antwort
            1
            • J Offline
              J Offline
              jobe451
              schrieb am zuletzt editiert von
              #15

              @apollon77
              Ja, ich denke es sollten schon channels sein auf zweiter Stufe. Zumindest verwende ich was, was sich "createChannel" nennt zum erstellen. In vereinfachter Form sieht das so aus:

              this.createDevice(label, 
                  {name: label,}, 
                  {}, 
                  (err: any, obj: any)=>{
                      this.createChannel(obj.id, 'A', (err: string | null, channel: any) => {
                          this.createState(obj.id, channel.id, "someSwitch", {
                              type: "boolean",
                              role: "switch",
                              read: true,
                              write: true,
                          },
                          (err: string | null, state: any) => {
                          });
                      })
                  }
              );
              

              @AlCalzone
              VSCode mit @iobroker/adapter-core verwende ich schon. Hilft auch oft, navgier da oft und gern mit F12 durch die Definitionen durch. Debuggen von VSCode aus schaff ich auch. Der Typescript-Code mit dem ich arbeite basiert hab ich mit ioBroker gemäss Doku generiert.

              Allerdings simmen die Defintionen nicht unbedingt immer mit der Realität überein.
              "getDevices" hat zum Beispiel einen Callback vom Typ "GetObjectsCallback3<DeviceObject>" entsprechnd sollte ich nach Definition im Callback neben einem Error|null auch ein Attribut vom Typ Array<GetObjectsItem<DeviceObject>> zurück kommen. In Tat und Wahrheit bekomm ich aber ein Array<DeviceObject> zurück.

              AlCalzoneA 1 Antwort Letzte Antwort
              1
              • J jobe451

                @apollon77
                Ja, ich denke es sollten schon channels sein auf zweiter Stufe. Zumindest verwende ich was, was sich "createChannel" nennt zum erstellen. In vereinfachter Form sieht das so aus:

                this.createDevice(label, 
                    {name: label,}, 
                    {}, 
                    (err: any, obj: any)=>{
                        this.createChannel(obj.id, 'A', (err: string | null, channel: any) => {
                            this.createState(obj.id, channel.id, "someSwitch", {
                                type: "boolean",
                                role: "switch",
                                read: true,
                                write: true,
                            },
                            (err: string | null, state: any) => {
                            });
                        })
                    }
                );
                

                @AlCalzone
                VSCode mit @iobroker/adapter-core verwende ich schon. Hilft auch oft, navgier da oft und gern mit F12 durch die Definitionen durch. Debuggen von VSCode aus schaff ich auch. Der Typescript-Code mit dem ich arbeite basiert hab ich mit ioBroker gemäss Doku generiert.

                Allerdings simmen die Defintionen nicht unbedingt immer mit der Realität überein.
                "getDevices" hat zum Beispiel einen Callback vom Typ "GetObjectsCallback3<DeviceObject>" entsprechnd sollte ich nach Definition im Callback neben einem Error|null auch ein Attribut vom Typ Array<GetObjectsItem<DeviceObject>> zurück kommen. In Tat und Wahrheit bekomm ich aber ein Array<DeviceObject> zurück.

                AlCalzoneA Offline
                AlCalzoneA Offline
                AlCalzone
                Developer
                schrieb am zuletzt editiert von
                #16

                @jobe451 said in API Dokumentation:

                Allerdings simmen die Defintionen nicht unbedingt immer mit der Realität überein.
                "getDevices" hat zum Beispiel einen Callback vom Typ "GetObjectsCallback3<DeviceObject>" entsprechnd sollte ich nach Definition im Callback neben einem Error|null auch ein Attribut vom Typ Array<GetObjectsItem<DeviceObject>> zurück kommen. In Tat und Wahrheit bekomm ich aber ein Array<DeviceObject> zurück.

                Ich habe die Definitionen nach bestem Wissen und Gewissen anhand des Quelltextes abgeleitet. Wenn du Unstimmigkeiten findest, bitte ein Issue in https://github.com/ioBroker/adapter-core aufmachen.

                Für deinen erwähnten Fall würde ich gern die JSON-Darstellung des zweiten Parameters sehen. Also adapter.log(JSON.stringify(devices)) oder wie dein zweiter Parameter auch heißt.

                Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

                1 Antwort Letzte Antwort
                0
                • J Offline
                  J Offline
                  jobe451
                  schrieb am zuletzt editiert von
                  #17

                  @AlCalzone
                  Vielen Dank für diese Type-Definitionen. Die sind extrem hilfreich, um sich in dem Projekt zurechtzufinden! Ich hab für den getDevice diesen Issue eröffnet:
                  https://github.com/ioBroker/adapter-core/issues/6

                  Leider löst das nicht das getChannelsOf-Problem. Ich würd immer noch behaupten, dass die Funktion einfach kaputt ist.

                  1 Antwort Letzte Antwort
                  0
                  • AlCalzoneA Offline
                    AlCalzoneA Offline
                    AlCalzone
                    Developer
                    schrieb am zuletzt editiert von
                    #18

                    @jobe451 Das Issue mit den Definitionen sollte demnächst gelöst sein.
                    Um deinen Fehler mit getChannelsOf einzugrenzen, kannst du bitte mal die Funktion ohne parentDevice aufrufen, also nur this.getChannelsOf((err, channels) => { ... })

                    Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

                    1 Antwort Letzte Antwort
                    0
                    • J Offline
                      J Offline
                      jobe451
                      schrieb am zuletzt editiert von
                      #19

                      Wenn ich in meiner onReady Funktion das hier mache:

                      this.getChannelsOf((error, channellist?: Array<any>) => {
                      	console.log("***************************************");
                      	console.log(JSON.stringify(channellist));
                      });
                      

                      Krieg ich ein leeres array zurück.

                      apollon77A 1 Antwort Letzte Antwort
                      0
                      • AlCalzoneA Offline
                        AlCalzoneA Offline
                        AlCalzone
                        Developer
                        schrieb am zuletzt editiert von
                        #20

                        Ok dann ist da grundlegend was kaputt:
                        https://github.com/ioBroker/ioBroker.js-controller/issues/333

                        Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

                        1 Antwort Letzte Antwort
                        0
                        • AlCalzoneA Offline
                          AlCalzoneA Offline
                          AlCalzone
                          Developer
                          schrieb am zuletzt editiert von AlCalzone
                          #21

                          @jobe451 Ich habe versucht nachzuvollziehen, was getChannelsOf tut. Bis zum Aufruf von that.objects.getObjectView macht das Sinn. Danach kann ich "offline" nicht testen.

                          Aber jetzt muss ich nochmal ganz dumm fragen... Was steht denn in error?

                          Und poste doch bitte mal Definitionen der Objekte die du erwartest.

                          Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

                          1 Antwort Letzte Antwort
                          0
                          • J jobe451

                            Wenn ich in meiner onReady Funktion das hier mache:

                            this.getChannelsOf((error, channellist?: Array<any>) => {
                            	console.log("***************************************");
                            	console.log(JSON.stringify(channellist));
                            });
                            

                            Krieg ich ein leeres array zurück.

                            apollon77A Offline
                            apollon77A Offline
                            apollon77
                            schrieb am zuletzt editiert von
                            #22

                            @jobe451 Ja mal blöd gefragt, sind denn da Channels? Bin mir nicht sicher ob er nicht nur auf der einen "Ebene" sucht.

                            Beitrag hat geholfen? Votet rechts unten im Beitrag :-) https://paypal.me/Apollon77 / https://github.com/sponsors/Apollon77

                            • Debug-Log für Instanz einschalten? Admin -> Instanzen -> Expertenmodus -> Instanz aufklappen - Loglevel ändern
                            • Logfiles auf Platte /opt/iobroker/log/… nutzen, Admin schneidet Zeilen ab
                            1 Antwort Letzte Antwort
                            0
                            • J Offline
                              J Offline
                              jobe451
                              schrieb am zuletzt editiert von
                              #23

                              Weiter oben habe ich einen Screenshot, von der Struktur wie ich sie in der Objektliste sehe. Ebenfalls weiter oben hab ich eine simplifizierte script-sequenz, die zeigt, wie ich die struktur schaffe.

                              Im wesentlichen mache ich:
                              this.createDevice => this.createChannel (mit id aus device callback) => this.createState (mit id aus channel callback)

                              Die Dinger, die ich mit this.createChannel erstelle erscheinen dann auch in der Objektliste. Also ich würd schon sagen, dass es da Channels hat...

                              1 Antwort Letzte Antwort
                              0
                              • AlCalzoneA Offline
                                AlCalzoneA Offline
                                AlCalzone
                                Developer
                                schrieb am zuletzt editiert von
                                #24

                                Der Screenshot zeigt leider das wichtigste nicht. Kannst bitte einfach eins dieser Channel-Objekte öffnen (Edit-Bleistift) und den Inhalt des Reiters "Raw" zeigen?

                                Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

                                1 Antwort Letzte Antwort
                                0
                                • apollon77A Offline
                                  apollon77A Offline
                                  apollon77
                                  schrieb am zuletzt editiert von
                                  #25

                                  Und was ich meinte war: Wenn deine Struktur "Instanz -> Device -> Channel" ist und Du fragst "channelsOf(Instanz)" dann kommt da nichts ... du musst wenn "getChannelsOf(Device)" fragen ... aber ja ich weiss das Du das schon durch hast ...

                                  Beitrag hat geholfen? Votet rechts unten im Beitrag :-) https://paypal.me/Apollon77 / https://github.com/sponsors/Apollon77

                                  • Debug-Log für Instanz einschalten? Admin -> Instanzen -> Expertenmodus -> Instanz aufklappen - Loglevel ändern
                                  • Logfiles auf Platte /opt/iobroker/log/… nutzen, Admin schneidet Zeilen ab
                                  1 Antwort Letzte Antwort
                                  0
                                  • J Offline
                                    J Offline
                                    jobe451
                                    schrieb am zuletzt editiert von
                                    #26

                                    Hier ist ein Screenshot, der auch die Icons rechts zeigt. Allerdings hab ich auf den ersten zwei Stufen keinen Edit-Bleistift verfügbar um den Raw-Inhalt aufzurufen. Was könnte das bedeuten?
                                    Bildschirmfoto von 2019-02-20 01-38-46.png

                                    1 Antwort Letzte Antwort
                                    0
                                    • apollon77A Offline
                                      apollon77A Offline
                                      apollon77
                                      schrieb am zuletzt editiert von apollon77
                                      #27

                                      Das bedeute wie vermutet das das keine Objekte sind! Sonst gäbe es in der Spalte wo sonsst "state" steht nämlich "device "und "channel".
                                      Also: Wie vermutet ganz am Anfang: DU hat keine existierenden Objekte vom Type device oder channel für enocean_jobe.0.enocean_jobe_0_tv und enocean_jobe.0.enocean_jobe_0_tv.enocean_jobe_0_tv_A ... und dann ist klar das "getChannelsOf" nichts findet.

                                      Man sollte als eher prüfen ob die CreateDevcie und createChannel methoden korrekt aufgerufen werden. An sich gilt auch hier das nichts mit punkten sein sollte sondern man die entsprechenden Namen (also das zwischen den punkten angibt. Das würe ggf auch erklären warum die benahmung so komisch ist weil überall enocean_jobe_0_ dabei ist

                                      Beitrag hat geholfen? Votet rechts unten im Beitrag :-) https://paypal.me/Apollon77 / https://github.com/sponsors/Apollon77

                                      • Debug-Log für Instanz einschalten? Admin -> Instanzen -> Expertenmodus -> Instanz aufklappen - Loglevel ändern
                                      • Logfiles auf Platte /opt/iobroker/log/… nutzen, Admin schneidet Zeilen ab
                                      1 Antwort Letzte Antwort
                                      0
                                      • AlCalzoneA Offline
                                        AlCalzoneA Offline
                                        AlCalzone
                                        Developer
                                        schrieb am zuletzt editiert von
                                        #28

                                        Ist das der komplette Objektbaum? Oder tauchen weiter unten "verlorene" Channel-Objekte ohne States auf?

                                        Warum `sudo` böse ist: https://forum.iobroker.net/post/17109

                                        1 Antwort Letzte Antwort
                                        0
                                        • J Offline
                                          J Offline
                                          jobe451
                                          schrieb am zuletzt editiert von
                                          #29

                                          Vielen Dank für die Unterstützung. Ich konnte das Problem lösen. Darum hatte es nicht geklappt:

                                          Auswahl_045.png

                                          Ich hatte erwartet, dass ich die id, welche aus dem callback zurück kommt, für's anlegen der weitern Objekte verwenden soll.

                                          1 Antwort Letzte Antwort
                                          0
                                          Antworten
                                          • In einem neuen Thema antworten
                                          Anmelden zum Antworten
                                          • Älteste zuerst
                                          • Neuste zuerst
                                          • Meiste Stimmen


                                          Support us

                                          ioBroker
                                          Community Adapters
                                          Donate

                                          400

                                          Online

                                          32.5k

                                          Benutzer

                                          81.7k

                                          Themen

                                          1.3m

                                          Beiträge
                                          Community
                                          Impressum | Datenschutz-Bestimmungen | Nutzungsbedingungen | Einwilligungseinstellungen
                                          ioBroker Community 2014-2025
                                          logo
                                          • Anmelden

                                          • Du hast noch kein Konto? Registrieren

                                          • Anmelden oder registrieren, um zu suchen
                                          • Erster Beitrag
                                            Letzter Beitrag
                                          0
                                          • Home
                                          • Aktuell
                                          • Tags
                                          • Ungelesen 0
                                          • Kategorien
                                          • Unreplied
                                          • Beliebt
                                          • GitHub
                                          • Docu
                                          • Hilfe