ICP DAS USA LinPAC-22 Series User manual

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 1
L
Li in nP PA AC C- -2 22 2x xx x/ /5 52 2x xx x
S
Se er ri ie es s
X
XV V- -B Bo oa ar rd d
A
AP PI I
U
Us se er r
M
Ma an nu ua al l
V1.0.0 Apr 2019
Warranty
AllproductsmanufacturedbyICPDASarewarrantedagainstdefectivematerialsfora
periodofoneyearfromthedateofdeliverytotheoriginalpurchaser.

Warning
ICPDASassumenoliabilityfordamagesconsequenttotheuseofthisproduct.ICPDAS
reservestherighttochangethismanualatanytimewithoutnotice.Theinformation
furnishedbyICPDASisbelievedtobeaccurateandreliable.However,noresponsibilityis
assumedbyICPDASforitsuse,norforanyinfringementsofpatentsorotherrightsof
thirdpartiesresultingfromitsuse.

Copyright
Copyright©2019byICPDASCo.,Ltd.Allrightsarereserved.

Trademarks
Namesareusedforidentificationpurposesonlyandmayberegisteredtrademarksof
theirrespectivecompanies.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 2
Table of Contents
1.Introduction.....................................................................................................3
1.1. What is the I/O Expansion Bus? ...........................................................................................3
1.2. Demo program...........................................................................................................................3
1.3. Specifications ............................................................................................................................4
2.XV-Board API functions .................................................................................5
2.1. modbusRequest........................................................................................................................5
2.2. modbusRequestXV...................................................................................................................8
2.3. getXVBitBack ...........................................................................................................................11
2.4. getXVBit.....................................................................................................................................13
2.5. getXVRegBack.........................................................................................................................15
2.6. getXVReg...................................................................................................................................17
2.7. setXVBit.....................................................................................................................................19
2.8. setXVReg...................................................................................................................................21
3.Error Codes...................................................................................................23
4.Demo for XV-Boards.....................................................................................24
4.1. AI/O, DI/O Expansion Boards...............................................................................................24
4.1.1. AIO.....................................................................................................................................24
4.1.2. DIO.....................................................................................................................................27
Appendix .............................................................................................................31
A. Revision History.........................................................................................................................31


