obdii.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef OBDII_H
#define OBDII_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define OBDII_CMD_FIRMWARE_VERSION      "ATI"
#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"
#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
#define OBDII_RX_DRV_BUFFER_SIZE        300
 
 // obdii_cmd
 
#define OBDII_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // obdii_map
 // obdii
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Input pins
    digital_in_t int_pin;       
    // Modules
    uart_t uart;                
    // Buffers
    uint8_t uart_rx_buffer[ OBDII_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ OBDII_TX_DRV_BUFFER_SIZE ];  
} obdii_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;          
    pin_name_t tx_pin;          
    // Additional gpio pins
    pin_name_t rst;             
    pin_name_t int_pin;         
    // Static variable
    uint32_t         baud_rate;         
    bool             uart_blocking;     
    uart_data_bits_t data_bit;          
    uart_parity_t    parity_bit;        
    uart_stop_bits_t stop_bit;          
} obdii_cfg_t;
 
typedef enum
{
    OBDII_OK = 0,
    OBDII_ERROR = -1,
    OBDII_ERROR_TIMEOUT = -2
 
} obdii_return_value_t;
 
void obdii_cfg_setup ( obdii_cfg_t *cfg );
 
err_t obdii_init ( obdii_t *ctx, obdii_cfg_t *cfg );
 
err_t obdii_generic_write ( obdii_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t obdii_generic_read ( obdii_t *ctx, uint8_t *data_out, uint16_t len );
 
void obdii_send_command ( obdii_t *ctx, uint8_t *cmd );
 
void obdii_reset_device ( obdii_t *ctx );
 
void obdii_set_rst_pin ( obdii_t *ctx, uint8_t state );
 
uint8_t obdii_get_int_pin ( obdii_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // OBDII_H
 
 // obdii
 
// ------------------------------------------------------------------------ END