Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ioBroker/ioBroker

Automate your life!
https://github.com/ioBroker/ioBroker

home-automation iobroker nodejs smarthome

Last synced: 13 days ago
JSON representation

Automate your life!

Awesome Lists containing this project

README 

        
![Logo](img/logos/ioBroker_Logo_Long_Vector.svg)

# ioBroker (windows installer)



[![NPM version](https://img.shields.io/npm/v/iobroker.svg)](https://www.npmjs.com/package/iobroker)

[![Downloads](https://img.shields.io/npm/dm/iobroker.svg)](https://www.npmjs.com/package/iobroker)



[![NPM](https://nodei.co/npm/iobroker.png?downloads=true)](https://nodei.co/npm/iobroker/)



*Automate your life!*



To install on Linux, just run: `npx @iobroker/install`



To install on Windows: `mkdir C:\iobroker && cd C:\iobroker && npx @iobroker/install` or use [installer](https://github.com/ioBroker/ioBroker.build)



See [ioBroker documentation](https://www.iobroker.net/#en/documentation) for more information



* [ioBroker website](https://www.iobroker.net)

* [Forum](https://forum.iobroker.net)

* [Requests for adapters](https://github.com/ioBroker/AdapterRequests/issues)



ioBroker is an integration platform for the [Internet of Things](https://en.wikipedia.org/wiki/Internet_of_Things), focused on Building Automation, Smart Metering, Ambient Assisted Living, Process Automation, Visualization and Data Logging.



## Concept



ioBroker is not just an application, it's more of a concept and a database schema.

It 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](img/architecture.png)



### Databases



ioBroker uses "in memory" database to hold the data and saves it on disk with reasonable intervals. 

There are two types of storage:

- objects (meta/configuration information)

- states (values)



Objects and states can be stored in "in memory" or in Redis.



[Redis](https://redis.io/) 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.



### 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.



See the actual list of adapters on [iobroker.net](https://www.iobroker.net/#en/adapters)



### 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 smart home 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. 

You should always activate **HTTPS** and use valid certificates for web, admin if open it for internet or 

for example, use it with additional security measures like VPN, VLAN and reverse proxies.



## Getting Started

### Operating System and Hardware

[ioBroker.js-controller](https://github.com/iobroker/ioBroker.js-controller/) should run on any hardware 

and OS that runs [Node.js](https://nodejs.org/) (ARM, x86, Windows, Linux, OSX).



ioBroker spawns a new Node.js process for every adapter instance, so RAM becomes a limiting factor. 

A single adapter's memory fingerprint is roundabout 10 to 60 MB.



### Installation and first steps

* [ioBroker Download](https://www.iobroker.net/#en/download)



### Community support

* Get help in the [ioBroker Forums](https://forum.iobroker.net) (english, german and russian languages)



## Logos and pictures



**All logos are protected by copyright and may not be used without permission.**



Please request permission via [email protected]



[Logos](https://github.com/ioBroker/ioBroker/tree/master/img)



## License



This module is distributor under the MIT License (MIT). 

**Please notice that other ioBroker adapters can have different licenses.**



The MIT License (MIT)



Copyright (c) 2014-2024 bluefox ,

Copyright (c) 2014      hobbyquaker



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.