System variables

Top  Previous  Next

System variables in EPAM4 are defined with /S/<Host>/<Name>. The EPAM3 system variables s_<name> must be replaced as follows:

 

EPAM3

Meaning

Data type

EPAM4

TYPE

Comment

s_alarm_active

Variable is set if alarms are active

INT

/S/SYS/Alarm[<name>].Active

BOOL

 

s_alarm[<name>].active_count

Number of active alarms

INT

/S/SYS/Alarm[<name>].ActiveCount

WORD

 

s_alarm_info

Name of the configured screen page of the Alarminfo action of the last alarm selected in the alarm list

STRING

/S/SYS/AlarmList[<name>].INFO

WSTRING

 

s_alarm_nr

Alarm number of the alarm last selected in the alarm list

WORD

/S/SYS/AlarmList[<name>].NR

DWORD

 

s_alarm_text

Alarm text of the alarm last selected in the alarm list

STRING

/S/SYS/AlarmList[<name>].TEXT

WSTRING

 

s_alarm_tin

Time alarm “Come” of the alarm last selected in the alarm list

STRING

/S/SYS/AlarmList[<name>].TIN

WSTRING

 

s_alarm_tin_dt

Time alarm “Come” of the alarm last selected in the alarm list

IEC_DT

/S/SYS/AlarmList[<name>].TIN_DT

DT

 

s_alarm_tout

Time alarm “Go” of the alarm last selected in the alarm list

STRING

/S/SYS/AlarmList[<name>].TOUT

WSTRING

 

s_alarm_tout_dt

Time alarm “Go” of the alarm last selected in the alarm list

IEC_DT

/S/SYS/AlarmList[<name>].TOUT_DT

DT

 

s_alarm_tquit

Time alarm “Acknowledged” of the alarm last selected in the alarm list

STRING

/S/SYS/AlarmList[<name>].TQUIT

WSTRING

 

s_alarm_tquit_dt

Time alarm “Acknowledged” of the alarm last selected in the alarm list

IEC_DT

/S/SYS/AlarmList[<name>].TQUIT_DT

DT

 

s_alarm_txtinfo

Variable with the name of the ASCII text file with the alarm specific text information (used with text list)

STRING

/S/SYS/AlarmList[<name>].TXTINFO

WSTRING

 

s_alarm_type

Variable with the name of the alarm type (used with several alarm objects)

STRING

/S/APP/Alarm:Type

WSTRING

 

s_backlight

Actual setting of the backlight (0-100%, default: 100%)

WORD

/S/APP/Backlight

WORD

 

s_contrast

Actual setting of the contrast (0-100%, default: 50%) Only passive LCDs!

WORD

 

 

Removed completely

s_dbconnection

DB connection status: 0 = not connected; 1 = connected

INT

 

 

Removed completely

s_dbpasswd_change_err

DB password modification status:

INT

 

 

Removed completely

s_dbpasswd_expires

DB password, days to expiry (default value = 0xFFFFFFFF)

DWORD

 

 

Removed completely

s_dbpasswd_login_err

DB login status:

INT

 

 

Removed completely

s_dbpasswd_name

DB user name

STRING

 

 

Removed completely

s_dbpasswd_pw

DB password

STRING

 

 

Removed completely

s_dbpasswd_pw1

DB new password

STRING

 

 

Removed completely

s_dbpasswd_pw2

DB new password repetition

STRING

 

 

Removed completely

s_dhcp_mode

0 = DHCP disabled, static IP address

INT

/S/SYS/Ethernet[0].DhcpMode

STRING

 

s_dns1_ip

DNS1 address of the target system (input in format xxx.xxx.xxx.xxx)

STRING

/S/SYS/Ethernet[0].Dns1IpAdr

STRING

 

s_dns2_ip

DNS2 address of the target system (input in format xxx.xxx.xxx.xxx)

STRING

/S/SYS/Ethernet[0].Dns2IpAdr

STRING

 

s_edit_val

Last value input

STRING

/S/SYS/Edit_Val

WSTRING

 

s_epam_date

 

