caffeine-sal 0.1.17
Header-only polymorphic middleware services layer for the Caffeine Framework
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
cfn_sal_dev_humidity.h File Reference

Abstract Humidity Sensor service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures

struct  cfn_sal_dev_humidity_config_t
 
struct  cfn_sal_dev_humidity_api_s
 Humidity Sensor Virtual Method Table (VMT). More...
 

Macros

#define CFN_SAL_DEV_TYPE_HUMIDITY   CFN_SAL_TYPE('H', 'U', 'M')
 

Typedefs

typedef struct cfn_sal_dev_humidity_s cfn_sal_dev_humidity_t
 
typedef struct cfn_sal_dev_humidity_api_s cfn_sal_dev_humidity_api_t
 
typedef void(* cfn_sal_dev_humidity_callback_t) (cfn_sal_dev_humidity_t *driver, uint32_t event, uint32_t error, void *user_arg)
 

Enumerations

enum  cfn_sal_dev_humidity_mode_t { CFN_SAL_DEV_HUMIDITY_MODE_CONTINUOUS , CFN_SAL_DEV_HUMIDITY_MODE_ONE_SHOT }
 
enum  cfn_sal_dev_humidity_event_t { CFN_SAL_DEV_HUMIDITY_EVENT_NONE = 0 , CFN_SAL_DEV_HUMIDITY_EVENT_DATA_READY = CFN_HAL_BIT(0) }
 
enum  cfn_sal_dev_humidity_oversampling_t {
  CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_NONE , CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_1X , CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_2X , CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_4X ,
  CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_8X , CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_16X
}
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_sal_dev_humidity_api_s)
 
 CFN_SAL_CREATE_DRIVER_TYPE (sal_dev_humidity, cfn_sal_dev_humidity_config_t, cfn_sal_dev_humidity_api_t, cfn_sal_phy_t, cfn_sal_dev_humidity_callback_t)
 