ICPDAS
LinPAC-52xx Series XV-Board API User Manual 3
1. Introduction
This manual is intended to be used as a reference for users who need to use API functions to
communicate with XV-Boards inserted into an LP-22xx/52xx series controller via the Modbus
protocol.
1.1. What is the I/O Expansion Bus?
The LinPAC-22xx/52xx series provides an I/O expansion bus which can be used to implement
various I/O functions, such as D/I, D/O, A/I, A/O, A/D, D/A, Timer/Counter, and other I/O
functions.
However, only one XV-Board can be inserted into each PAC at a time. For more information
related to the XV-Board series, refer to:
http://www.icpdas.com/root/product/solutions/hmi_touch_monitor/touchpad/xv-board_selection.html
1.2. Demo programs
ICP DAS provides a range of demo programs that can be used to implement a variety of
functions on the LP-22xx/52xx controller. To utilize these demo programs, transfer the files to the
LP-22xx/52xx controller from the LinPAC AM335X SDK.
The demo programs can be found in either the
C:\cygwin\LinPAC_AM335x_SDK\examples\xvboard\ or the
root@LinuxPC-ICPDAS:/icpdas/linpac_am335x_sdk/i8k/examples/xvboard/ folder.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 4
1.3. Specifications
For more detailed specifications related to specific XV-Boards and the Modbus register table,
refer to:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-board_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 5
2. XV-Board API functions
The following is an overview of the API functions used by the LP-22xx/52xx series controller that
contains an XV-Board.
2.1. modbusRequest
Description:
This function is used to send a Modbus protocol request.
Syntax:
[ C ]
int modbusRequest(char cPort, char cNetID, char cFunction, WORD wAddr,
WORD wCount, char szBuf, WORD wBufLen, WORD wTimeout, WORD *wT)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
cNetID: [Input] The NetID for the device.
The default slave address for the XV-Board is '1'.
cFunction: [Input] The Modbus RTU protocol function code.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Input/Output] Used to set or read back the value from a function code.
wBufLen: [Input] The length of the szBuf[ ].
wTimeout: [Input] The Timeout setting. The normal value is 100 milliseconds.
*wT: [Output] The total duration of the send/receive interval. Unit=1 ms.
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 6
Example:
int RetValue, timeout=100, count=1, netid=1;
int comport=COM1; /* Refer to [Remark 1] */
int function=1; /* Refer to [Remark 2] */
int addr=33; /* Refer to [Remark 3] */
char szBuf[80];
DWORD baudrate=115200;
WORD wT;
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue > 0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
RetValue=modbusRequest(comport, netid, function, addr, count, szBuf, sizeof(szBuf),
timeout, &wT);
Close_Com(comport);
if (RetValue==0) {
if((function==1)||(function==2))
printf("%d", szBuf[0]);
else {
RetValue=(szBuf[0]<<8)|szBuf[1];
printf("%ld", RetValue);
}
}

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 7
Remarks:
[1] Refer to the communication port number in the table below when sending the Modbus
protocol request.
'cPort’ parameter for the XV-Board module: 1=COM1=/dev/ttyO1.
'cPort' parameter for the RS-485 serial port: 2=COM2=/dev/ttyO2, 5=COM5=/dev/ttyO5.
Note: Remote I/O modules can be remotely controlled through an RS-485 serial bus. Refer
to Chapter 4.1.2: “DIO” for details of demonstration details.
Device Name Definition in the
LP-22xx/52xx SDK Description Default Baud Rate
- /dev/ttyO1 or COM1 Used for internal communication with the
XV-Board 115200
- Console port RS-232 (RxD, TxD and GND); Non-isolated 115200
ttyO4 /dev/ttyO4 or COM4 RS-232 (RxD, TxD and GND); Non-isolated 9600
ttyO2 /dev/ttyO2 or COM2 RS-485 (Data+, Data-); Non-isolated 9600
ttyO5 /dev/ttyO5 or COM5 RS-485 (Data+, Data-); 2500 VDC isolated 9600
[2] Modbus RTU protocol function codes.
Function Code Description Input
01 Reads the status of the Digital Output 1
02 Reads the status of the Digital Input 2
03 Reads the Analog Output channels 3
04 Reads the Analog Input channels 4
05 Writes to a single Digital Output channel 5
06 Writes to a singleAnalog Output channel 6
15 Writes to multiple Digital Output channels 15
16 Writes to multiple Analog Output channels 16
[3] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 8
2.2. modbusRequestXV
Description:
This function is used to send a Modbus protocol request in an LP-22xx/52xx system.
Syntax:
[ C ]
int modbusRequestXV(char cPort, char cFunction, WORD wAddr, WORD wCount,
char szBuf, WORD wBufLen)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
cFunction: [Input] The Modbus RTU protocol function code.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Input/Output] Used to set or read back the value from a function code.
wBufLen: [Input] The length of the szBuf[ ].
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 9
Example:
int RetValue, count=1;
int comport=COM1; /* Refer to [Remark 1] */
int function=1; /* Refer to [Remark 2] */
int addr=33; /* Refer to [Remark 3] */
char szBuf[80];
DWORD baudrate=115200;
WORD wValue;
switch(function) {
case FC05ForceSingleCoil:
case FC15ForceMultipleCoil:
szBuf[0]=wValue & 0xff;
break;
case FC06PresetSingleRegister:
case FC16PresetMultipleRegister:
szBuf[0]=(wValue >> 8) & 0xff;
szBuf[1]=wValue & 0xff;
break;
default:
return FAILURE;
}
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue >0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
RetValue=modbusRequest(comport, netid, function, addr, count, szBuf, sizeof(szBuf),
timeout, &wT);
Close_Com(comport);

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 10
Remarks:
[1] Refer to the communication port number in the table below to send the Modbus protocol
request.
'cPort’ parameter for the XV-Board module: 1=COM1=/dev/ttyO1.
'cPort' parameter for the RS-485 serial port: 2=COM2=/dev/ttyO2, 5=COM5=/dev/ttyO5.
Note: Remote I/O modules can be remotely controlled through an RS-485 serial bus. Refer
to Chapter 4.1.2: “DIO” for details of demonstration details.
Device Name Definition in the
LP-22xx/52xx SDK Description Default Baud Rate
- /dev/ttyO1 or COM1 Used for internal communication with the
XV-Board 115200
- Console port RS-232 (RxD, TxD and GND); Non-isolated 115200
ttyO4 /dev/ttyO4 or COM4 RS-232 (RxD, TxD and GND); Non-isolated 9600
ttyO2 /dev/ttyO2 or COM2 RS-485 (Data+, Data-); Non-isolated 9600
ttyO5 /dev/ttyO5 or COM5 RS-485 (Data+, Data-); 2500 VDC isolated 9600
[2] Modbus RTU protocol function codes.
Function Code Description Input
01 Reads the status of the Digital Output 1
02 Reads the status of the Digital Input 2
03 Reads the Analog Output channels 3
04 Reads the Analog Input channels 4
05 Writes to a single Digital Output channel 5
06 Writes to a singleAnalog Output channel 6
15 Writes to multiple Digital Output channels 15
16 Writes to multiple Analog Output channels 16
[3] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 11
2.3. getXVBitBack
Description:
This function is used to read back the channel status value from a specified DO module in an
LP-22xx/52xx system using the Modbus protocol.
Syntax:
[ C ]
int getXVBitBack(char cPort, WORD wAddr, WORD wCount, char szBuf, WORD wBufLen)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Output] Used to read back the Digital Output value.
wBufLen: [Input] The length of the szBuf[ ].
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 12
Example:
int RetValue, comport=COM1, count=4;
int addr=0; /* Refer to [Remark 1] */
char szBuf[80];
DWORD baudrate=115200;
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue > 0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
memset(szBuf, 0, sizeof(szBuf));
RetValue=getXVBitBack(comport, addr, count, szBuf, sizeof(szBuf));
Close_Com(comport);
if (RetValue==0) {
if(count<=8) {
printf("%d", szBuf[0]);
} else if (count<=16){
dwValue=(szBuf[1]<<8)|szBuf[0];
printf("%u", dwValue);
} else {
dwValue=(szBuf[3]<<24)|(szBuf[2]<<16)|(szBuf[1]<<8)|szBuf[0];
printf("%lu", dwValue);
}
}
Remarks:
[1] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 13
2.4. getXVBit
Description:
This function is used to read the channel status value from a specified DI module in an
LP-22xx/52xx system using the Modbus protocol.
Syntax:
[ C ]
int getXVBit(char cPort, WORD wAddr, WORD wCount, char szBuf, WORD wBufLen)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Output] The current status of the Digital Input.
wBufLen: [Input] The length of the szBuf[ ].
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 14
Example:
int RetValue, comport=COM1, count=4;
int addr=32; /* Refer to [Remark 1] */
char szBuf[80];
DWORD baudrate=115200;
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue > 0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
memset(szBuf, 0, sizeof(szBuf));
RetValue=getXVBit(comport, addr, count, szBuf, sizeof(szBuf));
Close_Com(comport);
if (RetValue==0) {
if(count<=8) {
printf("%d", szBuf[0]);
} else if (count<=16){
dwValue=(szBuf[1]<<8)|szBuf[0];
printf("%u", dwValue);
} else {
dwValue=(szBuf[3]<<24)|(szBuf[2]<<16)|(szBuf[1]<<8)|szBuf[0];
printf("%lu", dwValue);
}
}
Remarks:
[1] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 15
2.5. getXVRegBack
Description:
This function is used to read back the voltage float value from a specified AO module in an
LP-22xx/52xx system using the Modbus protocol.
Syntax:
[ C ]
int getXVRegBack(char cPort, WORD wAddr, WORD wCount, char szBuf, WORD wBufLen)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Output] Used to read back the Analog Output value.
wBufLen: [Input] The length of the szBuf[ ].
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 16
Example:
int RetValue, comport=COM1, count=1;
int addr=33; /* Refer to [Remark 1] */
char szBuf[80];
DWORD baudrate=115200;
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue > 0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
memset(szBuf, 0, sizeof(szBuf));
RetValue=getXVRegBack(comport, addr, count, szBuf, sizeof(szBuf));
Close_Com(comport);
if (RetValue==0) {
dwValue=(szBuf[0]<<8)|szBuf[1];
printf("%u", dwValue);
}
Remarks:
[1] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 17
2.6. getXVReg
Description:
This function is used to read the current input voltage value from a specified AI module in an
LP-22xx/52xx system using the Modbus protocol.
Syntax:
[ C ]
int getXVReg(char cPort, WORD wAddr, WORD wCount, char szBuf, WORD wBufLen)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Output] The currentAnalog Input value.
wBufLen: [Input] The length of the szBuf[ ].
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 18
Example:
int RetValue, comport=COM1, count=1;
int addr=3; /* Refer to [Remark 1] */
char szBuf[80];
DWORD baudrate=115200;
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue > 0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
memset(szBuf, 0, sizeof(szBuf));
RetValue=getXVReg(comport, addr, count, szBuf, sizeof(szBuf));
Close_Com(comport);
if (RetValue==0) {
dwValue=(szBuf[0]<<8)|szBuf[1];
printf("%u", dwValue);
}
Remarks:
[1] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 19
2.7. setXVBit
Description:
This function is used to set the status value for a specified DO module in an LP-22xx/52xx
system using the Modbus protocol.
Syntax:
[ C ]
int setXVBit(char cPort, WORD wAddr, WORD wCount, char szBuf, WORD wBufLen)
Parameters:
cPort: [Input] The number of the COM port for the XV-Board. 1=COM1=/dev/ttyO1.
wAddr: [Input] The channel address.
Note: Input the channel address mapping in decimal format.
wCount: [Input] The number of channels.
szBuf[ ]: [Input] Use to set the Digital Output data in decimal format.
wBufLen: [Input] The length of the szBuf[ ].
Return Values:
0: The function was successfully processed.
Other: The processing failed.
Refer to Chapter 3: “Error Codes” for details of other returned values.

ICPDAS
LinPAC-52xx Series XV-Board API User Manual 20
Example:
int RetValue, comport=COM1, count=4;
int addr=0; /* Refer to [Remark 1] */
char szBuf[80];
DWORD baudrate=115200, dwValue=15;
/* Open the device file */
RetValue=Open_Com(comport, baudrate, Data8Bit, NonParity, OneStopBit);
if (RetValue > 0) {
printf("open COM%d failed!\n",comport);
return FAILURE;
}
memset(szBuf, 0, sizeof(szBuf));
szBuf[0]=dwValue & 0xff;
szBuf[1]=(dwValue >> 8) & 0xff;
szBuf[2]=(dwValue >> 16) & 0xff;
szBuf[3]=(dwValue >> 24) & 0xff;
RetValue=setXVBit(comport, addr, count, szBuf, sizeof(szBuf));
Close_Com(comport);
Remarks:
[1] This is the input value reference address mapping (Modbus register table) for the 'wAddr'
parameter. More information regarding address mapping can be found at:
http://ftp.icpdas.com.tw/pub/cd/linpac/napdos/lp-5000/lp-52xx/lp-5231/user_manual/xv-boar
d_user_manual_v1.0.3.pdf