iobroker-javascript-vs-code-extension

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #android #deep-learning #docker #macos #awesome #security #pytorch #ios #openai

iobroker-javascript-vs-code-extension

(★ 29)

A Visual Studio Code extension for script development in Visual Studio Code.

iobroker-javascript-vs-code-extension 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# VS Code extension for ioBroker javascript adapter

[ioBroker](https://www.iobroker.net/) is a mighty IoT platform and enables you to write custom scripts with its [JavaScript adapter](https://github.com/ioBroker/ioBroker.javascript).

This extension for [Visual Studio Code](https://code.visualstudio.com/) enables you to develop the scripts completely in Visual Studio Code, without the need of the web interface.

![Script Explorer](https://media.githubusercontent.com/media/nokxs/iobroker-javascript-vs-code-extension/main/doc/script-explorer.gif)

## Features

Open the command palette (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> OR <kbd>F1</kbd>) 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](https://github.com/ioBroker/ioBroker.javascript/blob/master/src/lib/javascript.d.ts). 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](https://github.com/ioBroker/ioBroker.javascript/blob/master/docs/en/javascript.md).

### 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:

```js
const apiToken = "__IOBROKER_SECRET_API_TOKEN__";
```

`.env`:

```ini
API_TOKEN=super-secret-token
```

Uploaded script source:

```js
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.

### Create scripts and subdirectories
Right click on an existing directory to create a new file in this directory or in the root directory. It is possible to create subdirectories, TypeScript files and JavaScript files. Newly created scripts are immediately uploaded to
the server as stopped scripts.

### Delete scripts
Scripts can be deleted on your ioBroker server via the script explorer. Right click on a script, select `Delete` and confirm that the script shall be really be deleted. If the script is synced to
your local disk, it will also be deleted there.

### Delete directories recursively
Directories can be deleted on your ioBroker server via the script explorer. Right click on a directory and select `Delete` and confirm that the directory and ALL of its content shall be deleted. If the directory is synced to your disk it will be deleted with all of its content.

### Change JS Instance
The JS Instance for a script can be changed over the script explorer. Right click on a script and select `Change instance` via a quick pick.

![JS Instance Number](https://media.githubusercontent.com/media/nokxs/iobroker-javascript-vs-code-extension/main/doc/js-instance-nr.jpg)

### Show script logging
Press <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>U</kbd> to open the "Output" view. Open the drop-down and select `ioBroker (all)` or `ioBroker (current script)`.

* `ioBroker (all)`: As long as a connection to ioBroker exists, this will show the output of all scripts.
* `ioBroker (current script)`: As long as a connection to ioBroker exists, this will show only the outputs of the script in the currently active tab. This output gets not cleared, if the tab is changed. If you need to 
clear the output use Visual Studio's `Clear Output` feature.

### Hover over state id string to show value

Hover over any string with a full state id to show current data of the state:

![State Hover Info](https://media.githubusercontent.com/media/nokxs/iobroker-javascript-vs-code-extension/main/doc/state-hover-info.jpg)

This only works for states and not for channels.

### Auto completion (IntelliSense) of iobroker state ids

Type `.` inside any string to trigger the IntelliSense menu. If the string contains parts of
an ioBroker state id (for example `admin.0.`), IntelliSense will show all states/channels/devices/... under the
given partial state id. In case of `admin.0.` it will look like this:

![State Id auto completion](https://media.githubusercontent.com/media/nokxs/iobroker-javascript-vs-code-extension/main/doc/state-id-auto-completion.jpg)

If you press <kbd>.</kbd> instead of <kbd>enter</kbd> to select an item the next item will appear automatically.

The whole auto completion process in action:

![State Id auto completion](https://media.githubusercontent.com/media/nokxs/iobroker-javascript-vs-code-extension/main/doc/state-id-auto-completion.gif)

### Add name of ioBroker object/state id as comment

Sometimes it is hard to remember the meaning of a generic ioBroker object/state id. To make this easier
the name of an id can be added as comment via code action.

Put your cursor within a valid id and open the code actions menu (click on the light bulb or press <kbd>Ctrl</kbd>+<kbd>.</kbd>) and select `Add iobroker state name as comment`. The entry will only appear if the state id is valid.

![State name code action](https://media.githubusercontent.com/media/nokxs/iobroker-javascript-vs-code-extension/main/doc/iobroker-state-id-name-code-action.jpg)

## Extension Settings

After the first activation a `.iobroker-config.json` file is created in the root directory of your workspace. It contains all settings.

> Current limitation: Hot reloading the settings is currently not supported. After changing a setting, restart VS Code.

### Available settings

An example with all available settings can be found [here](./doc/.iobroker-config.json).

| Key           | Description           | Mandatory | Default |
|---------------|-----------------------|-----------|---------|
| `ioBrokerUrl` | The url has to be prefixed with http/https. Specify no port here. | Yes |  |
| `socketIoPort` | Use the port of the admin adapter (usually 8081). Do not use the port of the socket.io Adapter (usually 8084) as this will not work, because of missing permissions. | Yes | |
| `scriptRoot` | Relative directory path, which is used as root of ioBroker scripts. | Yes | |
| `adminVersion` | The admin version to connect to. Valid values: `Admin4`, `Admin5`, `Admin6`, `Admin7` | Yes | |
| `autoReconnect` | Should a lost connection be automatically be restored? | No | true |
| `allowSelfSignedCertificate` | Is it allowed to connect to a self signed certificate? | No | false |
| `username` | The user name for ioBroker. Only necessary for password protected ioBroker installations | No | |
| `collectDebugLog` | Should the debug log be created directly on start up? | No | false |
| `scriptExplorer.collapseDirectoriesOnStartup` | Should the directories in the script explorer be collapsed on startup. | No | true |
| `autoUpload` | Automatically upload scripts on save? | No | false |
| `scriptAutoRun` | Automatically start a uploaded script? | No | false |
| `forceLogin` | Should login detection be skipped and login to ioBroker be forced? Works only with admin version >= 7.6.2 | No | false |
| `iobrokerNodeTypesVersion` | Specify the version of @types/node to use for TypeScript definitions. Check [available versions on npm](https://www.npmjs.com/package/@types/node?activeTab=versions) to find a suitable version. Use the version number without the 'v' prefix (e.g., "20.14.10"). | No | "20.14.10" |

### Admin versions
The extension currently supports the following Admin versions:

- Admin4 (**Deprecated** Some features like password protected installations are not supported)
- Admin5
- Admin6
- Admin7

## Debug Log

To help diagnose connection or runtime issues, the extension can write a debug log file.

**Enable via command:** Open the command palette and run `iobroker: Start/Stop collecting debug log`. Run it again to stop collecting. The log is appended to an existing file each time collecting starts.

**Enable on startup:** Set `"collectDebugLog": true` in `.iobroker-config.json` to start collecting automatically when the extension connects.

**Log file location:** The log is written to `debug.log` in the root of your workspace.

## Known Issues

If you got any problems, please open a GitHub issue.

## Release Notes

See the section [Releases on Github](https://github.com/nokxs/iobroker-javascript-vs-code-extension/releases) for release notes.

iobroker-javascript-vs-code-extension

iobroker-javascript-vs-code-extension 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

iobroker-javascript-vs-code-extension

iobroker-javascript-vs-code-extension 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README