NestJS Adapter for Rest API access to function not covered by the standard simple Api like sendTo
npm install iobroker.sg_webapi!Logo
!Number of Installations
!Current version in stable repository
Tests: !Test and Release
NestJS Adapter for Rest API access to function not covered by the standard simple Api like sendTo
This section is intended for the developer. It can be deleted later
You are almost done, only a few steps left:
1. Create a new repository on GitHub with the name ioBroker.sg_webapi
1. Push all files to the GitHub repo. The creator has already set up the local repository for you:
``bash`
git push origin main
1. Head over to src/main.ts and start programming!
We've collected some best practices regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
Several npm scripts are predefined for your convenience. You can run them using npm run
| Script name | Description |
|-------------|-------------|
| | Compile the TypeScript sources. |watch
| | Compile the TypeScript sources and watch for changes. |test:ts
| | Executes the tests you defined in *.test.ts files. |test:package
| | Ensures your package.json and io-package.json are valid. |test:unit
| | Tests the adapter startup with unit tests (fast, but might require module mocks to work). |test:integration
| | Tests the adapter startup with an actual instance of ioBroker. |test
| | Performs a minimal test run on package files and your tests. |check
| | Performs a type-check on your code (without compiling anything). |lint
| | Runs ESLint to check your code for formatting errors and potential bugs. |translate
| | Translates texts in your adapter to all required languages, see @iobroker/adapter-dev for more details. |release
| | Creates a new release, see @alcalzone/release-script for more details. |
The adapter template uses esbuild to compile TypeScript and/or React code. You can configure many compilation settings
either in tsconfig.json or by changing options for the build tasks. These options are described in detail in the@iobroker/adapter-dev documentation.
When done right, testing code is invaluable, because it gives you the
confidence to change your code while knowing exactly if and when
something breaks. A good read on the topic of test-driven development
is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92.
Although writing tests before the code might seem strange at first, but it has very
clear upsides.
The template provides you with basic tests for the adapter startup and package files.
It is recommended that you add your own tests into the mix.
Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form
v. We strongly recommend that you do. The necessary steps are described in .github/workflows/test-and-release.yml.
Since you installed the release script, you can create a new
release simply by calling:
`bash`
npm run release
Additional command line options for the release script are explained in the
release-script documentation.
To get your adapter released in ioBroker, please refer to the documentation
of ioBroker.repositories.
In order to install the adapter locally without publishing, the following steps are recommended:
1. Create a tarball from your dev directory:
`bash`
npm pack
1. Upload the resulting file to your ioBroker host
1. Install it locally (The paths are different on Windows):
bash`
cd /opt/iobroker
npm i /path/to/tarball.tgz
For later updates, the above procedure is not necessary. Just do the following:
1. Overwrite the changed files in the adapter directory (/opt/iobroker/node_modules/iobroker.sg_webapi)iobroker upload sg_webapi` on the ioBroker host
1. Execute
- (Swissglider) URL Notification Subscription Service change:
- fix on addURLNotificationSubscription
- (Swissglider) URL Notification Subscription Service change:
- add ControlAdapterService
- (Swissglider) URL Notification Subscription Service change:
- deleteURLNotificationSubscriptions - fix unsubscribe
- (Swissglider) debugging
- (Swissglider) debugging
- (Swissglider) URL Notification Subscription Service change:
- deleteURLNotificationSubscriptions
- (Swissglider) URL Notification Subscription Service change:
- add addURLNotificationSubscriptions Array..
- (Swissglider) URL Notification Subscription Service change:
- add forceOverwritte to addURLNotificationSubscription
- fixes on addURLNotificationSubscription
- add getURLNotificationSubscriptionList Method
- add deleteAllURLNotificationSubscriptions
- add deleteURLNotificationSubscriptions
- (Swissglider) URL Notification Subscription Service added
- (Swissglider) Extended miio-service
- (Swissglider) Added miio-service
- (Swissglider) Version 1
- (Swissglider) Version 1
MIT License
Copyright (c) 2022 Swissglider
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.