Вы находитесь на странице: 1из 24

BX-IV Dynamic Library User Manual

Date: 2015-3-11
Version list:
Version

Date

Author

Comment, Description
Support the latest 5th generation products, and

15.03.11

2015-3-11

He

AX series products. Whats more, this version


does not

support

3rd and

4th generation

products.
13.11.06

2013-11-06

He

Add BX-5Q+ and BX-5QS+ series controllers

13.08.07

2013-08-07

Bai

Add Timer functions AddScreenProgramChroArea


AddScreenProgramChroAreaFile

13.05.18

2013-05-18

He

Re arrange the 3rd, 4th, and 5th generation DLL

BX102P002

Catalogue
BX-IV Dynamic Library User Manual................................................................................................... 0
Fast development guiding................................................................................................................... 2
Return to Status Code Definition.........................................................................................................2
Display Screen Initialization................................................................................................................ 3
Initialize screen parameters................................................................................................................ 3
AddScreen Function.....................................................................................................................3
DeleteScreen Function.................................................................................................................5
Send data to screen............................................................................................................................. 6
SendScreenInfo Function............................................................................................................. 6
SaveUSBScreenInfo Function.......................................................................................................7
Update program.................................................................................................................................. 7
AddScreenProgram Function.......................................................................................................8
AddScreenProgramBmpTextArea Function.................................................................................9
AddScreenProgramAreaBmpTextFile Function........................................................................... 9
AddScreenProgramTemperatureArea function........................................................................ 11
AddScreenProgramHumidityArea Function.............................................................................. 12
AddScreenProgramNoiseArea Function....................................................................................13
AddScreenProgramTimeArea function..................................................................................... 14
AddScreenProgramTimeAreaFile Function............................................................................... 15
AddScreenProgramClockArea function.....................................................................................16
AddScreenProgramClockAreaFile function............................................................................... 16
AddScreenProgramChroArea function..................................................................................... 18
AddScreenProgramChroAreaFile function................................................................................ 18
DeleteScreenProgram function................................................................................................. 20
DeleteScreenProgramArea function......................................................................................... 20
DeleteScreenProgramAreaBmpTextFile function......................................................................20
Other commands............................................................................................................................... 21
SetScreenTimerPowerONOFF function......................................................................................21
SetScreenAdjustLight function.................................................................................................. 21
Check the present display screen status........................................................................................... 22
GetScreenStatus function..........................................................................................................22
Attachment........................................................................................................................................ 22
Attachment 1.............................................................................................................................22

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-1-

BX102P002

Fast development guiding


If you want to develop a very simple control software quickly, you can read the protocol
according to the below:
1) Read Return to Status code definition, Display screen parameters initialization;
2) Add, Initialize display parameters, please read Initialization display screen
parameters;
3) If users want to send command to the screen, please read send data to the
screen command;
4) If users want to update the programs on the screen, please read update
programs;
5) If users want to control the Turn and Off function and brightness function on the
screen, please read other commands;
6) If users want to check the present screen status, please read check the present
screen status command;

Return to Status Code Definition


In DLL, every port parameter will return to parameter execute result at last, so, users can
check the execute status according to the execute result.
Parameter definition

Description

RETURN_ERROR_AERETYPE = 0xF7

Area type is wrong. If users get error when add


or delete Graphic&Text area, will return to
there.
Already has this screen information. If users
want to reset , please DeleteScreen delet this
screen first, and then, add new one.
Do not find out valid area file (Graphic&Text
area);
Do not find out valid display area; can use
AddScreenProgramBmpTextArea to add area
information.
Do not find out valid display area; can
useAddScreenProgramto add program.
Do not find this screen in the system; can use
AddScreen.
Its communicating now, please try again later.
Do not support USB mode
Do not find out usb route.
Other error.
No error.

RETURN_ERROR_RA_SCREENNO = 0xF8

RETURN_ERROR_NOFIND_AREAFILE = 0xF9
RETURN_ERROR_NOFIND_AREA = 0xFA

RETURN_ERROR_NOFIND_PROGRAM = 0xFB
RETURN_ERROR_NOFIND_SCREENNO = 0xFC
RETURN_ERROR_NOW_SENDING = 0xFD
RETURN_ERROR_NOSUPPORT_USB = 0xF6
RETURN_ERROR_NO_USB_DISK = 0xF5
RETURN_ERROR_OTHER = 0xFF
RETURN_NOERROR
=0

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-2-

BX102P002

Display Screen Initialization


Before connect to DLL, users need to set the control address, communication baud rate,
network IP(if theres Ethernet port), port address(if theres Ethernet port), scan mode, etc by our
LedshowTW2013; After finishing the settings, users can connect DLL and do settings.
Note: In present, only support fixed IP mode for Ethernet communication.

Initialize screen parameters


Before setting, cannot save the corresponding parameters to DLL by AddScreen. This
function doesnt do any communication to the screen, just for some settings.
If users want to delete some programs, just DeleteScreen. This function doesnt do any
communication to the screen, just for some settings.

AddScreen Function
function AddScreen(nControlType, nScreenNo, nWidth, nHeight, nScreenType, nPixelMode:
Integer;
nDataDA, nDataOE: Integer; nRowOrder, nFreqPar: Integer; pCom: PChar; nBaud:
Integer; pSocketIP: PChar;
nSocketPort: Integer; pWiFiIP: PChar; nWiFiPort: Integer;
pScreenStatusFile: PChar): integer;
Add screen information to DLL; This function doesnt do any communication to the screen, just
for some settings.
Parameters
Parameter

