VS Code extension for ioBroker javascript adapter

ioBroker is a mighty IoT platform and enables you to write custom scripts with its JavaScript adapter.

This extension for Visual Studio Code enables you to develop the scripts completely in Visual Studio Code, without the need of the web interface.

Features

Open the command palette (Ctrl + Shift + P OR F1) and type iobroker: to see all available commands.

Connect to your ioBroker instance by invoking the command iobroker: Connect to ioBroker. You can see the process in the gif above. If your connection fails, check the created file .iobroker-config.json and re-run the command iobroker: Connect to ioBroker for another connection attempt.

If .iobroker-config.json is found in the root of your workspace, the extension automatically starts a connection attempt.

Password protected ioBroker installations

If your ioBroker installation is protected via password, the extension will ask for it during the connection attempt. The username is stored in the config file .iobroker-config.json and the password is stored in the VS Code internal secret storage. If the password was changed, the extension will automatically ask for the new one. It might be necessary to restart VS Code in the case supplying the new password fails.

Disconnect / Logout

Use the command iobroker: Logout from ioBroker to disconnect from ioBroker and delete all stored credentials (username and password). This is useful when switching to a different ioBroker instance or when credentials need to be reset.

Type definitions

If you choose to configure ioBroker type definitions, the current definitions are downloaded from GitHub. Additionally a tsconfig.json is created (if it does not exist yet) with the necessary settings. This enables Visual Studio Code to know the ioBroker specific javascript functions.

View: Script explorer

The script explorer can be found in the activity bar behind the ioBroker logo. It shows all scripts, which are on the configured iobroker server. If the script content differs on the local disk from the remote version on the ioBroker server, a star (*) is shown next to the script name.

Click on a script to show its contents. If the script is not downloaded yet, only a preview is opened.

Every time a script object is changed, the script explorer refreshes its view. You can also manually refresh it by clicking the refresh button in the Script Explorer title bar. If the connection was lost, clicking refresh will automatically attempt to reconnect.

View: Changed scripts

The Changed scripts view can be found in the activity bar behind the ioBroker logo. It shows all scripts, where the local version differs from the server version. Only scripts which are on local disk and already uploaded to the server are shown (This might change in the future).

The same scripts are also shown in the script explorer marked with a star.

Download scripts

Either download only one script (iobroker: Download script) or all scripts at once (iobroker: Download all scripts). To download a single script you have the following options:

• Go to the script explorer and press the download button next to the script you want to download
• Use the command iobroker: Download script. This command is only for updating an existing script as it downloads the script in the active text editor.

Upload scripts

To upload a single script you have the following options:

• Go to the script explorer and press the upload button. This will only work, if the script resides on your disk.
• Use the command iobroker: Upload script. This command uploads the script in the active text editor.

Only scripts residing on local disk can be uploaded. Scripts which are marked as remote only in script explorer can be viewed by clicking on it, but changes cannot be uploaded.

Replace secrets from .env on upload

Before uploading a script, the extension can replace placeholders with values from an .env file in your workspace root.

Use the placeholder pattern __IOBROKER_SECRET_<KEY>__ in your script and define <KEY> in .env.

Example:

const apiToken = "__IOBROKER_SECRET_API_TOKEN__";

.env:

API_TOKEN=super-secret-token

Uploaded script source:

const apiToken = "super-secret-token";

If .env is missing or a key is not found, the placeholder stays unchanged.

Start/Stop scripts

To start/stop a single script you have the following options:

• Go to the script explorer and press the start or stop button.
• Use the command iobroker: Start script, respectively iobroker: Stop script. This command starts/stops the script in the active text editor.

Show diff between local and server version of a script

Use the diff button in either the script explorer or the changed scripts view to show a diff of all the changes made locally.

Move scripts

Scripts can be moved from one directory to another on your ioBroker server. Moving a script over the VS Code file browser is not supported yet.

Scripts can only be moved over the script explorer. Right click on the script you want to move, select Move and choose the directory you want the script to move to. If the script is synced to your local disk, it will also be moved there.

Rename scripts

Scripts can be renamed via the script explorer. Right click on the script you want to rename and select Rename. The script is renamed on the ioBroker server and, if it is synced to your local disk, the local file is renamed as well.

This is the beginning of the README. Read the rest at the original. Read the full README ↗