Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document receiving and transmitting of uds messages #282

Merged

Conversation

mdabrowski1990
Copy link
Owner

@mdabrowski1990 mdabrowski1990 commented Oct 3, 2024

Description

Update of documentation with information how to send and receive UDS messages using python-can Transport Interface.

Examples have been updated too.
I had to fix small pieces of code as they were not in lane with ISO 15765-2:2016.

How Has This Been Tested?

  • examples have been executed
  • review

Process

I know the process and did my best to follow it

- fix wrong behavior in code
- adjust existing test cases
- update docs with key information
- update docstrigs
Finish with knowledge base
- restructure transport_interface to shorten paths
- update `user guide` for CAN
add TODO markers
- restructure example part of documentation
- adjust existing example files
- add examples files (empty)
Add user guide for CAN Transport Interface
Provide examples for message/packet sending and receiving
@mdabrowski1990 mdabrowski1990 added documentation Improvements or additions to documentation CAN Related to CAN specific implementation labels Oct 3, 2024
@mdabrowski1990 mdabrowski1990 self-assigned this Oct 3, 2024
@mdabrowski1990 mdabrowski1990 linked an issue Oct 3, 2024 that may be closed by this pull request
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e3f0957) to head (77e4c3e).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #282   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           41        41           
  Lines         2689      2680    -9     
  Branches       652       648    -4     
=========================================
- Hits          2689      2680    -9     
Flag Coverage Δ
integration-tests 80.44% <75.00%> (+0.23%) ⬆️
integration-tests-branch 75.55% <75.00%> (+0.21%) ⬆️
unit-tests 100.00% <100.00%> (ø)
unit-tests-branch 100.00% <100.00%> (ø)
Files with missing lines Coverage Δ
...port_interface/can_transport_interface/__init__.py 100.00% <100.00%> (ø)
...nsport_interface/can_transport_interface/common.py 100.00% <ø> (ø)
...rt_interface/can_transport_interface/python_can.py 100.00% <100.00%> (ø)
uds/utilities/__init__.py 100.00% <100.00%> (ø)
uds/utilities/custom_exceptions.py 100.00% <ø> (ø)
uds/utilities/custom_warnings.py 100.00% <100.00%> (ø)

Copy link
Owner Author

@mdabrowski1990 mdabrowski1990 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mdabrowski1990 mdabrowski1990 merged commit 5be8710 into main Oct 3, 2024
61 checks passed
@mdabrowski1990 mdabrowski1990 deleted the document-receiving-and-transmitting-of-uds-messages branch October 3, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CAN Related to CAN specific implementation documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document receiving and transmitting of UDS messages over CAN
1 participant