ioBroker.template-ts

=================

This is a template for the creation of an ioBroker adapter with TypeScript. While you don't need it, it serves as a nice starting point for developing your own adapter.

It includes both code running within iobroker and as vis widget. If you only plan to create a vis widget then you should use the iobroker.vis-template instead.

If you are interested in a stripped down version without widget, docs and stuff, consider using the bare branch.

NOTE: This description is not updated for v0.2.0 yet!!!

Steps

1. download and unpack this packet from github https://github.com/AlCalzone/ioBroker.template-ts/archive/master.zip or clone git repository git clone --depth=1 https://github.com/AlCalzone/ioBroker.template-ts.git

2. download required npm packets. Write in ioBroker.template directory:

npm install

3. set name of this template. Call

grunt rename --name=mynewname --email=email@mail.com --author="Author Name"

mynewname must be lower case and with no spaces.

If grunt is not available, install grunt globally:

npm install -g grunt-cli

4. rename directory from ioBroker.template-ts (can be ioBroker.template-master) to iobroker.mynewname

5. to use this template you should copy it into .../iobroker/node_modules directory and then create an instance for it with iobroker.admin

6. create your adapter:

• you might want to start with main.ts (code running within iobroker) and admin/index.html (the adapter settings page).

• Adapter-Development-Documentation,

• Installation, setup and first steps with an ioBroker Development Environment

• Write and debug vis widgets

• files under the www folders are made available under http://<iobrokerIP>:8082/<adapter-name>/

  • for this to work the iobroker.vis adapter has to be installed
  • delete this folder if you do not plan to export any files this way
  • call iobroker upload <adapter-name> after you change files in the www folder to get the new files uploaded to vis

• the widget folder contains an example of a vis widget

  • you might want to start with widget/.html and widget/js/.js
  • call iobroker visdebug <adapter-name> to enable debugging and upload widget to "vis". (This works only from V0.7.15 of js-controller)
  • If you do not plan to export any widget then delete the whole widget folder and remove the "restartAdapters": ["vis"] statement from io-package.json
  • After admin/index.html is changed you must execute iobroker upload mynewname to see changes in admin console. The same is valid for any files in admin and www directory

7. change version: edit package.json and then call grunt p in your adapter directory.

8. share it with the community

Unit testing

As of version 0.1.0, the template adapter comes with TypeScript-style unit testing enabled. Files with the name *.test.ts in your src/ directory are automatically picked up by Travis/AppVeyor testing and run before the adapter testing.
An example is given in src/main.test.ts. It is advised to provide such test files for all modules in your adapter to pick up unwanted errors.

In order to test changes locally, run npm run test_ts for testing or npm run coverage for an extensive code coverage report. That report can be viewed in your browser by opening the file coverage/index.html.

Changelog

0.2.0 (2016-01-06)

• (AlCalzone) Added support for Admin v3

0.1.0

• (AlCalzone) added unit testing setup

0.0.1

• (AlCalzone) initial release

License

The MIT License (MIT)

Copyright (c) 2018 @@Author@@ <@@email@@>

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.