serializer 2.0.0.0
serializer.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures

struct  serializer_t
 Serializer Click context object. More...
 
struct  serializer_cfg_t
 Serializer Click configuration object. More...
 

Macros

#define SERIALIZER_STATUS_OVERTEMPERATURE   0x01
 Serializer status bits values.
 
#define SERIALIZER_STATUS_UNDERVOLTAGE   0x02
 
#define SERIALIZER_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define SERIALIZER_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define SERIALIZER_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  serializer_return_value_t { SERIALIZER_OK = 0 , SERIALIZER_ERROR = -1 }
 Serializer Click return value data. More...
 

Functions

void serializer_cfg_setup (serializer_cfg_t *cfg)
 Serializer configuration object setup function.
 
err_t serializer_init (serializer_t *ctx, serializer_cfg_t *cfg)
 Serializer initialization function.
 
uint8_t serializer_get_flt_pin (serializer_t *ctx)
 Serializer get FLT pin function.
 
err_t serializer_read_input (serializer_t *ctx, uint8_t *data_out)
 Serializer read input function.
 

Detailed Description

This file contains API for Serializer Click Driver.

Enumeration Type Documentation

◆ serializer_return_value_t

Serializer Click return value data.

Predefined enum values for driver return values.

Enumerator
SERIALIZER_OK 
SERIALIZER_ERROR