Functions for Xpanel Device

Type

Format

Description

Subroutine

ExitXpanel()

Terminates Xpanel runtime.

Function

GetTime(Value Type)

Returns the current time value.

Subroutine

LcdBacklight(ON/OFF)

Turns the LCD backlight on or off.

Subroutine

LcdBrightDown()

Dims the LCD light.

Subroutine

LcdBrightUp()

Brightens the LCD light.

Subroutine

OpenConfigSub(Function)

Brings up the Xpanel Config. window or its subfeatures.

Subroutine

OpenConfigWin()

Brings up the Xpanel Config. window.

Subroutine

PlayWave(WavFileLocation, Path, Sync/Async)

Executes the WAV file in the assigned path.

Subroutine

SetDate(Year,Month,Date)

Changes the date on Xpanel.

Subroutine

SetTime(Hour,Minute,Second)

Changes the time on Xpanel.

Subroutine

ShowAudioMixer()

Opens up a volume mixer in Windows touch PC.

Subroutine

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

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

Subroutine

StaticBeepCtrl(ON/OFF)

Controls the Beep output (On/Off) on Xpanel.

Subroutine

TouchCalib()

Brings up the touch calibration screen.

Subroutine

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

Brings up the Windows Explorer at the assigned position.

Subroutine

XpanelReset()

Restarts the Xpanel Runtime.

ExitXpanel

Terminates Xpanel runtime.

Subroutine

ExitXpanel();

Description

Terminates Xpanel runtime.

Example

Xpanel runtime is terminated.

ExitXpanel();

GetTime

Returns the current time value.

Function

n=GetTime(Value Type)

Description

Assign the type of data to acquire to Value Type.

0: The number of seconds after 1st Jan 1970 UTC

1: 4-digit Year (e.g. 1970, 1932)

2: Month (1-12)

3: Date (1-31)

4: Hour (0-23)

5: Minute (0-59)

6: Second (0-59)

7: Day of the week (1-7, 1=SUN, 2=MON, … 7=SAT)

8: Today’s minute counter (minutes passed since midnight).

9: Today’s second counter (seconds passed since midnight).

Example

Stores the current year to the variable GetYear.

VAR GetYear;

GetYear = GetTime(1);

LcdBacklight

Turns on or off the LCD Backlight.

Subroutine

LcdBacklight(ON/OFF)

Description

Assign a value other than 0 to turn ON the LCD Backlight. To turn OFF the backlight, assign 0.

Example

Turns off the LCD backlight.

LcdBacklight(0);

LcdBrightDown

Dims the LCD light.

Subroutine

LcdBrightDown()

Description

Dims the LCD light by one step. There is a total of 32 steps. If the current level is the lowest level, then this function has no effect.

Example

Dims the LCD light.

LcdBrightDown();

LcdBrightUp

Brightens the LCD light.

Subroutine

LcdBrightUp()

Description

Brightens the LCD light by one step. There is a total of 32 steps. If the current level is the highest level, then this function has no effect.

Example

Brightens the LCD light.

LcdBrightUp();

OpenConfigSub

Brings up the Xpanel Configuration window or its subfeatures.

Subroutine

OpenConfigSub(Function)

Description

Brings up the Xpanel Configuration window or its subfeatures.

You can assign the values as shown below to the Function.

0: Xpanel Config.

1: System Log

2: Comm Monitor

3: Comm Config

4: Misc Config

5: Touch Calibrate

6: Screen Capture

7: Date/Time

8: SW Keyboard

9: Printer Setup

10: Modbus

11: Datalog Config

12: Module Version

Example

Brings up the Comm Monitor subfeature.

OpenConfigSub(2);

OpenConfigWin

Brings up the Xpanel Configuration window.

Subroutine

OpenConfigWin()

Description

Brings up the Xpanel Configuration window.

Example

Brings up the Xpanel Configuration window.

OpenConfigWin();

PlayWave

Executes the WAV file in the assigned path.

Subroutine

PlayWave(WavFileLocation, Path, Sync/Async)

Description

Executes the *.wav file from the Path in the WavFileLocation.

WavFileLocation can be expressed with the following strings:

0: _LOCAL_ (\\Xpanel\)

1: _SDMEM_ (SD Memory Root Path)

2: _USBMEM_ (USB Memory Root Path)

Path must include the file’s name and extension.

The third parameter, Sync/Async, determines whether to synchronize or desynchronize. [0: Sync, 1: Async]

If 0 is entered, the next script will not execute until the current WAV file is completed.

If 1 is entered, the next script will execute while the current WAV file is operating.

Exercise

Execute the ‘alarm.wav’ file in the sound folder of the Xpanel. The next script will not be executed until the audio file ends.

PlayWave(_LOCAL_, "sound/alarm.wav", 0);

SetDate

Changes the date on the Xpanel.

Subroutine

SetDate(Year,Month,Date)

Description

Changes the date on the Xpanel.

Year: Enter a 4-digit number.

Month: Enter the value between 1-12.

Date: Enter the value between 1-31 according to the month.

Example

Changes the date on the Xpanel to 2018/11/30.

SetDate(2018,11,30);

SetTime

Changes the time on the Xpanel.

Subroutine

SetTime(Hour,Minute,Second)

Description

Changes the time on the Xpanel.

Hour: Enter the value between 0-24.

Minute: Enter the value between 0-59.

Second: Enter the value between 0-59.

Example

Changes the time on the Xpanel to 18:15:30.

SetTime(18,15,30);

ShowAudioMixer

Opens up a volume mixer in Windows touch PC.

Subroutine

ShowAudioMixer()

Description

Opens up a volume mixer in Windows touch PC.

Example

An audio mixer shows up on the screen.

ShowAudioMixer();

ShowTouchKeyboard

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

Subroutine

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

Description

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

0: Unpin

1: Pin

Example

A touch keyboard shows up at (0,0) with pinned status.

ShowTouchKeyboard(0, 0, 1);

StaticBeepCtrl

Controls the Beep output (On/Off).

Subroutine

StaticBeepCtrl(ON/OFF)

Description

Controls the Beep output (On/Off). Assign 0 to turn off the beep sound. Other values will turn on the Beep.

Example

Turns on the Beep.

StaticBeepCtrl(1);

StaticBeepCtrl function only operates in the following models:

XT04CA, XT05SB, XT06CB, XT07CA, XT07CB

TouchCalib

Brings up the touch calibration screen.

Subroutine

TouchCalib()

Description

Brings up the touch panel calibration window. Follow the instructions on the window to calibrate.

You must restart the device to save the calibration.

Example

Brings up the touch panel calibration.

TouchCalib();

WindowsExplorer

Brings up the Windows Explorer at the assigned position.

Subroutine

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

Description

Brings up the Windows Explorer at the assigned position.

Displays all files that correspond to the “Extension” in the “Path.

The Windows Explorer will be opened at the X Coordinate, Y Coordinate.

When you enter “ ” to the “Extension”, the Explorer will display the entire file in the device.

To open the Explorer at the center of the screen assign -1 to X Coordinate and Y Coordinate.

If you double-click the folder type, the folder will be opened.

Example

Brings up Window Explorer which displays the CSV files, at the center of the screen.

WindowsExplorer(“\Xpanel”, “CSV”, -1, -1);

XpanelReset

Restarts the Xpanel Runtime.

Subroutine

XpanelReset()

Description

Restarts the Xpanel Runtime. The Xpanel will be booted after 5 seconds.

Example

Restarts the Xpanel Runtime.

XpanelReset();