optoencoder4 2.1.0.0
optoencoder4.h File Reference

This file contains API for Opto Encoder 4 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  optoencoder4_t
 Opto Encoder 4 Click context object. More...
 
struct  optoencoder4_cfg_t
 Opto Encoder 4 Click configuration object. More...
 

Macros

#define OPTOENCODER4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  optoencoder4_return_value_t { OPTOENCODER4_OK = 0 , OPTOENCODER4_ERROR = -1 }
 Opto Encoder 4 Click return value data. More...
 

Functions

void optoencoder4_cfg_setup (optoencoder4_cfg_t *cfg)
 Opto Encoder 4 configuration object setup function.
 
err_t optoencoder4_init (optoencoder4_t *ctx, optoencoder4_cfg_t *cfg)
 Opto Encoder 4 initialization function.
 
uint8_t optoencoder4_get_out_pin (optoencoder4_t *ctx)
 Opto Encoder 4 get out pin function.
 
uint8_t optoencoder4_get_our_pin (optoencoder4_t *ctx)
 Opto Encoder 4 get our pin function.
 

Detailed Description

This file contains API for Opto Encoder 4 Click Driver.

Enumeration Type Documentation

◆ optoencoder4_return_value_t

Opto Encoder 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
OPTOENCODER4_OK 
OPTOENCODER4_ERROR