Tests: 
Template for adapter development
This section is intended for the developer. It can be deleted later.
Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README. You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you.
You are almost done, only a few steps left:
-
Create a new repository on GitHub with the name
ioBroker.template -
Initialize the current folder as a new git repository:
git init -b main git add . git commit -m "Initial commit"
-
Link your local repository with the one on GitHub:
git remote add origin https://github.com/Author/ioBroker.template
-
Push all files to the GitHub repo:
git push origin main
-
Add a new secret under https://github.com/Author/ioBroker.template/settings/secrets. It must be named
AUTO_MERGE_TOKENand contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens. -
Head over to widgets/template.html 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 <scriptname>
| Script name | Description |
|---|---|
test:package |
Ensures your package.json and io-package.json are valid. |
test |
Performs a minimal test run on package files. |
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. |
Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form
v<major>.<minor>.<patch>. 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:
npm run releaseAdditional command line options for the release script are explained in the release-script documentation.
To get your widget 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:
- Create a tarball from your dev directory:
npm pack
- Upload the resulting file to your ioBroker host
- Install it locally (The paths are different on Windows):
cd /opt/iobroker npm i /path/to/tarball.tgz
For later updates, the above procedure is not necessary. Just do the following:
- Overwrite the changed files in the adapter directory (
/opt/iobroker/node_modules/iobroker.template) - Execute
iobroker upload templateon the ioBroker host
- (Author) initial release
MIT License
Copyright (c) 2024 Author [email protected]
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.