Description

nControlType

The controller model;


Controller_BX_5AT
= 0x0051
Controller_BX_5A0
= 0x0151
Controller_BX_5A1
= 0x0251
Controller_BX_5A2
= 0x0351
Controller_BX_5A3
= 0x0451
Controller_BX_5A4
= 0x0551
Controller_BX_5A1_WIFI = 0x0651
Controller_BX_5A2_WIFI = 0x0751
Controller_BX_5A4_WIFI = 0x0851
Controller_BX_5A
= 0x0951
Controller_BX_5A2_RF
= 0x1351
Controller_BX_5A4_RF
= 0x1551
Controller_BX_5AT_WIFI = 0x1651

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-3-

BX102P002

Controller_BX_5AL

= 0X1851

Controller_AX-AT
Controller_AX-A0

= 0x2051
= 0x2151

Controller_BX_5M1
Controller_BX_5M1X
Controller_BX_5M2
Controller_BX_5M3
Controller_BX_5M4

= 0x0052
= 0x0152
= 0x0252
= 0x0352
= 0x0452

Controller_BX_5E1
Controller_BX_5E2
Controller_BX_5E3

= 0x0154
= 0x0254
= 0x0354

Controller_BX_5UT
Controller_BX_5U0
Controller_BX_5U1
Controller_BX_5U2
Controller_BX_5U3
Controller_BX_5U4
Controller_BX_5U5
Controller_BX_5U
Controller_BX_5UL

= 0x0055
= 0x0155
= 0x0255
= 0x0355
= 0x0455
= 0x0555
= 0x0655
= 0x0755
= 0x0855

Controller_AX-UL
Controller_AX-UT
Controller_AX-U0
Controller_AX-U1
Controller_AX-U2

= 0x2055
= 0x2155
= 0x2255
= 0x2355
= 0x2455

Controller_BX_5Q0
Controller_BX_5Q1
Controller_BX_5Q2
Controller_BX_5Q0+
Controller_BX_5Q1+
Controller_BX_5Q2+
Controller_BX_5QL

= 0x0056
= 0x0156
= 0x0256
= 0x1056
= 0x1156
= 0x1256
= 0x1356

Controller_BX_5QS1
Controller_BX_5QS2
Controller_BX_5QS
Controller_BX_5QS1+

= 0x0157
= 0x0257
= 0x0357
= 0x1157

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-4-

BX102P002

nScreenNo
nWidth
nHeight
nScreenType

nPixelMode
nDataDA
nDataOE
nRowOrder
nFreqPar
pCom
nBaud
pSocketIP

nSocketPort
pWiFiIP
nWiFiPort
pScreenStatusFile

Controller_BX_5QS2+
= 0x1257
Controller_BX_5QS+
= 0x1357
Screen number; This parameter is the same with LedshowTW
2013.
Screen width is the times of 16; minimum is 64; BX-5E series is
80.
Screen height is the times of 16; minimum is 16;
Screen type;
1: Single color;
2: Double color;
3: Tri color; Note: Only supported by BX-4MC; and this type
does not support any other type screen.
4: Full color; Note: Only supported by BX-5Q series; and this
type does not support any other type screen.
5: Single and double color with gray scale; Note: Only
supported by BX-5QS series and this type does not support any
other type screen.
Color type; 1: R+G; 2:G+R; This parameter is valid to double
color, Default is 2;
Data polarity;, 0x00: Data polarity is low, 0x01: Data polarity is
high; Default is 0.
OE polarity; 0x00:OE low; 0x01: OE high; Default is 0;
Line mode; 0: normal; 1: add one line; 2: cut one line; Default is
0.
Screen; 0~6; Default is 0;
Serial port name; Its valid when its serialp ort communication;
Like: COM1
Serial baud rate: In present, support 9600, 57600; Default is
57600;
Control card IP address, its valid when its in network
communication; Like: 192.168.0.199; Only support fixed IP
mode.
Control card network port; its valid when its in network
communication mode; Like: 5005
The IP address information of WIFI mode; its valid when its in
wifi mode; Like: 192.168.100.1
WIFI port; its valid when its in wifi mode; Like: 5005
Used to save the checked screen status paraters which saved
INI file name; Its valid only do check GetScreenStatus.

Return parameter:
Check return to status code definition

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-5-

BX102P002

DeleteScreen Function
function DeleteScreen(nScreenNo: Integer): Integer; stdcall;
Delete the screen information. After deleting the screen, all the programs in this screen will
be deleted from the DLL. This function does not communicate with screen, only for parameters
setting.
Parameters

Description

nScreenNo

Screen number; This parameter is corresponding with the


parameter of nScreenNo.

Return parameter:
Check return to status code definition

Send data to screen


Whatever users send programs, or set screen parameters/ Turn on or off/Timing Power on
and off/ brightness, all need to set corresponding parameters first. Then, can use SendScreenInfo,
send to the screen according to the commands. If the control cards support USB downloading,
can use SaveUSBScreenInfo, save to USB disk first, then upload by USB port.

