Appendix 1 Functions for Script

When you use functions with a return value, a variable to store the return value must be declared beforehand.

This manual is based on XpanelDesigner 2. 53 Ver. Software. Note that some features may differ depending on the version of XpanelDesigner.

Acos(number)

Computes the Arc Cosine value.

Asin(number)

Computes the Arc Sine value.

Atan(number)

Computes the Arc Tangent value.

Atan2(number1, number2)

Computes the Arc Tangent value of number1/number2.

Cos(number)

Computes the Cosine value.

Cosh(number)

Computes the Hyperbolic Cosine value.

Sin(number)

Computes the Sine value.

Sinh(number)

Computes the Hyperbolic Sine value.

Tan(number)

Computes the Tangent value.

Tanh (number)

Computes the Hyperbolic Tangent value.

Abs(number)

Returns the absolute value.

Ceil(number)

Returns the ceiling of a value.

Floor(number)

Returns the floor of a value.

Fmod(number1, number2)

Returns the floating-point remainder.

Log (number)

Computes the natural logarithm.

Log10(number)

Computes the base-10 logarithm.

Rand()

Generates the pseudorandom number.

Sqrt(number)

Computes the square root.

AddMessage(Message ID, Added Message)

Adds a new message to the scroll message window.

AddMessageEx(Message ID, Added Message,Level)

Adds a new message to the scroll message window with a level.

AlarmCsvWr(AlarmGroup, “CSVFileName”, TimeDisplay, PrintOption, Location)

Saves the alarm messages as a CSV file.

AlarmPrint(AlarmGroup, Messages,TimeDisplay, FontSize, PrintOption)

Prints the alarm messages with the printer.

ClearAlarmLog(AlarmGroup)

Deletes the entire alarm log of the assigned alarm group.

ClearDataLog()

Removes all logs from the data logging model.

ClosePort(PortNo)

Closes the serial port.

EnableDriver(“DeviceName”, “StationName”, Enable/Disable)

Controls the selected station’s communication.

ExitXpanel()

Terminated Xpanel runtime.

FrameOpen(“FrameFile”)

Opens the frame file.

GetExplorerPath(PathType)

Returns the recently selected file’s path.

GetCommStatus(“DeviceName”, “StationName”)

Checks the selected station’s communication status.

GetLength(Tag)

Returns the number of characters in a string tag.

GetRcpDnGroup(“Model Name”)

Returns the recipe group name which has downloaded recently.

GetRcpGroupname(“Model Name”, Group Number)

Returns the recipe group name.

GetRcpItemName(“Model Name”, Data item number)

Returns the name of recipe data.

GetScheduleState(Schedule Index)

Obtains the active state of a certain schedule.

GetScheduleSysMem(Schedule Index, Starting Address of SYSTEM MEMORY)

Obtains the time data of a certain schedule.

GetSecurity()

Returns the current security level.(0 – 10)

GetSysMem(System Memory Address)

Returns the system memory value.

GetSysMemString(Target system memory offset, Number of Word)

Converts ASCII code in the system memory into the string value.

GetTime(Value Type)

Returns the current time value.

HardCopy()

Prints out the runtime screen of Xpanel.

IsDirectory(“File or Folder Name”)

Checks if the file or folder exists in the Xpanel.

LcdBacklight(ON/OFF)

Turns on or off the LCD Backlight.

LcdBrightDown()

Dims the LCD light.

LcdBrightUp()

Brightens the LCD light.

LogOff()

Logs out the current user.

LogOn(“UserID”, “Password”)

Logs on with the user information.

LogOnWin()

Brings up the User Log On window.

MakeCsv(“LogModelName”, BlockNumber)

Saves the data block to the SD/MMC memory in CSV file format.

MakeLogCsvEx(“Header”, “LogModelName”, BlockNumber, Location)

Saves the data block in CSV file format and stores the header name at cell A1.

MakeCsvUsb(“LogModelName”, BlockNumber)

Saves the data block to the USB storage in CSV file format.

MakeLogCsv(“LogModelName”, BlockNumber, Location)

Saves the data block to the assigned location in CSV file format.

MakeLogCsvEx(“Header”, “LogModelName”, BlockNumber, Location)

Saves the data block in CSV file format and stores the header name at cell A1.

MakeSysMemCsv(“Header”, Starting address of System Memory, number of memories, number of Columns, Location)

Saves the system memories in CSV file format.

NumToStr(TargetValue, Value Type, Format)

Converts the numeric value to the string.

NumToAsc(Decimal value)

Converts a decimal value to an ASCII code value.

OpenConfigSub(Function)

Brings up the Xpanel Config. window or its subfeatures.

OpenConfigWin()

Brings up the Xpanel Config. window.

