NA System-defined Variables
Written by Arlo D'Cruz
Updated at October 24th, 2025
The following NA System Variables are be available for the user: These can be accessed within NA project like any other global variable.
System-related Variables
| Variable Name | Meaning | Description | Data Type | R/W |
|---|---|---|---|---|
| _HMI_Brightness | Brightness | Sets the brightness of the screen. | Integer | R/W |
| _HMI_CanEjectSDCard | Can Eject SD Card |
Tells whether you can remove the SD Memory Card. True: Ejection is possible. False: Ejection is not possible. |
Boolean | R |
| _HMI_ConnectedVNCClientCount | Connected number of VNC Client | Gives number of clients via VNC. | Integer | R |
| _HMI_CurrentPage | Current Page Name | Sets the name of the currently displayed page. | String | R/W |
| _HMI_CurrentPageIndex | Current Page Number | Sets the number of the currently displayed page. | Integer | R/W |
| _HMI_DateTime | System Time | Gives the system clock time as the local time. | DateTime | R |
| _HMI_Hour | Current Hour | Gives the hour in the current time. | Integer | R |
| _HMI_IsBatteryLow | Low Battery Voltage | Gives True if the battery voltage has dropped below a specific level. | Boolean | R |
| _HMI_IsDataInput | Data Entry in Progress | Gives True when a data entry object is selected. | Boolean | R |
| _HMI_IsPageSwitching | Page Switching in Progress | Gives True while page switching processing is in progress and False after processing is completed. | Boolean | R |
| _HMI_IsScreenSaverActive | Screen Saver Status |
Tells whether the screen saver is active. True: Active. False: Not active. |
Boolean | R/W |
| _HMI_ManagedRAMInUse | Usage of Managed RAM | Gives the total bytes of managed RAM that is currently allocated to some process. | ULong | R |
| _HMI_Millisecond | Current Milliseconds | Gives the milliseconds in the current time. | Integer | R |
| _HMI_Minute | Current Minutes | Gives the minutes in the current time. | Integer | R |
| _HMI_RAMInUse | Usage of RAM | Gives the total bytes of RAM that is currently allocated to some process. | ULong | R |
| _HMI_RAMTotal | Total RAM | Gives the total bytes of RAM that the system is using or can use. This is not the currently usable amount of RAM. | ULong | R |
| _HMI_RunSignal | Run Signal | Changes periodically while the HMI is operating. | Boolean | R |
| _HMI_Second | Current Seconds | Gives the seconds in the current time. | Integer | R |
Alarm-related Variables
| Variable Name | Meaning | Description | Data Type | R/W |
|---|---|---|---|---|
| _HMI_AlarmCount | Alarm Count | Gives the total number of alarms that have occurred, been cleared, or been acknowledged. The value is initialized when the alarm history is cleared. | Integer | R |
| _HMI_AlarmsClearedNotAck | Cleared Unacknowledged Alarms | Gives the number of alarms that are cleared but not acknowledged. | Integer | R |
| _HMI_AlarmsNotAck | Unacknowledged Alarm Count | Gives the number of alarms that are not acknowledged. | Integer | R |
| _HMI_AlarmsRaised | Current Alarm Count | Gives the number of current alarms. | Integer | R |
| _HMI_AlarmsRaisedNotAck | Unacknowledged Current Alarm Count | Gives the number of current alarms that are not acknowledged. | Integer | R |
User and Security
| Variable Name | Meaning | Description | Data Type | R/W |
|---|---|---|---|---|
| _HMI_CurrentUserName | Current User Name | Gives the name of the user that is currently logged in. | String | R |
| _HMI_CurrentUserRole | Current User Authority | Gives the authority (role) of the user that is currently logged in. | String | R |
System Enumeration Variables
| Data Type Name | Description |
|---|---|
| _eHMI_ALARM_STATUS | Specifies the alarm status. Acknowledged: Acknowledged All: All Cleared: Already cleared. ClearedAckNotRequired: Already cleared and no need to acknowledge. ClearedAcknowledged: Already cleared and acknowledged. ClearedUnacknowledged: Already cleared but not yet acknowl- edged. Raised: Raised. RaisedAckNotRequired: Raised and no need to acknowledge. RaisedAcknowledged: Raised and already acknowledged. RaisedUnacknowledged: Raised but not yet acknowledged. Unacknowledged: Not yet acknowledged. |
| _eHMI_BUZZER_TYPE | Specifies the buzzer mode. ContinuousBuzzer: Continuous buzzer IntermittentLongPulse: Intermittent long buzzer IntermittentShortPulse: Intermittent short buzzer |
| _eHMI_COLUMN | Specifies the column for sorting or filtering the user alarms viewer. AlarmCode: Alarm code All: All DateAndTime: Date and time Group: Group LoggedInUser: Logged-in user Message: Message Name: Name Priority: Priority Status: Status ElapsedTime: Elapsed time |
| _eHMI_EXPOSETTYPE | Specifies the search target of the Safety Monitor. All: All variables InputVariable: Input to Safety CPU OutputVariable: Output from Safety CPU |
| _eHMI_FTPFileType | Specifies the target when using an FTP client. All: All File: Files only Directory: Folders only |
| _eHMI_GRAPH_CURSOR | Specifies the cursor for graphs. Cursor1: Cursor 1 Cursor2: Cursor 2 |
| _eHMI_GRAPH_DIRECTION | Specifies the direction of graphs. Left: Left Right: Right |
| _eHMI_GRAPH_ZOOM_TARGET | Specifies the expansion mode for graphs. Both: Both Horizontal: Horizontal direction only Vertical: Vertical direction only |
| _eHMI_IME_LANGUAGE | Specifies the IME input mode. CurrentSystemLanguage: System language Japanese: Japanese Korean: Korean SimplifiedChinese: Simplified Chinese TraditionalChinese: Traditional Chinese |
| _eHMI_KNOWN_PATH | Specifies the medium. SDCard: SD card USBMemory: USB memory |
| _eHMI_PRIORITY | Specifies the priority of the items to be displayed in the user alarms viewer. All: All UserFaultLevel1: User alarm level 1 UserFaultLevel2: User alarm level 2 UserFaultLevel3: User alarm level 3 UserFaultLevel4: User alarm level 4 UserFaultLevel5: User alarm level 5 UserFaultLevel6: User alarm level 6 UserFaultLevel7: User alarm level 7 UserFaultLevel8: User alarm level 8 UserInformation: Information |
| _eHMI_SERVICE_STATE | Specifies the state of the service. Running: Running Suspended: Suspended |
| _eHMI_SERVICE_TYPE | Specifies the type of the service. VNCServer: VNC server |
| _eHMI_SORT_ORDER | Specifies the sort order of the user alarms viewer. Ascending: Ascending Descending: Descending |
| _eHMI_TROUBLESHOOTER_PAGE | Specifies the screen displayed for the troubleshooter. ActiveControllerEvents: Controller error list screen ActiveUserEvents: User error list screen ControllerEventLogs: Controller error log list screen UserEventLogs: User error log list screen |
System Structure Variables
| Data Type Name | Variable | Data Type | Description |
|---|---|---|---|
| _sHMI_VNC_CLIENT_INFO | Comment | String | Specifies a comment. |
| IPAddress | String | Specifies an IP address. | |
| MACAddress | String | Specifies a MAC address. |