Ninja Power Manifesto

    iobroker
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/iobroker package

    0.1.7 • Public • Published

    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.

    architecture

    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, java, perl, ...).

    adapter description status
    system services
    admin The admin user interface. Comfortably install and update adapters, manage adapter instance configuration and more beta
    history Manage state history in a two-staged process. A configurable amount of datapoints is kept in Redis for high-speed access, long-time archiving is written to CouchDB with a configurable retention-time. Configuration can be done individually for each state. beta
    legacy CCU.IO-compatible Webserver. Provides "SimpleAPI" alpha
    socketio Socket.io Server planned
    web Express based webserver alpha
    websocket Express and Socket.io based webserver alpha
    automation
    logic Graphical Javascript IDE (ScriptGUI) planned
    javascript Javascript and CoffeeScript 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 states into virtual namespaces and apply basic rules on the mappings (average, sum, min, max, offset, factor, toggle, timeout, history pattern matching and more). planned
    scenes Create and sequence scenes planned
    trigger Trigger simple actions, scenes or scripts by state change pattern recognition ("reverse-scenes") planned
    python Python script engine planned 2015
    php PHP script engine planned 2015
    user interfaces
    mobile jQuery Mobile based User Interface (yahui successor) alpha
    vis Template based HTML5 User Interface (Successor of DashUI - the successful UI-Builder-Framework of CCU.IO. View DashUI Demos planned
    slim Lightweight javascript library to build custom User Interfaces with pure HTML (former SlimUI) planned
    legacy CCU.IO compatible web server. CCU.IO alpha
    home automation
    cul Different RF Devices (FS20, MAX!, FHT, HMS, ...) via CUL/COC and culfw alpha
    artnet Control DMX512 devices via Art-Net (Stage-Lighting: powerful LED RGB Lamps and effects, powerful Dimmers and Switches, moving light effects, fog machines and much more.) alpha
    digital Control digitalSTROM devices planned 2015
    EnOcean Control EnOcean devices via EnOcean Pi planned 2015
    hm-rpc Homematic XML-RPC. Control Homematic Devices via Bidcos-Interfaces (unlimited number of CCUs, RF-LAN-Adapters with rfd and Homegear) beta
    hm-rega Homematic CCU1 or CCU2 (Logic Layer "ReGaHSS", needed in addition to ) beta
    hue Philips Hue LED bulbs and stripes, Smartlink capable LivingColors and LivingWhites beta
    homeeasy Home easy planned 2015
    homepilot Rademacher Homepilot planned
    knx KNX beta
    maxcube MAX! via MAX! Cube planned ?
    modbus Modbus planned ?
    z-wave Z-Wave planned
    home entertainment
    dream Dreambox planned ?
    irtrans IRTrans Send and receive infrared commands planned ?
    lirc LIRC Send and receive infrared commands planned 2014
    mpd mpd planned
    onkyo Onkyo AV Receiver beta
    plex Plex planned ?
    sonos Sonos beta
    xbmc XBMC planned ?
    ... ...several TVs and AV Receivers (Pioneer, Onkyo, Yamaha, Samsung, ...) planned
    messaging
    email send emails planned 2014
    imap Control ioBroker with emails in clear text over imap protocoll planned ?
    growl Growl planned 2014
    nma Notify My Android planned ?
    pushover Send Pushover notifications planned 2014
    pushbullet Send Pushbullet notifications planned 2015
    generic protocols
    mqtt MQTT beta
    ping Use system "ping" command to poll configured IP addresses. beta
    rest REST compliant API planned
    snmp SNMP planned ?
    telnet Telnet Client. Connect to a server and send and receive data planned 2014
    xmpp XMPP planned 2015
    xpl xPL planned ?
    smart metering
    b-control-em B-Control Energy Manager beta
    plugwise Plugwise planned ?
    external software
    graphite Manage huge amounts of history data and draw charts with Graphite beta
    nagios Offer selected objects as Nagios/Icinga checks with optional performance data, include nagios hosts as ioBroker objects planned 2015
    weather
    dwd fetch weather warnings from DWD (germany only) beta
    yr fetch 48h weather forecasts from yr.no (worldwide) beta
    hardware
    arduino planned ?
    gpio Use GPIOs, SPI, I2C and 1-Wire on Raspberry Pi, Banana Pi, Cubietruck, ... planned 2014
    owfs 1-Wire Devices via (http://owfs.org/) planned ?
    piface Use PiFace planned ?
    tessel Control Tessel Modules planned ?
    misc
    fritz FRITZ!Box planned ?
    geofency Receive Geofency webhooks planned 2014
    ical Fetch iCal/VCALENDAR events planned 2014
    noble Bluetooth Low Energy devices via noble (Parrot Flower Power, ...) planned
    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

    Community support

    Docs for (adapter-)developers

    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.

    Install

    npm i iobroker@0.1.7

    Homepage

    iobroker.net

    Version

    0.1.7

    License

    MIT

    Last publish

    Collaborators

    • foxriver76
    • iobluefox
    • bluefox
    • apollon77
    • ldittmar
    • alcalzone