1 of 100

Public Documentation

Welcome

Welcome to the MobiusFlow® documentation

MobiusFlow® connects, controls and communicates with 1000s of sensors and control devices to provide actionable insights and automated responses. Developed and successfully deployed with many projects over the past 17 years by engineers with first-hand experience in project management and installation such as CBRE, Ingram Micro, TD Synnex and IBM.

Whether you are looking for a full walkthrough or just dipping in to get more information about a single topic, our documentation site is the perfect companion to the training courses on our main site.

3️⃣ MobiusFlow Version 3

We have rebuilt MobiusFlow from the ground up. MobiusFlow V3 has a bunch of new features and enhancements improving both performance and adding improvements to data handling, searching and customisation.

This section is dedicated to guides and technical knowhow related to version 3.

To help you become a MobiusFlow Ninja, look out for our 💥 Interactive Demos in the MobiusFlow 3 articles.

📖 User Guides

The user guides are instructional walkthroughs. Follow these guides from start to finish or jump to a section to learn how to perform specific tasks.

⚙️ Technical Docs

Looking for more detailed technical information? These articles dive deeper into the more technical aspects of MobiusFlow®, from Architecture to API details, ports, protocols, configuring services creating flows, and more.

Our documentation is always improving and we are adding new articles each week, so come back often to see whats new.

We need your help to improve. Please rate the articles and raise support tickets to tell us where we can improve, what articles are missing, and point out any errors.

What is MobiusFlow®?

MobiusFlow® is a middleware software application

MobiusFlow V3

What's New?

Welcome to MobiusFlow re-imagined...

MobiusFlow V3 has been built from the ground up. We have listened to your feedback and added a host of new features to make MobiusFlow even more powerful and easier to use.

Tagging, we added it, custom object profiles, there too, and to make you even more productive we have added the ability for you to write your own data pre-processors and codecs. We are excite about these new features and are sure you will be too!

Engine and Toolbox

Both the MobiusFlow Engine (the heart of MobiusFlow) and MobiusFlow Toolbox have been completely rewritten to be more efficient and easier to use.

Object profiles define the shape and properties of MobiusFlow objects. Before version 3 object profiles were built into each release and could not be easily created or modified by users.

Version 3 has redefined how object profiles work. Object profiles can now be freely created by users in a simple editor. In fact each new instance of MobiusFlow has no object profiles defined. Instead we have taken all of the object profiles from version 2 (and a bunch of new ones) and created object profile templates.

Object profiles can be created from scratch, from templates, or from any profile that you have already created and then customised to your application. This gives users full flexibility without adding complexity as new objects can also be added directly from templates and MobiusFlow will automatically create the profile for you.

Exporting and Importing Profiles

Object profiles (along with their preprocessors, codecs and UI layouts) can be exported and imported allowing you to create your own library of profiles to be used on other projects.

Preprocessors, Codecs and UI Layouts

Have you ever needed to modify data before it is written to a resource? Have you wanted to change from °C to °F on the fly as new data arrives? Was totalising energy readings from meters difficult?

Not any more as preprocessor functions will do that for you!

Each object profile can have a preprocessor function written in Typescript or Javascript which allow you to do just that, you can even write it directly in a built in IDE in MobiusFlow Toolbox.

Codecs make adding new decoders for raw sensor data a breeze. Instead of waiting for us to add new decoders for sensors like EnOcean, LoRaWAN, or Ingy, you can create an object profile and define the codec to decode the raw sensor telegram. As with preprocessors, these codecs can be written in Typescript or Javascript using the built in IDE.

Capturing default values such as sensor IDs when configuring objects is simplified by adding your own configuration UI in a simple JSON format.

The data stored in MobiusFlow objects can now be persisted between restarts of a service. No longer will temperate values drop to zero, people counts be lost, and energy readings disappear when services are restarted! Persistence can be configured on a service by service basis and values are included in backups

Powerful tagging features have been added to both objects and resources. Tags can be defined on object profiles so that they are automatically added to each instance of an object, and added to individual object instances.

You can use simple tags or add values to tags. Tags are included as metadata when reading values or receiving change-of-value events via the new API.

For version 3 we have chosen to use epoch versioning so don't be surprised that our new software versions start from 3000

MobiusFlow Overview

