Get Started


The OpenRemote Platform is a tool for service providers who need to manage multiple devices, gateways and users. In this guide we will setup the platform and its manager web interface locally, add a live data source, and create some simple rules. After that you can explore the functionality of the platform. Developers can continue diving in deeper by customizing their project, creating their own protocols, or contributing to the code.

1. Set up the Platform

OpenRemote runs in Docker Containers. Therefore, you can run it on virtually any hardware and operating system: eg. Linux, Windows, Mac OS X, either locally or on a hosted server.

We will get a project running locally by following the OpenRemote Readme: QuickStart

In the manager interface you can access one realm (Master) on the top right. The ‘Master’ realm contains no assets yet. Assets are logical objects, which contain attributes representing static or dynamic characteristics of the assets. Attributes can be sensor values, control commands, locations, values generated by the rules engine or meta data.

In the next step we will create an asset and connect some live data to an attribute.

2. Connect a data source

There are several protocol agents available in OpenRemote such as HTTP, UDP, TCP-IP, Client Event (Websocket or MQTT), or for connecting OpenRemote as Edge Gateway. More protocol agents will follow (e.g. KNX Gateway, Velbus System, Z-wave).

For the purpose of getting familiar with OpenRemote, we will connect to an HTTP API to collect live weather data:

Connecting to an HTTP API

You can find more information on connecting your devices on our wiki under ‘Protocol agents’.

Monitor, adjust and control your assets

3. Create rules

The OpenRemote has several ways to add automation and intelligence to your project: Flow, When-Then, and Groovy. The Flow and When-Then rules interfaces are aimed at ease-of-use and are accessible for non-developers. With Groovy you can create more elaborate rulesets. In this guide we will focus on the first two, please follow the guides on these pages:

  1. Flow: Drag-and-drop assets and attributes to process data and create new attributes
  2. When-Then: Set up thresholds for attribute values that trigger actions such as controlling an asset, or sending an e-mail or push notification
  3. Groovy: Set up thresholds for attribute values that trigger actions such as controlling an asset, or sending an e-mail or push notification
Simple UI tool to create smart IoT rules

Now we have seen the main functionalities of the application. There is much more to explore, which you can do at your own leisure and with the support of our wiki and our forum.

Developers who want to learn more can continue reading in the ‘Developer Guide’ section on the wiki, starting with Setting up an IDE and Working on the UI

Strijp-S application on smartphone