COMP driver

group nrfx_comp

Comparator (COMP) peripheral driver.

Defines

NRFX_VOLTAGE_THRESHOLD_TO_INT(vol, ref)

Macro for converting the threshold voltage to an integer value (needed by the COMP_TH register).

Parameters

vol – [in] Voltage to be changed to COMP_TH register value. This value must not be smaller than reference voltage divided by 64.
ref – [in] Reference voltage.

NRFX_COMP_CONFIG_TH: COMP threshold default configuration.

NRFX_COMP_DEFAULT_CONFIG(_input)

COMP driver default configuration.

This configuration sets up COMP with the following options:

single-ended mode
reference voltage: internal 1.8 V
lower threshold: 0.5 V
upper threshold: 1.5 V
high speed mode
hysteresis disabled
current source disabled

Parameters

_input – [in] Analog input.

Typedefs

typedef void (*nrfx_comp_event_handler_t)(nrf_comp_event_t event)

COMP event handler function type.

Param event: [in] COMP event.

Enums

enum nrfx_comp_short_mask_t

COMP shortcut masks.

Values:

enumerator NRFX_COMP_SHORT_STOP_AFTER_CROSS_EVT: Shortcut between the CROSS event and the STOP task.

enumerator NRFX_COMP_SHORT_STOP_AFTER_UP_EVT: Shortcut between the UP event and the STOP task.

enumerator NRFX_COMP_SHORT_STOP_AFTER_DOWN_EVT: Shortcut between the DOWN event and the STOP task.

enum nrfx_comp_evt_en_mask_t

COMP events masks.

Values:

enumerator NRFX_COMP_EVT_EN_CROSS_MASK: CROSS event (generated after VIN+ == VIN-).

enumerator NRFX_COMP_EVT_EN_UP_MASK: UP event (generated when VIN+ crosses VIN- while increasing).

enumerator NRFX_COMP_EVT_EN_DOWN_MASK: DOWN event (generated when VIN+ crosses VIN- while decreasing).

enumerator NRFX_COMP_EVT_EN_READY_MASK: READY event (generated when the module is ready).

Functions

nrfx_err_t nrfx_comp_init(nrfx_comp_config_t const *p_config, nrfx_comp_event_handler_t event_handler)

Function for initializing the COMP driver.

This function initializes the COMP driver, but does not enable the peripheral or any interrupts. To start the driver, call the function nrfx_comp_start() after initialization.

Parameters

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

Return values

NRFX_SUCCESS – Initialization was successful.
NRFX_ERROR_INVALID_STATE – The driver has already been initialized.
NRFX_ERROR_BUSY – The LPCOMP peripheral is already in use. This is possible only if Peripheral Resource Sharing (PRS) module is enabled.

void nrfx_comp_uninit(void)

Function for uninitializing the COMP driver.

This function uninitializes the COMP driver. The COMP peripheral and its interrupts are disabled, and local variables are cleaned. After this call, you must initialize the driver again by calling nrfx_comp_init() if you want to use it.