readme.rst

   1 .. SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
   2
   3 ELM327 driver for Linux SocketCAN
   4 ==================================
   5
   6 Out-of-tree version
   7 --------------------
   8
   9 This is the non-upstreamed version of the elmcan driver.
  10 Please see out-of-tree.rst for compilation/usage hints.
  11
  12
  13
  14 Authors
  15 --------
  16
  17 Max Staudt <max-linux@enpas.org>
  18
  19
  20
  21 Motivation
  22 -----------
  23
  24 This driver aims to lower the initial cost for hackers interested in
  25 working with CAN buses.
  26
  27 CAN adapters are expensive, few, and far between.
  28 ELM327 interfaces are cheap and plentiful.
  29 Let's use ELM327s as CAN adapters.
  30
  31
  32
  33 Introduction
  34 -------------
  35
  36 This driver is an effort to turn abundant ELM327 based OBD interfaces
  37 into full fledged (as far as possible) CAN interfaces.
  38
  39 Since the ELM327 was never meant to be a stand alone CAN controller,
  40 the driver has to switch between its modes as quickly as possible in
  41 order to fake full-duplex operation.
  42
  43 As such, elmcan is a best effort driver. However, this is more than
  44 enough to implement simple request-response protocols (such as OBD II),
  45 and to monitor broadcast messages on a bus (such as in a vehicle).
  46
  47 Most ELM327s come as nondescript serial devices, attached via USB or
  48 Bluetooth. The driver cannot recognize them by itself, and as such it
  49 is up to the user to attach it in form of a TTY line discipline
  50 (similar to PPP, SLIP, slcan, ...).
  51
  52 This driver is meant for ELM327 versions 1.4b and up, see below for
  53 known limitations in older controllers and clones.
  54
  55
  56
  57 Data sheet
  58 -----------
  59
  60 The official data sheets can be found at ELM electronics' home page:
  61
  62   https://www.elmelectronics.com/
  63
  64
  65
  66 How to check the controller version
  67 ------------------------------------
  68
  69 Use a terminal program to attach to the controller.
  70 The default settings are 38400 baud/s, 8 data bits, no parity, 1 stopbit.
  71
  72 After issuing the "``AT WS``" command, the controller will respond with
  73 its version::
  74
  75     >AT WS
  76
  77
  78     ELM327 v1.4b
  79
  80     >
  81
  82 Note that clones may claim to be any version they like.
  83 It is not indicative of their actual feature set.
  84
  85
  86
  87 How to attach the line discipline
  88 ----------------------------------
  89
  90 Every ELM327 chip is factory programmed to operate at a serial setting
  91 of 38400 baud/s, 8 data bits, no parity, 1 stopbit.
  92
  93 The line discipline can be attached on a command prompt as follows::
  94
  95     sudo ldattach \
  96            --debug \
  97            --speed 38400 \
  98            --eightbits \
  99            --noparity \
 100            --onestopbit \
 101            --iflag -ICRNL,INLCR,-IXOFF \
 102            29 \
 103            /dev/ttyUSB0
 104
 105 To change the ELM327's serial settings, please refer to its data
 106 sheet. This needs to be done before attaching the line discipline.
 107
 108
 109
 110 Known limitations of the controller
 111 ------------------------------------
 112
 113 - Clone devices ("v1.5" and others)
 114
 115   Sending RTR frames is not supported and will be dropped silently.
 116
 117   Receiving RTR with DLC 8 will appear to be a regular frame with
 118   the last received frame's DLC and payload.
 119
 120   "``AT CSM``" not supported, thus no ACK-ing frames while listening:
 121   "``AT MA``" will always be silent. However, immediately after
 122   sending a frame, the ELM327 will be in "receive reply" mode, in
 123   which it *does* ACK any received frames. Once the bus goes silent
 124   or an error occurs (such as BUFFER FULL), the ELM327 will end reply
 125   reception mode on its own and elmcan will fall back to "``AT MA``"
 126   in order to keep monitoring the bus.
 127
 128
 129 - All versions
 130
 131   No full duplex operation is supported. The driver will switch
 132   between input/output mode as quickly as possible.
 133
 134   The length of outgoing RTR frames cannot be set. In fact, some
 135   clones (tested with one identifying as "``v1.5``") are unable to
 136   send RTR frames at all.
 137
 138   We don't have a way to get real-time notifications on CAN errors.
 139   While there is a command (``AT CS``) to retrieve some basic stats,
 140   we don't poll it as it would force us to interrupt reception mode.
 141
 142
 143 - Versions prior to 1.4b
 144
 145   These versions do not send CAN ACKs when in monitoring mode (AT MA).
 146   However, they do send ACKs while waiting for a reply immediately
 147   after sending a frame. The driver maximizes this time to make the
 148   controller as useful as possible.
 149
 150   Starting with version 1.4b, the ELM327 supports the "``AT CSM``"
 151   command, and the "listen-only" CAN option will take effect.
 152
 153
 154 - Versions prior to 1.4
 155
 156   These chips do not support the "``AT PB``" command, and thus cannot
 157   change bitrate or SFF/EFF mode on-the-fly. This will have to be
 158   programmed by the user before attaching the line discipline. See the
 159   data sheet for details.
 160
 161
 162 - Versions prior to 1.3
 163
 164   These chips cannot be used at all with elmcan. They do not support
 165   the "``AT D1``" command, which is necessary to avoid parsing conflicts
 166   on incoming data, as well as distinction of RTR frame lengths.
 167
 168   Specifically, this allows for easy distinction of SFF and EFF
 169   frames, and to check whether frames are complete. While it is possible
 170   to deduce the type and length from the length of the line the ELM327
 171   sends us, this method fails when the ELM327's UART output buffer
 172   overruns. It may abort sending in the middle of the line, which will
 173   then be mistaken for something else.
 174
 175
 176
 177 Known limitations of the driver
 178 --------------------------------
 179
 180 - No 8/7 timing.
 181
 182   ELM327 can only set CAN bitrates that are of the form 500000/n, where
 183   n is an integer divisor.
 184   However there is an exception: With a separate flag, it may set the
 185   speed to be 8/7 of the speed indicated by the divisor.
 186   This mode is not currently implemented.
 187
 188 - No evaluation of command responses.
 189
 190   The ELM327 will reply with OK when a command is understood, and with ?
 191   when it is not. The driver does not currently check this, and simply
 192   assumes that the chip understands every command.
 193   The driver is built such that functionality degrades gracefully
 194   nevertheless. See the section on known limitations of the controller.
 195
 196 - No use of hardware CAN ID filtering
 197
 198   An ELM327's UART sending buffer will easily overflow on heavy CAN bus
 199   load, resulting in the "``BUFFER FULL``" message. Using the hardware
 200   filters available through "``AT CF xxx``" and "``AT CM xxx``" would be
 201   helpful here, however SocketCAN does not currently provide a facility
 202   to make use of such hardware features.
 203
 204
 205
 206 Communication example
 207 ----------------------
 208
 209 This is a short and incomplete introduction on how to talk to an ELM327.
 210
 211
 212 The ELM327 has two modes:
 213
 214 - Command mode
 215 - Reception mode
 216
 217 In command mode, it expects one command per line, terminated by CR.
 218 By default, the prompt is a "``>``", after which a command can be
 219 entered::
 220
 221     >ATE1
 222     OK
 223     >
 224
 225 The init script in the driver switches off several configuration options
 226 that are only meaningful in the original OBD scenario the chip is meant
 227 for, and are actually a hindrance for elmcan.
 228
 229
 230 When a command is not recognized, such as by an older version of the
 231 ELM327, a question mark is printed as a response instead of OK::
 232
 233     >ATUNKNOWN
 234     ?
 235     >
 236
 237 At present, elmcan does not evaluate this response and silently assumes
 238 that all commands are recognized. It is structured such that it will
 239 degrade gracefully when a command is unknown. See the sections above on
 240 known limitations for details.
 241
 242
 243 When a CAN frame is to be sent, the target address is configured, after
 244 which the frame is sent as a command that consists of the data's hex
 245 dump::
 246
 247     >ATSH123
 248     OK
 249     >DEADBEEF12345678
 250     OK
 251     >
 252
 253 The above interaction sends the frame "``DE AD BE EF 12 34 56 78``" with
 254 the 11 bit CAN ID ``0x123``.
 255 For this to function, the controller must be configured for 11 bit CAN
 256 ID sending mode (using "``AT PB``", see code or datasheet).
 257
 258
 259 Once a frame has been sent and wait-for-reply mode is on (``ATR1``,
 260 configured on ``listen-only=off``), or when the reply timeout expires and
 261 the driver sets the controller into monitoring mode (``ATMA``), the ELM327
 262 will send one line for each received CAN frame, consisting of CAN ID,
 263 DLC, and data::
 264
 265     123 8 DEADBEEF12345678
 266
 267 For 29 bit CAN frames, the address format is slightly different, which
 268 elmcan uses to tell the two apart::
 269
 270     12 34 56 78 8 DEADBEEF12345678
 271
 272 The ELM327 will receive both 11 and 29 bit frames - the current CAN
 273 config (``ATPB``) does not matter.
 274
 275
 276 If the ELM327's internal UART sending buffer runs full, it will abort
 277 the monitoring mode, print "BUFFER FULL" and drop back into command
 278 mode. Note that in this case, unlike with other error messages, the
 279 error message may appear on the same line as the last (usually
 280 incomplete) data frame::
 281
 282     12 34 56 78 8 DEADBEEF123 BUFFER FULL
 283
 284
 285
 286 Rationale behind the chosen configuration
 287 ------------------------------------------
 288
 289 ``AT E1``
 290   Echo on
 291
 292   We need this to be able to get a prompt reliably.
 293
 294 ``AT S1``
 295   Spaces on
 296
 297   We need this to distinguish 11/29 bit CAN addresses received.
 298
 299   Note:
 300   We can usually do this using the line length (odd/even),
 301   but this fails if the line is not transmitted fully to
 302   the host (BUFFER FULL).
 303
 304 ``AT D1``
 305   DLC on
 306
 307   We need this to tell the "length" of RTR frames.
 308
 309
 310
 311 A note on CAN bus termination
 312 ------------------------------
 313
 314 Your adapter may have resistors soldered in which are meant to terminate
 315 the bus. This is correct when it is plugged into a OBD-II socket, but
 316 not helpful when trying to tap into the middle of an existing CAN bus.
 317
 318 If communications don't work with the adapter connected, check for the
 319 termination resistors on its PCB and try removing them.