The MobiusFlow software has been developed as an MQTT object bus which normalises all device data into standardised MobiusFlow objects which allow interoperability between all devices either real or virtual in the field or Cloud.

MobiusFlow enables actuators, sensors & controllers to connect, control and communicate with each other and to the Cloud so that IoT solutions using scalable monitoring, visualisation and predictive analytics can provide valuable insights into your business and act upon them automatically.

A complete control and communications platform

MobiusFlow Toolbox v3

MobiusFlow Toolbox is a browser-based engineering tool enabling users to easily configure and monitor an instance of MobiusFlow

Getting Started with Toolbox

Supported Browsers

MobiusFlow Toolbox supports the latest versions of most modern web browsers. We recommend the following:

Google Chrome
Firefox
Safari
Edge

MobiusFlow Toolbox requires Javascript to be enabled on your browser

Logging In

Open your web browser and navigate to your MobiusFlow Toolbox instance. This is typically a fully qualified domain name followed by /toolbox

The exact URL will depend our your installation, but for instances hosted in the cloud by MobiusFlow the URL will have been provided or you will have chosen it when creating a hosted instance in MobiusFlow Manager

The first time you login you must use the initial administrator credentials supplied to you. You can change the default admin password and create new users once you are logged in.

Make sure to change your default admin user password or create a new account and delete the default admin account as soon as possible!

Basic Navigation

Navigating around the Toolbox UI is very simple. The key areas are as follows:

The current user is shown in the top right of the window. You can click on this button to change your password or log out
The collapsable menu on the left side of the window is a quick way to access your configured Services, Flows, Historian settings, Object Profiles and instance Settings. Clicking on the menu icon in the the top left corner will either collapse or expand the menu. As you add new to your configuration they will shown in the menu under the Services heading
With the exception of Flows, clicking on an item in the left menu will show the view for that selection in the main view. Clicking on Flows will open the Flows window in a separate browser tab, or navigate to that tab if it is already open
Configuration of specific items such as services, objects and profiles will be shown in a pane to the right of the main view. This pane is only visible when a configurable item is selected

Adding Services

Adding services to a MobiusFlow instance

Overview

As each application differs you will need to chose which services are required for your application.

To add a service, first click on Services in the main menu and then click on the Show Library button to show the list of available services, find the service you want to add, and click on the Add button for that service.

The service will get added to the configuration with the next available Service ID (SID)

You can click on the Hide Library button to hide the service library when you are done.

Deleting Services

Deleting services from a MobiusFlow instance

Overview

Deleting a service also deletes all of its objects. This action cannot be undone!

To delete a service, first click on Services in the main menu and then find the correct service card.

Service Settings

Configuring services

To update a service's settings, first click on Services in the main menu and then find the correct service card.

On the service card toolbar click on the Settings button to open the service settings dialog.

The service settings dialog is shown above. All services have these default settings, but some services may have additional service specific settings. It is beyond the scope of this article to describe any service specific settings, please see the article for that specific service type for more information.

Some service settings changes may require a service restart to take effect. If a service is running you will be notified if you need to restart the service

Starting, Stopping, and Hot Reloading a Service

Learn how to control services

Services can be started and stopped individually and if enabled, and set to run at start, will start automatically whenever the MobiusFlow instance is started.

For more information on enabling services and setting them to run at start refer to the Service Settings article.

Some services have settings which affect how they operate e.g. the ports used by the MQTT broker service. These settings are typically only loaded on service start so changes to these settings may require a service to be stopped and started before they take effect. If a service is running and any critical settings are changed MobiusFlow Toolbox will notify you that a restart is required.

In addition to service settings changes requiring a restart, changes to object settings will only take affect if a service is restarted or if a hot reload takes place. Any objects that have changes requiring a restart or hot reload are highlighted in the service's page.

A hot reload only applies changes to objects and does not apply any service settings changes

Start, Stop, and Hot Reload Controls

The controls used to start, stop, and hot reload services are located on the service's card on the Services page and on the service's objects page. The buttons have the following icons (Start, Stop, Hot Reload).

Starting a Service

Services are started by clicking on the Start button.

When a service starts it first creates all of its objects, loads in any (if enabled) and then runs any logic such as raw sensor data decoding. You can only access objects on running services.

Disabled services cannot be started.

Stopping a Service

