DioGetDigitalFilter


Function

Retrieves the digital filter value being set.

Format

Ret = DioGetDigitalFilter ( Id , FilterValue )

Parameters

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

FilterValue [ VB.NET: Short ] [ C, C++: short * ] [ C#: out short ] [ Python: ctypes.POINTER(ctypes.c_short) ]
The returned digital filter setting value is one of the following values.

When using <DIO-1616LN-USB>
- It is a simple filter by software.
- The filter is invalid for interrupts.

Setting Value

[Dec]

Setting Time

0

Digital filter unused

1 to 11

Reserved

12

512 [usec]

13

1024 [usec]

14

2.048 [msec]

15

4.096 [msec]

16

8.192 [msec]

17

16.384 [msec]

18

32.768 [msec]

19

65.536 [msec]

20

131.072 [msec]

When using <CPSN-DI-08L, CPSN-DI-08BL>

Setting Value

[Dec]

Setting Time

0

Digital filter unused

1

Digital filter used

When using <DIO-1616LN-ETH, DIO-1616RYN-ETH, DIO-0404LY-WQ>
- It is a simple filter by software.

Setting Value

[Dec]

Setting Time

0

Digital filter unused

1 to 16

Reserved

17

16.384 [msec]

18

32.768 [msec]

19

65.536 [msec]

20

131.072 [msec]

When using <CPS-DIO-0808L, CPS-DIO-0808BL, CPS-DIO-0808RL, CPS-DI-16L, CPS-DI-16RL>

Setting Value

[Dec]

Setting Time

0

Digital filter unused

1

0.25 [usec]

2

0.5 [usec]

3

1 [usec]

4

2 [ usec]

5

4 [usec]

6

8 [usec]

7

16 [usec]

8

32 [usec]

9

64 [usec]

10

128 [usec]

11

256 [usec]

12

512 [usec]

13

1024 [usec]

14

2.048 [msec]

15

4.096 [msec]

16

8.192 [msec]

17

16.384 [msec]

18

32.768 [msec]

19

65.536 [msec]

20

131.072 [msec]

When using <CPSN-DI-16BCL>

Setting Value

[Dec]

Setting Time

0

Digital filter unused

1 to 1000

Setting Value [msec]

When using <PIO H series: PIO-XX(XX)H, PI-XX(XX)H, PIO-16/16RY(PCI), DIO-XXXX-PE, DI-XX-PE>
When using <DIO-XXXXLX-USB>

Setting Value

[Dec]

Setting Time

Setting Value

[Dec]

Setting Time

0

Digital filter unused

11

256[usec]

1

0.25[usec]

12

512[usec]

2

0.50[usec]

13

1.024[msec]

3

1.0[usec]

14

2.048[msec]

4

2.0[usec]

15

4.096[msec]

5

4.0[usec]

16

8.192[msec]

6

8.0[usec]

17

16.384[msec]

7

16[usec]

18

32.768[msec]

8

32[usec]

19

65.536[msec]

9

64[usec]

20

131.072[msec]

10

128[usec]

 

 

 

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_SYS_NOT_SUPPORTED

20001

This board couldn't use this function.

The others (See also: Details of Error Code)

Example

Retrieves the digital filter value being set.

VB.NET

Dim Ret As Integer
Dim FilterValue As Short
Ret = DioGetDigitalFilter ( Id , FilterValue )
 

C, C++

long Ret;
short FilterValue;
Ret = DioGetDigitalFilter ( Id , &FilterValue );
 

C#

int Ret;
short FilterValue;
Ret = dio.GetDigitalFilter ( Id , out FilterValue );
 

Python

Ret = ctypes.c_long()
FilterValue = ctypes.c_short()
Ret.value = cdio.DioGetDigitalFilter ( Id , ctypes.byref(FilterValue) )
 

See Also

DioSetDigitalFilter