ambient.h File Reference

This file contains API for Ambient Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures
struct	ambient_t
	Click ctx object definition. More...
struct	ambient_cfg_t
	Click configuration structure definition. More...

Macros
#define	AMBIENT_MAP_MIKROBUS(cfg, mikrobus)    cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN )
#define	AMBIENT_OK   0
#define	AMBIENT_ERROR   -1
#define	AMBIENT_VCC_5_0   5.0f
#define	AMBIENT_VCC_3_3   3.3f
#define	AMBIENT_VOLTS_TO_MILLIVOLTS   1000.0f
#define	AMBIENT_GAIN   7

Functions
void	ambient_cfg_setup (ambient_cfg_t *cfg)
	Config Object Initialization function.
err_t	ambient_init (ambient_t *ctx, ambient_cfg_t *cfg)
	Initialization function.
err_t	ambient_read_an_pin_value (ambient_t *ctx, uint16_t *data_out)
	Ambient read AN pin value function.
err_t	ambient_read_an_pin_voltage (ambient_t *ctx, float *data_out)
	Ambient read AN pin voltage level function.
uint16_t	ambient_get_light_intensity (ambient_t *ctx)
	Calculate light intensity function.

Detailed Description

This file contains API for Ambient Click driver.