EPAM date (creation date)

STRING


 

Removed completely

s_epam_version

Current EPAM version

STRING

/S/SYS/RtsVersion

STRING

 

s_gateway_ip

Current IP address of the gateway

(input in format xxx.xxx.xxx.xxx)

STRING

/S/SYS/Ethernet[0].GatewayIpAdr

STRING

 

s_helptext

Current Help text number

WORD

/S/SYS/HelpText

WORD

 

s_input_val

Current input value

STRING

 

 

removed completely, see #variable option mirror

s_irtouch

1 with IR touch screen; 0 others

INT

/S/SYS/IrTouch

WORD

 

s_language

Current language

STRING

/S/APP/Language

WSTRING

 

s_limit1

Current lower limit value

STRING

/S/SYS/Limit1

WSTRING

 

s_limit2

Current upper limit value

STRING

/S/SYS/Limit2

WSTRING

 

s_myrecipetype _dnload_max

Number of recipe variables of the corresponding recipe type for download

(the system variable is created for every defined recipe type)

WORD

 

 

not implemented

s_myrecipetype_cur_file

Recipe file currently selected in the recipe list for each recipe type defined (without extension)

STRING

/S/SYS/RecipeList:SelectedFile

WSTRING


s_myrecipetype_cur_name

Recipe name currently selected in the recipe list for each recipe type defined

STRING

/S/SYS/RecipeList:SelectedName

WSTRING


s_myrecipetype_dnload_act

Current number of loaded recipe variables for download

(the system variable is created for every defined recipe type)

WORD

 

 

not implemented

s_myrecipetype_file

Recipe file for each recipe type defined (without extension)

STRING

/S/APP/Recipe[<type>].file

WSTRING

 

s_myrecipetype_name

Recipe name for each recipe type defined

STRING

/S/APP/Recipe[<type>].name

WSTRING

 

s_myrecipetype_upload_act

Current number of loaded recipe variables for

(the system variable is created for every defined recipe type)

WORD

 

 

not implemented

s_myrecipetype_upload_max

Number of recipe variables of the corresponding recipe type for upload

(the system variable is created for every defined recipe type)

WORD

 

 

not implemented

s_mytrend_c1

Current value at cursor position

As per Trend

/S/SYS/Trend[<name>].c[<index>]

As per DataLog

 

 

 

 

/S/SYS/Trend[<name>].c[<index>].s

WSTRING

 

s_mytrend_c2

Current value at cursor position

As per Trend

 

 

 

s_mytrend_c3

Current value at cursor position

As per Trend

 

 

 

s_mytrend_c4

Current value at cursor position

As per Trend

 

 

 

s_newpage

New screen page name

Setting this variable initiates a screen page change to screen page s_newpage

STRING

/S/SYS/NewPage

WSTRING

 

s_pageidx

Current screen page ID

(in conjunction with option ID)

UINT

/S/SYS/PageId

WORD

 

s_pagename

Current screen page name

STRING

/S/SYS/PageName

WSTRING

 

s_password

Current password entry

STRING

Any name

WSTRING

 

s_password_x

Defined password for authorization level x

STRING

/S/APP/Password_<pwl>

WSTRING

 

s_plcstate

Current status (1=Stop, 0=Run) of local controller

WORD

 

 

Removed completely

s_plcstate_<hostname>

Current status of (remote) controller <hostname>

WORD

Drv[<driver>][<host>].state

e.g. /S/SYS/Drv[Plch][Plc1].state

WORD

 

s_projectname

Current project name

STRING

/S/SYS/ProjectName

WSTRING

 

s_projectprogrammer

Current project programmer

STRING

/S/SYS/ProjectProgrammer

WSTRING

 

s_projecttarget

Current project target system

STRING

/S/SYS/ProjectTarget

WSTRING

 

s_projectversion

Current project version

STRING

/S/SYS/ProjectVersion

WSTRING

 

s_pwl

Current password level

WORD

/S/SYS/Pwl

WORD

 

s_rc_password

Password for RemoteControl server

STRING

