README.md

About the "CustomConfig" sample

The CustomConfig-Extension contains a subfolder ConfigResources with a CSS-, JavaScript- and HTML-file. To show their content on the server configuration page, they must be copied to the output directory (Visual Studio: Right click → Properties → Copy to Output Directory).

If you open an HMI project with this extension, there will be a Custom config tab on the server configuration page which includes a button and a textarea. The title of this tab can be changed in the .Config.json file of the extension. If you click on the button, CustomConfig.GetRandom will be executed which returns a random integer between min and max of the extension configuration. The default configuration will be still available with the General tab.

The default configuration looks like this:

{
    "max": 0,
    "min": 0
}

Example: Change custom config title

To change the title of the custom config tab, add an entry with __CUSTOM_CONFIG__ as name and your localization key to the symbolCategories property of your .Config.json file.

{
    "symbolCategories": [
        {
            "name": "__CUSTOM_CONFIG__",
            "localization": "customConfig"
        }
    ]
}

Add an entry for customConfig to your language files.

{
    "$schema": "../TcHmiSrv/Language.Schema.json",
    "locale": "en",
    "localizedText": {
        "customConfig": "Random value"
    }
}

Example: Download file

1. Virtual directories

   To enable downloading a file of the server system, all file systems, which should be served, must be added as virtual directory. All virtual directories can be found on the configuration page under TcHmiSrv > Virtual directories.

   {
       "VIRTUALDIRECTORIES": {
           "/VirtualDirectory": "Path/Foldername"
       }
   }

2. Download button

   <a href="http://127.0.0.1:1010/VirtualDirectory/Path/Filename" download>Download link</a>

   Limitation: The download button is not available in the live-view of the HMI engineering.

Example requests

1. Read the current configuration of the sample extension:

   Request:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "CustomConfig.Config",
               "commandOptions": [ "SendErrorMessage" ]
           }
       ]
   }

   Response:

   {
       "commands": [
           {
               "symbol": "Custom.Config",
               "readValue": {
                   "min": 2,
                   "max": 4
               }
           }
       ]
   }

2. Get a random integer:

   Request:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "CustomConfig.GetRandom",
               "commandOptions": [ "SendErrorMessage" ]
           }
       ]
   }

   Response:

   {
       "commands": [
           {
               "symbol": "Custom.GetRandom",
               "readValue": 3
           }
       ]
   }