Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

iobroker

Package Overview
Dependencies
Maintainers
1
Versions
41
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

iobroker

...domesticate the Internet of Things

  • 0.2.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
139
increased by143.86%
Maintainers
1
Weekly downloads
 
Created
Source

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

adapterdescriptionstatus
system services
adminThe admin user interface. Comfortably install and update adapters, manage adapter instance configuration and morebeta
historyManage 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
legacyCCU.IO-compatible Webserver. Provides "SimpleAPI"alpha
socketioSocket.io Serverplanned
webExpress based webserveralpha
websocketExpress and Socket.io based webserveralpha
automation
logicGraphical Javascript IDE (ScriptGUI)planned
javascriptJavascript 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
virtualMap 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
scenesCreate and sequence scenesplanned
triggerTrigger simple actions, scenes or scripts by state change pattern recognition ("reverse-scenes")planned
pythonPython script engineplanned 2015
phpPHP script engineplanned 2015
user interfaces
mobilejQuery Mobile based User Interface (yahui successor)alpha
visTemplate based HTML5 User Interface (Successor of DashUI - the successful UI-Builder-Framework of CCU.IO. View DashUI Demosplanned
slimLightweight javascript library to build custom User Interfaces with pure HTML (former SlimUI)planned
legacyCCU.IO compatible web server. CCU.IOalpha
home automation
culDifferent RF Devices (FS20, MAX!, FHT, HMS, ...) via CUL/COC and culfwalpha
artnetControl 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
digitalControl digitalSTROM devicesplanned 2015
EnOceanControl EnOcean devices via EnOcean Piplanned 2015
hm-rpcHomematic XML-RPC. Control Homematic Devices via Bidcos-Interfaces (unlimited number of CCUs, RF-LAN-Adapters with rfd and Homegear)beta
hm-regaHomematic CCU1 or CCU2 (Logic Layer "ReGaHSS", needed in addition to )beta
huePhilips Hue LED bulbs and stripes, Smartlink capable LivingColors and LivingWhitesbeta
homeeasyHome easyplanned 2015
homepilotRademacher Homepilotplanned
knxKNXbeta
maxcubeMAX! via MAX! Cubeplanned ?
modbusModbusplanned ?
z-waveZ-Waveplanned
home entertainment
dreamDreamboxplanned ?
irtransIRTrans Send and receive infrared commandsplanned ?
lircLIRC Send and receive infrared commandsplanned 2014
mpdmpdplanned
onkyoOnkyo AV Receiverbeta
plexPlexplanned ?
sonosSonosbeta
xbmcXBMCplanned ?
......several TVs and AV Receivers (Pioneer, Onkyo, Yamaha, Samsung, ...)planned
messaging
emailsend emailsplanned 2014
imapControl ioBroker with emails in clear text over imap protocollplanned ?
growlGrowlplanned 2014
nmaNotify My Androidplanned ?
pushoverSend Pushover notificationsplanned 2014
pushbulletSend Pushbullet notificationsplanned 2015
generic protocols
mqttMQTTbeta
pingUse system "ping" command to poll configured IP addresses.beta
restREST compliant APIplanned
snmpSNMPplanned ?
telnetTelnet Client. Connect to a server and send and receive dataplanned 2014
xmppXMPPplanned 2015
xplxPLplanned ?
smart metering
b-control-emB-Control Energy Managerbeta
plugwisePlugwiseplanned ?
external software
graphiteManage huge amounts of history data and draw charts with Graphitebeta
nagiosOffer selected objects as Nagios/Icinga checks with optional performance data, include nagios hosts as ioBroker objectsplanned 2015
weather
dwdfetch weather warnings from DWD (germany only)beta
yrfetch 48h weather forecasts from yr.no (worldwide)beta
hardware
arduinoplanned ?
gpioUse GPIOs, SPI, I2C and 1-Wire on Raspberry Pi, Banana Pi, Cubietruck, ...planned 2014
owfs1-Wire Devices via (http://owfs.org/)planned ?
pifaceUse PiFaceplanned ?
tesselControl Tessel Modulesplanned ?
misc
fritzFRITZ!Boxplanned ?
geofencyReceive Geofency webhooksplanned 2014
icalFetch iCal/VCALENDAR eventsplanned 2014
nobleBluetooth Low Energy devices via noble (Parrot Flower Power, ...)planned
text-commandsControl ioBroker with commands in clear text, like "Switch on the light in the living room". Used by other adapters, like imap or voice controlplanned
text2speechText to speech adapterplanned
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

  • 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_cli and issue the command PSUBSCRIBE * 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.

Keywords

FAQs

Package last updated on 23 Jan 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc