LESENSE - Low Energy Sensor#

LESENSE_ClkPresc_TypeDef#

LESENSE_ClkPresc_TypeDef

Clock divisors for controlling the prescaling factor of the period counter.

Note: These enumeration values are used for different clock division related configuration parameters (hfPresc, lfPresc, pcPresc).

LESENSE_ScanMode_TypeDef#

LESENSE_ScanMode_TypeDef

Scan modes.

LESENSE_PRSSel_TypeDef#

LESENSE_PRSSel_TypeDef

PRS sources.

Note: These enumeration values are being used for different PRS related configuration parameters.

LESENSE_AltExMap_TypeDef#

LESENSE_AltExMap_TypeDef

Locations of the alternate excitation function.

LESENSE_BufTrigLevel_TypeDef#

LESENSE_BufTrigLevel_TypeDef

Result buffer interrupt and DMA trigger levels.

LESENSE_DMAWakeUp_TypeDef#

LESENSE_DMAWakeUp_TypeDef

Modes of operation for DMA wakeup from EM2.

LESENSE_BiasMode_TypeDef#

LESENSE_BiasMode_TypeDef

Bias modes.

LESENSE_ScanConfSel_TypeDef#

LESENSE_ScanConfSel_TypeDef

Scan configuration.

LESENSE_ControlDACData_TypeDef#

LESENSE_ControlDACData_TypeDef

DAC CHx data control configuration.

LESENSE_ControlACMP_TypeDef#

LESENSE_ControlACMP_TypeDef

ACMPx control configuration.

LESENSE_WarmupMode_TypeDef#

LESENSE_WarmupMode_TypeDef

Warm up modes.

ACMP and DAC duty cycle mode configuration.

LESENSE_DecInput_TypeDef#

LESENSE_DecInput_TypeDef

Decoder input source configuration.

LESENSE_ChSampleMode_TypeDef#

LESENSE_ChSampleMode_TypeDef

Compare source selection for sensor sampling.

LESENSE_ChIntMode_TypeDef#

LESENSE_ChIntMode_TypeDef

Interrupt generation setup for CHx interrupt flag.

LESENSE_ChPinExMode_TypeDef#

LESENSE_ChPinExMode_TypeDef

Channel pin mode for the excitation phase of the scan sequence.

LESENSE_ChPinIdleMode_TypeDef#

LESENSE_ChPinIdleMode_TypeDef

Channel pin mode for the idle phase of scan sequence.

LESENSE_ChClk_TypeDef#

LESENSE_ChClk_TypeDef

Clock used for excitation and sample delay timing.

LESENSE_ChCompMode_TypeDef#

LESENSE_ChCompMode_TypeDef

Compare modes for counter comparison.

LESENSE_ChEvalMode_TypeDef#

LESENSE_ChEvalMode_TypeDef

Sensor evaluation modes.

LESENSE_AltExPinIdle_TypeDef#

LESENSE_AltExPinIdle_TypeDef

Idle phase configuration of the alternate excitation channels.

LESENSE_StTransAct_TypeDef#

LESENSE_StTransAct_TypeDef

Transition action modes.

LESENSE_Init#

void LESENSE_Init (const LESENSE_Init_TypeDef *init, bool reqReset)

Initialize the LESENSE module.

This function configures the main parameters of the LESENSE interface. See the initialization parameter type definition (LESENSE_Init_TypeDef) for more details.

Note

• LESENSE_Init() is designed to initialize LESENSE once in an operation cycle. Be aware of the effects of reconfiguration if using this function from multiple sources in your code. This function has not been designed to be re-entrant. Requesting reset by setting reqReset to true is required in each reset or power-on cycle to configure the default values of the RAM mapped LESENSE registers. Notice that GPIO pins used by the LESENSE module must be properly configured by the user explicitly for the LESENSE to work as intended. (When configuring pins, one should remember to consider the sequence of configuration to avoid unintended pulses/glitches on output pins.)

LESENSE_Reset#

void LESENSE_Reset (void)

Reset the LESENSE module.

Use this function to reset LESENSE registers.

Note

• Resetting LESENSE registers is required in each reset or power-on cycle to configure the default values of the RAM mapped LESENSE registers. LESENSE_Reset() can be called on initialization by setting the reqReset parameter to true in LESENSE_Init(). Starting from Series 2 Config 3 (xG23 and higher), this function leaves LESENSE in the disabled state.

LESENSE_ScanFreqSet#

uint32_t LESENSE_ScanFreqSet (uint32_t refFreq, uint32_t scanFreq)

Set the scan frequency for periodic scanning.

