Skip to content

Commit 48d42c8

Browse files
committed
readme updates
1 parent 6c87d78 commit 48d42c8

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ tools such as GCC, Visual Studio, or XCode. More details can be found
2222

2323
## Connecting to OBD via USB
2424
Connecting to your vehicle's OBD system is relatively simple, you just need a
25-
USB ELM327 cable (like these)[https://www.amazon.com/s/?field-keywords=elm327+usb].
25+
USB ELM327 cable [like these](https://www.amazon.com/s/?field-keywords=elm327+usb).
2626
You might need to install drivers to get the cable working with your laptop,
2727
such as the macOS drivers at [this link](http://www.totalcardiagnostics.com/support/Knowledgebase/Article/View/19/0/how-to-install-elm327-usbbluetooth-on-mac-and-obd-software).
2828

@@ -40,8 +40,15 @@ $ ls /dev/tty.*
4040
```
4141

4242
The existence of `/dev/tty.usbserial` tells us that the connection is detected
43-
and available for use by this CLI.
43+
and available for use by this CLI. You can use it like so:
4444

45+
```
46+
$ obd poll -c serial -b 38400 -i /dev/tty.serialusb "Engine RPM"
47+
```
48+
49+
The `-c serial` tells us that we want to use a serial connection, `-b`
50+
specifies the baudrate (this might vary based on vehicle) ,and `-i` specifies
51+
the interface that the serial connection is running at.
4552

4653
## Usage
4754
Once installed you can run the program from a terminal. Here's how to load
@@ -69,7 +76,7 @@ $ obd --help
6976
-i, --interface <name> the interface to use for connection, e.g /dev/tty.serialusb
7077
```
7178

72-
### Listing PIDs
79+
### Listing PIDs (list)
7380

7481
Use the list command to view PIDs that can be read from vehicles. Currently only
7582
a handful are supported. Here's how you can view them:

0 commit comments

Comments
 (0)