Properties Panel

A explanation of how to work with Motorcortex Grid

5 minute read

The Properties Panel

On the right side of the application you will find the Properties Panel, this is where you configure all your grid elements. The Properties Panel also changes with each selected element in the grid. per default and by clicking the grid the Properties Panel will show the following menus:

Button Description
Client Connection Settings Will open and collapse Client connection settings menu.
Errors Will open and collapse Errors settings menu.
States Will open and collapse States settings menu.
Logs Will open and collapse Logs settings menu.
Screen Will open and collapse Screen settings menu.
Raster Will open and collapse Raster settings menu.

Client Connection Settings

In the Client Connection Settings menu you can set up the connection with your controller.

Client Connection Settings

Bar Description
IP address bar In the IP address bar you have to fill in your controllers local IP.
Request In the Request bar you fill in your Request/Reply channel port number by default this value is 5568.
Reveive In the Reveive bar you fill in your Publish/Subscribe channel port number by default this value is 5567.
Username In the User name bar you fill in your user name.
Password In the Password bar you fill in your password.
Secure With the Secure check box you can realize a secure connection.
Autologin With the auto-login check box you make the controller automatically re-login every time you connect.

Errors

In the Errors Settings menu you can manage the visualization of your errors. These settings are used in the Error handler located in The Grid.

Client Connection Settings

Bar Description
Errors Path Bar In the Path bar you select the path in the parameter tree to your error handler parameter. Per default this parameter is root/Logic/activeErrors.
Errors Acknowledge Bar In the Acknowledge bar you can select the path in the parameter tree to your acknowledge parameter. Per default this parameter is root/Logic/guiFaultAcknowledge.
Error Codes Bar In the Error codes bar you can select the .json file with your error codes.
Definitions Bar In the Definitions bar you can select the folder containing the error definitions.

Error Codes

The Error Parameter provides a Error number. This number can be linked to a file .json file created by the user to show text. Below is a template that gives an example of a errors.json file:

{
  "0": "SYSTEM_OK",
  "100": "WA_SYSTEM_WARNING",
  "101": "WA_REALTIME_VIOLATION",
  "500": "ES_SYSTEM_ERROR",
  "700": "SD_SYSTEM_ERROR",
}

This section will not cover how to set up a system error structure.
Learn how to create .json files in motorcortex.io here

Error Definitions

It is also possible to give definitions to errors. This can be done by putting .html files in the selected Errors folder. a template for the .html files inside this folder is given below:

{
<h1>100: Warning System Warning</h1>

<h2>Description</h2>
<p>Generic System Level Warning (used only for debug purposes)</p>
<!--
<h2>Cause</h2>
<ol>
<li>To Be Determined</li>
</ol>

<h2>Remedy</h2>
<ol>
<li>To Be Determined</li>
</ol>
-->
}

It is recommended to also put a deafault.html file inside the Errors folder for debugging purposes:

<h1>No error description available.</h1>
<p>Please consult the troubleshooting manual for more information.</p>

States

In the Client Connection Settings menu you can manage the visualization of your system states.

States

Bar Description
Path In the Path bar you select the path in the parameter tree to your state parameter. Per default this parameter is root/Logic/state.
State Codes In the State Codes bar you place the .json file with your state codes.

State Codes

The state parameter provides a state number. This number can be linked to a .json file file created by the user to show text. Below is a template that gives an example of a states.json file:

{
  "0": "INIT_S",
  "1": "OFF_S",
  "2": "DISENGAGED_S",
  "4": "ENGAGED_S",
  "7": "ESTOP_OFF_S",
}

This section will not cover how to set up a system state structure.
Learn how to create .json files in motorcortex.io here

Logs

the log keeps track of what is going on in the system and can be used for debugging purposes.

logs

Bar Description
Path In the Path bar you select the path in the parameter tree to your log parameter. Per default this parameter is root/Logic/logOut.

Screen

In the Screen Settings menu you can manage the visualization of your screens a GUI can have multiple screens.

Screen

Bar Description
Title In the Title bar you can change the title of your screen.
Start screen In the Start Screen bar you can choose the initial start screen.
delete With the Delete button you can delete a screen. A message will make you confirm deletion.
Visibility In the Visibility bar you can select the Parameter in the Parameter tree that will make this your screen show up. Per default no path screen will always make a screen show up. It is not possible to change visibility for the start screen.
Slot
Freq divider In the frequency divider you can adjust the screen update rate. The initial value freq divider value is 100.
Group with a Group you can specify a group of parameters used for this screen. For you will find more information about this Here
W In the Width screen you can define the with of all screens. The initial value for the width is 800.
H In the Height screen you can define the with of all screens. The initial value for the Height is 600.
Foreground In the Foreground color you can select the color you want for the foreground of your grid in hex value. The initial value for the hex value is #323c4e.
Background in the Background color you can select the color you want for the Background of your grid in hex value. The initial value for the hex value is #28303e.

Raster

In the Raster Settings menu you can manage the visualization of your raster to aid in placing components.

Raster

Bar Description
Color In the Raster color you can select the color you want for the Raster of your grid in hex value. The initial value for the hex value is #3c475d. The raster does not show up in a finished GUI.
W In the Width bar you can define the width the raster. The initial value for the width is 30.
H In the Height bar you can define the Height the raster. The initial value for the Height is 30.
Show With the Show check box you can make the raster visual.
Snap With the Snap check box you can make the components inside the grid snap to the raster.
Last modified March 23, 2021: Restructured GRID (44d0658)