1.0.0 • Published 6 years ago
smarthomeconnector v1.0.0
SmartHomeConnector.js
About
SmartHomeConnector.js is a JavaScript library for connecting web applications to home automation systems. It abolishes the need to learn the speficifcs of each supported system by providing a uniform API on top. The library currently supports the following features;
- Retrieving and adding components
- Retrieving component services
- Changing component service state
- Retrieving image data from camera components (openHAB only)
Currently supporting;
Installation
Using npm
npm install smarthomeconnector.js
TODO: npm package must be published first
Using CDN
TODO: publish, add example script tag
Manually
If you want to install SmartHomeConnector manually go through the following steps (npm needed):
- Download/Clone this repo
- Install build-dependencies
npm install
- Build JavaScript-File
npm run build
- Use SmartHomeConnector.js (found in dist-directory)
<script type="text/javascript" src="smarthomeconnector.js"></script>
Usage
See examples.
For more details see our documentation.
Questions, suggestions & feature requests
License
MIT License—see the LICENSE file for details
1.0.0
6 years ago