Configuring Raspberry Pi Connector
Page covers how to configure a Raspberry Pi Connector
Last updated
Page covers how to configure a Raspberry Pi Connector
Last updated
If the Connector is hosted via BalenaCloud and has an internet connection, the configuration can be accessed anywhere via the BalenaCloud Public Device URL.
If the connector is hosted by MobiusFlow, please contact support to receive the Public Device URL.
The BalenaCloud Public Device URL can be found by Navigating to the connector device on the BalenaCloud fleet.
By default, the MobiusFlow connector will broadcast a WiFi access point, the name of which matches the connector's serial number (in the form of MF_XXXXX). Connect to this access point on a computer or mobile device. Then the configuration window is accessible by browsing to 10.42.0.1.
If the connector is connected to a local network via Ethernet or WiFi (with a known IP address) and you're able to also connect to this network using a computer or mobile device, then simple browse to the local IP of the connector.
When browsed to the configuration window of the connector, a login screen is presented.
The default password of all new MobiusFlow connectors is:
mobiusflow
Note that, if the connector is not new, this login password may have been changed.
When on the the home page, the current status of the connector is shown. This includes:
The main menu also allows navigation to the connectors configuration pages. These includes those for Network Configuration, MQTT Configuration, Certification Configuration, and the Change Password page (allows the connector configuration password to be changed).
It is critical that the MobiusFlow connector's network situation is such that it can access the target MobiusFlow instance over the network. This may be over the internet or simply over a local network.
In either situation, the connector must be connected to the network and the configure network page allows for this.
The connection type allows choosing between a Wired or WiFi connection.
If using a Wired connection, ensure the Raspberry Pi is plugged in via Ethernet.
If using WiFi mode, the WiFi SSID and corresponding password must be populated.
Note that: In WiFi mode, the Wired network interface will remain enabled in the background. This acts as a secondary fall back interface, useful for accessing the connector the WiFi has failed to connect.
Note that: If using in WiFi mode, using the Connector as WiFi access point is no longer possible. This is because the Raspberry Pi only contains a single WiFi adapter and therefore it can only be used to either connect to WiFi or as an access point.
The TCP/IP settings allow switching between DHCP and Static IP allocation. Unless there are specific reasons to set the connector on a static IP address, using DHCP is recommended.
If using the connector in Static mode, the Subnet Mask, Default Gateway and DNS 1 can be set. If it is not clear what to use here, use the default settings as shown below.
Note that, the default gateway is not required however if the connector required access to the internet, the local IP address of the internet providing gateway (Network router / modem) must be populated here. This is often in the form XXX.XXX.XXX.1 or XXX.XXX.XXX.0 .
Setting the connector up to be a WiFi access point is useful for two reasons.
Firstly, it allows you to connect to it, allowing for easy wireless access to its configuration page. Secondly, if this connector has internet access via ethernet, it can act as an internet enabled hotspot to connect WiFi device to, in-turn giving them internet access.
Note that: If using in WiFi mode, using the Connector as WiFi access point is no longer possible. This is because the Raspberry Pi only contains a single WiFi adapter and therefore it can only be used to either connect to WiFi or as an access point.
If the WiFi access point is enabled, a WiFi SSID and Password must be set. It is recommended the default SSID is used (This matches the the connectors Serial Number)
To save the changes click the save button. If there are an issues with the configuration, such as an invalid input in one of the fields, the form will show this and the changes will not be saved. If the settings were saved correctly, a pop up will show this after the save button has been clicked.
Note that, when changes are saved here, they're only being saved to the local changes within the browser window. To realise the changes in the connector, the Reconfigure and Reboot button must be clicked on the main menu
Connectors use MQTT to communicate with MobiusFlow. As such, the Configure MQTT page allows the connector to be pointed at a specific MQTT broker. In almost all cases, the broker will be running the MobiusFlow instance itself.
Before setting up the connector's MQTT configuration, ensure you first set up the MobiusFlow instance ready for this connection. A guide on how to do this can be found here.
The configuration window shows the key 6 properties which must configured to allow an authorised connection to the MQTT broker.
To save the changes click the save button. If there are an issue with the configuration, such as an invalid input in one of the fields, the form will show this and the changes will not be saved. If the settings were saved correctly, a pop up will show this after the save button has been clicked.
Note that, when changes are saved here, they're only being saved to the local changes within the browser window. To realise the changes in the connector, the Reconfigure and Reboot button must be clicked on the main menu
Once the changes have been made locally, to implement the changes within the connector, click the Reconfigure and Reboot button.
This will cause the connector to reboot. As such, the configuration window's connection to the connector will be lost. This may automatically be restored once the connector reboots, but this may not be the case if the connector's configuration has changed such that it is no longer accessible over the network.
Property | Notes |
---|---|
Property | Explanation |
---|---|
Serial Number
Required in the MobiusFlow connectors service. Note that this is copyable using the copy button displayed next to the number is itself
Ethernet Connection Status
The IP address will be displayed if connected
WiFI Connection Status
The IP address will be displayed if connected
On-Board WiFi Hotspot (Labelled WiFi AP)
Will show a green tick if the On-Board WiFi Access point is enabled
MQTT Connected
Will show a green tick to indicate the connector is has connected to MobiusFlow
Module 1 / Module 2
Will show which types of transceivers are physically connected to the Raspberry Pi
Address
The IP location of the MQTT broker. This may be a local IP address, an internet IP address or a DNS name. Do not include any protocol prefix (such as mqtt:// or https://)
Port
The port the MQTT broker is running on. If using the MQTT broker within MobiusFlow, this port number is set and shown within the service settings within the MQTT broker service within MobiusFlow. This is often 1883. Note that, if the MobiusFlow instance is hosted in the MobiusFlow cloud, port 1883 is externally exposed on 8883 (i.e. use 8883 even if MobiusFlow shows 1883)
Username
The username of any MQTT user set up on the MQTT broker (if using the broker within MobiusFlow, this can be set up within the MQTT broker service settings within MobiusFlow)
Password
The password of any MQTT user set up on the MQTT broker (if using the broker within MobiusFlow, this can be set up within the MQTT broker service settings within MobiusFlow)
PSK
The pre-shared key of the connector. This can be anything however it must match the pre-shared key set up within the target connector object within the connectors service within the MobiusFlow instance.
Use TLS
A true / false property determining if the connection will attempt to use MQTT of TLS. This depends on how MobiusFlow is hosted and where the connector is accessing it from. Most set ups which involving accessing MobiusFlow over the internet will use TLS. If using an instance of MobiusFlow hosted via the MobiusFlow cloud, always enable TLS.