gnssrtk  2.0.0.0
Modules | Functions
GNSS RTK Click Driver

API for configuring and manipulating GNSS RTK Click driver. More...

Modules

 GNSS RTK MikroBUS Map
 MikroBUS pin mapping of GNSS RTK Click driver.
 
 Element
 
 Gnssrtk_error_t
 
 Command
 
 Gnssrtk_set
 

Functions

void gnssrtk_cfg_setup (gnssrtk_cfg_t *cfg)
 GNSS RTK configuration object setup function. More...
 
err_t gnssrtk_init (gnssrtk_t *ctx, gnssrtk_cfg_t *cfg)
 GNSS RTK initialization function. More...
 
void gnssrtk_default_cfg (gnssrtk_t *ctx)
 GNSS RTK default configuration function. More...
 
void gnssrtk_module_cold_start (gnssrtk_t *ctx)
 Module cold start function. More...
 
void gnssrtk_set_rst_pin (gnssrtk_t *ctx, uint8_t state)
 Set rst pin function. More...
 
uint8_t gnssrtk_get_rdy_pin (gnssrtk_t *ctx)
 Check rdy pin function. More...
 
uint8_t gnssrtk_get_rtk_pin (gnssrtk_t *ctx)
 Check rtk pin function. More...
 
uint8_t gnssrtk_get_tmp_pin (gnssrtk_t *ctx)
 Check tmp pin function. More...
 
err_t gnssrtk_generic_write (gnssrtk_t *ctx, char *data_buf, uint16_t len)
 GNSS RTK data writing function. More...
 
err_t gnssrtk_generic_read (gnssrtk_t *ctx, char *data_buf, uint16_t max_len)
 GNSS RTK data reading function. More...
 
gnssrtk_error_t gnssrtk_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function. More...
 

Detailed Description

API for configuring and manipulating GNSS RTK Click driver.

Function Documentation

◆ gnssrtk_cfg_setup()

void gnssrtk_cfg_setup ( gnssrtk_cfg_t cfg)

GNSS RTK configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See gnssrtk_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ gnssrtk_default_cfg()

void gnssrtk_default_cfg ( gnssrtk_t ctx)

GNSS RTK default configuration function.

This function executes a default configuration of GNSS RTK click board.

Parameters
[in]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ gnssrtk_generic_parser()

gnssrtk_error_t gnssrtk_generic_parser ( char *  rsp,
uint8_t  command,
uint8_t  element,
char *  parser_buf 
)

Generic parser function.

Parameters
[in]rspResponse buffer intended for parsing.
[in]commandNMEA ( GPS/GNSS ) command.
[in]elementElement position in command.
[out]parser_bufParser buffer for data storage.
Returns
GNSS RTK error code.

See gnssrtk_error_t definition for detailed explanation.

Note
None.

◆ gnssrtk_generic_read()

err_t gnssrtk_generic_read ( gnssrtk_t ctx,
char *  data_buf,
uint16_t  max_len 
)

GNSS RTK data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
[out]data_buf: Output read data.
[in]max_len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer.
See #err_t definition for detailed explanation.
Note
None.

◆ gnssrtk_generic_write()

err_t gnssrtk_generic_write ( gnssrtk_t ctx,
char *  data_buf,
uint16_t  len 
)

GNSS RTK data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
[in]data_buf: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ gnssrtk_get_rdy_pin()

uint8_t gnssrtk_get_rdy_pin ( gnssrtk_t ctx)

Check rdy pin function.

This function checks if the buffer is full and ready for transmition of data from the module. Return depends on the configuration of the polarity. By default, this feature is disabled.

Parameters
[in]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
Returns
  • 0 - Bytes are not ready for transmition,
  • 1 - Bytes are ready to be transmitted.
Note
None.

◆ gnssrtk_get_rtk_pin()

uint8_t gnssrtk_get_rtk_pin ( gnssrtk_t ctx)

Check rtk pin function.

This function checks the RTK_STAT of the module.

Parameters
[in]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
Returns
  • 0 - RTK fixed,
  • 1 - No carrier phase solution is available.
Note
None.

◆ gnssrtk_get_tmp_pin()

uint8_t gnssrtk_get_tmp_pin ( gnssrtk_t ctx)

Check tmp pin function.

This function checks the timepulse pin of the module which triggers periodically.

Parameters
[in]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
Returns
  • 0 - Timepulse status is inactive or low during period,
  • 1 - Timepulse status is triggered for a period of time.
Note
None.

◆ gnssrtk_init()

err_t gnssrtk_init ( gnssrtk_t ctx,
gnssrtk_cfg_t cfg 
)

GNSS RTK initialization function.

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

Parameters
[out]ctx: Click context object. See gnssrtk_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See gnssrtk_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ gnssrtk_module_cold_start()

void gnssrtk_module_cold_start ( gnssrtk_t ctx)

Module cold start function.

Resets the module receiver.

Parameters
[in]ctx: Click context object.
Note
None.

◆ gnssrtk_set_rst_pin()

void gnssrtk_set_rst_pin ( gnssrtk_t ctx,
uint8_t  state 
)

Set rst pin function.

This function sets the state of RST pin.

Parameters
ctxClick object.
[in]state:
  • 0 - Sets RST pin low.
  • 1 - Sets RST pin high.
Note
None.