CFN_HAL_INLINE void cfn_sal_dev_humidity_populate (cfn_sal_dev_humidity_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_dev_humidity_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_dev_humidity_config_t *config, cfn_sal_dev_humidity_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_dev_humidity_construct (cfn_sal_dev_humidity_t *driver, const cfn_sal_dev_humidity_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_sal_dev_humidity_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_dev_humidity_destruct (cfn_sal_dev_humidity_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_init (cfn_sal_dev_humidity_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_deinit (cfn_sal_dev_humidity_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_config_set (cfn_sal_dev_humidity_t *driver, const cfn_sal_dev_humidity_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_config_get (cfn_sal_dev_humidity_t *driver, cfn_sal_dev_humidity_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_callback_register (cfn_sal_dev_humidity_t *driver, cfn_sal_dev_humidity_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_power_state_set (cfn_sal_dev_humidity_t *driver, cfn_hal_power_state_t state)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_event_enable (cfn_sal_dev_humidity_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_event_disable (cfn_sal_dev_humidity_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_event_get (cfn_sal_dev_humidity_t *driver, uint32_t *event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_error_enable (cfn_sal_dev_humidity_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_error_disable (cfn_sal_dev_humidity_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_error_get (cfn_sal_dev_humidity_t *driver, uint32_t *error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_read_rh (cfn_sal_dev_humidity_t *driver, float *hum_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_read_raw (cfn_sal_dev_humidity_t *driver, int32_t *raw_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_start_conversion (cfn_sal_dev_humidity_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_get_status (cfn_sal_dev_humidity_t *driver, uint32_t *status_flags)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_enable_heater (cfn_sal_dev_humidity_t *driver, uint32_t power_mw, uint32_t duration_ms)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_soft_reset (cfn_sal_dev_humidity_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_get_id (cfn_sal_dev_humidity_t *driver, uint32_t *id_out)
 
CFN_HAL_INLINE void cfn_sal_dev_humidity_handle_interrupt (cfn_sal_dev_humidity_t *driver)
 

Detailed Description

Abstract Humidity Sensor service interface.

Macro Definition Documentation

◆ CFN_SAL_DEV_TYPE_HUMIDITY

#define CFN_SAL_DEV_TYPE_HUMIDITY   CFN_SAL_TYPE('H', 'U', 'M')

Typedef Documentation

◆ cfn_sal_dev_humidity_api_t

typedef struct cfn_sal_dev_humidity_api_s cfn_sal_dev_humidity_api_t

◆ cfn_sal_dev_humidity_callback_t

typedef void(* cfn_sal_dev_humidity_callback_t) (cfn_sal_dev_humidity_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_dev_humidity_t

typedef struct cfn_sal_dev_humidity_s cfn_sal_dev_humidity_t

Enumeration Type Documentation

◆ cfn_sal_dev_humidity_event_t

enum cfn_sal_dev_humidity_event_t
Enumerator
CFN_SAL_DEV_HUMIDITY_EVENT_NONE 
CFN_SAL_DEV_HUMIDITY_EVENT_DATA_READY 

◆ cfn_sal_dev_humidity_mode_t

enum cfn_sal_dev_humidity_mode_t
Enumerator
CFN_SAL_DEV_HUMIDITY_MODE_CONTINUOUS 
CFN_SAL_DEV_HUMIDITY_MODE_ONE_SHOT 

◆ cfn_sal_dev_humidity_oversampling_t

enum cfn_sal_dev_humidity_oversampling_t
Enumerator
CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_NONE 
CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_1X 
CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_2X 
CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_4X 
CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_8X 
CFN_SAL_DEV_HUMIDITY_OVERSAMPLING_16X 

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_dev_humidity_api_s  )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE ( sal_dev_humidity  ,
cfn_sal_dev_humidity_config_t  ,
cfn_sal_dev_humidity_api_t  ,
cfn_sal_phy_t  ,
cfn_sal_dev_humidity_callback_t   
)

◆ cfn_sal_dev_humidity_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_callback_register ( cfn_sal_dev_humidity_t *  driver,
cfn_sal_dev_humidity_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_humidity_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_config_get ( cfn_sal_dev_humidity_t *  driver,
cfn_sal_dev_humidity_config_t *  config 
)

◆ cfn_sal_dev_humidity_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_config_set ( cfn_sal_dev_humidity_t *  driver,
const cfn_sal_dev_humidity_config_t *  config 
)

◆ cfn_sal_dev_humidity_construct()

cfn_hal_error_code_t cfn_sal_dev_humidity_construct ( cfn_sal_dev_humidity_t *  driver,
const cfn_sal_dev_humidity_config_t *  config,
const cfn_sal_phy_t *  phy,
void *  dependency,
cfn_sal_dev_humidity_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_humidity_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_deinit ( cfn_sal_dev_humidity_t *  driver)

◆ cfn_sal_dev_humidity_destruct()

cfn_hal_error_code_t cfn_sal_dev_humidity_destruct ( cfn_sal_dev_humidity_t *  driver)

◆ cfn_sal_dev_humidity_enable_heater()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_enable_heater ( cfn_sal_dev_humidity_t *  driver,
uint32_t  power_mw,
uint32_t  duration_ms 
)

◆ cfn_sal_dev_humidity_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_error_disable ( cfn_sal_dev_humidity_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_humidity_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_error_enable ( cfn_sal_dev_humidity_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_humidity_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_error_get ( cfn_sal_dev_humidity_t *  driver,
uint32_t *  error_mask 
)

◆ cfn_sal_dev_humidity_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_event_disable ( cfn_sal_dev_humidity_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_humidity_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_event_enable ( cfn_sal_dev_humidity_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_humidity_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_event_get ( cfn_sal_dev_humidity_t *  driver,
uint32_t *  event_mask 
)

◆ cfn_sal_dev_humidity_get_id()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_get_id ( cfn_sal_dev_humidity_t *  driver,
uint32_t *  id_out 
)

◆ cfn_sal_dev_humidity_get_status()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_get_status ( cfn_sal_dev_humidity_t *  driver,
uint32_t *  status_flags 
)

◆ cfn_sal_dev_humidity_handle_interrupt()

CFN_HAL_INLINE void cfn_sal_dev_humidity_handle_interrupt ( cfn_sal_dev_humidity_t *  driver)

◆ cfn_sal_dev_humidity_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_init ( cfn_sal_dev_humidity_t *  driver)

◆ cfn_sal_dev_humidity_populate()

CFN_HAL_INLINE void cfn_sal_dev_humidity_populate ( cfn_sal_dev_humidity_t *  driver,
uint32_t  peripheral_id,
void *  dependency,
const cfn_sal_dev_humidity_api_t *  api,
const cfn_sal_phy_t *  phy,
const cfn_sal_dev_humidity_config_t *  config,
cfn_sal_dev_humidity_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_humidity_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_power_state_set ( cfn_sal_dev_humidity_t *  driver,
cfn_hal_power_state_t  state 
)

◆ cfn_sal_dev_humidity_read_raw()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_read_raw ( cfn_sal_dev_humidity_t *  driver,
int32_t *  raw_out 
)

◆ cfn_sal_dev_humidity_read_rh()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_read_rh ( cfn_sal_dev_humidity_t *  driver,
float *  hum_out 
)

◆ cfn_sal_dev_humidity_soft_reset()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_soft_reset ( cfn_sal_dev_humidity_t *  driver)

◆ cfn_sal_dev_humidity_start_conversion()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_humidity_start_conversion ( cfn_sal_dev_humidity_t *  driver)
Generated by doxygen 1.9.8