dtmfgenerator 2.0.0.0
dtmfgenerator.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  dtmfgenerator_t
 DTMF Generator Click context object. More...
 
struct  dtmfgenerator_cfg_t
 DTMF Generator Click configuration object. More...
 

Macros

#define DTMFGENERATOR_OUT_TONE_0   0x00
 DTMF Generator description setting.
 
#define DTMFGENERATOR_OUT_TONE_1   0x01
 
#define DTMFGENERATOR_OUT_TONE_2   0x02
 
#define DTMFGENERATOR_OUT_TONE_3   0x03
 
#define DTMFGENERATOR_OUT_TONE_4   0x04
 
#define DTMFGENERATOR_OUT_TONE_5   0x05
 
#define DTMFGENERATOR_OUT_TONE_6   0x06
 
#define DTMFGENERATOR_OUT_TONE_7   0x07
 
#define DTMFGENERATOR_OUT_TONE_8   0x08
 
#define DTMFGENERATOR_OUT_TONE_9   0x09
 
#define DTMFGENERATOR_OUT_TONE_A   0x0A
 
#define DTMFGENERATOR_OUT_TONE_B   0x0B
 
#define DTMFGENERATOR_OUT_TONE_C   0x0C
 
#define DTMFGENERATOR_OUT_TONE_D   0x0D
 
#define DTMFGENERATOR_OUT_TONE_ASTERISK   0x0E
 
#define DTMFGENERATOR_OUT_TONE_HASH   0x0F
 
#define DTMFGENERATOR_OUT_TONE_STOP   0x10
 
#define DTMFGENERATOR_GPIO_PIN_STATE_LOW   0x00
 
#define DTMFGENERATOR_GPIO_PIN_STATE_HIGH   0x01
 
#define DTMFGENERATOR_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  dtmfgenerator_return_value_t { DTMFGENERATOR_OK = 0 , DTMFGENERATOR_ERROR = -1 }
 DTMF Generator Click return value data. More...
 

Functions

void dtmfgenerator_cfg_setup (dtmfgenerator_cfg_t *cfg)
 DTMF Generator configuration object setup function.
 
err_t dtmfgenerator_init (dtmfgenerator_t *ctx, dtmfgenerator_cfg_t *cfg)
 DTMF Generator initialization function.
 
void dtmfgenerator_set_dat (dtmfgenerator_t *ctx, uint8_t pin_state)
 Set DATA ( RST ) pin state function.
 
void dtmfgenerator_set_ce (dtmfgenerator_t *ctx, uint8_t pin_state)
 Set CE ( CS ) pin state function.
 
void dtmfgenerator_set_clk (dtmfgenerator_t *ctx, uint8_t pin_state)
 Set CLK ( PWM ) pin state function.
 
void dtmfgenerator_power_on (dtmfgenerator_t *ctx)
 Power ON function.
 
void dtmfgenerator_transmit_out_tone (dtmfgenerator_t *ctx, uint8_t out_tone, uint16_t delay_m_s)
 Transmit output tone function.
 

Detailed Description

This file contains API for DTMF Generator Click Driver.

Enumeration Type Documentation

◆ dtmfgenerator_return_value_t

DTMF Generator Click return value data.

Predefined enum values for driver return values.

Enumerator
DTMFGENERATOR_OK 
DTMFGENERATOR_ERROR