SendScreenInfo Function
function SendScreenInfo(nScreenNo, nSendMode, nSendCmd, nOtherParam1: Integer): Integer;
stdcall;
According to the comunication mode, send corresponding information/command to screen.
This function will communicate with screen
Parameters:
Parameters

Description

nScreenNo

Screen nuber; This parameter correspond with the


parameters of nScreenNo.
The communication mode with screen;
0: Serial port mode, BX-5A2&RF, BX-5A4&RF are wireless
mode
2: Ethernet port mode
4: Wifi mode
Communication Commands
SEND_CMD_PARAMETER =41471; Write screen parameter
SEND_CMD_SENDALLPROGRAM = 41456; Send all programs
SEND_CMD_POWERON =41727; Power off and off
SEND_CMD_POWEROFF = 41726; Power off and off
SEND_CMD_TIMERPOWERONOFF = 41725; Timing ON and
OFF
SEND_CMD_CANCEL_TIMERPOWERONOFF = 41724; Delete
Timing ON and OFF

nSendMode

nSendCmd

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-6-

BX102P002

nOtherParam1

SEND_CMD_RESIVETIME = 41723; Correction Time


SEND_CMD_ADJUSTLIGHT = 41722; Brightness adjustmnet
Reserve parameters; 0

Return parameter:
Check return to status code definition

SaveUSBScreenInfo Function
function SaveUSBScreenInfo(nScreenNo: Integer; bCorrectTime, nAdvanceHour, nAdvanceMinute:
Integer; pUSBDisk: PChar): Integer; stdcall;
Save programs to USB disk.
When users use this function, please note that the present controller support USB
downloading function.
Parameter

Description

nScreenNo

Screen number; This parameter corresponds with


the parameter of nScreenNo.
Correction time or not
0: Do not correct
1: Correct
Advance hour. Range from 0~23; Its valid when
bCorrectTime=1.
Advance minute. Range from 0~59; Its valid when
bCorrectTime=1.
The route name of USB; Format is ;\; Like: F:\

bCorrectTime

nAdvanceHour
nAdvanceMinute
pUSBDisk
Return parameter:
Check return to status code definition

Update program
Update the programs on screen. The DLL now supports graphic and text ( including subtile
area) area, Time area, Clock area, Temperature area, Humidity area, Noice area, etc. Users can
add the area and information according to their own needs.
Before adding program/ areas, need to AddScreen, then add according to the below steps,
lastly, send programs by SendScreenInfo or Save USBScreenInfo.
If users want to delete some programs, do DeleteScreenProgram. Meanwhile, all the
programs on this program will be deleted. If users need some area info, just do
DeleteScreenProgramArea.
If
users
need
to
delete
some
files,
just
do
DeleteScreenProgramAreaBmpTextFile. The aboved parameters do not do any communication,
just for some corresponding settings.

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-7-

BX102P002

AddScreenProgram Function
function AddScreenProgram(nScreenNo, nProgramType: Integer; nPlayLength: Integer;
nStartYear, nStartMonth, nStartDay, nEndYear, nEndMonth, nEndDay: Integer;
nMonPlay,
nTuesPlay, nWedPlay, nThursPlay, bFriPlay, nSatPlay, nSunPlay: integer;
nStartHour,
nStartMinute, nEndHour, nEndMinute: Integer): Integer; stdcall;
Add program on DLL; This function does not do communication, just for settings.
Parameter

Description

nScreenNo

Screen number; The parameter corresponds with


the parameter with nScreenNo.
Program type; 0 is normal.
0: play orderly; or means the time period of
program; From 1~65535; Unite is seconds
The period of program; Start year. If its unlimited,
will be 65535; like 2010
The period of program; Start month. like 11
The period of program; Start day. like 26
The period of program; End year. like 2011
The period of program; End month. like 11
The period of program; End day. like 26
Do you want to play the program on Monday on
the program period; 0: NO ; 1: YES
Do you want to play the program on Tuesday on
the program period; 0: NO ; 1: YES
Do you want to play the program on Wednseday
on the program period; 0: NO ; 1: YES
Do you want to play the program on Thursday on
the program period; 0: NO ; 1: YES

nProgramType
nPlayLength
nStartYear
nStartMonth
nStartDay
nEndYear
nEndMonth
nEndDay
nMonPlay
nTuesPlay
nWedPlay
nThursPlay

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-8-

BX102P002

bFriPlay
nSatPlay
nSunPlay
nStartHour
nStartMinute
nEndHour
nEndMinute

Do you want to play the program on Friday on the


program period; 0: NO ; 1: YES
Do you want to play the program on Saturday on
the program period; 0: NO ; 1: YES
Do you want to play the program on Sunday on the
program period; 0: NO ; 1: YES
Start hour from the day. Like 8
Start minute from the day. Like 0
End hour from the day. Like 18
End minute from te day. Like 0

Return parameter:
Check return to status code definition

AddScreenProgramBmpTextArea Function
function AddScreenProgramBmpTextArea(nScreenNo, nProgramOrd: Integer; nX, nY, nWidth,
nHeight: integer): Integer; stdcall;
Add Graphic&Text area on DLL; This function does not do communication, just for settings.
Parameter

Description

nScreenNo

Screen number; The parameter corresponds with


the parameter with nScreenNo.
Screen order; Start from 0, if users delete one
number from the middle, the below will be
modified automatically.
X-coordinate of area; The x-coordinate on the
left cornor is 0; The minimum is 0