Services are stopped by clicking on the Stop button.

If a service has persistence enabled the current resource values will be persisted before the service stops.

When a service is stopped all of its objects will be destroyed and will no longer be available for reading or writing.

Hot Reloading a Service

Adding objects or configuration changes to objects on running services will only take affect if a service is restarted or if the service is hot reloaded.

Hot reloading a service does not stop it. Instead all objects that have configuration changes are refreshed and new objects are created without affecting any other objects.

Click on the Hot Reload button to hot reload its objects.

💥 Interactive Demo

Cloning Services

Learn how to clone a service and all of it objects

Overview

To create a copy of a service along with all of its settings and objects you can click on the Clone button on the service card of the service you want to copy. The new service will be given the next available SID. You can change the SID in the service's settings if required.

💥 Interactive Demo

System Services

System Services are required my MobiusFlow to function correctly. Examples include the Engine API and Historian services.

MobiusFlow Engine API

The MobiusFlow Engine API service is a RESTful API used by MobiusFlow Toolbox, Flows, and user applications to both configure an instance of MobiusFlow and read and write data to MobiusFlow objects.

It is not possible to configure or stop this service from MobiusFlow Toolbox as this would prevent Toolbox from communicating with the MobiusFlow Engine.

More details about this API can be found

Accessing a Service's Objects

Access the objects belonging to a service

Overview

All MobiusFlow must belong to a service. To add, delete, modify, and view a service's objects you can either click on the main body of a service card on the 's page or click on the service in the main menu.

Value Persistence

Configuring value persistence

Value persistence ensures that objects keep their values between restarts.

In MobiusFlow versions before v3 any restart would cause all resources to be reset to their default values. This would often cause anomalies or loss of data such as all temperature values dropping to zero, meter readings being lost or people counts resetting.

MobiusFlow 3 has solved this problem by adding optional value persistence. This can be configured on a service by service basis in the service settings. To access a service's settings follow the instructions here.

When a service starts it first creates all objects with their default values and then applies any persisted values before running.

Enabling / Disabling Persistence

You can enable or disable persistence on each service. Changing the persistence enabled state will affect all objects belonging to that service.

If you wish to have persistence enabled only for some objects consider adding another service and splitting your objects between services, one with persistence and one without

You can enable or disable persistence by clicking on the Enable Persistence switch in the service's settings.

If persistence is not required consider switching it off as it will add some CPU load.

Disabling persistence will also delete any persisted values. If you need to reset the persisted values you can disable and then re-enable persistence.

Setting the Persistence Interval

In order to lower CPU load values are only persisted at regular intervals and not on every value change. You can set this interval (in minutes) in the service's settings. Try to find a reasonable balance between saving the current values and load on the system. The more objects a service has, the greater the CPU load required to persist the values.

In addition to persisting values at a regular interval, values are also persisted when you manually stop a service.

Default Settings

Services have persistence enabled with an interval of 5 minutes by default.

💥 Interactive Demo

Object Profiles Page

To open the Object Profiles page click on Object Profiles in the main menu.

You must have Administrator or Editor roles to see the Object Profiles option in the main menu

The object profiles table shows a list of all of the profiles that exist on this instance of MobiusFlow. Any profiles that have not been used to create objects, and therefore can be deleted are shown with a greyed out PID and icon.

Above the table is a toolbar with options to

Create a new profile
Filter the list by profile group
Search for a profile - this filters by PID and profile name
Import and export profiles

Clicking on a profile in the table opens the Profile Settings Sidebar. The width of the sidebar can be changed by dragging on the vertical splitter.

Creating Profiles

Learn how to create new object profiles

To create a new profile open the Object Profiles page, make sure that the sidebar is closed, and click on the Create button. This will open the Create Object Profile wizard.

To close a sidebar click on the X button in the sidebar toolbar

The wizard will have three starting point options. Selecting one of the options will change the steps required to complete the wizard.

Codecs

What are Codecs and how do you create them?

Preprocessors

What can I do with Preprocessors and how do you create them?

Preprocessors are run every time a new value is written to a resource. They are used to modify the value before it is written e.g. change from °C to °F, or update another resource e.g. update a message counter

UI Layouts

Defining new object UI Layouts

Adding Objects to a Service

Flows

User Management

Manage users and roles

