Controls Manage View

The Edit Control Element window allows editing the name, site, output type, sensor selection, and saving or cancelling changes.

The Edit Control Element window allows users to modify a control element's settings. Here's a breakdown of its components.

Controls Manage View

When the user clicks the Manage button, a new window titled "Edit Control Element" opens. This view allows users to modify an existing control element's details and configuration.

Overview

  • The Edit Control Element view is pre-populated with the existing details of the selected control.

  • Users can modify the following fields: Element Name, Site, Control Output, and any dynamic fields related to the chosen output type (Native, MQTT, or HTTP).

  • Sensitive fields, like the MQTT Password, are obscured for security.

Mandatory Fields

These fields are required for the control element and are marked with a star (*).

Field Name
Description

Element Name*

The name of the control element, pre-filled with the current value but editable.

Site*

A dropdown menu to select or update the location associated with the control element.

Control Output*

Displays the current communication method (Native, MQTT, or HTTP). Users can switch to another method.

Control Output Options

The behaviour of the form changes dynamically based on the selected Control Output type.

1. Native

  • Displays the basic form with no additional fields.

  • Editable fields:

    • Element Name

    • Site

    • Sensor

2. MQTT

  • If MQTT is selected, additional fields specific to MQTT configuration are displayed.

  • Password Field Behaviour: The MQTT password is displayed as obscured input (e.g., "•••••") for security. Users can delete and re-enter a new password if needed.

Field Name
Description

Topic*

The MQTT topic used for publishing messages. Pre-filled with the existing value, but editable.

Message (ON)*

The payload sent when the control is turned ON.

Message (OFF)*

The payload sent when the control is turned OFF.

User ID*

The username used to authenticate with the MQTT server.

Password*

Displays the password as obscured input (e.g., "•••••"). Users can modify this if necessary.

Server*

The MQTT server’s URL or IP address, pre-filled with the current value but editable.

3. HTTP

  • If HTTP is selected, additional fields specific to HTTP communication are displayed, along with body format options.

Field Name
Description

Body Format

Options include x-www-form-URL encoded, raw, and binary. The current selection is pre-filled.

URL*

The endpoint URL for HTTP communication. Pre-filled with the current value but editable.

Message (ON)*

The payload sent when the control is turned ON.

Message (OFF)*

The payload sent when the control is turned OFF.

Action Buttons

Located at the bottom-right corner, these buttons allow users to save changes or cancel edits.

Button Name
Description

Cancel

Discards all changes and exits the view without saving.

Save

Saves the updated control element configuration.

Dynamic Behaviour Summary

Control Output
Additional Fields Displayed

Native

No additional fields are displayed.

MQTT

Fields for Topic, Messages (ON/OFF), User ID, Password, and Server appear. Password is obscured for security.

HTTP

Fields for Body Format, URL, and Messages (ON/OFF) appear.

Example Table: MQTT Password Behaviour

Field Name
Description
Behaviour

Password*

Used to authenticate with the MQTT server.

Obscured input (e.g., "•••••").

Conclusion

The Edit Control Element view provides a streamlined interface for updating control configurations. With dynamic form behaviour based on the Control Output type and security features like password obscuration, it ensures flexibility and data integrity while maintaining user-friendly operations.

Last updated