Smart Home openHAB 2 Visual Studio Code Editor

Smart Home – openHAB 2 Visual Studio Code

In diesem Beitrag möchte ich Euch den openHAB 2 Visual Studio Code Editor vorstellen. Neben der Installation von der openHAB Extension werde ich auch auf die grundlegende Konfiguration eingehen. Der Grund ist einfach, der von mir im Beitrag  openHAB 2 Konfiguration vorgestellte Eclipse Smart Home Designer wurde inzwischen abgekündigt und daher sind die Tage definitiv gezählt. Ihr solltet den Beitrag als Anfänger aber dennoch durchlesen, da hier die Grundlagen zu Items erklärt werden. Diese werden weiterhin aktuell für viele Automatisierungen und auch für die Visualisierung benötigt. Ihr seid mehr für audiovisuell?  Dann bucht meinen neuen openHAB 2 Kurs auf Udemy.

Nun aber los…

openHAB 2 Visual Studio Code – Installation

openHAB 2 Visual Studio Code – VS Code

Die Installation von Visual Studio Code ist denkbar einfach. Ihr ladet Visual Studio Code für euer Betriebssystem herunter. Klickt die Installationsroutine einfach durch. Bilder hierzu spare ich mir.

openHAB 2 Visual Studio Code – openHAB Extension

Nach der Installation öffnet VS Code und installiert die openHAB Extension. Dies macht ihr, indem ihr Erweiterungen (1) klickt, in der Suchzeile (2) openHAB sucht und die openHAB Extension installiert (3).

openHAB-Visual-Studio-Code-openHAB-Extension-2

Im Anschluss an die Installation der VS Code openHAB Erweiterung startet Visual Studio neu.

openHAB-Visual-Studio-Code-openHAB-2-Extension

Werbung
IA0KPHNjcmlwdCBhc3luYyBzcmM9Ii8vcGFnZWFkMi5nb29nbGVzeW5kaWNhdGlvbi5jb20vcGFnZWFkL2pzL2Fkc2J5Z29vZ2xlLmpzIj48L3NjcmlwdD4NCjwhLS0gT25lU21hcnRIb21lIC0tPg0KPGlucyBjbGFzcz0iYWRzYnlnb29nbGUiDQogICAgIHN0eWxlPSJkaXNwbGF5OmJsb2NrIg0KICAgICBkYXRhLWFkLWNsaWVudD0iY2EtcHViLTY4ODcwMjQzNzgwMDQzMjEiDQogICAgIGRhdGEtYWQtc2xvdD0iNzcxMjIyOTQ0MCINCiAgICAgZGF0YS1hZC1mb3JtYXQ9ImF1dG8iPjwvaW5zPg0KPHNjcmlwdD4NCihhZHNieWdvb2dsZSA9IHdpbmRvdy5hZHNieWdvb2dsZSB8fCBbXSkucHVzaCh7fSk7DQo8L3NjcmlwdD4NCg==

openHAB 2 Visual Studio Code – Konfiguration

Die Konfiguration ist zu Teilen gleich aber auch unterschiedlich.

openHAB 2 Visual Studio Code – Ordner einbinden

Als erstes wählt wieder das Installationsverzeichnis aus. Hierfür klickt ihr auf Explorer (1) und im Anschluss auf Ordner öffnen (2).

openHAB-Visual-Studio-Code-Ordner-1

Ruft wie gehabt nun den Ordner Conf auf. Dies kann entweder das Samba Share Verzeichnis von openHABian (am besten als Netzlaufwerk eingebunden) oder das Windows / Mac Verzeichnis sein. Navigiert in den Ordner (1) und klickt auf Ordner auswählen (2).

openHAB-Visual-Studio-Code-Ordner-2

Im Anschluss findet ihr wie gehabt auf der linken Seite die Konfigurations Ordner von openHAB 2.

openHAB-Visual-Studio-Code-Ordner-3

openHAB 2 Visual Studio Code – Syntaxprüfungen und Hostnamen einstellen