nProgramOrd

nX
nY

Y-coordinate of area; The y-coordinate on the left


cornor is 0; The minimum is 0
Area width; The maximum cannot over the screen
width -nX
Area height; The maximum cannot over the screen
height -nY

nWidth
nHeight
Return parameter:
Check return to status code definition

AddScreenProgramAreaBmpTextFile Function
function AddScreenProgramAreaBmpTextFile(nScreenNo, nProgramOrd, nAreaOrd: Integer;
pFileName: PChar; nShowSingle: integer; pFontName: PChar; nFontSize, nBold, nFontColor:
Integer; nStunt, nRunSpeed, nShowTime: Integer): Integer; stdcall;
Add file to Graphic&Text area on DLL; This function does not do communication, just for
settings.

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

-9-

BX102P002

nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
Area number; Start from 0, if users delete one number from
the middle, the below will be modified automatically.
File name
Support .bmp,jpg,jpeg,rtf,txt etc.
Single line or multi line display; 1: single line display; 0: multi
line display; Its valid when its txt format on pFileName.
Font name; Support the present font library in the system;
Its valid when its txt format on pFileName.
Font size; Support the size in present system; Its valid when
its txt format on pFileName.
Font bold Support 1: bold; 0: normal; Its valid when its txt
format on pFileName.
Font color; Its valid when its txt format on pFileName. Red
255; Green 65280; Yellow 65535
Display mode
0x00: Random
0x01: Static
0x02: Direct show
0x03: Move left
0x04: Continuously move left
0x05: move up
3T cards do not support it
0x06: Continuously move up
3T cards do not
support it
0x07: Flicker
3T cards do not support it
0x08: Snowing
0x09: Bubbling
0x0A: Middle out
0x0B: Moved around
0x0C: Horizontal cross move
0x0D: Vertical cross move
0x0E: Scroll closed
0x0F: Scroll opened
0x10: Left Stretch
0x11: Right Stretch
0x12: Up Stretch
0x13: Down Stretch
3T cards do not support it
0x14: Left Laser
0x15: Right Laser
0x16: Up Laser
0x17: Down Laser

nAreaOrd
pFileName
nShowSingle
pFontName
nFontSize
nBold
nFontColor
nStunt

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 10 -

BX102P002

0x18: Cross curtain left and right


0x19: Cross curtain up and down
0x1A: Curtain scattered to the left
0x1B: Horizontal blinds
3T3A4A3A13A2
4A14A24A34AQ cards do not support it
0x1C: Vertical blinds
3T3A4A3A13A24A1
4A24A34AQ3M4M4M14MCcards do not support
it
0x1D: Curtain left
0x1E: Curtain right
it

nRunSpeed
nShowTime

3T3A4A cards do not support it


3T3A4A cards do not support

0x1F: Curtain up
3T3A4A cards do not support it
0x20: Curtain down
3T3A4A cards do not support
it
0x21: Move to center from left to right
3T cards do
not support it
0x22: Split to left and right
3T cards do not support
it
0x23: Move to center from up and down
3T cards do
not support it
0x24: Splite to up and down
3T cards do not support
it
0x25: Move right
0x26: Continuously move right
0x27: Move down
3T cards do not support it
0x28: Continuously move down
3T cards do not
support it
Run speed; 0~63;It will be slower if the value is bigger.
Show time; 0-65525; Unit is 0.5 seconds

Return parameter:
Check return to status code definition

AddScreenProgramTemperatureArea function
function AddScreenProgramTemperatureArea(nScreenNo, nProgramOrd: Integer;
nX, nY,
nWidth, nHeight: integer;
nSensorType,
nTemperatureUnit,
nTemperatureMode,
nTemperatureUnitScale,
nTemperatureValueWidth,
nTemperatureCorrectionPol,
nTemperatureCondition, nTemperatureThreshPol, nTemperatureThresh, nTemperatureColor,
nTemperatureErrColor: Integer; pStaticText, pStaticFont: pChar; nStaticSize, nStaticColor,
nStaticBold: Integer): Integer; stdcall;
Add Temperature area on DLL; This function does not do communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 11 -

BX102P002

nProgramOrd
nX
nY
nWidth
nHeight
nSensorType

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
X-coordinate of area; The x-coordinate on the left cornor is
0; The minimum is 0
Y-coordinate of area; The y-coordinate on the left cornor is
0; The minimum is 0
Area width; The maximum cannot over the screen width -nX
Area height; The maximum cannot over the screen height
-nX
Temperature sensor type;
0:"Temp sensor S-T1";
1:"Temp and hum sensor S-RHT 1";
2:"Temp and hum sensor S-RHT 2"

nTemperatureUnit
nTemperatureMode

The unit of Temperature; 0: ; 1: ; 2: NO


The mode of temperature; 0: Integer ; 1: Decimals

nTemperatureMode:
nTemperatureUnitScale

The mode of temperature; 0: Integer ; 1: Decimals


The unit display proportion of temperature; 50~100; Default
is 100.
Temperature value display width;
Temperature error correction; 0; positive; 1: negtive
Temperature condition
Temperature threshold value; 0: less than; 1: move than
Temperature thresh
Normal temperature color
The color when temperature is over thresholdvalue
Static text before temperature area; Its can be empty
Font name; Support the font library on the present system
Static size
Static color
Static bold

