hydrogen.h File Reference

This file contains API for Hydrogen Click Driver. More...

#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures
struct	hydrogen_t
	Hydrogen Click context object. More...
struct	hydrogen_cfg_t
	Hydrogen Click configuration object. More...

Macros
#define	HYDROGEN_MAP_MIKROBUS(cfg, mikrobus)    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
	MikroBUS pin mapping.

Enumerations
enum	hydrogen_return_value_t { HYDROGEN_OK = 0 , HYDROGEN_ERROR = -1 }
	Hydrogen Click return value data. More...

Functions
void	hydrogen_cfg_setup (hydrogen_cfg_t *cfg)
	Hydrogen configuration object setup function.
err_t	hydrogen_init (hydrogen_t *ctx, hydrogen_cfg_t *cfg)
	Hydrogen initialization function.
err_t	hydrogen_read_an_pin_value (hydrogen_t *ctx, uint16_t *data_out)
	Hydrogen read AN pin value function.
err_t	hydrogen_read_an_pin_voltage (hydrogen_t *ctx, float *data_out)
	Hydrogen read AN pin voltage level function.

Detailed Description

This file contains API for Hydrogen Click Driver.

Enumeration Type Documentation

hydrogen_return_value_t

enum hydrogen_return_value_t

Hydrogen Click return value data.

Predefined enum values for driver return values.

Enumerator
HYDROGEN_OK
HYDROGEN_ERROR