.controls¶

Find writable setpoints¶

To find writable setpoints, you have two options. You can either find setpoints by checking the datapoints that are pinned to components in the project, or you can start off with a specific datapoint naming schema if you already found it or are not working with existing components.

Working with a known datapoint naming schema¶

If you already know the naming schema of the controller you are working with, you can just enter it here. For example, if all setpoints and measurements of the room/AHU/etc. you are working with start with Building1_Room70_ followed by individual datapoint names and types, you can enter the naming scheme here and enable the gui to find all relevant datapoints automatically.

Once the naming scheme has been selected, the GUI gathers all necessary information regarding possible setpoint candidates, their current status and displays the setpoint testing window.

Working with components¶

If you want to find writable setpoints based on the building components, you can select this option, and in the following window select the component and its corresponding pin (or only the setpoint type, such as On/Off or analogue). Once you selected your target setpoint, the GUI makes a suggestion of possible naming schemas.

It lets the user make the decision, which datapoint schema might be the correct one for the controller they are working with. In the example below, the first option OC_ would be too vague and likely result in hundreds or thousands of datapoints being selected and displayed. The third option might already be too specific, since it seems to include a datapoint type at the end. Therefore, the second option seems to be the correct choice in this case

Once the naming scheme has been selected, the GUI gathers all necessary information regarding possible setpoint candidates, their current status and displays the setpoint testing window.

Setpoint testing window¶

The setpoint testing window allows the user to systematically go through the setpoint candidates and automates many of the necessary steps.

The setpoint testing window consists of the following items, which are automatically adjusted to fit the setpoint type 1. Datapoint ID: contains the name of the datapoint. By right clicking it, you get the options to copy the datapoint id into your clipboard, show the current values in the frontend, or even additionally show the associated components values in the frontend, if you chose the datapoint based on a component

2. Datapoint description: contains the description of the datapoint. By right clicking it, you also get the full list of tags associated with the datapoint. These contain relevant information, so take a look!

3. Datapoint type: the datapoint type, as specified in the datapoint tags

4. Current Value: the last value of the datapoint, before the window was opened (Note: Currently, this value is not being refreshed!)

5. Writing value selection/input field: Drop-Down menu or input field, where you can enter the value you want to write to the setpoint. For multi state values, these are automatically replaced with the correct names of the states, as specified in the datapoint tags (if the corresponding tag does not exist, only the sate number values are shown)

6. Test, Write and Reset buttons: the heart of the functionality and explained in the following section.

By clicking the Test button, the value selected/entered in the writing value input field is sent to the datapoint as a setpoint in dryrun mode. This means that the edge device will check for writability of this datapoint, without actually writing to it. You always have to do this step for any datapoint, before being allowed to write to it without the dryrun enabled.

If this is the first write command sent to the datapoint, the gui will try to set the writing boundaries. For multi state values and binary values these are set automatically, but for analogue values, a secondary window will appear, prompting you to enter the writing boundaries. Enter possible boundaries that you might expect for this datapoint, e.g. min 18 and max 25 for a room temperature setpoint. These writing boundaries can later be changed via the api, if you made any mistakes.

If the test was successful, the Write value button is enabled for the corresponding datapoint. Once you click it, your selected value is sent as a setpoint without dryrun, and the GUI will monitor the edge devices response. If the setpoint write command is accepted, a browser window will automatically open, and enable the user to monitor whether the write command has actually changed the datapoint, and whether this has any influence on the other datapoints pinned in the component.

If the writing was successful, the Reset value button is enabled. This allows you to set the value back to it´s original current value (or if priority arrays are enabled, it will automatically free up or reset the used priority to allow the local controller and facility manager to take back control)

Additionally, the Reset all values button allows you to reset all values you have changed while this window was open

The GUI is set up in a way that avoids closing or exiting the window without resetting all values, but should some unexpected error occur, you can check the gui logs for a full list of the setpoints, your written values, the reset values and their priorities, so in the worst case scenario, you can manually reset them using the API.