This function only applies to LESENSE if a period counter is used as a trigger for scan start. The calculation is based on the following formula: Fscan = LFACLKles / ((1+PCTOP)*2^PCPRESC)

Note

• Note that the calculation does not necessarily result in the requested scan frequency due to integer division. Check the return value for the resulted scan frequency.

Returns

• Frequency in Hz calculated and set by this function. Users can use this to compare the requested and set values.

LESENSE_ScanModeSet#

void LESENSE_ScanModeSet (LESENSE_ScanMode_TypeDef scanMode, bool start)

Set scan mode of the LESENSE channels.

This function configures how the scan start is triggered. It can be used for re-configuring the scan mode while running the application but it is also used by LESENSE_Init() for initialization.

Note

• Users can configure the scan mode by LESENSE_Init() function, but only with a significant overhead. This simple function serves the purpose of controlling this parameter after the channel has been configured. Be aware of the effects of the non-atomic Read-Modify-Write cycle.

LESENSE_StartDelaySet#

void LESENSE_StartDelaySet (uint8_t startDelay)

Set the start delay of the sensor interaction on each channel.

This function sets the start delay of the sensor interaction on each channel. It can be used for adjusting the start delay while running the application but it is also used by LESENSE_Init() for initialization.

Note

• Users can configure the start delay by LESENSE_Init() function, but only with a significant overhead. This simple function serves the purpose of controlling this parameter after the channel has been configured. Be aware of the effects of the non-atomic Read-Modify-Write cycle.

LESENSE_ClkDivSet#

void LESENSE_ClkDivSet (LESENSE_ChClk_TypeDef clk, LESENSE_ClkPresc_TypeDef clkDiv)

Set the clock division for LESENSE timers.

Use this function to configure the clock division for the LESENSE timers used for excitation timing. The division setting is global but the clock source can be selected for each channel using LESENSE_ChannelConfig() function. See documentation for more details.

Note

• If AUXHFRCO is used for excitation timing, LFACLK can't exceed 500 kHz. LFACLK can't exceed 50 kHz if the ACMP threshold level (ACMPTHRES) is not equal for all channels.

LESENSE_ChannelAllConfig#

void LESENSE_ChannelAllConfig (const LESENSE_ChAll_TypeDef *confChAll)

Configure all (16) LESENSE sensor channels.

This function configures all sensor channels of the LESENSE interface. See the configuration parameter type definition (LESENSE_ChAll_TypeDef) for more details.

Note

• Channels can be configured individually using LESENSE_ChannelConfig() function. Notice that pins used by the LESENSE module must be properly configured by the user explicitly for LESENSE to work as intended. (When configuring pins, consider the sequence of the configuration to avoid unintended pulses/glitches on output pins.)

LESENSE_ChannelConfig#

void LESENSE_ChannelConfig (const LESENSE_ChDesc_TypeDef *confCh, uint32_t chIdx)

Configure a single LESENSE sensor channel.

This function configures a single sensor channel of the LESENSE interface. See the configuration parameter type definition (LESENSE_ChDesc_TypeDef) for more details.

Note

• This function has been designed to minimize the effects of sensor channel reconfiguration while LESENSE is in operation. However, be aware of these effects and the right timing to call this function. Parameter useAltEx must be true in the channel configuration to use alternate excitation pins.

LESENSE_ChannelEnable#

void LESENSE_ChannelEnable (uint8_t chIdx, bool enaScanCh, bool enaPin)

Enable/disable LESENSE scan channel and the pin assigned to it.

Use this function to enable/disable a selected LESENSE scan channel and the pin assigned to it.

Note

• Users can enable/disable scan channels and the channel pin with the LESENSE_ChannelConfig() function, but only with a significant overhead. This simple function controls these parameters after the channel has been configured.

LESENSE_ChannelEnableMask#

void LESENSE_ChannelEnableMask (uint16_t chMask, uint16_t pinMask)

Enable/disable LESENSE scan channel and the pin assigned to it.

Use this function to enable/disable LESENSE scan channels and the pins assigned to them using a mask.

Note

• Users can enable/disable scan channels and channel pins by using the LESENSE_ChannelAllConfig() function, but only with a significant overhead. This simple function controls these parameters after the channel has been configured.

LESENSE_ChannelTimingSet#

void LESENSE_ChannelTimingSet (uint8_t chIdx, uint8_t exTime, uint8_t sampleDelay, uint16_t measDelay)

Set LESENSE channel timing parameters.

Use this function to set timing parameters on a selected LESENSE channel.

Note