nTemperatureValueWidth
nTemperatureCorrectionPol
nTemperatureCondition
nTemperatureThreshPol
nTemperatureThresh
nTemperatureColor
nTemperatureErrColor
pStaticText
pStaticFont
nStaticSize
nStaticColor
nStaticBold

Return parameter:
Check return to status code definition

AddScreenProgramHumidityArea Function
function AddScreenProgramHumidityArea(nScreenNo, nProgramOrd: Integer; nX, nY, nWidth,
nHeight: integer; nSensorType, nHumidityUnit, nHumidityMode, nHumidityUnitScale,
nHumidityValueWidth, nHumidityConditionPol, nHumidityCondition, nHumidityThreshPol,
nHumidityThresh, nHumidityColor, nHumidityErrColor: Integer; pStaticText, pStaticFont:
pChar; nStaticSize, nStaticColor, nStaticBold: Integer): Integer; stdcall;
Add Humidity area on DLL; This function does not do communication, just for settings.
Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 12 -

BX102P002

nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
X-coordinate of area; The x-coordinate on the left cornor is
0; The minimum is 0
Y-coordinate of area; The y-coordinate on the left cornor is
0; The minimum is 0
Area width; The maximum cannot over the screen width -nX
Area height; The maximum cannot over the screen height
-nX
Humidity sensor type;
0:"Temp and hum sensor S-RHT 1";
1:"Temp and hum sensor S-RHT 2"
The unit of Humidity; 0: %RH ; 1: NO
The mode of Humidity; 0: Integer ; 1: Decimals
The unit display proportion of Humidity; 50~100; Default is
100.
Humidity value display width;
Humidity error correction; 0; positive; 1: negtive
Humidity condition
Humidity threshold value; 0: less than; 1: move than
Humidty threshold
Normal Humidty color
The color when Humidity is over thresholdvalue
Static text before humidity area; Its can be empty
Font name; Support the font library on the present system
Static size; Support the size on the present system
Static color
Static bold; Support 1: bold; 0: normal

nX
nY
nWidth
nHeight
nSensorType

nHumidityUnit
nHumidityMode
nHumidityUnitScale
nHumidityValueWidth
nHumidityConditionPol
nHumidityCondition
nHumidityThreshPol
nHumidityThresh
nHumidityColor
nHumidityErrColor
pStaticText
pStaticFont
nStaticSize
nStaticColor
nStaticBold

Return parameter:
Check return to status code definition

AddScreenProgramNoiseArea Function
function AddScreenProgramNoiseArea(nScreenNo, nProgramOrd: Integer;
nX, nY, nWidth,
nHeight: integer;
nSensorType,
nNoiseUnit,
nNoiseMode,
nNoiseUnitScale,
nNoiseValueWidth,
nNoiseConditionPol,
nNoiseCondition,
nNoiseThreshPol,
nNoiseThresh,
nNoiseColor, nNoiseErrColor: Integer;
pStaticText, pStaticFont: pChar;
nStaticSize, nStaticColor, nStaticBold: Integer): Integer; stdcall;
Add voice sensor area on DLL; This function does not do communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 13 -

BX102P002

nProgramOrd
nX
nY
nWidth
nHeight
nSensorType

nNoiseUnit
nNoiseMode
nNoiseUnitScale
nNoiseValueWidth
nNoiseConditionPol
nNoiseCondition
nNoiseThreshPol
nNoiseThresh
nNoiseColor
nNoiseErrColor
pStaticText
pStaticFont
nStaticSize
nStaticColor
nStaticBold

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
X-coordinate of area; The x-coordinate on the left cornor is
0; The minimum is 0
Y-coordinate of area; The y-coordinate on the left cornor is
0; The minimum is 0
Area width; The maximum cannot over the screen width -nX
Area height; The maximum cannot over the screen height
-nX
Voice sensor type;
0:"I-";
1:"II-"
The unit of Voice;
The mode of voice; 0: Integer ; 1: Decimals
The unit display proportion of voice; 50~100; Default is 100.
Voice value display width;
Voice error correction; 0; positive; 1: negtive
Voice condition
Voice threshold value; 0: less than; 1: move than
Voice threshold
Normal Voice color
The color when Voice is over thresholdvalue
Static text before Voice area; Its can be empty
Font name; Support the font library on the present system
Static size; Support the size on the present system
Static color
Static bold; Support 1: bold; 0: normal

Return parameter:
Check return to status code definition

AddScreenProgramTimeArea function
function AddScreenProgramTimeArea(nScreenNo, nProgramOrd: Integer;
nX, nY, nWidth,
nHeight: integer): Integer; stdcall;
Add time area on DLL; This function does not do communication, just for settings.
Parameter

Description

nScreenNo

Screen number; The parameter corresponds with


the parameter with nScreenNo.
Program order; Start from 0, if users delete one
number from the middle, the below will be
modified automatically.
X-coordinate of area; The x-coordinate on the left
cornor is 0; The minimum is 0

nProgramOrd

nX

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 14 -

BX102P002

nY

Y-coordinate of area; The y-coordinate on the left


cornor is 0; The minimum is 0
Area width; The maximum cannot over the screen
width -nX
Area height; The maximum cannot over the screen
height -nX

nWidth
nHeight
Return parameter:
Check return to status code definition

