|
2 | 2 | # ioBroker.kmcanio
|
3 | 3 | =================
|
4 | 4 |
|
5 |
| -This adapter is a kmcanio for the creation of an ioBroker adapter. You do not need it at least that you plan developing your own adapter. |
6 |
| - |
7 |
| -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-kmcanio](https://github.com/ioBroker/ioBroker.vis-kmcanio) instead. |
8 |
| - |
9 |
| -## Steps |
10 |
| -1. download and unpack this packet from github ```https://github.com/ioBroker/ioBroker.kmcanio/archive/master.zip``` |
11 |
| - or clone git repository ```git clone --depth=1 https://github.com/ioBroker/ioBroker.kmcanio.git``` |
12 |
| - |
13 |
| -2. download required npm packets. Write in ioBroker.kmcanio directory: |
14 |
| - |
15 |
| - ```npm install``` |
16 |
| - |
17 |
| -3. set name of this kmcanio. Call |
18 |
| - |
19 |
| - ```gulp rename --name mynewname --email email@mail.com --author "Author Name"``` |
20 |
| - |
21 |
| - *mynewname* must be **lower** case and with no spaces. |
22 |
| - |
23 |
| - If gulp is not available, install gulp globally: |
24 |
| - |
25 |
| - ```npm install -g gulp-cli``` |
26 |
| - |
27 |
| -4. rename directory from *ioBroker.kmcanio* (can be *ioBroker.kmcanio-master*) to *iobroker.mynewname* |
28 |
| - |
29 |
| -5. to use this kmcanio you should copy it into *.../iobroker/node_modules* directory and then create an instance for it with iobroker.admin |
30 |
| - |
31 |
| -6. create your adapter: |
32 |
| - |
33 |
| - * you might want to start with main.js (code running within iobroker) and admin/index.html (the adapter settings page). |
34 |
| - |
35 |
| - * [Adapter-Development-Documentation](https://github.com/ioBroker/ioBroker/wiki/Adapter-Development-Documentation), |
36 |
| - |
37 |
| - * [Installation, setup and first steps with an ioBroker Development Environment](https://github.com/ioBroker/ioBroker/wiki/Installation,-setup-and-first-steps-with-an-ioBroker-Development-Environment) |
38 |
| - |
39 |
| - * [Write and debug vis widgets](https://github.com/ioBroker/ioBroker/wiki/How-to-debug-vis-and-to-write-own-widget-set) |
40 |
| - |
41 |
| - * files under the www folders are made available under http://<iobrokerIP>:8082/<adapter-name>/ |
42 |
| - * for this to work the iobroker.vis adapter has to be installed |
43 |
| - * delete this folder if you do not plan to export any files this way |
44 |
| - * call ```iobroker upload <adapter-name>``` after you change files in the www folder to get the new files uploaded to vis |
45 |
| - * the widget folder contains an example of a vis widget |
46 |
| - * you might want to start with *widget/<adapter-name>.html* and *widget/js/<adapter-name>.js* |
47 |
| - * call ```iobroker visdebug <adapter-name>``` to enable debugging and upload widget to "vis". (This works only from V0.7.15 of js-controller) |
48 |
| - * 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* |
49 |
| - * 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 |
50 |
| - |
51 |
| -7. change version: edit package.json and then call ```grunt p``` in your adapter directory. |
52 |
| - |
53 |
| -8. share it with the community |
| 5 | +This adapter connects KM SmartHome Modules to ioBroker. |
| 6 | +Note that tis adapter is making its first steps. |
| 7 | +It is alpha state! |
54 | 8 |
|
55 | 9 | ## Requirements
|
56 |
| -* your github repository must have name "ioBroker.<adaptername>". **B** is capital in "ioBroker", but in the package.json the *name* must be low case, because npm does not allow upper case letters. |
57 |
| -* *title* in io-package.json (common) is simple short name of adapter in english. *titleLang* is object that consist short names in many languages. *Lang* ist not german Länge, but english LANGuages. |
58 |
| -* Do not use in the title the words "ioBroker" or "Adapter". It is clear anyway, that it is adapter for ioBroker. |
| 10 | +* you need to setup can0 interface on your system |
59 | 11 |
|
60 | 12 | ## Changelog
|
61 | 13 |
|
62 |
| -### 0.6.0 (2017.01.02) |
63 |
| -* (bluefox) Support of admin3 |
64 |
| - |
65 |
| -### 0.5.0 |
66 |
| -* (vegetto) include vis widget |
67 |
| - |
68 |
| -### 0.4.0 |
69 |
| -* (bluefox) fix errors with grunt |
70 |
| - |
71 |
| -### 0.2.0 |
72 |
| -* (bluefox) initial release |
| 14 | +### 0.0.1 |
| 15 | +* nitial release |
73 | 16 |
|
74 | 17 | ## License
|
75 | 18 | The MIT License (MIT)
|
|
0 commit comments