Errors

  2 minute read  

Pressing Errors button will open and collapse Errors menu.

  1. In the Errors menu you can manage the visualization of your errors. These settings are used in the Error handler located in the Grid.
  2. 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.
  3. 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.
  4. With the frequency divider you can reduce the rate at which the server publishes its data. The server update rate is divided by this value; e.g. if the server has an update rate of 1000 Hz, a frequency divider of 100 will make the publisher send only every 100th sample, resulting in an update rate of the received data of 10 Hz.
  5. In the Error codes bar you can select the .json file with your error codes.
  6. In the Definitions bar you can select the folder containing the error definitions.
image not found

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",
}

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 default.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>
}