AddScreenProgramTimeAreaFile Function
function AddScreenProgramTimeAreaFile(nScreenNo, nProgramOrd, nAreaOrd: Integer;
pInputtxt, pFontName: PChar; nSingal, nAlign, nFontSize, nBold, nItalic, nUnderline: Integer;
nUsetxt, nTxtcolor, nUseymd, nYmdstyle, nYmdcolor, nUseweek, nWeekstyle, nWeekcolor,
nUsehns, nHnsstyle, nHnscolor, nAutoset: Integer): Integer; stdcall;
Attributes of time area; This function does not do communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
Area order; Start from 0, if users delete one number from
the middle, the below will be modified automatically.
Fixed text
Font of text
Single or multi lines, 0 is single line; 1 is multi lines; nAlign
is not valid when its in single line
Align mode, its valid when its in multi lines; 0 is left, 1 is
middle, 2 is right
Font size
Bold or not, 0 is no, 1 is yes
Italic or not, 0 is no, 1 is yes
Underline or not, 0 is no, 1 is yes
Use fixed text or not, 0 is no, 1 is yes
Color of fixed text, RED 255, Green 65280, Yellow 65535
Use year, month, day or not, 0 is no, 1 is yes
Format of year, month and day, check attachment 1
Color of year , month, and day
Use week or not, 0 is no, 1 is yes
Format of week, check attachment 1
Color of week
Use Hour, minute and seconds or not, 0 is no, 1 is yes
Format of hour, minute and seconds, check attachment 1
Color of hour, minute and seconds

nAreaOrd
pInputtxt
pFontName
nSingal
nAlign
nFontSize
nBold
nItalic
nUnderline
nUsetxt
nTxtcolor
nUseymd
nYmdstyle
nYmdcolor
nUseweek
nWeekstyle
nWeekcolor
nUsehns
nHnsstyle
nHnscolor

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 15 -

BX102P002

nAutoset

Set automatically width or not, 0 is no, 1 is yes (Defult is no)

Return parameter:
Check return to status code definition

AddScreenProgramClockArea function
function AddScreenProgramClockArea(nScreenNo, nProgramOrd: Integer;
nX, nY, nWidth,
nHeight: integer): Integer; stdcall;
Add clock area on DLL; This function does not do communication, just for settings.
Parameter

Description

nScreenNo

Screen number; The parameter corresponds with


the parameter with nScreenNo.
Program order; Start from 0, if users delete one
number from the middle, the below will be
modified automatically.
X-coordinate of area; The x-coordinate on the left
cornor is 0; The minimum is 0
Y-coordinate of area; The y-coordinate on the left
cornor is 0; The minimum is 0
Area width; The maximum cannot over the screen
width -nX
Area height; The maximum cannot over the screen
height -nX

nProgramOrd

nX
nY
nWidth
nHeight
Return parameter:
Check return to status code definition

AddScreenProgramClockAreaFile function
function AddScreenProgramClockAreaFile(nScreenNo, nProgramOrd, nAreaOrd: Integer;
nusetxt, nusetime, nuseweek, ntimeStyle, nWeekStyle, ntxtfontsize, ntxtfontcolor, ntxtbold,
ntxtitalic, ntxtunderline, txtleft, txttop, ntimefontsize, ntimefontcolor, ntimebold, ntimeitalic,
ntimeunderline, timeleft, timetop,nweekfontsize, nweekfontcolor, nweekbold, nweekitalic,
nweekunderline, weekleft, weektop, nclockfontsize, nclockfontcolor, nclockbold, nclockitalic,
nclockunderline,
clockcentersize, clockcentercolor, mhrdotstyle, mhrdotsize, mhrdotcolor,
hrdotstyle, hrdotsize, hrdotcolor, mindotstyle, mindotsize, mindotcolor,hrhandsize, hrhandcolor,
minhandsize, minhandcolor, sechandsize, sechandcolor, nAutoset: integer;btxtcontent,
btxtfontname, btimefontname, bweekfontname, bclockfontname: pchar): Integer; stdcall;
Attributes of clock area; This function does not do communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
Area order; Start from 0, if users delete one number from

nAreaOrd

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 16 -

BX102P002

nusetxt
nusetime
nuseweek
ntimeStyle
nWeekStyle
ntxtfontsize
ntxtfontcolor
ntxtbold
ntxtitalic
ntxtunderline
txtleft
txttop
ntimefontsize
ntimefontcolor
ntimebold
ntimeitalic
ntimeunderline
timeleft
timetop
nweekfontsize
nweekfontcolor
nweekbold
nweekitalic
nweekunderline
weekleft
weektop
nclockfontsize
nclockfontcolor
nclockbold
nclockitalic
nclockunderline
clockcentercolor
mhrdotstyle
mhrdotsize
mhrdotcolor
hrdotstyle
hrdotsize
hrdotcolor
mindotstyle
mindotsize

the middle, the below will be modified automatically.


