nrfx 3.3
Macros | Enumerations | Functions
TEMP HAL

Hardware access layer for managing the Temperature sensor (TEMP). More...

Macros

#define NRF_TEMP_HAS_CALIBRATION   1
 Symbol indicating whether the calibration of temperature measurement is present.
 

Enumerations

enum  nrf_temp_task_t {
  NRF_TEMP_TASK_START = offsetof(NRF_TEMP_Type, TASKS_START) ,
  NRF_TEMP_TASK_STOP = offsetof(NRF_TEMP_Type, TASKS_STOP)
}
 TEMP tasks. More...
 
enum  nrf_temp_event_t { NRF_TEMP_EVENT_DATARDY = offsetof(NRF_TEMP_Type, EVENTS_DATARDY) }
 TEMP events. More...
 
enum  nrf_temp_int_mask_t { NRF_TEMP_INT_DATARDY_MASK = TEMP_INTENSET_DATARDY_Msk }
 TEMP interrupts. More...
 

Functions

NRF_STATIC_INLINE void nrf_temp_int_enable (NRF_TEMP_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_temp_int_disable (NRF_TEMP_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_temp_int_enable_check (NRF_TEMP_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_temp_task_address_get (NRF_TEMP_Type const *p_reg, nrf_temp_task_t task)
 Function for getting the address of the specified TEMP task register.
 
NRF_STATIC_INLINE void nrf_temp_task_trigger (NRF_TEMP_Type *p_reg, nrf_temp_task_t task)
 Function for activating the specified TEMP task.
 
NRF_STATIC_INLINE uint32_t nrf_temp_event_address_get (NRF_TEMP_Type const *p_reg, nrf_temp_event_t event)
 Function for getting the address of the specified TEMP event register.
 
NRF_STATIC_INLINE void nrf_temp_event_clear (NRF_TEMP_Type *p_reg, nrf_temp_event_t event)
 Function for clearing the specified TEMP event.
 
NRF_STATIC_INLINE bool nrf_temp_event_check (NRF_TEMP_Type const *p_reg, nrf_temp_event_t event)
 Function for getting the state of a specific event.
 
NRF_STATIC_INLINE int32_t nrf_temp_result_get (NRF_TEMP_Type const *p_reg)
 Function for getting the result of temperature measurement.
 
NRF_STATIC_INLINE void nrf_temp_calibration_coeff_set (NRF_TEMP_Type *p_reg, uint32_t coeff)
 Function for setting the calibration coefficient for the temperature measurement.
 
NRF_STATIC_INLINE uint32_t nrf_temp_calibration_coeff_get (NRF_TEMP_Type const *p_reg)
 Function for getting the calibration coefficient for the temperature measurement.
 
NRF_STATIC_INLINE void nrf_temp_subscribe_set (NRF_TEMP_Type *p_reg, nrf_temp_task_t task, uint8_t channel)
 Function for setting the subscribe configuration for a given TEMP task.
 
NRF_STATIC_INLINE void nrf_temp_subscribe_clear (NRF_TEMP_Type *p_reg, nrf_temp_task_t task)
 Function for clearing the subscribe configuration for a given TEMP task.
 
NRF_STATIC_INLINE void nrf_temp_publish_set (NRF_TEMP_Type *p_reg, nrf_temp_event_t event, uint8_t channel)
 Function for setting the publish configuration for a given TEMP event.
 
NRF_STATIC_INLINE void nrf_temp_publish_clear (NRF_TEMP_Type *p_reg, nrf_temp_event_t event)
 Function for clearing the publish configuration for a given TEMP event.
 

Detailed Description

Hardware access layer for managing the Temperature sensor (TEMP).

Enumeration Type Documentation

◆ nrf_temp_event_t

TEMP events.

Enumerator
NRF_TEMP_EVENT_DATARDY 

Temperature measurement complete, data ready.

◆ nrf_temp_int_mask_t

TEMP interrupts.

Enumerator
NRF_TEMP_INT_DATARDY_MASK 

Interrupt on DATARDY event.

◆ nrf_temp_task_t

TEMP tasks.

Enumerator
NRF_TEMP_TASK_START 

Start temperature measurement.

NRF_TEMP_TASK_STOP 

Stop temperature measurement.

Function Documentation

◆ nrf_temp_calibration_coeff_get()

NRF_STATIC_INLINE uint32_t nrf_temp_calibration_coeff_get ( NRF_TEMP_Type const *  p_reg)

Function for getting the calibration coefficient for the temperature measurement.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Calibration coefficient.

◆ nrf_temp_calibration_coeff_set()

NRF_STATIC_INLINE void nrf_temp_calibration_coeff_set ( NRF_TEMP_Type *  p_reg,
uint32_t  coeff 
)

Function for setting the calibration coefficient for the temperature measurement.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]coeffCalibration coefficient.

◆ nrf_temp_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_temp_event_address_get ( NRF_TEMP_Type const *  p_reg,
nrf_temp_event_t  event 
)

Function for getting the address of the specified TEMP event register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventRequested event.
Returns
Address of the requested event register.

◆ nrf_temp_event_check()

NRF_STATIC_INLINE bool nrf_temp_event_check ( NRF_TEMP_Type const *  p_reg,
nrf_temp_event_t  event 
)

Function for getting the state of a specific event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be checked.
Return values
trueThe event has been generated.
falseThe event has not been generated.

◆ nrf_temp_event_clear()

NRF_STATIC_INLINE void nrf_temp_event_clear ( NRF_TEMP_Type *  p_reg,
nrf_temp_event_t  event 
)

Function for clearing the specified TEMP event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to clear.

◆ nrf_temp_int_disable()

NRF_STATIC_INLINE void nrf_temp_int_disable ( NRF_TEMP_Type *  p_reg,
uint32_t  mask 
)

Function for disabling specified interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be disabled. Use nrf_temp_int_mask_t values for bit masking.

◆ nrf_temp_int_enable()

NRF_STATIC_INLINE void nrf_temp_int_enable ( NRF_TEMP_Type *  p_reg,
uint32_t  mask 
)

Function for enabling specified interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be enabled. Use nrf_temp_int_mask_t values for bit masking.

◆ nrf_temp_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_temp_int_enable_check ( NRF_TEMP_Type const *  p_reg,
uint32_t  mask 
)

Function for checking if the specified interrupts are enabled.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be checked. Use nrf_temp_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_temp_publish_clear()

NRF_STATIC_INLINE void nrf_temp_publish_clear ( NRF_TEMP_Type *  p_reg,
nrf_temp_event_t  event 
)

Function for clearing the publish configuration for a given TEMP event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent for which to clear the configuration.

◆ nrf_temp_publish_set()

NRF_STATIC_INLINE void nrf_temp_publish_set ( NRF_TEMP_Type *  p_reg,
nrf_temp_event_t  event,
uint8_t  channel 
)

Function for setting the publish configuration for a given TEMP event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent for which to set the configuration.
[in]channelChannel through which to publish the event.

◆ nrf_temp_result_get()

NRF_STATIC_INLINE int32_t nrf_temp_result_get ( NRF_TEMP_Type const *  p_reg)

Function for getting the result of temperature measurement.

Note
Returned value is in 2's complement format, 0.25 °C steps
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Temperature value register contents.

◆ nrf_temp_subscribe_clear()

NRF_STATIC_INLINE void nrf_temp_subscribe_clear ( NRF_TEMP_Type *  p_reg,
nrf_temp_task_t  task 
)

Function for clearing the subscribe configuration for a given TEMP task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask for which to clear the configuration.

◆ nrf_temp_subscribe_set()

NRF_STATIC_INLINE void nrf_temp_subscribe_set ( NRF_TEMP_Type *  p_reg,
nrf_temp_task_t  task,
uint8_t  channel 
)

Function for setting the subscribe configuration for a given TEMP task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask for which to set the configuration.
[in]channelChannel through which to subscribe events.

◆ nrf_temp_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_temp_task_address_get ( NRF_TEMP_Type const *  p_reg,
nrf_temp_task_t  task 
)

Function for getting the address of the specified TEMP task register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskRequested task.
Returns
Address of the requested task register.

◆ nrf_temp_task_trigger()

NRF_STATIC_INLINE void nrf_temp_task_trigger ( NRF_TEMP_Type *  p_reg,
nrf_temp_task_t  task 
)

Function for activating the specified TEMP task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask to be activated.

Documentation feedback | Developer Zone | Subscribe | Updated