JavaScript

ioBroker.template

Tests:

template adapter for ioBroker

Template for adapter development

Developer manual

This section is intended for the developer. It can be deleted later.

DISCLAIMER

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.

Getting started

You are almost done, only a few steps left:

1. Create a new repository on GitHub with the name ioBroker.template

2. Initialize the current folder as a new git repository:

   git init -b main
   git add .
   git commit -m "Initial commit"

3. Link your local repository with the one on GitHub:

   git remote add origin https://github.com/Author/ioBroker.template

4. Push all files to the GitHub repo:

   git push origin main

5. Add a new secret under https://github.com/Author/ioBroker.template/settings/secrets. It must be named AUTO_MERGE_TOKEN and 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.

6. Head over to main.js and start programming!

Best Practices

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

State Roles

When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the state roles documentation.

Important: Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.

Scripts in package.json

Several npm scripts are predefined for your convenience. You can run them using npm run <scriptname>

Script name	Description
test:js	Executes the tests you defined in *.test.js files.
test:package	Ensures your package.json and io-package.json are valid.
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.

Writing tests

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.

Publishing the adapter

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

Test the adapter manually on a local ioBroker installation

In order to install the adapter locally without publishing, the following steps are recommended:

1. Create a GitHub repository for your adapter if you haven't already
2. Push your code to the GitHub repository
3. Use the ioBroker Admin interface or command line to install the adapter from GitHub:
   • Via Admin UI: Go to the "Adapters" tab, click on "Custom Install" (GitHub icon), and enter your repository URL:

     https://github.com/Author/ioBroker.template
     

     You can also install from a specific branch by adding #branchname at the end:

     https://github.com/Author/ioBroker.template#dev
     

   • Via Command Line: Install using the iob command:

     iob url https://github.com/Author/ioBroker.template

     Or from a specific branch:

     iob url https://github.com/Author/ioBroker.template#dev

For later updates:

1. Push your changes to GitHub
2. Repeat the installation steps above (via Admin UI or iob url command) to update the adapter

Changelog

WORK IN PROGRESS

• (Author) initial release

License

MIT License

Copyright (c) 2025 Author author@mail.com

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.