Used fixed text or not, 0 is no, 1 is yes
Used year , month, day or not, 0 is no, 1 is yes
Use week or not 0 is no, 1 is yes
Year, month and day format
Week format
Size of fixed text
Color of fixed text, RED 255, Green 65280, Yellow 65535
Bold or not, 0 is no, 1 is yes
Italic or not, 0 is no, 1 is yes
Underline or not, 0 is no, 1 is yes
The X coordinate of fixed text on clock
The Y coordinate of fixed text on clock
The size of year, month, day font
The color of year, month and day
Bold for year, month day or not, 0 is no, 1 is yes
Italic for year, month day or not, 0 is no, 1 is yes
Underline for year, month day or not, 0 is no, 1 is yes
The X coordinate of year, month and day on clock
The Y coordinate of year, month and day on clock
Font size of week
Font color of week
Bold for week or not, 0 is no, 1 is yes
Italic for week or not, 0 is no, 1 is yes
Underline for week or not, 0 is no, 1 is yes
The X coordinate of week on clock
The Y coordinate of week on clock
Font size of clock
Font color of clock
Bold for clock or not, 0 is no, 1 is yes
Italic for clock or not, 0 is no, 1 is yes
Underline for clock or not, 0 is no, 1 is yes
Center color on clock
3/6/9 dot style 0 linear, 1 round, 2 square, 3 number, 4
Rome
3/6/9 dot size 0-8
3/6/9 dot color
Dot style except 3/6/9
0 linear, 1 round, 2 square, 3
number, 4 Rome
Dot size except 3/6/9 0-8
Dot color except 3/6/9
Minute dot style
0 linear, 1 round, 2 square
Minute dot size 0-1

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 17 -

BX102P002

mindotcolor
hrhandsize
hrhandcolor
minhandsize
minhandcolor
sechandsize
sechandcolor
nAutoset

btxtcontent
btxtfontname
btimefontname
bweekfontname
bclockfontname

Minute dot color


Hour hands size 0-8
Hour hands color
Minutes hands size
Minutes hands color
Seconds hand 0-8
Seconds hands color
Auto-fit, o is no, 1 is yes; If its 1, then, users need to set
coordinate
value
in
txtleft/txttop/
weekleft/weektop/timeleft/timetop
Fixed text info
Fixed text font
Time font
Week font
Clock font

Return parameter:
Check return to status code definition

AddScreenProgramChroArea function
function AddScreenProgramChroArea(nScreenNo, nProgramOrd: Integer;
nX, nY, nWidth,
nHeight: integer): Integer; stdcall;
Add Timer area on DLL; This function does not do communication, just for settings.
Parameter

Description

nScreenNo

Screen number; The parameter corresponds with


the parameter with nScreenNo.
Program order; Start from 0, if users delete one
number from the middle, the below will be
modified automatically.
X-coordinate of area; The x-coordinate on the left
cornor is 0; The minimum is 0
Y-coordinate of area; The y-coordinate on the left
cornor is 0; The minimum is 0
Area width; The maximum cannot over the screen
width -nX
Area height; The maximum cannot over the screen
height -nX

nProgramOrd

nX
nY
nWidth
nHeight
Return parameter:
Check return to status code definition

AddScreenProgramChroAreaFile function
function AddScreenProgramChroAreaFile(nScreenNo, nProgramOrd, nAreaOrd: Integer;
pInputtxt, pDaystr, pHourstr, pMinstr, pSecstr, pFontName: PChar;nSingal, nAlign, nFontSize,
Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 18 -

BX102P002

nBold, nItalic, nUnderline,nTxtcolor, nFontcolor,nShowstr, nShowAdd, nUseTxt, nUseDay,


nUseHour, nUseMin, nUseSec,nDayLength, nHourLength, nMinLength, nSecLength,EndYear,
EndMonth, EndDay, EndHour, EndMin, EndSec,nAutoset: Integer): Integer; stdcall;
Attributes of clock area; This function does not do communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the parameter


with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number from the
middle, the below will be modified automatically.
Area order; Start from 0, if users delete one number from the
middle, the below will be modified automatically.
Fixed text info
Day uni
Hour unit
Minute unit
Seconds unit
Timer font
Single or multi lines, 0 is single line; 1 is multi lines; nAlign is
not valid when its in single line
Align mode, its valid when its in multi lines; 0 is left, 1 is middle,
2 is right
Font size
Bold or not, 0 is no, 1 is yes
Italic or not, 0 is no, 1 is yes
Underline or not, 0 is no, 1 is yes
Fixed text color
Timer text color
Show Timer unit or not
Show accumulation or not
Use fixed text or not ; 0 is no, 1 is yes
Use day or not, 0 is no, 1 is yes
Use hour or not, 0 is no, 1 is yes
Use minute or not, 0 is no, 1 is yes
Use seconds or not, 0 is no, 1 is yes
Display width used by day 0 is automatic
Display width used by hour 0 is automatic
Display width used by minute 0 is automatic
Display width used by seconds 0 is automatic
End Year
End Month
End Day
End Hour
End Min
End Sec

nAreaOrd
pInputtxt
pDaystr
pHourstr
pMinstr
pSecstr
pFontName
nSingal
nAlign
nFontSize
nBold
nItalic
nUnderline
nTxtcolor
nFontcolor
nShowstr
nShowAdd
nUseTxt
nUseDay
nUseHour
nUseMin
nUseSec
nDayLength
nHourLength
nMinLength
nSecLength
EndYear
EndMonth
EndDay
EndHour
EndMin
EndSec

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 19 -

BX102P002

nAutoset

Auto-fit, 0 is no, 1 is yes; If its 1, then users need to set


