Skip to content

Commit 3eb485c

Browse files
author
Brendan Whitfield
committed
readme comments
1 parent 2330b72 commit 3eb485c

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ After installing the library, simply import pyobd, and create a new OBD connecti
2929

3030
# OR
3131

32-
ports = obd.scanSerial()
32+
ports = obd.scanSerial() # return list of valid USB or RF ports
3333
print ports
3434
connection = obd.OBD(ports[0]) # connect to the first port in the list
3535

@@ -38,26 +38,26 @@ Once a connection is made, pyOBD-IO will load a list of the available sensors in
3838

3939
import obd
4040

41-
connection = obd.OBD() # create connection
41+
connection = obd.OBD()
4242

4343
for sensor in connection.supportedSensors:
44-
print str(sensor) # prints the sensor name
45-
print connection.valueOf(sensor)
44+
print str(sensor) # prints the sensor name
45+
print connection.valueOf(sensor) # gets and prints the sensor's value
46+
print sensor.unit # prints the sensors units
4647

4748

4849
Sensors can also be explicitly targetted for values. The hasSensor() function will determine whether or not your car has the requested sensor.
4950

5051
import obd
5152

52-
connection = obd.OBD() # create connection object
53+
connection = obd.OBD()
5354

54-
if connection.hasSensor(obd.sensors.RPM):
55-
print connection.valueOf(obd.sensors.RPM)
55+
if connection.hasSensor(obd.sensors.RPM): # check for existance of sensor
56+
print connection.valueOf(obd.sensors.RPM) # get value of sensor
5657

5758

58-
Here is a list of currently supported sensors with pyOBD-IO:
59+
Here are the currently supported sensors with pyOBD-IO:
5960

60-
+ Supported PIDs
6161
+ S-S DTC Cleared
6262
+ Calculated Engine Load
6363
+ Engine Coolant Temperature

0 commit comments

Comments
 (0)