preconfiguration

The EFR Profile settings can be configured through environment (ENV) variables. These settings are applied during system startup and, once active, block changes to the same configuration via the UI or API in order to avoid conflicts.

Structure

• Environment variables must follow this format where __DOT__ is used as a separator between the different properties of the setting object: EFSTA_EFR_PROFILE_CFG__DOT__{RN}__DOT__{setting_name}={value}

  • If the structure is not respected, the setting will not be applied

• The RN must be defined so the system knows which register to apply the setting to

  • On single-RN systems, def can be used instead of a specific RN
  • Since some RNs may contain the $ symbol, which is not supported in ENV variable names, use __DOLLAR__ instead. The EFR automatically converts it back to $

• Boolean values must be lowercase (true, false)

Example (using PL specific settings)

EFSTA_EFR_PROFILE_CFG__DOT__def__DOT__RN_TT=true
EFSTA_EFR_PROFILE_CFG__DOT__001_1__DOT__Sign_require="FP_T88FVA"
EFSTA_EFR_PROFILE_CFG__DOT__001_1__DOT__Sign_Cfg="COM7:115200"
EFSTA_EFR_PROFILE_CFG__DOT__001_2__DOT__Sign_require="FP_T88FVA"
EFSTA_EFR_PROFILE_CFG__DOT__001_2__DOT__Sign_Cfg="COM5:115200"
EFSTA_EFR_PROFILE_CFG__DOT____DOLLAR__001_456__DOT__Sign_Cfg="COM5:115200"

Blocking of Settings

If a configuration is applied through ENV variables, it cannot be modified via the UI or API. The API will return the following message if a blocked setting is changed: Setting of {setting_name} for {RN} is blocked

To re-enable UI/API configuration:

• Remove the corresponding ENV variable(s)
• Restart the EFR

Querying ENV Settings

The EFR provides a way to query which settings have been applied through ENV variables. Use the following endpoint to view them:

GET /state

note

This does not list all Profile settings, only those from ENV.

Example response (EnvSettings section highlighted)

{
  "uptime": 162815,
  "name": "EFR",
  "version": "2.6.1.1",
  "Country": "ZZ AT BE CZ DE DK ES FR HR HU IT LT NO PL PT SE SI SK",
  "Online": false,
  "Recorder": "inactive",
  "RN": "def $001_456 001_1 001_2",
  ...
  "EnvSettings": {
    "def": {
      "RN_TT": true
    },
    "001_1": {
      "Sign_require": "FP_T88FVA",
      "Foo": "Bar",
      "Sign_Cfg": "COM7:115200"
    },
    "001_2": {
      "Sign_require": "FP_T88FVA",
      "Sign_Cfg": "COM5:115200"
    },
    "$001_456": {
      "Sign_Cfg": "COM5:115200"
    }
  }
}

System Restart Triggers

If the following settings are applied via ENV variables, the EFR will automatically restart:

• HttpServer_Port
• UdpServer_Port
• DiskQuota
• Proxy