All access to MobiusFlow Toolbox and the MobiusFlow Engine API requires a valid username and password. Adding, deleting, and modifying users is done on the User Management tab on the Settings page.

Make sure to change your default admin user password or create a new account and delete the default admin account as soon as possible!

The User Management page shows a list of all users with their roles, whether they are active or not, and an Actions button for additional user management.

MobiusFlow Engine API v3

Auth

Node

Profiles

Discover

Services

Objects

Users

Commands

MobiusFlow Historian Data API v3

Profile

Object

Telemetry

MobiusFlow Historian

What is MobiusFlow Historian and how to configure it

MobiusFlow Data Agent

This page explains the MobiusFlow Data Agent found in MobiusFlow View

Overview

The Data Agent introduces an agentic / chat style interface to interact with your MobiusFlow data. The enables tasks such as:

Reporting what data exists

MobiusFlow Engine Agent

This feature is coming soon.

User Guides

MobiusFlow Manager

MobiusFlow Manager is the management platform MobiusFlow customers can use to the self-manage their MobiusFlow instances.

The full MobiusFlow Manager training course can be .

Getting Started

Administration

The Administration page covers user management, backup and restore, licence settings, security as well as setting the node's Hub ID. The page is divided into corresponding tabs accordingly.

User administration

Users can be added, modified and deleted from within the User Management Tab on the Administration page.

Backup/Restore

Backup and restore functionality is accessed via the settings tab on the Administration page. A full article covering backup and restore can be found .

Setting the Hub ID

All Mobius nodes are identified by their hub ID. This is a six character hexadecimal number and should be unique within any group of Mobius nodes. See and for more information about Hub IDs.

Service and Object Configuration

For MobiusFlow 1.x.x only

The configuration page is used to create and configure the MobiusFlow configuration for a Mobius node (see MobiusFlow Architecture). The page is split into five main sections:

The main menu
The services palette
The objects palette
The configuration tree
The service and object configuration section

The main menu

The main menu is displayed on all pages. It allows switching between Configuration, Diagnostics, Node-RED Flows and Administration. The Administration option is only shown for users who have admin privileges.

The services palette

The services palette shows the list of Mobius services that can be added to the configuration. To add a service to your configuration drag it from the services palette and drop it on to the configuration tree.

The objects palette

The objects palette shows the list of Mobius objects that can be added to the configuration. To add an object to your configuration drag it from the objects palette and drop it on to a service in the configuration tree.

The configuration tree

The configuration tree shows the services and objects currently added to the configuration. Clicking on the triangles on the left of the tree either expands or contracts a branch of the tree. The currently selected item is shown as highlighted in orange.

To delete a service or object, hover over the item and click on the dustbin icon which appears to the right of the item.

Deleting a service deletes all associated objects

The service and object configuration section

This section is dynamic and updates depending on which item has been selected in the configuration tree. If a service has been selected the service's configuration properties are displayed. Similarly, selecting an object or object resource shows the relevant configuration options.

Always click the Save Changes button to persist changes to a service, object or resource configuration. Any changes to a service, object or resource only become active after the service has been restarted on the diagnostics page.

Deploying MobiusFlow in MobiusFlow Cloud

For most use cases, Deploying MobiusFlow in the MobiusFlow Cloud is simplest and most cost effective hosting option.

Customers can create new MobiusFlow instances themselves using the MobiusFlow manager platform. A full guide on how to use this platform can be found here.

MobiusFlow a hosting fee for hosting instances in the MobiusFlow cloud. As such, purchaser permissions are required.

When creating a new MobiusFlow instance using manager ensure the Host instance on MobiusFlow Cloud option is checked:

If this option is not available, this is because you do not have purchaser permissions within this fleet.

On creation, there are several options that must be populated:

Hostname

This is the URL the new MobiusFlow cloud instance will be hosted on. In the above example, Manager has automatically suggested average-pug-2488. As such, new Cloud instance will be accessible at the URL average-pug-2488.mobiusflow.io.

Build Type

This selects the version of MobiusFlow to use. If use for the MobiusFlow LoRaWAN LNS is required, ensure the MobiusFlow V2 with LoRaWAN Stack option is selected.

Region

This specifies the region of the world the new Cloud instance is to be hosted on. It is recommended to host the instance as near to where it will be used as possible.\

