VSCode extension for js rules and variables

Setup, Configuration and Use Beginners
1

GitHub - openhab/openhab-vscode: VS Code extension for openHAB configuration files is a nice extension for DSL rules where you can get mouse over item state tool tips.
However, it does not seem to work with js files. Is there an equivalent for javascript ?

2

No, there is no extension for VSCode that supports JS openHAB rules like that.

In the UI one has access to the developer sidebar which provides that sort of thing and more, but through VSCode there’s just support for generic JS extensions that are not openHAB aware.

3

I thought there might be something for js files. The extension hasn’t been updated in a while so I asked my friend Claude to modify it for me:

It was just one line of code and now the extension also has mouse over on js files:

grafik
grafik402×204 7.17 KB

4

From JavaScript Scripting - Automation | openHAB

openHAB JavaScript library provides type definitions for most of its APIs to enable code completion is IDEs like VS Code (opens new window). To use the type definitions, install the openhab npm package (opens new window)(read the installation guide (opens new window)for more information), and manually import the used namespaces (see above).

You need to special extension for VS Code, VS Code only needs the type definitions available.

5

You need more than that to do what OP was after, hover over an Item’s name and see it’s current state.

6

Thx, works great, was looking for that for a long time already :+1:

7

Ah, sorry did overlook that. Probably I shouldn’t use the community from my phone.

8

I just updated the extension. Tooltip now also reports variable states if found in the log. All you have to do is log the variable. E.g. myVariable=”state” should appear in the log and when you mouse over it looks like this:

image
image541×178 7.31 KB

If the string is found in the log and has no = “..” formatting, it looks like this:

image
image744×159 7.58 KB

Check it out here: Release v1.0.1 · s0170071/openhab-vscode · GitHub
You have to configure the location of the log. In the settings you would search for openhab.log and then edit the settings file:


    "openhab.log.openhabLogPath": "/opt/openhab/userdata/logs/openhab.log",

    "openhab.log.eventsLogPath": "/opt/openhab/userdata/logs/events.log"

Now Iet me look into breakpoints…

9

Mouse over for Item values does not work anymore on *.sitemap files. Any idea?

10

Jep. That never had worked in the first place. Noticed that too. Added sitemap support.
Here you go: Release v1.0.1 · s0170071/openhab-vscode · GitHub

11

Works like a charm, makes troubleshooting so much easier.
Thx a lot :+1:

12

I would encourage you to consider a PR or series of PRs with all of these improvements being made. It will benefit the community more widely.

13

https://github.com/openhab/openhab-vscode/pull/329

14

Thx for the PR.
Unfortunately there were no PR merged since years for that repo :joy:

15

It is part of the openHAB project so it should be possible to get someone to review and merge the PR. Someone may need to volunteer to be a maintainer though if the current maintainer is no longer active. It’s better than needing to fork the repo at least.

16

Check this out:

17

The link to the vsix file leads to a 404 error, could you please provide it again?

I had to reinstall my system and unfortunately I did not save this very helpful file.
I did not find any other way to show the actual state of Items in js files … thx a lot.

18

thanks for the heads up. I updated the link: https://github.com/s0170071/openhab-vscode/releases/ta

19

The link in the “Downloads” section on GitHub - s0170071/openhab-vscode: VS Code extension for openHAB configuration files · GitHub also results in a 404 error.

Changes in v1.0.1

Added

  • Hover tooltips for .items files: Hovering over item names in .items configuration files now provides live state information from the REST API and log files.
  • Hover tooltips for JavaScript automation files: Item hover tooltips work in .js files, not just DSL files.
  • Hover tooltips for sitemap files: Item name hover tooltips work in .sitemap files, including item=<name> references on widget lines.
  • Key-value state extraction from log lines: Hovering a variable found in events.log or openhab.log shows its value when the line contains varname="state" format.

The Hover tooltips for sitemap files don’t work for me.

20

No, works for me.
Browser cache issue?

https://github.com/s0170071/openhab-vscode/releases/download/v1.0.1/openhab-1.0.1.vsix

Edit: ah, you are talking about another link, sorry