Skip to content

Commit 6fa53f4

Browse files
committed
doc correction
1 parent df79975 commit 6fa53f4

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/source/udsoncan/examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,13 @@ Note that, in order to run this code, both ``python-can`` and ``can-isotp`` must
7676
from udsoncan.connections import PythonIsoTpConnection
7777
from udsoncan.client import Client
7878
79-
# Refer to isotp documentation for full details of parameters
79+
# Refer to isotp documentation for full details about parameters
8080
isotp_params = {
8181
'stmin' : 32, # Will request the sender to wait 32ms between consecutive frame. 0-127ms or 100-900ns with values from 0xF1-0xF9
8282
'blocksize' : 8, # Request the sender to send 8 consecutives frames before sending a new flow control message
8383
'wftmax' : 0, # Number of wait frame allowed before triggering an error
8484
'll_data_length' : 8, # Link layer (CAN layer) works with 8 byte payload (CAN 2.0)
85-
'tx_padding' : 0, # Will pad tramissted CAN message with byte 0x00. None means no padding
85+
'tx_padding' : 0, # Will pad all transmitted CAN messages with byte 0x00. None means no padding
8686
'rx_flowcontrol_timeout' : 1000 # Triggers a timeout if a flow control is awaited for more than 1000 milliseconds
8787
'rx_consecutive_frame_timeout' : 1000, # Triggers a timeout if a consecutive frame is awaited for more than 1000 milliseconds
8888
'squash_stmin_requirement' : False # When sending, respect the stmin requirement of the receiver. If set to True, go as fast as possible.

udsoncan/connections.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,9 +406,9 @@ def empty_txqueue(self):
406406
class PythonIsoTpConnection(BaseConnection):
407407
"""
408408
Sends and receives data using a `can-isotp <https://github.com/pylessard/python-can-isotp>`_ Python module which is a Python implementation of the IsoTp transport protocol
409-
and `python-can <https://python-can.readthedocs.io>`_ module to interract with CAN hardware
409+
which can be coupled with `python-can <https://python-can.readthedocs.io>`_ module to interract with CAN hardware
410410
411-
Both `can-isotp <https://github.com/pylessard/python-can-isotp>`_ and `python-can <https://python-can.readthedocs.io>`_ must be installed in order to use this connection.
411+
`can-isotp <https://github.com/pylessard/python-can-isotp>`_ must be installed in order to use this connection.
412412
413413
See an :ref:`example<example_using_python_can>`
414414

0 commit comments

Comments
 (0)