91 lines
4.4 KiB
Markdown
91 lines
4.4 KiB
Markdown
|
|
# yunkong2.rest
|
|
=================
|
|
|
|
This adapter is a template for the creation of an yunkong2 adapter. You do not need it, at least that you plan developing your own adapter.
|
|
|
|
This is extension of [yunkong2.template](https://git.spacen.net/yunkong2/yunkong2.template) adapter with REST service.
|
|
By default the WEB server will be started to serve HTTP GET/POST requests. It can be started as secure(https) or unsecure(http) and with authentication or without.
|
|
|
|
Additionally is shown how to poll some other URL for JSON data and parse them.
|
|
|
|
##Steps
|
|
1. download and unpack this packet from github ```https://git.spacen.net/yunkong2/yunkong2.template/archive/master.zip```
|
|
or clone git repository ```git clone https://git.spacen.net/yunkong2/yunkong2.template.git```
|
|
|
|
2. download required npm packets. Write in yunkong2.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 *yunkong2.template* (can be *yunkong2.template-master*) to *yunkong2.mynewname*
|
|
|
|
5. to use this template you should copy it into *.../yunkong2/node_modules* directory and then create an instance for it with yunkong2.admin
|
|
|
|
6. create your adapter:
|
|
|
|
* you might want to start with main.js (code running within yunkong2) and admin/index.html (the adapter settings page).
|
|
|
|
* [Adapter-Development-Documentation](https://git.spacen.net/yunkong2/yunkong2/wiki/Adapter-Development-Documentation),
|
|
|
|
* [Installation, setup and first steps with an yunkong2 Development Environment](https://git.spacen.net/yunkong2/yunkong2/wiki/Installation,-setup-and-first-steps-with-an-yunkong2-Development-Environment)
|
|
|
|
* [Write and debug vis widgets](https://git.spacen.net/yunkong2/yunkong2/wiki/How-to-debug-vis-and-to-write-own-widget-set)
|
|
|
|
* files under the www folders are made available under http://<yunkong2IP>:8082/<adapter-name>/
|
|
* for this to work the yunkong2.vis adapter has to be installed
|
|
* delete this folder if you do not plan to export any files this way
|
|
* call ```yunkong2 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/<adapter-name>.html* and *widget/js/<adapter-name>.js*
|
|
* call ```yunkong2 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 ```yunkong2 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
|
|
|
|
## Usage
|
|
After the adapter is started, you can check following requests:
|
|
|
|
http://ip:9090/api/system.adapter.admin.0.memHeapTotal
|
|
http://ip:9090/api/plain/system.adapter.admin.0.memHeapTotal
|
|
|
|
## Changelog
|
|
|
|
#### 0.1.0
|
|
* (bluefox) initial release
|
|
|
|
## License
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2017 @@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.
|