spirit  2.0.0.0
Functions
Public function

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...
 

Detailed Description

Function Documentation

◆ spirit_cfg_setup()

void spirit_cfg_setup ( spirit_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ spirit_generic_read()

int32_t spirit_generic_read ( spirit_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

Parameters
ctxClick object.
data_bufData buffer for read data.
max_lenThe maximum length of data that can be read.
Returns
Number of reads data.

◆ spirit_generic_write()

void spirit_generic_write ( spirit_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

Parameters
ctxClick object.
data_bufData buffer for sends.
lenNumber of bytes for sends.

◆ spirit_init()

SPIRIT_RETVAL spirit_init ( spirit_t ctx,
spirit_cfg_t cfg 
)

Initialization function.

Parameters
spiritClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ spirit_power_module()

void spirit_power_module ( spirit_t ctx,
uint8_t  power_state 
)

Power module function.

Parameters
ctxClick object.
power_stateState of PWM pin

◆ spirit_reset()

void spirit_reset ( spirit_t ctx)

Software reset function.

Parameters
ctxClick object.

◆ spirit_send_cmd()

void spirit_send_cmd ( spirit_t ctx,
char *  cmd 
)

Send command function.

This function sends the specified command to the click module.

Parameters
[in]ctx: Click context object. See spirit_t object definition for detailed explanation.
[in]cmdCommand variable.
Returns
Nothing.

◆ spirit_send_cmd_check()

void spirit_send_cmd_check ( spirit_t ctx,
char *  at_cmd_buf 
)

Check the sent command.

This function checks the command that is sent.

Parameters
[in]ctx: Click context object. See spirit_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
Returns
Nothing.

◆ spirit_send_cmd_parameter_check()

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.

Parameters
[in]ctx: Click context object. See spirit_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
Returns
Nothing.

◆ spirit_send_cmd_with_parameter()

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.

Parameters
[in]ctx: Click context object. See spirit_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
[in]param_bufParameter buffer.
Returns
Nothing.

◆ spirit_set_mode()

void spirit_set_mode ( spirit_t ctx,
uint8_t  mode 
)

Set mode function.

Parameters
ctxClick object.
modeSet mode.