dtmfdecoder
2.0.0.0
|
API for configuring and manipulating DTMF Decoder Click driver. More...
Modules | |
DTMF Decoder Command List | |
List of command bytes of DTMF Decoder Click driver. | |
DTMF Decoder Registers Settings | |
Settings for registers of DTMF Decoder Click driver. | |
DTMF Decoder MikroBUS Map | |
MikroBUS pin mapping of DTMF Decoder Click driver. | |
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... | |
API for configuring and manipulating DTMF Decoder Click driver.
void dtmfdecoder_cfg_setup | ( | dtmfdecoder_cfg_t * | cfg | ) |
DTMF Decoder configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See dtmfdecoder_cfg_t object definition for detailed explanation. |
void dtmfdecoder_default_cfg | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder default configuration function.
This function executes a default configuration of DTMF Decoder click board.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
uint8_t dtmfdecoder_delayed_steering_check | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder check delayed steering function.
This function checks the state of the StD pin.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
1
- Tone-pair has been registered, 0
- Voltage on St/GT is below VTSt. err_t dtmfdecoder_generic_read | ( | dtmfdecoder_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | rx_buf, | ||
uint8_t | rx_len | ||
) |
DTMF Decoder I2C reading function.
This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | rx_buf | : Output read data. |
[in] | rx_len | : Number of bytes to be read. |
0
- Success, -1
- Error.err_t dtmfdecoder_generic_write | ( | dtmfdecoder_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | tx_buf, | ||
uint8_t | tx_len | ||
) |
DTMF Decoder I2C writing function.
This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[in] | tx_buf | : Data to be written. |
[in] | tx_len | : Number of bytes to be written. |
0
- Success, -1
- Error.void dtmfdecoder_inhibit_off | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder inhibit off function.
This function allows the detection of tones representing characters A, B, C and D.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
void dtmfdecoder_inhibit_on | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder inhibit on function.
This function inhibits the detection of tones representing characters A, B, C and D.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
err_t dtmfdecoder_init | ( | dtmfdecoder_t * | ctx, |
dtmfdecoder_cfg_t * | cfg | ||
) |
DTMF Decoder initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See dtmfdecoder_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void dtmfdecoder_powerdown_off | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder power down off function.
This function powers up the device and along with the oscillator.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
void dtmfdecoder_powerdown_on | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder power down on function.
This function powers down the device and inhibits the oscillator.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |
uint8_t dtmfdecoder_tone_read | ( | dtmfdecoder_t * | ctx | ) |
DTMF Decoder read tone function.
This function reads a last registered tone and returns decoded data in character format.
[in] | ctx | : Click context object. See dtmfdecoder_t object definition for detailed explanation. |