An introduction to the Realer platform

The Realer platform allows users to control and automate their devices, empowering developers to craft Internet of Things (IoT) solutions to manage connected things, inspire action, and synergize services.

This guide focuses on control-device integrations through the iot/v1 HTTP contract. MQTT integrations use the same OAuth authority, then discover the broker URL, topics, and credential endpoint through the dedicated MQTT device flow.

The public HTTP device API is served from https://api.therealer.com/iot/v1/....

Control-device interaction

At a high level, a control device follows a structured loop:

  1. Authentication with Realer
    The control device requests an OAuth 2.0 Bearer access token from the Realer platform and uses it to authorize subsequent iot/v1 requests.
  2. Command and sensor data acquisition
    Upon authentication, the device retrieves its command and sensor catalog for local processing and execution of actions through connected actuators, while concurrently gathering environmental data through connected sensors.
  3. Feed-data ingestion
    Subsequently, the control device sends command acknowledgements and sensor readings through the feed-data ingestion contract for analysis and current-state updates.
  4. Loop iteration and token renewal
    The control device re-enters the loop at step 2, perpetuating its functionality. In the event of access-token expiration, the device reinitiates the authentication process from step 1 before continuing the loop.
Realer IoT V1 device flow diagram

Choose HTTPS or MQTT before implementing the firmware loop. Both transports use the same OAuth identity and feed-data model.

Use HTTPS when Use MQTT when
Your device wakes up, sends data, then sleeps. Your device keeps a broker connection open.
Periodic catalog polling is enough. You need low-latency command desired-state delivery.
Your firmware or network stack does not support MQTT/TLS reliably. Your firmware can renew short-lived MQTT credentials and reconnect safely.

Use the HTTP flow for catalog polling and direct feed-data ingestion. Use the MQTT flow when the device should publish feed data over MQTT, receive application acknowledgements, or subscribe to command desired-state topics.

Realer IoT V1 MQTT device flow diagram

What you need

To begin developing your own control device that seamlessly integrates with the Realer platform, here is what you will need:

  • An electronics device
    You will need an electronics device capable of connecting to the Internet. Consider options like Arduino, Raspberry Pi, STM32, ESP32, or others that suit your project requirements.
  • Realer API keys
    Get API keys to register a new control device on Realer. These client credentials are used at the OAuth token endpoint to obtain Bearer access tokens for the device API. Once you receive your API keys, you can jump into experimentation and development.
  • Programming knowledge
    Developing control devices requires proficiency in coding. You should know languages like C/C++, Python, or Java to program your control device.
  • Documentation and resources
    Explore our API documentation and resources to seamlessly integrate your devices with Realer. Feel free to reach out to us for further assistance or clarification.

With these essentials in hand, you are ready to embark on your journey with the Realer platform. Let's bring your control device ideas to life in the exciting world of IoT.