obdii  2.0.0.0
Functions
Public function

Functions

void obdii_cfg_setup (obdii_cfg_t *cfg)
 Config Object Initialization function. More...
 
OBDII_RETVAL obdii_init (obdii_t *ctx, obdii_cfg_t *cfg)
 Initialization function. More...
 
void obdii_module_reset (obdii_t *ctx)
 Reset module. More...
 
uint8_t obdii_get_int_pin (obdii_t *ctx)
 Get INT pin state. More...
 
void obdii_generic_write (obdii_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t obdii_generic_read (obdii_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void obdii_send_command (obdii_t *ctx, char *command)
 Function for send command. More...
 

Detailed Description

Function Documentation

◆ obdii_cfg_setup()

void obdii_cfg_setup ( obdii_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.

◆ obdii_generic_read()

int32_t obdii_generic_read ( obdii_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

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

◆ obdii_generic_write()

void obdii_generic_write ( obdii_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

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

◆ obdii_get_int_pin()

uint8_t obdii_get_int_pin ( obdii_t ctx)

Get INT pin state.

Parameters
obdiiClick object.
Returns
current pin state.

◆ obdii_init()

OBDII_RETVAL obdii_init ( obdii_t ctx,
obdii_cfg_t cfg 
)

Initialization function.

Parameters
obdiiClick object.
cfgClick configuration structure.

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

◆ obdii_module_reset()

void obdii_module_reset ( obdii_t ctx)

Reset module.

Parameters
obdiiClick object.

◆ obdii_send_command()

void obdii_send_command ( obdii_t ctx,
char *  command 
)

Function for send command.

Parameters
ctxClick object.
commandData to be send.