obdii  2.1.0.0
obdii.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef OBDII_H
29 #define OBDII_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define OBDII_CMD_FIRMWARE_VERSION "ATI"
60 #define OBDII_CMD_DISABLE_ECHO "ATE0"
61 #define OBDII_CMD_ENABLE_ECHO "ATE1"
62 #define OBDII_CMD_AUTO_PROTOCOL "ATSP0"
63 #define OBDII_CMD_SPACES_OFF "ATS0"
64 #define OBDII_CMD_RESET_DEFAULT "ATD"
65 #define OBDII_CMD_RESET_DEVICE "ATZ"
66 #define OBDII_CMD_GET_CURRENT_RPM "010C"
67 #define OBDII_CMD_GET_CURRENT_SPEED "010D"
68 
73 #define OBDII_RSP_OK "OK"
74 #define OBDII_RSP_UNKNOWN_CMD "ERROR"
75 #define OBDII_RSP_PROMPT ">"
76 #define OBDII_RSP_CURRENT_RPM "410C"
77 #define OBDII_RSP_CURRENT_SPEED "410D"
78 
84 #define OBDII_TX_DRV_BUFFER_SIZE 100
85 #define OBDII_RX_DRV_BUFFER_SIZE 300
86  // obdii_cmd
88 
103 #define OBDII_MAP_MIKROBUS( cfg, mikrobus ) \
104  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
105  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
106  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
107  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
108  // obdii_map // obdii
111 
116 typedef struct
117 {
118  // Output pins
119  digital_out_t rst;
121  // Input pins
122  digital_in_t int_pin;
124  // Modules
125  uart_t uart;
127  // Buffers
128  uint8_t uart_rx_buffer[ OBDII_RX_DRV_BUFFER_SIZE ];
129  uint8_t uart_tx_buffer[ OBDII_TX_DRV_BUFFER_SIZE ];
131 } obdii_t;
132 
137 typedef struct
138 {
139  // Communication gpio pins
140  pin_name_t rx_pin;
141  pin_name_t tx_pin;
143  // Additional gpio pins
144  pin_name_t rst;
145  pin_name_t int_pin;
147  // Static variable
148  uint32_t baud_rate;
150  uart_data_bits_t data_bit;
151  uart_parity_t parity_bit;
152  uart_stop_bits_t stop_bit;
154 } obdii_cfg_t;
155 
160 typedef enum
161 {
162  OBDII_OK = 0,
165 
167 
184 
198 err_t obdii_init ( obdii_t *ctx, obdii_cfg_t *cfg );
199 
212 err_t obdii_generic_write ( obdii_t *ctx, uint8_t *data_in, uint16_t len );
213 
226 err_t obdii_generic_read ( obdii_t *ctx, uint8_t *data_out, uint16_t len );
227 
239 void obdii_send_command ( obdii_t *ctx, uint8_t *cmd );
240 
250 
260 void obdii_set_rst_pin ( obdii_t *ctx, uint8_t state );
261 
270 uint8_t obdii_get_int_pin ( obdii_t *ctx );
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 #endif // OBDII_H
276  // obdii
278 
279 // ------------------------------------------------------------------------ END
OBDII_ERROR
@ OBDII_ERROR
Definition: obdii.h:163
obdii_generic_write
err_t obdii_generic_write(obdii_t *ctx, uint8_t *data_in, uint16_t len)
OBDII data writing function.
obdii_cfg_t::rx_pin
pin_name_t rx_pin
Definition: obdii.h:140
obdii_cfg_t
OBDII Click configuration object.
Definition: obdii.h:138
obdii_reset_device
void obdii_reset_device(obdii_t *ctx)
OBDII reset device function.
obdii_cfg_t::int_pin
pin_name_t int_pin
Definition: obdii.h:145
obdii_send_command
void obdii_send_command(obdii_t *ctx, uint8_t *cmd)
OBDII send command function.
obdii_get_int_pin
uint8_t obdii_get_int_pin(obdii_t *ctx)
OBDII get int pin function.
obdii_t::uart
uart_t uart
Definition: obdii.h:125
obdii_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: obdii.h:150
obdii_generic_read
err_t obdii_generic_read(obdii_t *ctx, uint8_t *data_out, uint16_t len)
OBDII data reading function.
OBDII_RX_DRV_BUFFER_SIZE
#define OBDII_RX_DRV_BUFFER_SIZE
Definition: obdii.h:85
obdii_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: obdii.h:152
obdii_t::rst
digital_out_t rst
Definition: obdii.h:119
OBDII_TX_DRV_BUFFER_SIZE
#define OBDII_TX_DRV_BUFFER_SIZE
OBDII driver buffer size.
Definition: obdii.h:84
obdii_cfg_t::baud_rate
uint32_t baud_rate
Definition: obdii.h:148
obdii_cfg_t::uart_blocking
bool uart_blocking
Definition: obdii.h:149
obdii_return_value_t
obdii_return_value_t
OBDII Click return value data.
Definition: obdii.h:161
obdii_t
OBDII Click context object.
Definition: obdii.h:117
obdii_set_rst_pin
void obdii_set_rst_pin(obdii_t *ctx, uint8_t state)
OBDII set rst pin function.
obdii_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: obdii.h:151
obdii_cfg_t::tx_pin
pin_name_t tx_pin
Definition: obdii.h:141
OBDII_OK
@ OBDII_OK
Definition: obdii.h:162
obdii_init
err_t obdii_init(obdii_t *ctx, obdii_cfg_t *cfg)
OBDII initialization function.
OBDII_ERROR_TIMEOUT
@ OBDII_ERROR_TIMEOUT
Definition: obdii.h:164
obdii_cfg_setup
void obdii_cfg_setup(obdii_cfg_t *cfg)
OBDII configuration object setup function.
obdii_cfg_t::rst
pin_name_t rst
Definition: obdii.h:144
obdii_t::int_pin
digital_in_t int_pin
Definition: obdii.h:122