• Users can configure the channel timing parameters with the LESENSE_ChannelConfig() function, but only with a significant overhead. This simple function controls these parameters after the channel has been configured.

LESENSE_ChannelThresSet#

void LESENSE_ChannelThresSet (uint8_t chIdx, uint16_t acmpThres, uint16_t cntThres)

Set LESENSE channel threshold parameters.

Use this function to set threshold parameters on a selected LESENSE channel.

Note

• Users can configure the channel threshold parameters with the LESENSE_ChannelConfig() function, but only with a significant overhead. This simple function serves controls these parameters after the channel has been configured.

LESENSE_ChannelSlidingWindow#

void LESENSE_ChannelSlidingWindow (uint8_t chIdx, uint32_t windowSize, uint32_t initValue)

Configure a Sliding Window evaluation mode for a specific channel.

This function will configure the evaluation mode, the initial sensor measurement (COMPTHRES), and the window size. For other channel-related configuration, see the LESENSE_ChannelConfig() function.

Warnings

• Note that the step size and window size configuration are global to all LESENSE channels and use the same register field in the hardware. This means that any windowSize configuration passed to this function will apply for all channels and override all other stepSize/windowSize configurations.

LESENSE_ChannelStepDetection#

void LESENSE_ChannelStepDetection (uint8_t chIdx, uint32_t stepSize, uint32_t initValue)

Configure the step detection evaluation mode for a specific channel.

This function will configure the evaluation mode, the initial sensor measurement (COMPTHRES) and the window size. For other channel-related configuration, see the LESENSE_ChannelConfig() function.

Warnings

• Note that the step size and window size configuration are global to all LESENSE channels and use the same register field in the hardware. This means that any stepSize configuration passed to this function will apply for all channels and override all other stepSize/windowSize configurations.

LESENSE_WindowSizeSet#

void LESENSE_WindowSizeSet (uint32_t windowSize)

Set the window size for all LESENSE channels.

The window size is used by all channels that are configured as lesenseEvalModeSlidingWindow.

Warnings

• The window size configuration is using the same register field as the step detection size. As a result, the window size configuration will have an effect on channels configured with the lesenseEvalModeStepDetection evaluation mode as well.

LESENSE_StepSizeSet#

void LESENSE_StepSizeSet (uint32_t stepSize)

Set the step size for all LESENSE channels.

The step size is configured using the same register field as used to configure window size. Therefore, calling this function will overwrite any previously configured window size as done by the LESENSE_WindowSizeSet() function.

LESENSE_AltExConfig#

void LESENSE_AltExConfig (const LESENSE_ConfAltEx_TypeDef *confAltEx)

Configure the LESENSE alternate excitation modes.

This function configures the alternate excitation channels of the LESENSE interface. See the configuration parameter type definition (LESENSE_ConfAltEx_TypeDef) for more details.

Note

• The useAltEx parameter must be true in the channel configuration structure (LESENSE_ChDesc_TypeDef) to use alternate excitation pins on the channel.

LESENSE_DecoderStateAllConfig#

void LESENSE_DecoderStateAllConfig (const LESENSE_DecStAll_TypeDef *confDecStAll)

Configure all LESENSE decoder states.

This function configures all the decoder states of the LESENSE interface. See the configuration parameter type definition (LESENSE_DecStAll_TypeDef) for more details.

Note

• Decoder states can be configured individually using LESENSE_DecoderStateConfig() function. Starting from Series 2 Config 3 (xG23 and higher), this function configures a transition ARC instead of a decoder state.

LESENSE_DecoderStateConfig#

void LESENSE_DecoderStateConfig (const LESENSE_DecStDesc_TypeDef *confDecSt, uint32_t decSt)

Configure a single LESENSE decoder state.

This function configures a single decoder state of the LESENSE interface. See the configuration parameter type definition (LESENSE_DecStDesc_TypeDef) for more details.

Note

• Starting from Series 2 Config 3 (xG23 and higher), this function configures a transition ARC instead of a decoder state.

LESENSE_DecoderStateSet#

void LESENSE_DecoderStateSet (uint32_t decSt)

Set the LESENSE decoder state.

This function can be used for setting the initial state of the LESENSE decoder.

Note

• Make sure the LESENSE decoder state is initialized by this function before enabling the decoder!

LESENSE_DecoderStateGet#

uint32_t LESENSE_DecoderStateGet (void)

Get the current state of the LESENSE decoder.

Returns

• This function returns the value of the LESENSE_DECSTATE register that represents the current state of the LESENSE decoder.

LESENSE_DecoderPrsOut#

