Developers
The OpenRemote open source IoT platform is free to use under the license AGPLv3. This page is the starting point for developers to find the information they need to work with OpenRemote. We actively support the community by answering questions and developing much-requested features. We encourage everyone in our community to contribute to the codebase, be it with protocols, rules or UI elements and to share their exemplary projects on the forum.
OpenRemote Manager Community
Manager 3.0 Documentation
User Application & Consoles
- Manager UI: Demo Smart City
- Architecture: Apps and consoles
- Use UI components
- Create iOS Console
- Create Android Console
Rules Engine
Assets & Attributes
- Assets and attributes
- The Asset model and API
- Use Asset APIs
- Asset location tracking
- Use Health Status Provider
Protocol Agents
- Generic protocols
- ArtNET/DMX
- ClientEvent for MQTT/Websocket
- Controller 2.5
- HTTP API
- IKEA Trådfri
- KNX Gateway
- Macro
- MQTT
- Survey
- Velbus Socket
- Velbus Serial
- TCP
- Web socket Server
- UDP Server
- Use Timer
- UPnP
- Z-wave
Account management & Identity Service
- Using realms, users and roles
- Forgot password flow
- Link to Active Directory
- Security OAuth
Edge Gateways
Developer Guide
- Preparing the environment
- Installing and using Docker
- Building the code
- Setting up an IDE
- Working on the UI
- Working on the Mobile Consoles
- Working on Maps
- Docker compose profiles
- Creating a custom project
- Maintaining an installation
- Writing Console applications
- Connecting Protocol adapters with Agents
- Licensing guidelines for contributors
- Useful commands and queries
- Docker swarm mode
- MQTT Connections
- Edge Gateways