obdii 2.1.0.0
obdii.h File Reference

This file contains API for OBDII Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  obdii_t
 OBDII Click context object. More...
 
struct  obdii_cfg_t
 OBDII Click configuration object. More...
 

Macros

#define OBDII_CMD_FIRMWARE_VERSION   "ATI"
 OBDII control commands.
 
#define OBDII_CMD_DISABLE_ECHO   "ATE0"
 
#define OBDII_CMD_ENABLE_ECHO   "ATE1"
 
#define OBDII_CMD_AUTO_PROTOCOL   "ATSP0"
 
#define OBDII_CMD_SPACES_OFF   "ATS0"
 
#define OBDII_CMD_RESET_DEFAULT   "ATD"
 
#define OBDII_CMD_RESET_DEVICE   "ATZ"
 
#define OBDII_CMD_GET_CURRENT_RPM   "010C"
 
#define OBDII_CMD_GET_CURRENT_SPEED   "010D"
 
#define OBDII_RSP_OK   "OK"
 OBDII device response for AT commands.
 
#define OBDII_RSP_UNKNOWN_CMD   "ERROR"
 
#define OBDII_RSP_PROMPT   ">"
 
#define OBDII_RSP_CURRENT_RPM   "410C"
 
#define OBDII_RSP_CURRENT_SPEED   "410D"
 
#define OBDII_TX_DRV_BUFFER_SIZE   100
 OBDII driver buffer size.
 
#define OBDII_RX_DRV_BUFFER_SIZE   300
 
#define OBDII_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  obdii_return_value_t { OBDII_OK = 0 , OBDII_ERROR = -1 , OBDII_ERROR_TIMEOUT = -2 }
 OBDII Click return value data. More...
 

Functions

void obdii_cfg_setup (obdii_cfg_t *cfg)
 OBDII configuration object setup function.
 
err_t obdii_init (obdii_t *ctx, obdii_cfg_t *cfg)
 OBDII initialization function.
 
err_t obdii_generic_write (obdii_t *ctx, uint8_t *data_in, uint16_t len)
 OBDII data writing function.
 
err_t obdii_generic_read (obdii_t *ctx, uint8_t *data_out, uint16_t len)
 OBDII data reading function.
 
void obdii_send_command (obdii_t *ctx, uint8_t *cmd)
 OBDII send command function.
 
void obdii_reset_device (obdii_t *ctx)
 OBDII reset device function.
 
void obdii_set_rst_pin (obdii_t *ctx, uint8_t state)
 OBDII set rst pin function.
 
uint8_t obdii_get_int_pin (obdii_t *ctx)
 OBDII get int pin function.
 

Detailed Description

This file contains API for OBDII Click Driver.

Enumeration Type Documentation

◆ obdii_return_value_t

OBDII Click return value data.

Predefined enum values for driver return values.

Enumerator
OBDII_OK 
OBDII_ERROR 
OBDII_ERROR_TIMEOUT