/S/SYS/Rc_Password

WSTRING

 

s_recipe_path

Current directory path of all recipes

STRING

/S/APP/Recipe:Path

WSTRING

 

s_recipe_type

Currently selected recipe type

STRING

/S/APP/Recipe:Type

WSTRING

 

s_recipelist_empty

1 with an empty recipe list, 0 at least 1 recipe in the list

INT

 

 

not implemented

s_remoteclient_connected

1 if access via RemoteClient active

INT

/S/SYS/RemoteClient.connected

INT

 

s_subnetmask

Current subnet mask of the target system

(input in IP format xxx.xxx.xxx.xxx)

STRING

/S/SYS/Ethernet[0].SubnetMask

                                                                         


s_target_ip

Current IP address of the target system

(input in format xxx.xxx.xxx.xxx)

STRING

/S/SYS/Ethernet[0].IpAdr

STRING

 

s_tm_day

Day (1-31)

WORD

/S/SYS/tm_Day

WORD

 

s_tm_hour

Hours (00-23)

WORD

/S/SYS/tm_Hour

WORD

 

s_tm_isdst

s_tm_isdst > 0  ...DST change

WORD

 

 

Removed completely

s_tm_min

Minute 0-59

WORD

/S/SYS/tm_Min

WORD

 

s_tm_mon

Month (1-12)

WORD

/S/SYS/tm_Mon

WORD

 

s_tm_nsec

Nominal seconds (00-59) for input

WORD

/S/SYS/tm_nSec

WORD

 

s_tm_sec

Actual seconds (00-59) for display

WORD

/S/SYS/tm_Sec

WORD

 

s_tm_wday

Weekday (0-6; 0 = Sunday)

WORD

/S/SYS/tm_wDay

WORD

 

 

 

 

/S/SYS/tm_yDay

WORD

Day of the year 0 - 365

s_tm_year

Year (1980-2099)

WORD

/S/SYS/tm_Year

WORD

 

 

 

 

/S/APP/tm_UseAmPm

BOOL

affects /S/SYS/tm_hour

0 = Hours 0-23

1 = Hours 0-11 (AM/PM)

 

 

 

/S/SYS/tm_HourMax

WORD

Is set according to

/S/APP/Tm_UseAmPm 0->24¦1->12. Normally as Limit2 to input the time via /S/SYS/Tm_hour.

 

 

 

/S/SYS/tm_IsPM

BOOL

0 = 00:00-11:59

1 = 12:00-23:59

s_toucherror

0 o.k.

1 Touch test error (only IR touch)

INT

/S/SYS/TouchError

WORD

 

s_trend_t

“Raw value” of the X position

DWORD

/S/SYS/Trend[<name>].t

DT

 

s_trend_t_hour

Time at cursor position (hours)

DWORD

 

 

Removed completely

s_trend_t_mday

Time at cursor position (day)

DWORD

 

 

Removed completely

s_trend_t_min

Time at cursor position (minutes)

DWORD

 

 

Removed completely

s_trend_t_mon

Time at cursor position (month)

DWORD

 

 

Removed completely

s_trend_t_sec

Time at cursor position (seconds)

DWORD

 

 

Removed completely

s_trend_t_sec

Time at cursor position (minutes)

DWORD

 

 

Removed completely

s_trend_t_wday

Time at cursor position (weekday)

DWORD

 

 

Removed completely

s_trend_t_year

Time at cursor position (year)

DWORD

 

 

Removed completely

s_unit_idx

Current unit system 0, 1, …

WORD

/S/APP/UnitIdx

WORD

(see Unit systems)

s_user_x

Defined user name for authorization level x

STRING

/S/APP/User_<pwl>

WSTRING

Users per pwl

 

 

 

/S/SYS/DateTime

DT

Current system time and date

s_user

 

STRING

/S/SYS/User

WSTRING

User for current pwl

s_pwl_required


WORD

/S/SYS/PwlRequired

WORD

Required password level to operate actuated object.

s_pageid_last

 

WORD

/S/SYS/PageIdLast

WORD