ticaki / iobroker.example

Template adapter for ioBroker

ioBroker examples

This is a collection of examples for ioBroker developers to create adapters or VIS widgets. You can use it to get an overview how ioBroker adapter code and structure looks like.

Please use @iobroker/create-adapter to generate a custom skeleton based on your exact needs. We recommend that way if you start developing an adapter or widget.

Templates

Currently, the following templates are available:

Adapter and visualization

JavaScript

TypeScript

Adapter only

JavaScript

TypeScript

Visualization only

Features

All templates come with the following features:

• IntelliSense (auto completion and tooltips) in supporting editors
• JavaScript only:
  • ESLint for code quality
  • Type checking based on the ioBroker declarations
• TypeScript only:
  • ESLint for code quality
  • nyc for code coverage
• Built-in component tests using mocha & chai (with chai-as-promised) and sinon (with sinon-chai) for:
  • Correctly defined package files
  • and your own tests
• ... and more to come

Anything missing?

The templates are automatically generated using @iobroker/create-adapter. If you're missing a feature or found a bug, please open an issue in that repository. Or consider using the tool directly for much more configuration goodness.

For developers

Please don't edit these files directly (except this README). Instead the CI builds in the create-adapter repo should be updated.