void LESENSE_DecoderPrsOut (bool enable, uint32_t decMask, uint32_t decVal)

Enable or disable the PRS output from the LESENSE decoder.

LESENSE_ScanStart#

void LESENSE_ScanStart (void)

Start scanning sensors.

Note

• This function will wait for any pending previous write operation to the CMD register to complete before accessing the CMD register. It will also wait for the write operation to the CMD register to complete before returning. Each write operation to the CMD register may take up to 3 LF clock cycles, so expect some delay. The user may implement a separate function to write multiple command bits in the CMD register in one single operation to optimize an application.

LESENSE_ScanStop#

void LESENSE_ScanStop (void)

Stop scanning sensors.

Note

• This function will wait for any pending previous write operation to the CMD register to complete before accessing the CMD register. It will also wait for the write operation to the CMD register to complete before returning. Each write operation to the CMD register may take up to 3 LF clock cycles, so the user should expect some delay. The user may implement a separate function to write multiple command bits in the CMD register in one single operation in order to optimize an application.

• If issued during a scan, the command takes effect after scan completion.

LESENSE_DecoderStart#

void LESENSE_DecoderStart (void)

Start the LESENSE decoder.

Note

• This function will wait for any pending previous write operation to the CMD register to complete before accessing the CMD register. It will also wait for the write operation to the CMD register to complete before returning. Each write operation to the CMD register may take up to 3 LF clock cycles, so expect some delay. The user may implement a separate function to write multiple command bits in the CMD register in one single operation to optimize an application.

LESENSE_ResultBufferClear#

void LESENSE_ResultBufferClear (void)

Clear the result buffer.

Note

• This function will wait for any pending previous write operation to the CMD register to complete before accessing the CMD register. It will also wait for the write operation to the CMD register to complete before returning. Each write operation to the CMD register may take up to 3 LF clock cycles, so expect some delay. The user may implement a separate function to write multiple command bits in the CMD register in one single operation to optimize an application.

LESENSE_DecoderStop#

void LESENSE_DecoderStop (void)

Stop LESENSE decoder.

Disables LESENSE decoder by setting the command to LESENSE_DECCTRL register.

LESENSE_StatusGet#

uint32_t LESENSE_StatusGet (void)

Get the current status of LESENSE.

Returns

• Returns the value of the LESENSE_STATUS register that contains the OR combination of the following status bits for EFR series 0/1:

  • LESENSE_STATUS_BUFDATAV - Result data valid. Set when data is available in result buffer. Cleared when buffer is empty.

  • LESENSE_STATUS_BUFFULL - Result buffer full. Set when result buffer is full.

  • LESENSE_STATUS_BUFHALFFULL - Result buffer half full. Set when result buffer is half full.

  • LESENSE_STATUS_RUNNING - LESENSE is active.

  • LESENSE_STATUS_SCANACTIVE - LESENSE is currently interfacing sensors.

  The OR combination of the following status bits for EFR series 2:

  • LESENSE_STATUS_RESFIFOV - Result Fifo valid. Set when data is available in result Fifo. Cleared when Fifo is empty.

  • LESENSE_STATUS_RESFIFOFULL - Result Fifo full. Set when result Fifo is full.

  • LESENSE_STATUS_RUNNING - LESENSE is active.

  • LESENSE_STATUS_SCANACTIVE - LESENSE is currently interfacing sensors.

  • LESENSE_STATUS_FLUSHING - Fifo flushing

  • LESENSE_STATUS_READBUSY - Fifo Read busy

LESENSE_StatusWait#

void LESENSE_StatusWait (uint32_t flag)

Wait until status of LESENSE is equal to what was requested.

Polls LESENSE_STATUS register and waits until requested combination of flags are set.

LESENSE_ChannelActiveGet#

uint32_t LESENSE_ChannelActiveGet (void)

Get the currently active channel index.

Returns

• Returns the value of the LESENSE_CHINDEX register that contains the index of currently active channel (0-15).

LESENSE_ScanResultGet#

uint32_t LESENSE_ScanResultGet (void)

Get the latest scan comparison result (1 bit / channel).

Returns

• Returns the value of the LESENSE_SCANRES register that contains the comparison result of last scan on all channels. Bit x is set if a comparison triggered on channel x, which means that LESENSE counter met the comparison criteria set in LESENSE_CHx_EVAL by COMPMODE and CNTTHRES.

LESENSE_ScanResultDataGet#

uint32_t LESENSE_ScanResultDataGet (void)

Get the oldest unread data from the result buffer.

Note

