shutter 2.1.0.0
shutter.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  shutter_t
 Shutter Click context object. More...
 
struct  shutter_cfg_t
 Shutter Click configuration object. More...
 

Macros

#define SHUTTER_STATE_OFF   0
 Shutter state setting.
 
#define SHUTTER_STATE_ON   1
 
#define SHUTTER_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  shutter_return_value_t { SHUTTER_OK = 0 , SHUTTER_ERROR = -1 }
 Shutter Click return value data. More...
 

Functions

void shutter_cfg_setup (shutter_cfg_t *cfg)
 Shutter configuration object setup function.
 
err_t shutter_init (shutter_t *ctx, shutter_cfg_t *cfg)
 Shutter initialization function.
 
void shutter_set_auto_focus (shutter_t *ctx, uint8_t state)
 Shutter set auto focus function.
 
void shutter_set_shutter (shutter_t *ctx, uint8_t state)
 Shutter set shutter function.
 
void shutter_take_picture (shutter_t *ctx, uint8_t auto_focus)
 Shutter take picture function.
 

Detailed Description

This file contains API for Shutter Click Driver.

Enumeration Type Documentation

◆ shutter_return_value_t

Shutter Click return value data.

Predefined enum values for driver return values.

Enumerator
SHUTTER_OK 
SHUTTER_ERROR