Once a MobiusFlow Cloud hosted instance as online, an Environment is created, in-turn controlling how the instance can communicate with the outside world. A full article on this environment can be found .

Deploying MobiusFlow On-Prem

These subsections explain deploy MobiusFlow On-Prem.

Deploying MobiusFlow to approved Hardware (Using BalenaCloud)

Deploy MobiusFlow or MobiusFlow RPI Connector software to a new balenaCloud device or update existing devices

You must be signed up to balena.io and have a paid plan as these MobiusFlow® images use the Microservices fleet type which is only available on a paid plan

What is balenaCloud?

Creating a Fleet

Create a new balenaCloud fleet

After signing up to balenaCloud follow their instructions to create a fleet and add your first device. We have simplified the process so you will only need to perform some of the actions they list. The steps below outline the process but for more information see the balena.io documentation.

What You Will Need?

This guide assumes you will be using a Raspberry Pi 4. The instructions are the same for the UP and Intel NUC devices with the exception of loading the initial balenaOS onto your device.

A balenaCloud account with Microservices access (this requires a paid account)

Creating a New Fleet

A fleet is a collection of devices with the same device type (or architecture). Fleets allow simple management of a group of devices

Navigate to your and login in

Navigate to the Fleets page

Click on the Create Fleet button

Enter a fleet name

Choose device type Raspberry Pi 4 (using 64bit OS)

Select fleet type Microservices

Click on the Create new fleet button

You have created your first balenaCloud fleet! Now go to to add a device to this fleet

Adding Your Licence

License your MobiusFlow® instance

All MobiusFlow® instances require a valid licence to run. Licences define the maximum number of MobiusFlow® objects that you can add to an instance. For more information about MobiusFlow® licences refer to the page.

What You Will Need?

Deploying MobiusFlow on Customer Servers / Cloud

Deploy MobiusFlow to on pre-existing hardware either On-Prem or in the Cloud

Page coming soon. Please contact [email protected] to arrange a support call on this topic.

MobiusFlow Connectors

Overview of MobiusFlow Connectors

The Connector collects data from sensors and sends data to actuators via standard wireless sensor protocols such as EnOcean and Workplace Occupancy, and sends this data securely to a MobiusFlow using an MQTT based Protocol.

Once the data has been received by a MobiusFlow instance, it is decoded and the associated MobiusFlow object is updated with the latest sensor readings which can then be processed by the gateway.

A full guide on configuring MobiusFlow for use with Connectors can be found here.

Connector Options

There are several hardware options for the MobiusFlow Connector software:

Configuring MobiusFlow for use with Connectors

Configure a MobiusFlow instance for connectors

Configuring MobiusFlow for use with Connectors uses the MobiusFlow Connectors service. A full guide on how to use this service can be found .

MobiusFlow Official Connector

Configure your MobiusFlow Connector and connect it to a MobiusFlow instance

Part Numbers

It is possible to have up to two radios for wireless sensors in a single connector. This is useful when you have combination of sensors using different protocols.

The current options are EnOcean and Workplace Occupancy using either 868MHz for the EMEA region of 915MHz for the USA and Canada.

Configuring a Connector

Configure a connector to connect to a MobiusFlow® instance

What You Will Need?

A device with a web browser such as a laptop, tablet or smart phone, capable of connecting to a 2.4GHz WiFi access point
A SIM card removal tool, large paper clip or pin to push the configuration mode button
A powered MobiusFlow® connector
The connector's Serial Number

Enabling Configuration Mode

If you leave the connector in configuration mode for more than 5 minutes it will automatically reboot and leave configuration mode

The connector's configuration mode can be enabled in two ways:

Using the Configuration button

Using a pin hold in the configuration mode button (inside the small hole to the right of the USB connector) on the front panel for 2 seconds

Release the button and the green LED will flash rapidly

Using your laptop / tablet / smartphone look for a WiFi network with the same name as the connectors serial number

Connect to this network and enter the connector's Config Mode Password. The default is mobiusflow

Open a web browser on your laptop / tablet / smartphone and enter http://192.168.4.1 into the browsers address bar and hit enter

The web browser will show the connector's configuration Home page

Using a Web Browser

This method is only available if you already know the IP address of the connector

