spirit
2.0.0.0
|
Functions | |
void | spirit_cfg_setup (spirit_cfg_t *cfg) |
Config Object Initialization function. More... | |
SPIRIT_RETVAL | spirit_init (spirit_t *ctx, spirit_cfg_t *cfg) |
Initialization function. More... | |
void | spirit_power_module (spirit_t *ctx, uint8_t power_state) |
Power module function. More... | |
void | spirit_reset (spirit_t *ctx) |
Software reset function. More... | |
void | spirit_set_mode (spirit_t *ctx, uint8_t mode) |
Set mode function. More... | |
void | spirit_generic_write (spirit_t *ctx, char *data_buf, uint16_t len) |
Generic write function. More... | |
int32_t | spirit_generic_read (spirit_t *ctx, char *data_buf, uint16_t max_len) |
Generic read function. More... | |
void | spirit_send_cmd (spirit_t *ctx, char *cmd) |
Send command function. More... | |
void | spirit_send_cmd_with_parameter (spirit_t *ctx, char *at_cmd_buf, char *param_buf) |
Send command function with parameter. More... | |
void | spirit_send_cmd_check (spirit_t *ctx, char *at_cmd_buf) |
Check the sent command. More... | |
void | spirit_send_cmd_parameter_check (spirit_t *ctx, char *at_cmd_buf) |
Check the command parameters. More... | |
void spirit_cfg_setup | ( | spirit_cfg_t * | cfg | ) |
Config Object Initialization function.
cfg | Click configuration structure. |
@description This function initializes click configuration structure to init state.
int32_t spirit_generic_read | ( | spirit_t * | ctx, |
char * | data_buf, | ||
uint16_t | max_len | ||
) |
Generic read function.
ctx | Click object. |
data_buf | Data buffer for read data. |
max_len | The maximum length of data that can be read. |
void spirit_generic_write | ( | spirit_t * | ctx, |
char * | data_buf, | ||
uint16_t | len | ||
) |
Generic write function.
ctx | Click object. |
data_buf | Data buffer for sends. |
len | Number of bytes for sends. |
SPIRIT_RETVAL spirit_init | ( | spirit_t * | ctx, |
spirit_cfg_t * | cfg | ||
) |
Initialization function.
spirit | Click object. |
cfg | Click configuration structure. |
@description This function initializes all necessary pins and peripherals used for this click.
void spirit_power_module | ( | spirit_t * | ctx, |
uint8_t | power_state | ||
) |
Power module function.
ctx | Click object. |
power_state | State of PWM pin |
void spirit_reset | ( | spirit_t * | ctx | ) |
Software reset function.
ctx | Click object. |
void spirit_send_cmd | ( | spirit_t * | ctx, |
char * | cmd | ||
) |
Send command function.
This function sends the specified command to the click module.
[in] | ctx | : Click context object. See spirit_t object definition for detailed explanation. |
[in] | cmd | Command variable. |
void spirit_send_cmd_check | ( | spirit_t * | ctx, |
char * | at_cmd_buf | ||
) |
Check the sent command.
This function checks the command that is sent.
[in] | ctx | : Click context object. See spirit_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void spirit_send_cmd_parameter_check | ( | spirit_t * | ctx, |
char * | at_cmd_buf | ||
) |
Check the command parameters.
This function checks the command that is sent.
[in] | ctx | : Click context object. See spirit_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void spirit_send_cmd_with_parameter | ( | spirit_t * | ctx, |
char * | at_cmd_buf, | ||
char * | param_buf | ||
) |
Send command function with parameter.
This function sends commands to the click module.
[in] | ctx | : Click context object. See spirit_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
[in] | param_buf | Parameter buffer. |
void spirit_set_mode | ( | spirit_t * | ctx, |
uint8_t | mode | ||
) |
Set mode function.
ctx | Click object. |
mode | Set mode. |