methane.h File Reference

This file contains API for Methane 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	methane_t
	Methane Click context object. More...
struct	methane_cfg_t
	Methane Click configuration object. More...

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

Enumerations
enum	methane_return_value_t { METHANE_OK = 0 , METHANE_ERROR = -1 }
	Methane Click return value data. More...

Functions
void	methane_cfg_setup (methane_cfg_t *cfg)
	Methane configuration object setup function.
err_t	methane_init (methane_t *ctx, methane_cfg_t *cfg)
	Methane initialization function.
err_t	methane_read_an_pin_value (methane_t *ctx, uint16_t *data_out)
	Methane read AN pin value function.
err_t	methane_read_an_pin_voltage (methane_t *ctx, float *data_out)
	Methane read AN pin voltage level function.

Detailed Description

This file contains API for Methane Click Driver.

Enumeration Type Documentation

methane_return_value_t

enum methane_return_value_t

Methane Click return value data.

Predefined enum values for driver return values.

Enumerator
METHANE_OK
METHANE_ERROR