Introduction To NA System Variables

Modified on Sun, 11 May, 2025 at 10:46 PM

 
The following NA System Variables will be available for the user: These can be accessed within NA project like any other GLOBAL VARIABLE.

  

System Variable Name

Description

Data Type

Read Only?

_HMI_Brightness

The current backlight brightness.  This is a control variable, so setting it to a valid value will cause the current backlight brightness to be changed.

Integer

Read-Write

_HMI_IsScreenSaverActive

Whether the screen saver is active.  The ActivateScreenSaver action has to be used to make the screen saver active.

Boolean

Read-Write

_HMI_DateTime

The current local time, read from the internal clock.  The SetDateTime action has to be used to adjust the time.

Date

Read-Only

_HMI_CanEjectSDCard

Whether the power for SD memory card is currently supplied.  To remove the SD memory card, the EjectSDMemory action has to be used.

Boolean

Read-Only

 

_HMI_RunSignal

Whether HMI is operating normally. The value of this variable should be toggled periodically while HMI is normal. Even when displaying any menu or a message box, this variable should be toggled.

Boolean

Read-Only

_HMI_IsPageSwitching

Whether the page is being switched. When switching a page, this variable should be turned ‘ON’. After the operation is complete, this variable should be turned ‘OFF’.

Boolean

Read-Only

_HMI_IsDataInput

 Whether any data input object on page is being used to enter data. When any data input object on page has a focus for data input, this variable should be turned ‘ON’, otherwise it should be turned ‘OFF’.

Boolean

Read-Only

_HMI_IsBatteryLow

The HMI internal battery voltage state. When the voltage level is below the warning threshold, this variable should be turned ‘ON’, otherwise it should be turned ‘OFF’.

Boolean

Read-Only

_HMI_CurrentPage

The name of the currently displayed page.

This is a control variable – setting it to a valid page will cause the displayed page to be changed. Invalid page names will be ignored.

String

Read-Write

_HMI_Millisecond

Milliseconds, based on the system clock value.

Integer

Read-Only

_HMI_Second

Seconds, based on the system clock value.

Integer

Read-Only

_HMI_Minute

Minutes, based on the system clock value.

Integer

Read-Only

_HMI_Hour

Hours, based on the system clock value.

Integer

Read-Only

_HMI_RAMTotal

The amount of RAM in the NA

Integer

Read-Only

_HMI_RAMInUse

The amount of RAM currently in use in the NA

Integer

Read-Only

_HMI_ManagedRAMInUse

The amount of Managed RAM in use the NA

Integer

Read-Only

 

Alarm Variables

System Variable Name

Description

Data Type

Read Only?

_HMI_AlarmCount

Total number of alarms raised since the beginning of the current runtime session

Integer

Read-Only

_HMI_AlarmsRaised

Total number of alarms currently in the raised state

Integer

Read-Only

_HMI_AlarmsNotAck

Total number of alarms currently requiring acknowledgement (whether raised or cleared)

Integer

Read-Only

_HMI_AlarmsRaisedNotAck

Number of currently raised alarms requiring acknowledgement

Integer

Read-Only

_HMI_AlarmsClearedNotAck

Number of alarms cleared but still requiring acknowledgement

Integer

Read-Only

 

Security Variables:

System Variable Name

Description

Data Type

Read Only?

_HMI_CurrentUserName

Contains the name of the currently logged in user.

String

Read-Only

_HMI_CurrentUserRole

Contains the security role of the currently logged in user (e.g. Administrator)

String

Read-Only

 

See Also:

Introduction to the NA series HMI

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article