Make sure that the connector and your laptop / tablet / smart phone are connected to the same Ethernet network

Open a web browser and browse to <your connector IP address>:8080 e.g. 192.168.1.20:8080

You will need to enter a user name and password. The user name is admin and the password is the same as the connector's Config Mode Password. The default is mobiusflow

After a short delay the web browser will redirect to the connector's configuration Home page

Home Page

The Home page has the following buttons

Configure Network

Configure the wired or wireless Ethernet network settings

Manage Certificates

Manage all certificates for TLS connections. The default certificates are for MobiusFlow® cloud hosted instances but you can add your own if required

Configure MQTT

Configure the connection to the MQTT broker you chose when

Set Config Mode Password

Change the configuration mode password

About

See information about the connector such as the software version, serial number, andwhich modules are installed

You can also update the firmware on this page

Reboot Device

Reboot the device to exit configuration mode and use the new settings

Configure Network Page

Configure the wired or wireless Ethernet connection

Select Network Type

You can choose to use a wired or wireless (2.4GHz WiFi) connection to connect a connector to your MobiusFlow® instance

Select your network type using the Connect Via dropdown. The page layout will change depending on the option selected

When using a wireless connection you need to enter the WiFi network's SSID (name) and password. You can click on the Scan WiFi Networks button to get a list of available WiFi networks

You can set a connection timeout in minutes. If the connector fails to connect to a network within this time it will reboot and try again

Select TCP/IP Mode

You can choose to use a DHCP server to allocate the connector an IP Address or set a static IP Address. If you choose to use a static IP Address a few more options will be shown. Set these according to your network

Save Settings

Once you have configured all network settings click the Save button

Click the Home button on the settings saved confirmation page to return to the Home page

Manage Certificates Page

Manage certificates for TLS connections

Setting CA / Server Certificates

When using TLS you will need to set the correct CA / Server certificates. You can have up to three certificates set. If the connector fails to connect using one of the certificates it will cycle through all three, trying each one until it connects

The default certificates are ISRG Root X1 certificates which are used when connecting to MobiusFlow® hosted instances of MobiusFlow®

You can set the certificate by pasting the certificate text into the selected certificate slot

Setting Client Certificate and Keys

If your setup requires the use of Client certificates you can set up to four different certificates and keys. Paset these into the selected certificate and key slots

Configure MQTT Page

Configure the MQTT connection to MobiusFlow®

MobiusFlow® connectors send and receive data via MQTT. You need to configure the MQTT settings to match the configuration you set in the Configuring MobiusFlow® section of this guide.

MQTT Broker Settings

You can choose any MQTT client ID but this must be unique for your MQTT broker. The default is the connector's serial number

Enter the IP Address or URL of the MQTT broker. You do not need to specify MQTT:// or MQTTS:// before the URL

Enter the MQTT Port number. This is normally 1883 or 8883 for TLS enabled connections

If required enter the MQTT broker authorisation Username and Password. These can be left blank if no authentication is required

Enter the same pre-shared key (PSK) as you entered in the section of this guide

Security

If you are using TLS make sure you check the TLS using CA Certificate option. You must also set the correct CA Server Certificate on the page

You may also choose to use a Client Certificate and Key. Check this option if required and ensure that you have setup your client certificate and key on the page

Save Settings

Once you have configured all MQTT settings click the Save button

Click the Home button on the settings saved confirmation page to return to the Home page

Set Config Mode Password Page

Set the configuration mode password

The Config Mode Password is used to login to the configuration pages of the connector. The default password is mobiusflow

You can change the password on this page

If you forget your password you will have to the connector

About Page

Get connector details and update firmware

The about page shows you information about the connector. You can also update the connector's firmware by clicking on the Update Firmware button

Updating Firmware

Click on the Update Firmware button on the About page

Click on Choose File and select the firmware file you want to upload

Click on the Update button

After a few minutes the connector will reboot and start running the new firmware

Make sure that you choose firmware with the same model number as your connector!

Factory Resetting a Connector

Return all settings to factory default

If you forget your connector's Config Mode Password or want to fully reset all settings to the factory default follow the procedure below

What You Will Need?

A SIM card removal tool, large paper clip or pin to push the configuration mode button

MobiusFlow Raspberry Pi Connector

Technical Training Guides

Repository of Technical Training walkthrough guides

