dtmfgenerator
2.0.0.0
|
API for configuring and manipulating DTMF Generator Click driver. More...
Modules | |
DTMF Generator Registers Settings | |
Settings for registers of DTMF Generator Click driver. | |
DTMF Generator MikroBUS Map | |
MikroBUS pin mapping of DTMF Generator Click driver. | |
Functions | |
void | dtmfgenerator_cfg_setup (dtmfgenerator_cfg_t *cfg) |
DTMF Generator configuration object setup function. More... | |
err_t | dtmfgenerator_init (dtmfgenerator_t *ctx, dtmfgenerator_cfg_t *cfg) |
DTMF Generator initialization function. More... | |
void | dtmfgenerator_set_dat (dtmfgenerator_t *ctx, uint8_t pin_state) |
Set DATA ( RST ) pin state function. More... | |
void | dtmfgenerator_set_ce (dtmfgenerator_t *ctx, uint8_t pin_state) |
Set CE ( CS ) pin state function. More... | |
void | dtmfgenerator_set_clk (dtmfgenerator_t *ctx, uint8_t pin_state) |
Set CLK ( PWM ) pin state function. More... | |
void | dtmfgenerator_power_on (dtmfgenerator_t *ctx) |
Power ON function. More... | |
void | dtmfgenerator_transmit_out_tone (dtmfgenerator_t *ctx, uint8_t out_tone, uint16_t delay_m_s) |
Transmit output tone function. More... | |
API for configuring and manipulating DTMF Generator Click driver.
void dtmfgenerator_cfg_setup | ( | dtmfgenerator_cfg_t * | cfg | ) |
DTMF Generator configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See dtmfgenerator_cfg_t object definition for detailed explanation. |
err_t dtmfgenerator_init | ( | dtmfgenerator_t * | ctx, |
dtmfgenerator_cfg_t * | cfg | ||
) |
DTMF Generator initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See dtmfgenerator_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See dtmfgenerator_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void dtmfgenerator_power_on | ( | dtmfgenerator_t * | ctx | ) |
Power ON function.
The function run the power-on sequence.
[in] | ctx | : Click context object. See dtmfgenerator_t object definition for detailed explanation. |
void dtmfgenerator_set_ce | ( | dtmfgenerator_t * | ctx, |
uint8_t | pin_state | ||
) |
Set CE ( CS ) pin state function.
The function set CE ( CS ) pin state.
[out] | ctx | : Click context object. See dtmfgenerator_t object definition for detailed explanation. |
[in] | pin_state | : The RST the pin state ( low or high ). |
void dtmfgenerator_set_clk | ( | dtmfgenerator_t * | ctx, |
uint8_t | pin_state | ||
) |
Set CLK ( PWM ) pin state function.
The function set CLK ( PWM ) pin state.
[out] | ctx | : Click context object. See dtmfgenerator_t object definition for detailed explanation. |
[in] | pin_state | : The PWM the pin state ( low or high ). |
void dtmfgenerator_set_dat | ( | dtmfgenerator_t * | ctx, |
uint8_t | pin_state | ||
) |
Set DATA ( RST ) pin state function.
The function set DATA ( RST ) pin state.
[out] | ctx | : Click context object. See dtmfgenerator_t object definition for detailed explanation. |
[in] | pin_state | : The RST the pin state ( low or high ). |
void dtmfgenerator_transmit_out_tone | ( | dtmfgenerator_t * | ctx, |
uint8_t | out_tone, | ||
uint16_t | delay_m_s | ||
) |
Transmit output tone function.
The function transmit duration time of the desired tone.
[in] | ctx | : Click context object. See dtmfgenerator_t object definition for detailed explanation. |
[in] | out_tone | : The tone for digit that is being sent to the DTMF Generator. |
[in] | delay_m_s | : 16-bit tone duration time in milliseconds. |