coordinate
value
by
themselves
in
txtleft/txttop/
weekleft/weektop/timeleft/timetop

Return parameter:
Check return to status code definition

DeleteScreenProgram function
function DeleteScreenProgram(nScreenNo, nProgramOrd: Integer): Integer; stdcall;
Delete program, all informations in this program will be deleted too. This function does not
do communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.

Return parameter:
Check return to status code definition

DeleteScreenProgramArea function
function DeleteScreenProgramArea(nScreenNo, nProgramOrd, nAreaOrd: Integer): Integer;
stdcall;
Delete area, all informations in this area will be deleted too. This function does not do
communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
Area order; Start from 0, if users delete one number from
the middle, the below will be modified automatically.

nAreaOrd

Return parameter:
Check return to status code definition

DeleteScreenProgramAreaBmpTextFile function
function DeleteScreenProgramAreaBmpTextFile(nScreenNo, nProgramOrd, nAreaOrd, nFileOrd:
Integer): Integer; stdcall;
Delete file, all informations in this file will be deleted too. This function does not do
communication, just for settings.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nProgramOrd

Program order; Start from 0, if users delete one number


from the middle, the below will be modified automatically.
Area order; Start from 0, if users delete one number from

nAreaOrd

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 20 -

BX102P002

the middle, the below will be modified automatically.


Screen number; The parameter corresponds with the
parameter with nScreenNo.

nFileOrd

Return parameter:
Check return to status code definition

Other commands
Before set timer power on and off, brightness adjustment, need to use
SetScreenTimerPowerONOFF, SetScreenAdjustLight, then, use SendScreenInfo as to send
command.

SetScreenTimerPowerONOFF function
function SetScreenTimerPowerONOFF(nScreenNo: Integer;
nOnHour1, nOnMinute1,
nOffHour1, nOffMinute1,
nOnHour2, nOnMinute2, nOffHour2, nOffMinute2,
nOnHour3,
nOnMinute3, nOffHour3, nOffMinute3: Integer): Integer; stdcall;
Users can set 3 nos power on and off time. This function is not for communication, only for
settings on DLL. Use SendScreenInfo to send commands.
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nOnHour1
nOnMinute1
nOffHour1
nOffMinute1
nOnHour2
nOnMinute2
nOffHour2
nOffMinute2
nOnHour3
nOnMinute3
nOffHour3
nOffMinute3

The first nos hour for power on


The first nos minute for powe on
The first nos hour for power off
The first nos minute for powe off
The second nos hour for power on
The second nos minute for powe on
The second nos hour for power off
The second nos minute for powe off
The third nos hour for power on
The third nos minute for powe on
The third nos hour for power off
The third nos minute for powe off

Return parameter:
Check return to status code definition

SetScreenAdjustLight function
function SetScreenAdjustLight(nScreenNo: Integer; nAdjustType, nHandleLight: Integer; nHour1,
nMinute1, nLight1,
nHour2, nMinute2, nLight2,
nHour3, nMinute3, nLight3,
nHour4,
nMinute4, nLight4: Integer): Integer; stdcall;
Set parameters of brightness adjustment, manual and timer mode.This function is not for
Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 21 -

BX102P002

communication, only for settings on DLL. Use SendScreenInfo to send commands.


nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nAdjustType
nHandleLight

Adjust type; 0: manual; 1: timer


The brightness value for manual adjustment; Its valid when
nAdjustType=0
The first nos hour for timer adjustment
The first nos minute for timer adjustment
The first nos brightness value for timer adjustment
The second nos hour for timer adjustment
The second nos minute for timer adjustment
The second nos brightness value for timer adjustment
The third nos hour for timer adjustment
The third nos minute for timer adjustment
The third nos brightness value for timer adjustment
The fourth nos hour for timer adjustment
The fourth nos minute for timer adjustment
The fourth nos brightness value for timer adjustment

nHour1
nMinute1
nLight1
nHour2
nMinute2
nLight2
nHour3
nMinute3
nLight3
nHour4
nMinute4
nLight4

Return parameter:
Check return to status code definition

Check the present display screen status


GetScreenStatus function
function GetScreenStatus(nScreenNo, nSendMode: Integer): Integer; stdcall;
Check the present screen status, save the checking result to INI format file of pScreenStatusFile
on AddScreen. This function can get communication with screen
nScreenNo

Screen number; The parameter corresponds with the


parameter with nScreenNo.

nSendMode

Communication mode with screen;


0: serial port, BX-5A2&RF, BX-5A4&RF is RF serial port
wireless mode
2: Ethernet port mode
4: WiFi mode

Return parameter:
Check return to status code definition

Attachment
Attachment 1
Time format
Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 22 -

BX102P002

format

Description

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14

2000 12 30
00 12 30
12/30/2000
2000/12/30
00-12-30
00.12.30
12 30
12.30.2000
2000-12-30
30 12 2000
30:12:2000
30:12:00
2000
12
30

Week mode
format

Description

0
1
2

Monday
Mon

Hour, minute, second mode


format

Description

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

20 59 59
20:59:59
20 59 59
8 59 59
20 59
20:59

AM
20()
59()
59()
8:59
AM 8:59
8:59 AM
AM 8 59
8 59 AM
8:59

Shanghai ONBON Software Technology Co.,ltd | BX-IV Dynamic Library User Manual

- 23 -