Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
}
],
"cSpell.words": [
"openhab"
"basicui",
"matchresult",
"openhab",
"openhabhost"
]
}
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Bump minimum VS Code engine requirement to ^1.76.0 (required for native fetch support)
- Add Jest test suite for client-side HTTP code (jest, ts-jest, jest-fetch-mock)

### Removed

- Remove `openhab.updateNotice` command and its backing `MigrationManager.updateCheck()` call (#362)
- Remove `UpdateNoticePanel` and `MigrationManager` as active extension features (#362)

Comment thread
pgfeller marked this conversation as resolved.
### Fixed

- Fix CI workflow paths-ignore pattern (.azure-pipelines/**)
Expand All @@ -41,7 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Refactor configuration entries (#247)
- Remove 3rd Party references and rename console setting (#247)
- Replace deprecated http library (#247)
- Add update notice prepared for loing term usage (#250, #258, #260)
- Add update notice prepared for long term usage (#250, #258, #260)
- Remove Changelog from .vscodeignore for better marketplace presentation (#253)
- Dependency update (#254)

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In order to join our forces here, you'd need a few things to get started:

Please report [openHAB VS Code Extension specific issues here](https://github.com/openhab/openhab-vscode/issues),
while issues that are related to *openHAB2 addons* or *openHAB Core* should be reported in the
[openHAB2 GitHub repository](https://github.com/openhab/openhab2-addons/issues) or the
[openHAB add-ons GitHub repository](https://github.com/openhab/openhab-addons/issues) or the
[openHAB Core GitHub repository](https://github.com/openhab/openhab-core), respectively.
Do not worry, if you are not clear, which category your issue belongs to - we will
redirect you, if necessary.
Expand Down Expand Up @@ -60,7 +60,7 @@ You can find our builds and artifacts on <https://dev.azure.com/openhab/vscode-o

## Explore the API

- You can open the full set of our API when you open the file `node_modules/vscode/vscode.d.ts`
- You can open the full set of our API when you open the file `node_modules/@types/vscode/index.d.ts`

## Run tests

Expand Down
12 changes: 0 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,12 @@

[openHAB](http://www.openhab.org) is a vendor and techology agnostic open source automation software for your home. This [Visual Studio Code](https://code.visualstudio.com) extension allows you to work with openHAB configuration files (like `*.items`, `*.rules`, `*.sitemap` and `*.script`) thanks to the syntax highlighting, code snippets and integrated search.

The extension is designed with openHAB 2.x in mind - most snippets and design patterns will work in openHAB 2.x

## Features

- Syntax highlighting for the [openHAB DSL](https://www.openhab.org/docs/configuration/) (rules, items, scripts and sitemaps).
- Code snippets for openHAB, including [Design Patterns](https://community.openhab.org/tags/designpattern) by Rich Koshak
- Integrated quick search of [openHAB Community](https://community.openhab.org)
- Integrated Basic UI browser window (`Ctrl + Alt + O` or editor title icon)
- Integrated Paper UI preview for the Items and Things
- Integration with openHAB REST API
- List of all Items accessible from the tree view
- Code completions
Expand Down Expand Up @@ -67,20 +64,11 @@ See [Contributing.md](https://github.com/openhab/openhab-vscode/blob/master/CONT
[ADOBuildBadgeImage]: https://img.shields.io/azure-devops/build/openhab/82e39b03-2e63-4a34-84ca-3cb57be32202/2/master?logo=azure-pipelines&logoColor=blue
[ADOBuildBadgeImageLink]: https://dev.azure.com/openhab/vscode-openhab/_build?definitionId=2

[ADOTestImage]: https://img.shields.io/azure-devops/tests/openhab/82e39b03-2e63-4a34-84ca-3cb57be32202/2/master?logo=azure-devops&logoColor=blue
[ADOTestImageLink]: https://dev.azure.com/openhab/vscode-openhab/_build?definitionId=2

[LicenseBadgeImage]: https://img.shields.io/badge/license-EPL%202-green.svg (License Information)
[LicenseBadgeImageLink]: https://opensource.org/licenses/EPL-2.0

[MarketplaceRatingBadgeImage]: https://img.shields.io/visual-studio-marketplace/stars/openhab.openhab?color=orange&label=marketplace&logo=visual-studio-code&logoColor=blue (Star rating)
[MarketplaceRatingBadgeImageLink]: https://marketplace.visualstudio.com/items?itemName=openhab.openhab&ssr=false#review-details

[MarketplaceDownloadBadgeImage]: https://img.shields.io/visual-studio-marketplace/d/openhab.openhab?logo=visual-studio-code&logoColor=blue
[MarketplaceDownloadBadgeImageLink]: https://marketplace.visualstudio.com/items?itemName=openhab.openhab

[openVsxDownloadBadgeImage]: https://img.shields.io/open-vsx/dt/openhab/openhab?label=Open%20VSX%20downloads&style=plastic
[openVsxDownloadBadgeImageLink]: https://open-vsx.org/extension/openhab/openhab

[GitHubReleaseBadge]: https://img.shields.io/github/v/release/openhab/openhab-vscode?include_prereleases (latest by date including pre-releases)
[GitHubReleaseBadgeLink]: https://github.com/openhab/openhab-vscode/releases
10 changes: 5 additions & 5 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ description: "The openHAB vscode extension provides useful features for configur

You are able to configure the hostname and port for the Sitemap preview.

- `openhab.connection.host` (mandatory), default: openhabianpi
- `openhab.connection.port` (optional), default: 8080
- `openhab.connection.host` (mandatory), default: *not set*
- `openhab.connection.port` (optional), default: *not set*

Comment on lines +12 to 14
*openhab.connection.host* will also work with the IP address of your openHAB instance, instead of the hostname.

Expand Down Expand Up @@ -47,17 +47,17 @@ It's also utilized for code completions.

If you're using this extension just for the syntax highlighting
and don't want to involve the REST API, you can disable it by providing
the following parameter in your User Settings (`Ctrl + Shift + S`):
the following parameter in your User Settings (`Ctrl + ,`):

```json
"openhab.useRestApi": false
```

You may need to reload the VSCode window to take effect.

#### openHAB 3 Rest API
#### openHAB Rest API

Since openHAB 3 (with its on default activated api authentication) has been released you have to fulllfil some additional steps to get a working connection.
Since openHAB 3 (with its on default activated api authentication) has been released you have to fullfil some additional steps to get a working connection.

1. [Generate an api token for your user](https://www.openhab.org/docs/configuration/apitokens.html)
2. Add the generated token as `openhab.connection.authToken` configuration
Expand Down
Loading