Arduino C++ Configuration Objects

9 February 2022

Control configuration objects are only required for configuration messages that enable an IoT device to configure its layout in the DashIO app.

Configuration Process

The process of creating and sending a configuration message is:

1. Only send configuration messages once the IoT device has received a configuration request message.
2. Create a controlCfg object and set any attributes that you want to change from the default values.
3. From the dashioDevice, call a method to create the configuration message getConfigMessage with controlCfg as an attribute
4. Send the configuration message through the appropriate comms library. For example, if the configuration request message is received via BLE, the configuration message should be sent back throught BLE.

The example below shows the creation of button control confguration message:

ButtonCfg aButton("BUTTON_ID", "DEV_VIEW_ID", "Button", {0.5, 0.788, 0.2, 0.121});
aButton.iconName = "bell";
aButton.offColor = "blue";
aButton.onColor = "black";
String message = dashioDevice.getConfigMessage(aButton);

An instance of DashioDevice is used to create the configuration message by using the function dashioDevice.getConfigMessage(aButton)

All controls are instantiated with the same set of attributes as in the example above. In order, they are:

• controlID - Identifier of the control. Must be unique to the IoT device.
• parentID - Identifier of the control that is the parent control to this control. May be a device view, menu, or button group.
• title - Title or name of the control to be displayed on the DashIO app.
• coordinates - Position and size of the control on the device view, where 0 is the top or left side and 1 is right or the right side. The four coordinates, in order, are {control left side position, control top position, control width, control height}.

In the above example code the iconName, offColor, and onColor are also set for the button. There are many attributes than can be set for each control. Please refer to the file DashIO.h for details or all alltribtes for all controls.

Configuration Enumerators

The enumerator types shown below are used when setting up Configuration Objects:

LineType

ButtonMultiState

MQTTTopicType

TitlePosition

LabelStyle

KnobPresentationStyle

DialNumberPosition

DialPresentationStyle

DirectionPresentationStyle

TextFormat

KeyboardType

TextAlign

BarStyle

XAxisLabelsStyle

Configuration Objects

Configuration Objects are used to create configuration messages that are required to configure the IoT device on the DashIO app. After a DashIODevice object has been created, it can be use to create the configuration message:

DashioDevice dashioDevice("My Device Type");

String cfgMsg = dashioDevice.getConfigMessage(ConfigurationObject);

The tables below show all the Configuration bjects that are available:

BLEConnCfg

For configuring BLE connections.

TCPConnCfg

For configuring TCP connections.

MQTTConnCfg

For configuring MQTT connections.

AlarmCfg

For configuring Alarm (push notification) sounds.

DeviceCfg

For configuring the Device.

*Device provisioning setup text contains comma separated device setup options: “name, wifi, tcp, dashio, mqtt”:

• “name" = can change change the device name
• “wifi” = can change the wifi Country Code, SSID and password
• “tcp” = can change the TCP port
• “dashio” = can change the DashIO server MQTT username and password
• “mqtt”= can change the MQTT URL, port, SSL (enabled), username, and password

DeviceViewCfg

For configuring Device Views.

Rect

The Rect is a Struct that is used for defining the position and size of all the displayed controls below.

CommonControl

All displayed control listed below inherit from the Common Control.

LabelCfg : CommonControl

ButtonCfg : CommonControl

MenuCfg : CommonControl

ButtonGroupCfg : CommonControl

EventLogCfg : CommonControl

No other attributes

KnobCfg : CommonControl

DialCfg : CommonControl

DirectionCfg : CommonControl

TextBoxCfg : CommonControl

SelectorCfg : CommonControl

No other attributes

SliderCfg : CommonControl

GraphCfg : CommonControl

TimeGraphCfg : CommonControl

MapCfg : CommonControl

No other attributes

ColorPicker : CommonControl

AudioVisual : CommonControl

No other attributes