CanSetChannelAcceptance

Function

Set reception acceptance.

Format

Ret = CanSetChannelAcceptance ( Id , ChannelNo , MessageTypeMask , CanIdMask , CanIdCode )

Parameters

Id [ C, C++: short ] [ Python: ctypes.c_short ]
Specify the device ID retrieved from CanInit.

ChannelNo [ C, C++: unsigned short ] [ Python: ctypes.c_ushort ]
Specify the channel number.

MessageTypeMask [ C, C++: unsigned int ] [ Python: ctypes.c_uint ]
Specify message types that you do not want to receive.
Message types with specified bits will not be received.

When specifying multiple message types, perform bitwise operations using logical OR.
For example, if it is 0x00, there is no message type specified, so all message types will be received.

CanIdMask [ C, C++: unsigned int ] [ Python: ctypes.c_uint ]
Specify the mask for the CAN IDs to be received.

When standard format is specified, specify with base ID (11bit).
Valid specification range is 0x000 to 0x7FF.
If you specify 0x000, all CAN ID messages will be stored in the receive buffer.
When you specify 0x7FF, all CAN ID messages are the filtered target. And you can designate some of CAN ID messages to be stored in the receive buffer with CanIdCode.

When extended format is specified, specify it as extended ID + base ID (29 bits in total).
Valid specification range is 0x000 to 0x1FFFFFFF.
If you specify 0x00000000, all CAN ID messages will be stored in the receive buffer.
If you specify 0x1FFFFFFF, all CAN ID messages are the filtered target. And you can designate some of CAN ID messages to be stored in the receive buffer with CanIdCode.

CanIdCode [ C, C++: unsigned int ] [ Python: ctypes.c_uint ]
Indicate the CAN ID with code to be stored in the receive buffer among the messages filtered by the CanIdMask setting.

When standard format is specified, specify with base ID (11bit).
Valid specification range is 0x000 to 0x7FF.

If extended format is specified, specify it as extended ID + base ID (29 bits in total).
The extended ID is the upper bits, and the base ID is the lower bits.
Valid specification range is 0x000 to 0x1FFFFFFF.

Return Value

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

The others (See also: Details of Error Code)

Initial Value

MessageTypeMask = 0x00 (CCAN_MSG_TYPE_DISABLE. Not specified (all message types will be received))
CanIdMask = 0x00000000 (All messages are stored in the receive buffer)
CanIdCode = 0x00000000

Remarks

Set reception acceptance.

This can be set only when the bus is not connected.

In addition to store only one CAN ID message to the receive buffer, you can store the multiple CAN ID messages to the receive buffer by combining CanIdMask and CanIdCode.
Please refer [Examples of the combination for CanIdMask and CanIdCode setting] topic to know more details.

Example

Set CanIdMask = 2047, CanIdCode = 3 with standard format CAN communication to ChannelNo = 1. The decimal number 2047 is expressed as 0x7FF in hexadecimal.

See Also

CanGetChannelAcceptance