LPCOMP driver

group nrfx_lpcomp

Low Power Comparator (LPCOMP) peripheral driver.

Defines

NRFX_LPCOMP_DEFAULT_CONFIG(_input)

LPCOMP driver default configuration.

This configuration sets up LPCOMP with the following options:

  • reference voltage: 4/8 of supply voltage

  • detection of both up and down crossings

  • hysteresis disabled

Parameters:

  • _input – [in] Comparator input pin.

Typedefs

typedef void (*nrfx_lpcomp_event_handler_t)(nrf_lpcomp_event_t event)

LPCOMP event handler function type.

Param event:

[in] LPCOMP event.

Functions

nrfx_err_t nrfx_lpcomp_init(nrfx_lpcomp_config_t const *p_config, nrfx_lpcomp_event_handler_t event_handler)

Function for initializing the LPCOMP driver.

This function initializes the LPCOMP driver, but does not enable the peripheral or any interrupts. To start the driver, call the function nrfx_lpcomp_enable() 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_ALREADY – The driver is already initialized.

  • NRFX_ERROR_INVALID_STATE – The driver is already initialized. Deprecated - use NRFX_ERROR_ALREADY instead.

  • NRFX_ERROR_BUSY – The COMP peripheral is already in use. This is possible only if Peripheral Resource Sharing (PRS) module is enabled.

void nrfx_lpcomp_uninit(void)

Function for uninitializing the LPCOMP driver.

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

See also

nrfx_lpcomp_disable

See also

nrfx_lpcomp_init

bool nrfx_lpcomp_init_check(void)

Function for checking if the LPCOMP driver is initialized.

Return values:

  • true – Driver is already initialized.

  • false – Driver is not initialized.

void nrfx_lpcomp_enable(void)

Function for enabling the LPCOMP peripheral and interrupts.

Before calling this function, the driver must be initialized. This function enables the LPCOMP peripheral and its interrupts.

See also

nrfx_lpcomp_disable

void nrfx_lpcomp_disable(void)

Function for disabling the LPCOMP peripheral.

Before calling this function, the driver must be initialized. This function disables the LPCOMP peripheral and its interrupts.

See also

nrfx_lpcomp_enable

struct nrfx_lpcomp_config_t
#include <nrfx_lpcomp.h>

LPCOMP configuration.

Public Members

nrf_lpcomp_ref_t reference

Reference selection.

nrf_lpcomp_ext_ref_t ext_ref

External analog reference selection.

nrf_lpcomp_detect_t detection

Detection type.

nrf_lpcomp_input_t input

Input to be monitored.

uint8_t interrupt_priority

LPCOMP interrupt priority.