Damit Visual Studio Code mit der openHAB Extension eine Syntaxprüfung vornehmen kann, muss der korrekte Hostname (Name des Rechner wo openHAB 2 läuft) eingestellt werden. Weiterhin muss für ein Syntaxprüfung mindestens openHAB 2.2.0 Build #1065 installiert sein. Hintergrund ist die Nutzung des Language Server Protocol (LSP). Diese ist erst aber der genannten Version integriert.

Bei openHABian ist eingentlich nichts weiter zu tun, es sei denn ihr habt den Hostnamen oder z.B. den Port geändert. Damit VS Code weiterhin in der Lage ist euch auf Fehler aufmerksam zu machen ändert die Parameter. Anbei als Beispiel die Schritte für den Hostnamen.

Hierfür öffnet über das Zahnrad unten links (1) die Einstellungen.

openHAB-Visual-Studio-Code-Hostname-1

Scrollt bei den Einstellungen zum Bereich openHAB Configuration (1) . Klickt auf den Bleifstift neben dem den Eintrag „openhab.host“: „openhabianpi“, (2)  und wählt „in Einstellungen kopieren“ Falls ihr lokal auf einem Windowsrechner arbeitet, gebt „localhost“ als Hostnamen ein. Falls ihr eine Diskstation oder einen Raspberry habt, den Hostnamen oder die IP.

openHAB-Visual-Studio-Code-Hostname-2

Auf der rechten Seite ändert nun den Hostnamen entsprechend ab (1).

openHAB-Visual-Studio-Code-Hostname-3

Hier noch mal der Ausschnitt. meinheim ist der Hostname oder die IP des openHAB 2 Rechner.

openHAB-Visual-Studio-Code-openHAB-Extension-3

Syntaxfehler werden dann im untern Bereich im Reiter „Probleme“ angezeigt. Durch einen Klick auf die Meldung navigiert der Editor in die Zeile. In diesem Beispiel habe ich einfach einen Fehler produziert.

openHAB-Visual-Studio-Code-Syntax

openHAB 2 Visual Studio Code – Funktionen

Zum Abschluss noch ein paar geniale Funktionen, die ihr Nutzen könnt, um euch das Editieren mit VS Code zu erleichtern.

Visual Studio Code – Funktionen – Basic UI

Über das openHAB 2 Symbol rechts oben könnt ihr direkt die Basic UI öffnen.

openHAB-Visual-Studio-Code-Basic-UI-1

Die Darstellung sieht dann wie folgt aus.

openHAB-Visual-Studio-Code-Basic-UI-2

Visual Studio Code – Funktionen – Paper UI

Auch die Paper UI wurde direkt integriert. Hierfür klickt ihr unten links in den Bereich Things (1) und macht ein Rechtsklick auf das Thing (3), welches ihr editieren möchtet. Im Kontextmenü wählt nun den Eintrag „Show in Paper UI“ (3).

openHAB-Visual-Studio-Code-Paper-UI-1

Nun habt ihr die Möglichkeit direkt die Kanäle zu verbinden oder auch Namen bei automatischen Things anzupassen.

openHAB-Visual-Studio-Code-Paper-UI-2

Visual Studio Code – Funktionen – Items aus Thing Channel erstellen

Ihr könnt auch so schöne Dinge machen wie aus den Kanälen der Dinge direkt Items erstellen. Hierfür wieder in den Bereich der Things und im Kontextmenü auf „Create Items from Channels“ (1).

openHAB-Visual-Studio-Code-openHAB-Items-Channels

Im Anschluss habt ihr für alle Kanäle Items geniert. Wirklich grandios…

openHAB-Visual-Studio-Code-openHAB-Items-Channels-2

openHAB 2 Visual Studio Code – Fazit

Mein Fazit? Es mach Spaß, wirklich sehr viel Spaß. VS Code mit der openHAB Extension ist nicht nur sexy, sonder auch eine echte Arbeitserleichterung. Das alte Schwergewicht der Smart Home Designer kann nun endlich einpacken. Ich spare mir das schnelle editieren in Notepad ++ und mögliche Syntaxfehler, da ich nun nur noch einen Editor brauche. Ich bin begeistert und wer mehr Eindrück möchte, kriegt diese auch im Kurs auf Udemy. Schaut Euch bei Bedarf die kostenlosen Lektionen an.

