QDEC driver

Quadrature Decoder (QDEC) peripheral driver. More...

Modules
	QDEC peripheral driver configuration

Data Structures
struct	nrfx_qdec_config_t
	QDEC configuration structure. More...
struct	nrfx_qdec_sample_data_evt_t
	QDEC sample event data. More...
struct	nrfx_qdec_report_data_evt_t
	QDEC report event data. More...
struct	nrfx_qdec_event_t
	QDEC event handler structure. More...

Macros
#define	NRFX_QDEC_DEFAULT_CONFIG(_pin_a, _pin_b, _pin_led)
	QDEC driver default configuration. More...

Typedefs
typedef void(*	nrfx_qdec_event_handler_t) (nrfx_qdec_event_t event)
	QDEC event handler. More...

Functions
nrfx_err_t	nrfx_qdec_init (nrfx_qdec_config_t const *p_config, nrfx_qdec_event_handler_t event_handler)
	Function for initializing QDEC. More...
void	nrfx_qdec_uninit (void)
	Function for uninitializing QDEC. More...
void	nrfx_qdec_enable (void)
	Function for enabling QDEC. More...
void	nrfx_qdec_disable (void)
	Function for disabling QDEC. More...
void	nrfx_qdec_accumulators_read (int16_t *p_acc, int16_t *p_accdbl)
	Function for reading accumulated transitions from the QDEC peripheral. More...
NRFX_STATIC_INLINE uint32_t	nrfx_qdec_task_address_get (nrf_qdec_task_t task)
	Function for returning the address of the specified QDEC task. More...
NRFX_STATIC_INLINE uint32_t	nrfx_qdec_event_address_get (nrf_qdec_event_t event)
	Function for returning the address of the specified QDEC event. More...

Detailed Description

Quadrature Decoder (QDEC) peripheral driver.

Macro Definition Documentation

NRFX_QDEC_DEFAULT_CONFIG

#define NRFX_QDEC_DEFAULT_CONFIG	(		_pin_a,
			_pin_b,
			_pin_led
	)

Value:

{ \
 .reportper = NRF_QDEC_REPORTPER_10, \
 .sampleper = NRF_QDEC_SAMPLEPER_16384us, \
 .psela = _pin_a, \
 .pselb = _pin_b, \
 .pselled = _pin_led, \
 .ledpre = 500, \
 .ledpol = NRF_QDEC_LEPOL_ACTIVE_HIGH, \
 .dbfen = NRF_QDEC_DBFEN_DISABLE, \
 .sample_inten = false, \
 .interrupt_priority = NRFX_QDEC_DEFAULT_CONFIG_IRQ_PRIORITY \
 }

QDEC driver default configuration.

This configuration sets up QDEC with the following options:

• report period: 10 samples
• sampling period: 16384 us
• LED enabled for 500 us before sampling
• LED polarity: active high
• debouncing filter disabled
• sample ready interrupt disabled

Parameters

[in]	_pin_a	Pin for A encoder channel input.
[in]	_pin_b	Pin for B encoder channel input.
[in]	_pin_led	Pin for LED output.

Typedef Documentation

nrfx_qdec_event_handler_t

typedef void(* nrfx_qdec_event_handler_t) (nrfx_qdec_event_t event)

QDEC event handler.

Parameters

[in]

event

QDEC event structure.

Function Documentation

nrfx_qdec_accumulators_read()

void nrfx_qdec_accumulators_read	(	int16_t *	p_acc,
		int16_t *	p_accdbl
	)

Function for reading accumulated transitions from the QDEC peripheral.

Note

Function asserts if module is not enabled.

Accumulators are cleared after reading.

Parameters

[out]	p_acc	Pointer to store the accumulated transitions.
[out]	p_accdbl	Pointer to store the accumulated double transitions.

nrfx_qdec_disable()

void nrfx_qdec_disable

(

void

)

Function for disabling QDEC.

Note

Function asserts if module is uninitialized or disabled.

nrfx_qdec_enable()

void nrfx_qdec_enable

(

void

)

Function for enabling QDEC.

Note

Function asserts if module is uninitialized or enabled.

nrfx_qdec_event_address_get()

NRFX_STATIC_INLINE uint32_t nrfx_qdec_event_address_get

(

nrf_qdec_event_t

event

)

Function for returning the address of the specified QDEC event.

Parameters

event

QDEC event.

Returns

Event address.

nrfx_qdec_init()

nrfx_err_t nrfx_qdec_init	(	nrfx_qdec_config_t const *	p_config,
		nrfx_qdec_event_handler_t	event_handler
	)

Function for initializing QDEC.

Parameters

[in]	p_config	Pointer to the structure with the initial configuration.
[in]	event_handler	Event handler provided by the user. Must not be NULL.

Return values

NRFX_SUCCESS	Initialization was successful.
NRFX_ERROR_INVALID_STATE	The QDEC was already initialized.

nrfx_qdec_task_address_get()

NRFX_STATIC_INLINE uint32_t nrfx_qdec_task_address_get

(

nrf_qdec_task_t

task

)

Function for returning the address of the specified QDEC task.

Parameters

task	QDEC task.

Returns

Task address.

nrfx_qdec_uninit()

void nrfx_qdec_uninit

(

void

)

Function for uninitializing QDEC.

Note

Function asserts if module is uninitialized.