DioInpMultiBitSR

Function

Inputs multiple bits from input ports on the wireless I/O device.

Format

Ret = DioInpMultiBitSR ( Id , BitNo , BitNum , Data , Timestamp , Mode )

Parameters

Id [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the device ID retrieved from DioInit.

BitNo [ VB.NET: Short ] [ C, C++: short * ] [ C#: out short ] [ Python: ctypes.POINTER(ctypes.c_short) ]
Store the logical input bit numbers into an array, and specify the base address of this array.

BitNum [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the number of bits which are specified by BitNo. The maximum number of bits is 256.

Data [ VB.NET: Byte ] [ C, C++: BYTE * ] [ C#: out byte ] [ Python: ctypes.POINTER(ctypes.c_ubyte) ]
Specify the base address of the array to store the input data.

Timestamp [ VB.NET: UShort ] [ C, C++: unsigned short * ] [ C#: out ushort ] [ Python: ctypes.POINTER(ctypes.c_ushort) ]
Specify the address of the variable to store the timestamp.

Mode [ VB.NET: Byte ] [ C, C++: BYTE ] [ C#: out byte ] [ Python: ctypes.c_ubyte ]
Specify where to refer to the input data.

Definition

Value

[Dec]

Description

DIONET_MODE_DIRECT

Refer to the input data of Terminal.

DIONET_MODE_AP

Refer to the input data of Gateway.

Return Value

Ret [ VB.NET: Integer ] [ C, C++: long ] [ C#: int ] [ Python: ctypes.c_long ]

Definition	Value [Dec]	Description
DIO_ERR_SUCCESS	0	Normal completed.
DIO_ERR_SYS_RECOVERED_FROM_STANDBY	7	Execute DioResetDevice function because the device has recovered from standby mode.
DIO_ERR_DLL_INVALID_ID	10001	Invalid ID specified.
DIO_ERR_DLL_CALL_DRIVER	10002	Not call the driver (Failure on DEVICE I/O CONTROL).
DIO_ERR_DLL_BUFF_ADDRESS	10100	Invalid data buffer address.
DIO_ERR_SYS_NOT_SUPPORTED	20001	This board couldn't use this function.
DIO_ERR_SYS_BIT_NO	20102	Bit No. beyond the limit.
DIO_ERR_SYS_BIT_NUM	20103	Bit number beyond the limit.

The others (See also: Details of Error Code)

Initial Value

The initial values of input data are 0 in the state that other external equipment is not connected.

Remarks

Inputs multiple bits from input ports. Before this function is called, it is necessary that the logical bit numbers to be input are set into the array specified by BitNo. The input data are stored into the array named Data by the order of logical bits which are specified by BitNo.
To acquire data, there are two methods. One is acquiring data stored in master unit, the other one is acquiring data directly from slave unit.
Please refer to the wireless I/O specification for features of each acquisition method.

For the data acquisition method, when acquiring the data stored in the master unit, you can acquire the time stamp of the data stored in the master unit.
The time stamp returns the time since the last update in seconds.
If the time stamp is longer than the update interval of the slave unit, the data from the slave unit is not reaching the master unit for some reason.
Please use it to check the validity of the data saved in the master unit.

Example

Inputs data from bit 0 and bit 1.

VB.NET	Dim Ret As Integer Dim BitNo(1) As Short Dim Data(1) As Byte Dim Timestamp As UShort Dim Mode As Byte BitNo(0) = 0 BitNo(1) = 1 Mode = 0 Ret = DioInpMultiBitSR ( Id , BitNo , 2 , Data , Timestamp , Mode )
C, C++	long Ret; short BitNo[2] BYTE Data[2]; unsigned short Timestamp; BYTE Mode; BitNo[0] = 0; BitNo[1] = 1; Mode = 0; Ret = DioInpMultiBitSR ( Id , BitNo , 2 , Data , &Timestamp , Mode );
C#	int Ret; short[] BitNo = new short[2]; byte[] Data = new byte[2]; ushort Timestamp; byte Mode; BitNo[0] = 0; BitNo[1] = 1; Mode = 0; Ret = dio.DioInpMultiBitSR ( Id , out BitNo , 2 , out Data , out Timestamp , Mode );
Python	Ret = ctypes.c_long() BitNoType = ctypes.c_short * 2 BitNo = BitNoType() DataType = ctypes.c_ubyte * 2 Data = DataType() Timestamp = ctypes.c_ushort() Mode = ctypes.c_ubyte() BitNo[0] = 0 BitNo[1] = 1 Mode.value = 0 Ret.value = cdio.DioInpMultiBitSR ( Id , BitNo , 2 , Data , ctypes.byref(Timestamp) , Mode )