Ich möchte noch Danke sagen. Danke @KubaWolanin!!!

 

 

 

 

Werbung
38 Comments
  1. […] Code mit der openHAB Extension. Installation und ein paar Funktionen stelle ich im Beitrag openHAB 2 Visual Studio Code Editor […]

  2. Hallo,
    die Screenshots lassen sich zum Teil leider nicht lesbar vergrößern. Beim Schritt „Auf der rechten Seite ändert nun den Hostnamen entsprechend ab (1).“ schaffe ich keine Änderung, ich habe aber auch keine Erfahrungen mit Editoren, Was genau muss ich da eintragen (wenn openHAB auf einer Sysnology läuft) und wie speichere ich es ab?
    Vielen Dank für die Unterstützung!

    • Hallo Jochen,

      habe den Beitrag geändert und auch ein größeres Bild eingefügt. Lies es Dir noch mal durch. Passt es so? Falls nicht, melde dich gerne noch mal.

      Grüße
      Thomas

      • Ja, ich habe es jetzt nachvollziehen und erfolgreich einstellen können, vielen Dank für Deine Mühe!

        • Noch als kleine Ergänzung zum Visual Studio Code Editor, nach ein paar Tagen des „herum spielens“ bin ich sehr angetan von der Funktionalität, das war ein guter Tipp!

  3. Hallo Thomas,

    vielen Dank für den interessanten Beitrag.
    Leider finde ich das Symbol nicht:
    „Über das openHAB 2 Symbol rechts oben könnt ihr direkt die Basic UI öffnen.“
    Muss da noch etwas eingestellt werden?

    • Hallo Dirk,

      Die openHAB 2 Extension hast du installiert und vs code neu gestartet?

      Beste Grüße
      Thomas

      • Hallo Thomas,

        ja die Extension habe ich installiert – und auch GIT.
        Unter Einstellungen erscheint auch der Eintrag „openHAB Configuration“ – trotzdem habe ich oben rechts nur die Icons für „Editor teilen“ und „…“.

  4. Jetzt funktioniert es 🙂

    Ich habe mir nochmal Abschnitt 4 – Lektion 18 auf Udemy angesehen und die Remote Console auf dem PI installiert. Scheinbar lag es daran.

  5. Bei mir wird das openHab Symbol oben rechts auch nicht angezeigt.

    Von Remote Console steht ja in dem Beitrag nichts. Muss ich noch etwas einstellen?

    Danke und Gruß
    Robi

  6. Ich habe openhab auf einem rapsberry 3 laufen.
    Ich habe items angelegt und eine sitemap erstellt. Die items werden auch in der PaperUI angezeigt (wenn ich über den Browser gehe).

    Allerdings werden mir im VS Code und unter dem direkten link (in meinem fall: http://192.168.xxx.31:8080/basicui/app?sitemap=robi2) nur folgendes angezeigt:

    Welcome!
    Available sitemaps
    It seems like you have not defined any sitemaps yet. To build one, please check the documentation for guidance.

    Anbei der Code meiner ITEMS (robi2.items):

    Group gObergeschoss
    Group gKinderzimmer
    Group gLicht

    Switch og_kind_li_vorne „Kinderzimmer Decke vorne“ (gObergeschoss, gKinderzimmer, gLicht) [„Lighting“] {knx=“2/0/0″ }

    und der Code meiner SITEMAP (robi2.sitemap):

    sitemap robi2 label=“Haus“ {
    Frame label=“Gruppen“ {
    Group item=gKinderzimmer label=“Kinderzimmer“ icon=“girl_3″
    Group item=gObergeschoss label=“Obergeschoss“ icon=“firstfloor“
    Group item=gLicht label=“Licht“ icon=“lightbulb“
    }

    Frame label=“Items“ {
    Switch item=og_kind_li_vorne
    }
    }

    Es werden durch VS Code auch keine Fehlermeldungen angezeigt.. Nur, wo ist der Fehler?

    • Hallo Robi,

      auf den ersten Blick passt das meiner Meinung nach. Hast aber gesichert?

      Beste Grüße
      Thomas

  7. […] Smart Home openHAB 2 Visual Studio Code Editor […]

  8. Guten Tag,
    bis einschließlich „OpenHAB 2 Visual Studio Code – Ordner einbinden“ hat das bei mir geklappt, aber meine Ordner in Conf sind leer, Google hat mir gesagt, wenn ich mit dem PaperUI Things suche und diese dann Items zuweise etc., dann wird das ganze in einer .json db abgespeichert und ich müsste, damit diese in den Ordnern abgelegt werden, die .things, .items, Dateien selbst erstellen.

    Nun meine Frage, bei dir sind alle Things etc. vorhanden, wie hast du das bewerkstelligt?

    • Hallo Steven,

      das ist richtig. Die über die Paper UI erstellten Einstellungen, Things etc. werden in seperaten Daten z.B. json DB Dateien abgelegt. Bei Z-Wave gibt es noch XML Dateien. Hängt teils vom Binding ab. Ich empfehle Anfängern immer den Simple Mode in der Paper UI zu aktivieren. (Configuration->System->Simple Item Linking. So werden die Kanäle direkt verbunden. In VS Code kannst Du später dann einfach einen Rechtsklick auf das Thing machen und Create Items from Channels auswählen. Kannst Dir mal das folgende Video anschauen https://youtu.be/JtppEe2QPtA. Ca. ab Minute 3:30 demonstriere ich das.

      Grüße
      Thomas

  9. Falls openhab auf anderem port läuft wie z.B. beim qnap pkg,
    muss der Port mit separatem Kommando zusätzlich definiert werden.
    (es geht also nicht „openhab.host“:ipadresse:port) sondern

    „openhab.host“: „ip_oder_hostname“,
    „openhab.port“: 8090 (oder_anderer_definierter_port)

  10. Bei mir hat sich Visual Studio zunächst immer beschwert, dass GIT nicht installiert ist und sich mit entsprechender Fehlermeldung geweigert meine Sitemap Vorschau anzuzeigen.
    Inzwischen hab ich GIT installiert. Die Sitemap Vorschau funktioniert leider weiterhin nicht. Ich bekomme statdessen die Fehlermeldung „…kann nicht geöffnet werden: resource is not available“. Ich habe sowohl den Hostnamen als auch die IP Adresse versucht.
    Woran könnte das liegen?

  11. Hallo Thomas,
    danke für die Rückmeldung. Ja, ich arbeite mit der aktuellen Extension (v 0.4). Inzwischen habe ich noch etwas weiter gesucht und bin hierauf gestoßen: https://github.com/openhab/openhab-vscode/issues/109

    Scheint also ein bekannter Fehler zu sein.

    • Hallo Joe,

      ok, ich habe die Vermutung, dass es daran liegt, dass ich bisher einige Updates von VS Code ausgesetzt habe.

      Dann hilft wohl nur warten.

      BG
      Thomas

  12. Hallo Thomas,
    erst mal vielen Dank für die tollen Anleitungen. Ich bin absoluter beginner und kämpfe mich gerade durch. openHab2 läuft bei mir auf einer Synology. Bei der Einrichtung von Visual Studio Code nach deiner Anleitung komme ich bei „Ordner einrichten“ nicht weiter. Wo soll der Conf-Ordner sein? Auf meinem PC (dazu müßte ich ihn samt Unterordnern manuell anlegen – richtig?) oder auf der Synology, wo es diese nach der Installation von openHab schon gibt. Aber wie komme ich in diesem Fall von VS da ran? Muß ich die als Laufwerksbuchstabe im Windows Explorer anlegen? – Ist vielleicht ’ne blöde Frage, aber wie gesagt – Anfänger…
    Vielen Dank für Deine Unterstützung
    Uli

    • Hallo Uli,

      Danke und dumme Fragen gibt es nicht .

      Du musst auf das Verzeichnis der Synology zugreifen. Ich weiß nicht genau wie du installiert hast. Aber im Verzeichnis, welches du zuvor angelegt hast, findest du den Conf Ordner. Binde diesen als Netzwerklaufwerk ein. Dann einfach das Laufwerk in VS Code öffnen.

      Beste Grüße
      Thomas

  13. Hallo Thomas,
    vielen Dank für deinen letzten Tip – jetzt bin ich schon etwas weiter. Folgendes Problem: ich habe in VS zur Übung ein ganz einfaches item angelegt (string VS_test = „abc“ „anzeigen“). Es wird defaults.items gespeichert – soweit ok. Aber im Habpanel und PaperUI kann ich das item nicht finden. Das openhab-Symbol sehe ich im Editor, aber beim Draufklicken kommt die Fehlermeldung „Unable to open ‚_default‘: resource is not availableW. Wahrscheinlich hängt beides zusammen. Aber was mache ich falsch?
    Viele Grüße
    Uli

    • Hallo Uli,

      du wirst die Items so nicht einfach in der Paper UI und Habpanel finden. Habpanel nutze ich noch nicht. Ist aber geplant. Paperui zeigt Items zu verbundenen Kanäle an. Da bei dir kein Kanal angebunden ist, siehst nichts.

      Items werden direkt in den Sitemaps verwendet und können in der Basic UI und Papier UI angezeigt werden.

      Lies am besten den Beitrag openHAB Konfiguration .

      Beste Grüße
      Thomas

  14. Hallo Thomas,
    danke für den Tip. Ich habe jetzt eine Sitemap angelegt – genau nach deinem Beitrag und auch nochmal in der opeHab-Doku nachgesehen. Leider kann ich die sitemap nicht in der BasicUI sehen (er zeigt an, dass noch keine sitemaps angelegt wurden). In den user settings habe ich die lokale URL des Servers angelegt – mal mit, mal ohne Portangabe probiert. Irgendwie scheint die Kommunikation zwischen VS und der openHAB-Installation nicht zu klappen – siehe auch meine gepostete Fehlermeldung, die immer noch da ist. Ist es eigentlich ok, dass dass openHab-Symbol oben rechts im VS nur auftaucht, wenn ich die items-Datei editiere? Bei der sitemap-Datei ist es weg.

    Hier mal die ganz kurzen Codes:
    in default.items gespeichert:
    string VS_test „anzeigen…“

    in test2.sitemaps gespeichert:
    sitemap erste_Seite label=“weiter“ {
    Frame label=“Items“ {
    String item=VS_test
    }
    }

    Vielleicht hast du noch einen Hinweis.
    Danke und viele Grüße
    Uli

  15. Hallo Thomas,
    nach (fast) 2 Nächten intensiver Suche jetzt der Erkenntnisstand:

    1. openHab 0.4.0 hat einen Bug beim Aufrufen der Basic- und PaperUI, siehe
    https://github.com/openhab/openhab-vscode/issues/109

    2. Dein Tip, „auf openHab 0.3.5 downgraden“, scheitert an einem Bug in VS 1.127.2, siehe
    https://github.com/Microsoft/vscode/issues/58097

    Was nun? Abwarten, bis eines der Probleme gefixt ist? Oder hast Du noch eine Idee?
    Viele Grüße
    Uli

    • Hallo Uli,

      oh Backe, da kommt einiges zusammen. Das gute ist aber. Ich habe es gerade bei mir in der Version 1.27.2 getan und es läuft alles.

      Mache bitte folgende Schritte
      – Aktualisiere VS Code
      – Öffne VS Code und deinstalliere das 0.4.0 addon
      – Gehe in die Einstellungen, suche nach Extensions: Auto Update und deaktiviere diese Einstellung
      – Öffne die Kommandozeile in Windows und kopiere folgendes rein (code –install-extension openhab-0.3.5.vsix)

      Das lief bei mir ohne Probleme. Ich kann sowohl Paper UI als auch Basic UI in VS Code öffnen.

      Gruß
      Thomas

  16. Hallo Thomas,
    es geht ein bischen voran. Jetzt geht das BasicUI-Fenster auf (das Deaktivieren des Autoupdate war hier wohl das Entscheidende), aber er sagt, dass keine Sitemaps installiert sind.
    Alle items und things, die ich in PaperUI angelegt habe, kennt VS und zeigt sie auch richtig an.
    Wie kann ich dir mal einen screenshot schicken? Vielleicht hilft das weiter.
    Danke und viele Grüße
    Uli

  17. ….hat leider nichts gebracht. Gibt es in VS noch irgendeine Einstellung, die man beachten muß, um sitemaps in BasicUI sichtbar zu machen?
    Danke für Deine Geduld.
    Uli

  18. Hallo Thomas
    schon wieder ich – sorry.
    Ich habe jetzt mal die Ausgabe auf clasicUI gesetzt („openhab.sitemapPreviewUI“: „classicui“), da passiert was Interessantes. Es kommt folgende Fehlermeldung:

    HTTP ERROR 500

    Problem accessing /classicui/app. Reason:

    Server Error
    Caused by:

    javax.servlet.ServletException: Sitemap ’smarthome‘ could not be found
    at org.eclipse.smarthome.ui.classic.internal.servlet.WebAppServlet.service(WebAppServlet.java:205)
    at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:848)
    at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:584)
    at org.ops4j.pax.web.service.jetty.internal.HttpServiceServletHandler.doHandle(HttpServiceServletHandler.java:71)
    at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)
    at org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:548)
    ……….

    Das sieht so aus, als ob er die Datei „smarthome“ überall sucht (ich weiß nicht mal, wo org.eclipse.jetty… liegt), aber eben nicht auf der lokalen Serveradresse 192.168. ….\smarthome\…..
    Könnte das der Grund sein, warum er BasicUI und ClassicUI nicht findet, und wenn ja, was muß ich tun, damit er im richtigen Verzeichnis sucht (smarthome\openhab2\conf…..).
    Viele Grüße
    Uli

    • Hallo Uli,

      hast du die Classic UI installiert? Es kann so viele Ursachen haben.

      Ich glaube inzwischen ist eventuell ziemlich der Wurm drin.

      Schon mal überlegt den Kurs zu buchen? Das wird dir sicherlich eine Menge Frustration und Zeit sparen.

      Beste Grüße
      Thomas

  19. Heureka! Es geht – Hallo Thomas. Ich habe noch mal ganz von vorn angefangen, und dabei ist mir aufgefallen, dass ich den Ordner in der Synology nicht openHAB, sondern openHAB2 genannt habe – kleine Ursache, große Wirkung. Morgen spendiere ich dir erst mal einen Kaffee, und Deinen Kurs werde ich an den langen Winterabenden durcharbeiten. Nochmals besten Dank und viele Grüße – Uli

  20. Hallo,
    ich bekommen folgende Fehlermeldung im VS Code wenn ich den das Symbol zum Aufruf des BasicUI klicke.
    Basic UI kann nicht geöffnet werden: resource is not available

    Auch sehe ich unten links keine Things und keine Items.
    Mir kommt es so vor, als wenn VS Code keine Verbindung zum OpenHAB-Server hat.
    OpenHAB läuft bei mir auf einer Synology DS.
    Hostname und Port habe ich entsprechend geändert.
    Der Installationsordner auf der DS ist kein Standard. Hier habe ich aber auch keine Option gefunden, diesen irgendwo anzupassen.
    Die Firewall habe ich auch zum Testen schon abgeschaltet.
    VS Code = Version 1.28.2
    OpenHAB-Extension = Version 0.4.0

    Hat jemand einen Tipp für mich?
    Danke

    • Hallo,

      ich habe es aktuell nur mit einem Downgrade hinbekommen.

      Macht bitte folgende Schritte, falls ihr Probleme habt:
      – Aktualisiert VS Code
      – Öffnet VS Code und deinstalliert das 0.4.0 addon
      – Geht in die Einstellungen, sucht nach Extensions: Auto Update und deaktiviert diese Einstellung
      – Öffnet die Kommandozeile in Windows und kopiert folgendes rein (code –install-extension openhab-0.3.5.vsix) 
      Beste Grüße
      Thomas

  21. Dann sollte doch die Extension mit Version 0.3.5 in VS Code erscheinen, oder?
    Bei mir tut es das zumindest nicht.

  22. Habs manuell von GitHub geladen und installiert. Und schon funktioniert es. Danke Dir trotzdem!!!

    Hinterlasse einen Kommentar

    openHAB 2 Schritt für Schritt installieren

    Spare dir stundenlange Suche

    WERBUNG

    openHAB Videotraining

    10,5  Stunden Videotraining 

    4,5 von 5 Sternen