Module Properties Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_ENC_GetModuleRev (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outModRev)
	Retrieves the module revision for the specified Encoder channel.
NAIBRDFUNC int32_t NAIAPI	naibrd_ENC_GetChannelCount (uint32_t modid)
	Returns the number of channels for the specified Encoder Module ID.
NAIBRDFUNC float64_t NAIAPI	naibrd_ENC_GetTimeBaseLSB (uint32_t modid)
	Returns the LSB for the timer interval for Debounce for the specified ENC Module ID. LSB in milliseconds.

Detailed Description

Function Documentation

naibrd_ENC_GetChannelCount()

NAIBRDFUNC int32_t NAIAPI naibrd_ENC_GetChannelCount

(

uint32_t

modid

)

Returns the number of channels for the specified Encoder Module ID.

Parameters

modid

: (Input) Encoder Module ID

Returns

• Number of channels for the Module ID.

naibrd_ENC_GetModuleRev()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetModuleRev	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outModRev )

Retrieves the module revision for the specified Encoder channel.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outModRev	: (Output) Module Revision.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_ENC_GetTimeBaseLSB()

NAIBRDFUNC float64_t NAIAPI naibrd_ENC_GetTimeBaseLSB

(

uint32_t

modid

)

Returns the LSB for the timer interval for Debounce for the specified ENC Module ID. LSB in milliseconds.

Parameters

modid

: (Input) ENC Module ID

Returns

• LSB for the module clock interval.