batterysource  2.1.0.0
Data Structures | Macros | Enumerations | Functions
batterysource.h File Reference

This file contains API for Battery Source Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  batterysource_t
 Battery Source Click context object. More...
 
struct  batterysource_cfg_t
 Battery Source Click configuration object. More...
 

Macros

#define BATTERYSOURCE_ENABLE_OUTPUT   0x01
 Battery Source description setting. More...
 
#define BATTERYSOURCE_DISABLE_OUTPUT   0x00
 
#define BATTERYSOURCE_MAP_MIKROBUS(cfg, mikrobus)    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
 MikroBUS pin mapping. More...
 

Enumerations

enum  batterysource_return_value_t { BATTERYSOURCE_OK = 0, BATTERYSOURCE_ERROR = -1 }
 Battery Source Click return value data. More...
 

Functions

void batterysource_cfg_setup (batterysource_cfg_t *cfg)
 Battery Source configuration object setup function. More...
 
err_t batterysource_init (batterysource_t *ctx, batterysource_cfg_t *cfg)
 Battery Source initialization function. More...
 
void batterysource_set_output (batterysource_t *ctx, uint8_t output_state)
 Battery Source set output state function. More...
 

Detailed Description

This file contains API for Battery Source Click Driver.

Enumeration Type Documentation

◆ batterysource_return_value_t

Battery Source Click return value data.

Predefined enum values for driver return values.

Enumerator
BATTERYSOURCE_OK 
BATTERYSOURCE_ERROR