dtmfdecoder  2.0.0.0
Data Structures | Macros | Enumerations | Functions
dtmfdecoder.h File Reference

This file contains API for DTMF Decoder Click Driver. More...

#include "mikrosdk_version.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  dtmfdecoder_t
 DTMF Decoder Click context object. More...
 
struct  dtmfdecoder_cfg_t
 DTMF Decoder Click configuration object. More...
 

Macros

#define DTMFDECODER_CMD_BYTE_INPUT   0x00
 
#define DTMFDECODER_CMD_BYTE_OUTPUT   0x01
 
#define DTMFDECODER_CMD_BYTE_POL_INV   0x02
 
#define DTMFDECODER_CMD_BYTE_CONFIG   0x03
 
#define DTMFDECODER_SET_DEV_ADDR   0x41
 DTMF Decoder device address setting. More...
 
#define DTMFDECODER_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  dtmfdecoder_return_value_t { DTMFDECODER_OK = 0, DTMFDECODER_ERROR = -1 }
 DTMF Decoder Click return value data. More...
 

Functions

void dtmfdecoder_cfg_setup (dtmfdecoder_cfg_t *cfg)
 DTMF Decoder configuration object setup function. More...
 
err_t dtmfdecoder_init (dtmfdecoder_t *ctx, dtmfdecoder_cfg_t *cfg)
 DTMF Decoder initialization function. More...
 
void dtmfdecoder_default_cfg (dtmfdecoder_t *ctx)
 DTMF Decoder default configuration function. More...
 
err_t dtmfdecoder_generic_write (dtmfdecoder_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 DTMF Decoder I2C writing function. More...
 
err_t dtmfdecoder_generic_read (dtmfdecoder_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 DTMF Decoder I2C reading function. More...
 
void dtmfdecoder_inhibit_on (dtmfdecoder_t *ctx)
 DTMF Decoder inhibit on function. More...
 
void dtmfdecoder_inhibit_off (dtmfdecoder_t *ctx)
 DTMF Decoder inhibit off function. More...
 
void dtmfdecoder_powerdown_on (dtmfdecoder_t *ctx)
 DTMF Decoder power down on function. More...
 
void dtmfdecoder_powerdown_off (dtmfdecoder_t *ctx)
 DTMF Decoder power down off function. More...
 
uint8_t dtmfdecoder_delayed_steering_check (dtmfdecoder_t *ctx)
 DTMF Decoder check delayed steering function. More...
 
uint8_t dtmfdecoder_tone_read (dtmfdecoder_t *ctx)
 DTMF Decoder read tone function. More...
 

Detailed Description

This file contains API for DTMF Decoder Click Driver.

Enumeration Type Documentation

◆ dtmfdecoder_return_value_t

DTMF Decoder Click return value data.

Predefined enum values for driver return values.

Enumerator
DTMFDECODER_OK 
DTMFDECODER_ERROR