Technical Docs

MobiusFlow Basics

Learn how to use the full version of MobiusFlow

MobiusFlow Overview

A complete control and communications platform

Security

Authorization

API Authorization calls

The authorization controller is used to login to the API, in addition user management.

When a login call is completed, the API will return a bearer token which should be used in the auth header of all future calls. This token is set to expire 10 minutes after its generation.

A refresh token is also included in the login response, and this is used in the body of the refresh call to get new tokens with refreshed expiry times. Ensure a refresh call is made prior to any given bearer token's expiry to avoid having to login again.

Discover

API Discover calls

The discover calls are used to learn about the present state of a given MobiusFlow instance

Node

API Node Calls

The node calls are for reading a MobiusFlow hub as well as resetting the pre-shared keys on a given hub

Backup

Object

API Object & Resource Calls

The object calls are used to read, add, remove and manipulate MobiusFlow objects and resources.

Responses

201

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

namestringRequired

Service name

enabledbooleanRequired

Is the service enabled?

runAtStartbooleanRequired

Should the service run at start?

sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b

spidstring · min: 4 · max: 4Required

Service Profile ID (SPID)

Example: 000APattern: \b[0-9A-F]{4}$\b

localnumberRequired

remotenumberRequired

enabledbooleanRequired

intervalnumber · min: 1Required

levelstring · enumRequired

Log level

Possible values:

levelstring · enumRequired

Log level

Possible values:

Other propertiesanyOptional

pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b

insstring · min: 4 · max: 4Required

Object Instance (INS)

Example: 0001Pattern: \b[0-9A-F]{4}$\b

configIsDirtybooleanOptional

ridstringRequired

Resource ID (RID)

Example: 40Pattern: \b(?:[0-9A-F]{4}|[0-9A-F]{2})\b

Other propertiesanyOptional

valuestringOptional

fromany ofRequired

string · enumOptionalPossible values:

valuestringOptional

fromany ofRequired

string · enumOptionalPossible values:

400

Default Response

application/json

Bad Request

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 400

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

401

Default Response

application/json

Unauthorized

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 401

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

403

Default Response

application/json

Forbidden

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 401

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

404

Default Response

application/json

Not Found

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 404

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

408

Default Response

application/json

Request Timeout

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 408

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

409

Default Response

application/json

Conflict

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 409

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

422

Default Response

application/json

Unprocessable Entity

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 422

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

500

Default Response

application/json

Internal Server Error

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 500

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

Create an object profile

post

Path parameters

hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b

Body

pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b

profileNamestring · min: 6RequiredPattern: ^[a-zA-Z0-9&/_-]*$

descriptionstringOptional

uinamestring · min: 4Required

groupstringOptional

valuestringOptional

fromany ofRequired

string · enumOptionalPossible values:

ridstringRequired

Resource ID (RID)

Example: 40Pattern: \b(?:[0-9A-F]{4}|[0-9A-F]{2})\b

namestringRequired

typestring · enumRequiredPossible values:

uinamestringRequired

attributebooleanOptional

If true this resource is considered an object attribute, otherwise it is considered as telemetry data

Other propertiesanyOptional

valuestringOptional

fromany ofRequired

string · enumOptionalPossible values:

languagestring · enumRequiredPossible values:

funcstringRequired

languagestring · enumRequiredPossible values:

funcstringRequired

uiLayoutstringOptional

Responses

201

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b

profileNamestring · min: 6RequiredPattern: ^[a-zA-Z0-9&/_-]*$

descriptionstringOptional

uinamestring · min: 4Required

groupstringOptional

valuestringOptional

fromany ofRequired

string · enumOptionalPossible values:

ridstringRequired

Resource ID (RID)

Example: 40Pattern: \b(?:[0-9A-F]{4}|[0-9A-F]{2})\b

namestringRequired

typestring · enumRequiredPossible values:

uinamestringRequired

attributebooleanOptional

If true this resource is considered an object attribute, otherwise it is considered as telemetry data

Other propertiesanyOptional

valuestringOptional

fromany ofRequired

string · enumOptionalPossible values:

languagestring · enumRequiredPossible values:

funcstringRequired

languagestring · enumRequiredPossible values:

funcstringRequired

uiLayoutstringOptional

400

Default Response

application/json

Bad Request

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 400

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

