ioBroker
...domesticate the Internet of Things.
ioBroker is an integration platform for the Internet of Things, focused on Building Automation, Smart Metering, Ambient Assisted Living, Process Automation, Visualization and Data Logging. It aims to be a possible replacement for software like f.e. fhem, OpenHAB or the thing system by the end of 2014. ioBroker will be the successor of CCU.IO, a project quite popular in the german HomeMatic community.
Concept
ioBroker is not just an application, it's more of a a concept, a database schema, and offers a very easy way for systems to interoperate. ioBroker defines some common rules for a pair of databases used to exchange data and publish events between different systems.
Databases
ioBroker uses Redis and CouchDB. Redis is an in-memory key-value data store and also a message broker with publish/subscribe pattern. It's used to maintain and publish all states of connected systems. CouchDB is used to store rarely changing and larger data, like metadata of systems and things, configurations or any additional files.
Adapters
Systems are attached to ioBrokers databases via so called adapters, technically processes running anywhere in the network and connecting all kinds of systems to ioBrokers databases. A connection to ioBrokers databases can be implemented in nearly any programming language on nearly any platform and an adapter can run on any host that is able to reach the databases via ip networking.
A library module for fast and comfortable adapter development exists for Javascript/Node.js until now. Libraries for adapter development in other languages are planned (python, php, java, perl, ...).
| adapter | description | status |
|---|---|---|
| system services | ||
| admin | admin user interface | alpha |
| history | state history | alpha |
| legacy | CCU.IO-compatible Webserver | alpha |
| socketio | Socket.io Server | planned |
| web | Express and Socket.io based webserver | planned |
| automation | ||
| logic | Graphical Javascript IDE (former: ScriptGUI) | planned |
| javascript | Javascript script engine. Use Javascripts/Node.js asynchronous programming with comfortable methods to subscribe to events and schedule events with sophisticated scheduling-features. | beta |
| virtual | Map objects and states into other namespaces and apply basic rules on the mappings (average, sum, min, max, offset, factor, ...) | planned |
| scenes | Create and sequence scenes | planned |
| python | Python script engine. | planned |
| user interfaces | ||
| mobile | jQuery Mobile based User Interface (former yahui) | planned |
| vis | Template based HTML5 User Interface (former DashUI) | planned |
| home automation | ||
| cul | Different RF Devices (FS20, Max, FHT, HMS, ...) via CUL/COC and culfw | alpha |
| hm-rpc | Homematic XML-RPC | beta |
| hm-rega | Homematic CCU | beta |
| hue | Philips Hue LED bulbs and stripes, Smartlink capable LivingColors and LivingWhites | beta |
| Homepilot | Rademacher Homepilot | planned |
| knx | KNX | planned |
| z-wave | Z-Wave | planned |
| home entertainment | ||
| sonos | Sonos | planned |
| mpd | mpd | planned |
| lirc | LIRC | planned |
| ...several TVs and AV Receivers (Pioneer, Onkyo, Yamaha, Samsung, Sony) | planned | |
| generic protocols | ||
| alpha | ||
| telnet | planned | |
| rest | REST compliant API | planned |
| xmpp | XMPP | planned |
| mqtt | MQTT | planned |
| smart metering | ||
| b-control-em | Smart Metering with B-Control Energy Manager | planned |
| external software | ||
| graphite | Manage huge amounts of history data and draw charts with Graphite | planned |
| nagios | Offer selected objects as Nagios/Icinga checks with optional performance data, include nagios hosts as ioBroker objects | planned |
| web services | ||
| send emails | planned | |
| imap | Control ioBroker with emails in clear text over imap protocoll | planned |
| dwd | fetch weather warnings from DWD | planned |
| geofency | Receive Geofency webhooks | planned |
| ical | Fetch iCal/VCALENDAR events | planned |
| pushover | Send Pushover notifications | planned |
| pushbullet | Send Pushbullet notifications | planned |
| yr | fetch 48h weather forecasts from yr.no | stable |
| other | ||
| text-commands | Control ioBroker with commands in clear text, like "Switch on the light in the living room". Used by other adapters, like imap or voice control | planned |
| text2speech | Text to speech adapter | planned |
Security
ioBroker is designed to be accessed by trusted adapters inside trusted networks. This means that usually it is not a good idea to expose the ioBroker databases, adapters or any smarthome devices directly to the internet or, in general, to an environment where untrusted clients can directly access these network services. Adapters that offer services supposed to be exposed to the internet should be handled with care, for example with additional security measures like VPN, VLAN and reverse proxys.
Getting Started
Operating System and Hardware
ioBroker.nodejs should run on any hardware and os that runs Node.js (ARM, x86, Windows, Linux, OSX). Binary builds for CouchDB and Redis are also available for the ARM and x86 under Windows, Linux and OSX. ioBroker spawns a new Node.js-Process for every adapter instance, so RAM becomes is a limiting factor. A single adapters memory fingerprint is roundabout 10-60MB. Since CouchDB can create quite a lot of load a dual core system is beneficial.
We recommend x86 based or ARM based systems like BananaPi or Cubietruck using Debian based Linux as operating system.
Installation and first steps
- automated installation packages for windows and linux coming soon
- ioBroker.nodejs manual install
Community support
- get help in the ioBroker Forums (english, german and russian language)
Docs for (adapter-)developers
- Core Concepts and Database Schema
- Example Javascript/Node.js Adapter
- ioBroker styleguides
- ioBroker.nodejs Changelog
- ioBroker.nodejs Roadmap
- Direct access to all ioBroker Objects is possible via the CouchDB-Webinterface "Futon":
http://<couch>:5984/_utils/ - Use the view selector on the upper right in CouchDB to browse ioBroker objects
- you can use
redis_cliand issue the commandPSUBSCRIBE *to watch all stateChange Events on the Console
License
The MIT License (MIT)
Copyright (c) 2014 hobbyquaker, bluefox
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.