OpenPort (PortNo, BaudRate, Parity, Databit, Stopbit)

Opens the serial port.

PageOpen(“PageName”)

Opens the page.

PlayWave(WavFileLocation, Path, Sync/Async)

Executes the WAV file in the assigned path.

PrePage()

Moves to the previous page.

PrePageEx()

Moves to the previous base page.

RcpConfig()

Displays the recipe settings window in Xpanel runtime.

RcpCsvRd(“Model Name”, “CSV File Name”, CSV file directory)

Reads recipe model group data (*.csv file) and saves it in the memory.

RcpCsvWr(“Model Name”, “CSV File Name”, CSV file directory)

Saves model group data in the memory as a CSV file format.

RcpDownload(“Model Name”, Group Number)

Downloads model group data to the PLC.

RcpFileRead(“Model Name”, Group Number)

Reads PLC data and saves it to the recipe file.

RcpFileStore(“Model Name”, Group Number)

Saves the model group data in the recipe file.

RcpGetSysMem(“Model Name”, System Memory Address)

Copies one block of system memory to Xpanel memory.

RcpMemDown(“Model Name”)

Downloads the model group data from Xpanel to PLC.

RcpMemUp(“Model Name”)

Receives the data from PLC and saves it at the model group data in Xpanel.

RcpNewGroupName (“Model Name”, Group number, “New group name”)

Changes the recipe group name.

RcpSetSysMem(“Model Name”, System Memory Address)

Copies data in Xpanel memory and pastes it to the system memory.

RcpStop(“Model Name”)

Stops and terminates the Recipe.

RcpUpload(“Model Name”, Group Number)

Reads PLC data and saves it to the recipe file.

ReceiveByte(PortNo, Data)

Receives data with the selected port.

RemoveLastAlarms()

Remove contents except for current alarms from the alarm summary.

RemoveMessage(MessageID)

Removes the scroll message which is added by the AddMessage() function.

ResetTrend(“YT Trend Name”, Pen number)

Resets min/max values of the pen to the default value in the YT trend.

RunApp(“ProgramName”, “ProgramParameter”)

Executes the external program.

ScheduleConfig()

Displays the schedule list dialog box in the Xpanel runtime.

ScrCapture(“SeedName”, Location)

Saves the Xpanel screen in the BMP file.

SendByte(PortNo, Data)

Sends byte data with the selected port.

SendString(PortNo, Data)

Sends string data with the selected port.

SetDate(Year,Month,Date)

Changes the date of Xpanel.

SetScheduleState(Schedule Index, Active State)

Changes the active state of a certain schedule.

SetScheduleSysMem(Schedule Index, Starting Address of SYSTEM MEMORY)

Modifies the schedule directly without using the schedule setting window.

SetSpeed(Acc./Dec.)

Controls the processing time of the script module.

SetSysMem(System Memory Address, Set Value)

Sets the system memory value.

SetSysMemString(Target system memory offset, Source string tag, Number of word)

Converts the string value into ASCII code and stores it in the system memory.

SetTime(Hour, Minute, Second)

Changes the time of Xpanel.

SetTrendRatio(“YT Trend Name”, Pen number, Min value ratio to set, Max value ratio to set)

Changes min/max values ratio of the pen in the YT trend.

SetTrendZoom(“YT Trend Name”, Pen number, Min value to set, Max value to set)

Changes min/max values of the pen in the YT trend.

ShowAudioMixer()

Opens up a volume mixer in Windows touch PC.

ShowTouchKeyboard(X coordinate, Y coordinate, Pin/Unpin)

Opens up a touch keyboard in touch PC above Windows 8.1.

Sleep(Delay)

Delays the script program.

SoftKeyboard(Show/Hide, X Coordinate, Y Coordinate)

Opens or closes the virtual keyboard.

StaticBeepCtrl(ON/OFF)

Controls the Beep output (On/Off)

StringTable(Group Number, String Number)

Gets string data from the string table.

StrToNum(Target String, Numeral System)

Converts the string to the numeric value.

SysMemFill(System Memory Address, Data, Number of data)

Fills the block of system memory with the assigned value.

SysMemMove(Current Address, Target Address, Number of Data)

Moves the data block in the system memory.

TimeStr(Acquired Value, “Format”)

Generates the time-displaying string.

TouchCalib()

Brings up the touch calibration screen.

TrendCsvWr(“TrendName”, Location)

Saves the Trend in CSV format.

TrendGetPenVal(“YT Trend Name”, Pen number, Set value)

Returns set value from the min/max value of the pen in the YT trend.

WindowsExplorer(“Path”, “Extension”, X Coordinate, Y Coordinate)

Brings up the Windows Explorer at the assigned position.

XpanelReset()

Restarts the Xpanel Runtime.