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 "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define OBDII_CMD_FIRMWARE_VERSION "ATI"
70 #define OBDII_CMD_DISABLE_ECHO "ATE0"
71 #define OBDII_CMD_ENABLE_ECHO "ATE1"
72 #define OBDII_CMD_AUTO_PROTOCOL "ATSP0"
73 #define OBDII_CMD_SPACES_OFF "ATS0"
74 #define OBDII_CMD_RESET_DEFAULT "ATD"
75 #define OBDII_CMD_RESET_DEVICE "ATZ"
76 #define OBDII_CMD_GET_CURRENT_RPM "010C"
77 #define OBDII_CMD_GET_CURRENT_SPEED "010D"
78 
83 #define OBDII_RSP_OK "OK"
84 #define OBDII_RSP_UNKNOWN_CMD "ERROR"
85 #define OBDII_RSP_PROMPT ">"
86 #define OBDII_RSP_CURRENT_RPM "410C"
87 #define OBDII_RSP_CURRENT_SPEED "410D"
88 
94 #define OBDII_TX_DRV_BUFFER_SIZE 100
95 #define OBDII_RX_DRV_BUFFER_SIZE 300
96  // obdii_cmd
98 
113 #define OBDII_MAP_MIKROBUS( cfg, mikrobus ) \
114  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
115  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
116  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
117  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
118  // obdii_map // obdii
121 
126 typedef struct
127 {
128  // Output pins
129  digital_out_t rst;
131  // Input pins
132  digital_in_t int_pin;
134  // Modules
135  uart_t uart;
137  // Buffers
138  uint8_t uart_rx_buffer[ OBDII_RX_DRV_BUFFER_SIZE ];
139  uint8_t uart_tx_buffer[ OBDII_TX_DRV_BUFFER_SIZE ];
141 } obdii_t;
142 
147 typedef struct
148 {
149  // Communication gpio pins
150  pin_name_t rx_pin;
151  pin_name_t tx_pin;
153  // Additional gpio pins
154  pin_name_t rst;
155  pin_name_t int_pin;
157  // Static variable
158  uint32_t baud_rate;
160  uart_data_bits_t data_bit;
161  uart_parity_t parity_bit;
162  uart_stop_bits_t stop_bit;
164 } obdii_cfg_t;
165 
170 typedef enum
171 {
172  OBDII_OK = 0,
175 
177 
194 
208 err_t obdii_init ( obdii_t *ctx, obdii_cfg_t *cfg );
209 
222 err_t obdii_generic_write ( obdii_t *ctx, uint8_t *data_in, uint16_t len );
223 
236 err_t obdii_generic_read ( obdii_t *ctx, uint8_t *data_out, uint16_t len );
237 
249 void obdii_send_command ( obdii_t *ctx, uint8_t *cmd );
250 
260 
270 void obdii_set_rst_pin ( obdii_t *ctx, uint8_t state );
271 
280 uint8_t obdii_get_int_pin ( obdii_t *ctx );
281 
282 #ifdef __cplusplus
283 }
284 #endif
285 #endif // OBDII_H
286  // obdii
288 
289 // ------------------------------------------------------------------------ END
OBDII_ERROR
@ OBDII_ERROR
Definition: obdii.h:173
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:150
obdii_cfg_t
OBDII Click configuration object.
Definition: obdii.h:148
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:155
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:135
obdii_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: obdii.h:160
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:95
obdii_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: obdii.h:162
obdii_t::rst
digital_out_t rst
Definition: obdii.h:129
OBDII_TX_DRV_BUFFER_SIZE
#define OBDII_TX_DRV_BUFFER_SIZE
OBDII driver buffer size.
Definition: obdii.h:94
obdii_cfg_t::baud_rate
uint32_t baud_rate
Definition: obdii.h:158
obdii_cfg_t::uart_blocking
bool uart_blocking
Definition: obdii.h:159
obdii_return_value_t
obdii_return_value_t
OBDII Click return value data.
Definition: obdii.h:171
obdii_t
OBDII Click context object.
Definition: obdii.h:127
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:161
obdii_cfg_t::tx_pin
pin_name_t tx_pin
Definition: obdii.h:151
OBDII_OK
@ OBDII_OK
Definition: obdii.h:172
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:174
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:154
obdii_t::int_pin
digital_in_t int_pin
Definition: obdii.h:132