401

Default Response

application/json

Unauthorized

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 401

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

403

Default Response

application/json

Forbidden

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 401

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

404

Default Response

application/json

Not Found

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 404

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

408

Default Response

application/json

Request Timeout

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 408

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

409

Default Response

application/json

Conflict

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 409

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

422

Default Response

application/json

Unprocessable Entity

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 422

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

500

Default Response

application/json

Internal Server Error

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

statusCodenumberRequired

HTTP status code

Example: 500

errorCodestringRequired

Error code

messagestringRequired

Error message

detailanyOptional

Error details (optional)

post

/api/engine/v3/profile/object/{hid}

Public Documentation

Welcome

hashtag3️⃣ MobiusFlow Version 3

hashtag📖 User Guides

hashtag⚙️ Technical Docs

What is MobiusFlow®?

MobiusFlow V3

What's New?

hashtagEngine and Toolbox

hashtag

hashtagExporting and Importing Profiles

hashtagPreprocessors, Codecs and UI Layouts

hashtag

hashtag

hashtag

hashtag

hashtag

MobiusFlow Overview

MobiusFlow Toolbox v3

hashtagMobiusFlow Toolbox is a browser-based engineering tool enabling users to easily configure and monitor an instance of MobiusFlow

Getting Started with Toolbox

hashtagSupported Browsers

hashtagLogging In

Basic Navigation

hashtagNavigation

Page

Adding Services

hashtagOverview

Deleting Services

hashtagOverview

Service Settings

Starting, Stopping, and Hot Reloading a Service

hashtagStart, Stop, and Hot Reload Controls

hashtagStarting a Service

hashtagStopping a Service

hashtagHot Reloading a Service

hashtag💥 Interactive Demo

Cloning Services

hashtagOverview

hashtag💥 Interactive Demo

System Services

hashtagMobiusFlow Engine API

Accessing a Service's Objects

hashtagOverview

Value Persistence

hashtagEnabling / Disabling Persistence

hashtagSetting the Persistence Interval

hashtagDefault Settings

hashtag💥 Interactive Demo

Object Profiles Page

hashtagObject Profiles Page

Creating Profiles

Codecs

Preprocessors

UI Layouts

Adding Objects to a Service

Flows

Tags

hashtagAdding tags

hashtagAdding a simple tag

hashtagAdding a tag with value

hashtagModifying a tag value

hashtagDeleting a tag

hashtag💥 Interactive Demo

User Management

MobiusFlow Engine API v3

Auth

Node

Profiles

Discover

Services

Objects

Users

Commands

MobiusFlow Historian Data API v3

Profile

Object

Telemetry

MobiusFlow Historian

MobiusFlow Data Agent

3️⃣ MobiusFlow Version 3

📖 User Guides

⚙️ Technical Docs

Engine and Toolbox

Exporting and Importing Profiles

Preprocessors, Codecs and UI Layouts

MobiusFlow Toolbox is a browser-based engineering tool enabling users to easily configure and monitor an instance of MobiusFlow

Supported Browsers

Logging In

Navigation

Overview

Overview

Start, Stop, and Hot Reload Controls

Starting a Service

Stopping a Service

Hot Reloading a Service

💥 Interactive Demo

Overview

💥 Interactive Demo

MobiusFlow Engine API

Overview

Enabling / Disabling Persistence

Setting the Persistence Interval

Default Settings

💥 Interactive Demo

Object Profiles Page

Adding tags

Adding a simple tag

Adding a tag with value

Modifying a tag value

Deleting a tag

💥 Interactive Demo

Overview

User administration

Backup/Restore

Setting the Hub ID

The main menu

The services palette

The objects palette

The configuration tree

The service and object configuration section

Hostname

Build Type

Region

What is balenaCloud?

What You Will Need?

Creating a New Fleet

What You Will Need?

Connector Options

Part Numbers

What You Will Need?

Enabling Configuration Mode

Using the Configuration button

Using a Web Browser

Configure Network

Manage Certificates

Configure MQTT

Set Config Mode Password

About

Reboot Device

Select Network Type

Select TCP/IP Mode

Save Settings

Setting CA / Server Certificates

Setting Client Certificate and Keys

MQTT Broker Settings

Security

Save Settings

Updating Firmware

What You Will Need?