AioSetAiCallBackProc


Function

Registers the callback function that is called when the events relative to analog input raise.

Format

Ret = AioSetAiCallBackProc ( Id , CallBackProc , AiEvent , Param)

Parameters

Id [ C, C++ : short ] [ Python : ctypes.c_short ]
Specifies the Device ID retrieved from AioInit function.

CallBackProc [ C, C++ : long * ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the callback function.

AiEvent [ C, C++ : long ] [ Python : ctypes.c_long ]
Specifies the event factor from the following range in macro or value that calls the callback function.
AiEvent has the following meanings in bit, it can be specified by a combination of these bits.

The available event factor is based on whether the device buffer is used or whether the user buffer is used.

Event factor

Using Device buffer

Using User buffer

Macro

Value

Event that AD conversion start

Yes

Yes

AIE_START

00000002H

Event that repeat end

Yes

Yes

AIE_RPTEND

00000010H

Event that device operation end

Yes

Yes

AIE_END

00000020H

Event that the specified number of data are stored

Yes

No

AIE_DATA_NUM

00000080H

Event that the specified number of data are transferred

No

Yes

AIE_DATA_TSF

00000100H

Event that overflow

Yes

Yes

AIE_OFERR

00010000H

Event that sampling clock period error

Yes

Yes

AIE_SCERR

00020000H

Event that AD conversion error

Yes

Yes

AIE_ADERR

00040000H

When "Event that the specified number of data are stored" is used, set the number of samplings that raises the event by using the AioSetAiEventSamplingTimes function.

Param [ C, C++ : void * ] [ Python : ctypes.c_void_p ]
Specifies the parameter address passed to the callback function.
If the parameter isn't necessary, specify NULL.

Return value

Ret [ C, C++ : long ] [ Python : ctypes.c_long ]

Return values

Content

0

Normality completion

7

Execute AioResetDevice function because the device has recovered from standby mode

10001

Invalid Id was specified
Use the Id retrieved from AioInit to specify the Id in this function.

10002

AIO driver can't be called
At first, perform AioInit function.

20001

This function can't be used by this device

20002

Can not use while by another device works
To use this function, analog input operation must be stopped.

20003

Can not use because another process is using the device
When another process is using the device, all functions except for those that support multi-process can not be performed.

Remarks

Registers the callback function using in this function, the callback function is called when any event raised in the device.

This function cannot be used on devices without the analog input function.
If the device is in operation, the function cannot be performed.

When AioStopAi function is performed, the callback function isn't called.

You should not execute the functions that start/stop devices operation in the callback routine.

For Ethernet devices
    If communication with the device is lost, the process will be unregistered and will no longer receive event notifications.
    If you want to perform event notification again, please make the settings again using this function.

Example

Registers the callback function in "Event that device operation end" and "Event that the specified number of data are output" factor.

C, C++

long Ret;
Ret = AioSetAiCallBackProc ( Id , CallBackProc , AIE_END | AIE_DATA_NUM , this );
 

Python

Ret = ctypes.c_long()
Ret.value = caio.AioSetAiCallBackProc ( Id , CallBackProc , caio.AIE_END | caio.AIE_DATA_NUM , 0 )
 

See also



Callback Function

Format

Ret = CallBackProc ( Id , Message , wParam , lParam , Param )

Parameters

Id [ C, C++ : short ] [ Python : ctypes.c_short ]
The ID retrieved from AioInit is passed

Message [ C, C++ : short ] [ Python : ctypes.c_short ]
The message ID is passed that cause the callback function to be called.
Message ID is any of the following value.

Analog input message factor

Macro

Value

Event that AD conversion start

AIOM_AIE_START

1000H

Event that repeat end

AIOM_AIE_RPTEND

1001H

Event that device operation end

AIOM_AIE_END

1002H

Event that the specified number of data are stored

AIOM_AIE_DATA_NUM

1003H

Event that the specified number of data are transferred

AIOM_AIE_DATA_TSF

1007H

Event that overflow

AIOM_AIE_OFERR

1004H

Event that sampling clock period error

AIOM_AIE_SCERR

1005H

Event that AD conversion error

AIOM_AIE_ADERR

1006H

wParam [ C, C++ : long ] [ Python : ctypes.c_long ]
The parameter is passed from the driver. It isn't used now.

lParam [ C, C++ : long ] [ Python : ctypes.c_long ]
The parameter peculiar to event is passed.

Event factor

Parameter

Event that AD conversion start

None

Event that repeat end

The current number of repeats

Event that device operation end

The current number of samplings

Event that the specified number of data are stored

The current number of samplings

Event that the specified number of data are transferred

The current transfer times

Event that overflow

The current number of samplings

Event that sampling clock period error

The current number of samplings

Event that AD conversion error

The current number of samplings

Param [ C, C++ : void * ] [ Python : ctypes.c_void_p ]
The parameter specified in the function AioSetAiCallBackProc is passed.
NULL is stored in this when NULL is specified in the parameter.