• Make sure that the STORERES bit is set in LESENSE_CHx_EVAL, or the STRSCANRES bit is set in LESENSE_CTRL; otherwise, returns the undefined value.

Returns

• Returns the value of LESENSE_RESDATA register that contains the oldest unread counter result from result buffer.

LESENSE_ScanResultDataBufferGet#

uint32_t LESENSE_ScanResultDataBufferGet (uint32_t idx)

Get data from the result data buffer.

Note

• Make sure that the STORERES bit is set in LESENSE_CHx_EVAL, or the STRSCANRES bit is set in LESENSE_CTRL; otherwise, returns the undefined value.

Returns

• Returns the selected word from the result data buffer.

LESENSE_SensorStateGet#

uint32_t LESENSE_SensorStateGet (void)

Get the current state of the LESENSE sensor.

Returns

• Returns the value of LESENSE_SENSORSTATE register that represents the current state of the LESENSE sensor.

LESENSE_IntClear#

void LESENSE_IntClear (uint32_t flags)

Clear one or more pending LESENSE interrupts.

LESENSE_IntEnable#

void LESENSE_IntEnable (uint32_t flags)

Enable one or more LESENSE interrupts.

LESENSE_IntDisable#

void LESENSE_IntDisable (uint32_t flags)

Disable one or more LESENSE interrupts.

LESENSE_IntSet#

void LESENSE_IntSet (uint32_t flags)

Set one or more pending LESENSE interrupts from SW.

LESENSE_IntGet#

uint32_t LESENSE_IntGet (void)

Get pending LESENSE interrupt flags.

Note

• Event bits are not cleared by the use of this function.

Returns

• Pending LESENSE interrupt sources. The OR combination of valid interrupt flags of the LESENSE module (LESENSE_IF_nnn).

LESENSE_IntGetEnabled#

uint32_t LESENSE_IntGetEnabled (void)

Get enabled and pending LESENSE interrupt flags.

Useful for handling more interrupt sources in the same interrupt handler.

Note

• Event bits are not cleared by the use of this function.

Returns

• Pending and enabled LESENSE interrupt sources. Return value is the bitwise AND combination of

  • the OR combination of enabled interrupt sources in LESENSE_IEN_nnn register (LESENSE_IEN_nnn) and

  • the OR combination of valid interrupt flags of LESENSE module (LESENSE_IF_nnn).

LESENSE_NUM_DECODER_STATES#

#define LESENSE_NUM_DECODER_STATES

(_LESENSE_DECSTATE_DECSTATE_MASK + 1)

Number of decoder states supported by current device.

LESENSE_NUM_CHANNELS#

#define LESENSE_NUM_CHANNELS

16

Number of LESENSE channels.

LESENSE_CORECTRL_DESC_DEFAULT#

#define LESENSE_CORECTRL_DESC_DEFAULT

Default configuration for LESENSE_CtrlDesc_TypeDef structure.

LESENSE_TIMECTRL_DESC_DEFAULT#

#define LESENSE_TIMECTRL_DESC_DEFAULT

Default configuration for LESENSE_TimeCtrlDesc_TypeDef structure.

LESENSE_PERCTRL_DESC_DEFAULT#

#define LESENSE_PERCTRL_DESC_DEFAULT

Default configuration for LESENSE_PerCtrl_TypeDef structure.

LESENSE_DECCTRL_DESC_DEFAULT#

#define LESENSE_DECCTRL_DESC_DEFAULT

Default configuration for LESENSE_PerCtrl_TypeDef structure.

LESENSE_INIT_DEFAULT#

#define LESENSE_INIT_DEFAULT

Default configuration for LESENSE_Init_TypeDef structure.

LESENSE_CH_CONF_DEFAULT#

#define LESENSE_CH_CONF_DEFAULT

Default configuration for the scan channel.

LESENSE_SCAN_CONF_DEFAULT#

#define LESENSE_SCAN_CONF_DEFAULT

Default configuration for all the sensor channels.

LESENSE_ALTEX_CH_CONF_DEFAULT#

#define LESENSE_ALTEX_CH_CONF_DEFAULT

Default configuration for the alternate excitation channel.

LESENSE_ALTEX_CONF_DEFAULT#

#define LESENSE_ALTEX_CONF_DEFAULT

Default configuration for all the alternate excitation channels.

LESENSE_ST_CONF_DEFAULT#

#define LESENSE_ST_CONF_DEFAULT

Default configuration for the decoder state condition.

LESENSE_DECODER_CONF_DEFAULT#

#define LESENSE_DECODER_CONF_DEFAULT

Default configuration for all decoder states.