thingstream  2.0.0.0
Functions

Functions

void thingstream_cfg_setup (thingstream_cfg_t *cfg)
 Config Object Initialization function. More...
 
THINGSTREAM_RETVAL thingstream_init (thingstream_t *ctx, thingstream_cfg_t *cfg)
 Initialization function. More...
 
void thingstream_module_power (thingstream_t *ctx, uint8_t power_state)
 Power module. More...
 
uint8_t thingstream_reset_pin_state (thingstream_t *ctx, uint8_t state)
 Set RST pin state. More...
 
void thingstream_generic_write (thingstream_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t thingstream_generic_read (thingstream_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void thingstream_send_command (thingstream_t *ctx, char *command)
 Send command. More...
 
thingstream_error_t thingstream_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function. More...
 

Detailed Description

Function Documentation

◆ thingstream_cfg_setup()

void thingstream_cfg_setup ( thingstream_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.

◆ thingstream_generic_parser()

thingstream_error_t thingstream_generic_parser ( char *  rsp,
uint8_t  command,
uint8_t  element,
char *  parser_buf 
)

Generic parser function.

Parameters
ctxClick object.
commandNEMA ( GPS/GNSS ) command.
elementElement position in command.
parser_bufParser buffer for data storage.
Returns
error data

◆ thingstream_generic_read()

int32_t thingstream_generic_read ( thingstream_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.

◆ thingstream_generic_write()

void thingstream_generic_write ( thingstream_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

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

◆ thingstream_init()

THINGSTREAM_RETVAL thingstream_init ( thingstream_t ctx,
thingstream_cfg_t cfg 
)

Initialization function.

Parameters
thingstreamClick object.
cfgClick configuration structure.

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

◆ thingstream_module_power()

void thingstream_module_power ( thingstream_t ctx,
uint8_t  power_state 
)

Power module.

Parameters
ctxClick object.
power_stateState of pin.

◆ thingstream_reset_pin_state()

uint8_t thingstream_reset_pin_state ( thingstream_t ctx,
uint8_t  state 
)

Set RST pin state.

Parameters
ctxClick object.
statePin state ( 1 or 0 ).

◆ thingstream_send_command()

void thingstream_send_command ( thingstream_t ctx,
char *  command 
)

Send command.

Parameters
ctxClick object.
commandCommand to send.