***
UDS
***
|CI| |SecurityScan| |BestPractices| |ReadTheDocs| |CodeCoverage|
|LatestVersion| |PythonVersions| |PyPIStatus| |TotalDownloads| |MonthlyDownloads| |Licence|
Python package for handling `Unified Diagnostic Services`_ (UDS) protocol defined by ISO 14229.
It supports different communication buses on both communication sides (client and server).
Documentation
-------------
User documentation is hosted by ReadTheDocs portal and available under the following link: https://uds.readthedocs.io/
Security policy for this package is defined in `SECURITY.md`_ file.
If you want to become a contributor, please read `CONTRIBUTING.md`_ file.
Why another UDS package?
------------------------
There are a few already existing python packages to handle UDS protocol,
so you might wonder why would you consider using this one?
This package is meant to support **multiple buses** (including CAN, LIN, Ethernet, K-Line, FlexRay) and **multiple
bus managers** (e.g. `python-can`_).
Additionally, it handles both communication nodes (client and server), and contains detailed configuration to fully
control all timing and transmission parameters.
Thanks to all these features, this package can have multiple use-cases, including:
- simple send-receive messages to/from any network
- comprehensive node simulations
- testing of UDS protocol communication implementation
Unfortunately, all previously mentioned plans make the project a huge effort and at the time of writing,
the implementation process of these features is still ongoing (and probably the status will stay the same for at least
a couple more years).
On the other hand, the architecture to support all these features is already designed and some of the features
are already implemented with others defined or planned.
To check the current implementation status, visit:
- https://uds.readthedocs.io/en/stable/#features
- https://uds.readthedocs.io/en/stable/pages/knowledge_base/osi_model.html#uds-functionalities
Alternative options
```````````````````
python-udsoncan
'''''''''''''''
Link: https://github.com/pylessard/python-udsoncan
- pros:
- comprehensive documentation
- handlers for multiple diagnostic services is implemented
- cons:
- only positive use case scenarios (where communication is in line with UDS standard) are supported
- only CAN bus is supported
- only Client side communication can be handled
- limited communication parameters configuration
python-uds
''''''''''
Link: https://github.com/richClubb/python-uds
- pros:
- CAN and LIN buses are supported
- cons:
- modest documentation
- only a few communication interfaces are supported
- only Client side communication can be handled
- limited communication parameters configuration
Contact
-------
- e-mail: uds-package-development@googlegroups.com
- group: `UDS package development`_
- discord: https://discord.gg/y3waVmR5PZ
.. _SECURITY.md: https://github.com/mdabrowski1990/uds/blob/main/SECURITY.md
.. _CONTRIBUTING.md: https://github.com/mdabrowski1990/uds/blob/main/CONTRIBUTING.md
.. _UDS package development: https://groups.google.com/g/uds-package-development/about
.. _Unified Diagnostic Services: https://en.wikipedia.org/wiki/Unified_Diagnostic_Services
.. _python-can: https://github.com/hardbyte/python-can
.. |CI| image:: https://github.com/mdabrowski1990/uds/actions/workflows/testing.yml/badge.svg?branch=main
:target: https://github.com/mdabrowski1990/uds/actions/workflows/testing.yml
:alt: Continuous Integration Status
.. |SecurityScan| image:: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml/badge.svg?branch=main
:target: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml
:alt: Security Scan Status
.. |ReadTheDocs| image:: https://readthedocs.org/projects/uds/badge/?version=latest
:target: https://uds.readthedocs.io/
:alt: ReadTheDocs Build Status
.. |BestPractices| image:: https://bestpractices.coreinfrastructure.org/projects/4703/badge
:target: https://bestpractices.coreinfrastructure.org/projects/4703
:alt: CII Best Practices
.. |CodeCoverage| image:: https://codecov.io/gh/mdabrowski1990/uds/branch/main/graph/badge.svg?token=IL7RYZ5ERC
:target: https://codecov.io/gh/mdabrowski1990/uds
:alt: Software Tests Coverage
.. |LatestVersion| image:: https://img.shields.io/pypi/v/py-uds.svg
:target: https://pypi.python.org/pypi/py-uds
:alt: The latest Version of UDS package
.. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/py-uds.svg
:target: https://pypi.python.org/pypi/py-uds/
:alt: Supported Python versions
.. |PyPIStatus| image:: https://img.shields.io/pypi/status/py-uds.svg
:target: https://pypi.python.org/pypi/py-uds/
:alt: PyPI status
.. |TotalDownloads| image:: https://pepy.tech/badge/py-uds
:target: https://pepy.tech/project/py-uds
:alt: Total PyPI downloads
.. |MonthlyDownloads| image:: https://pepy.tech/badge/py-uds/month
:target: https://pepy.tech/project/py-uds
:alt: Monthly PyPI downloads
.. |Licence| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: https://lbesson.mit-license.org/
:alt: License Type
Raw data
{
"_id": null,
"home_page": null,
"name": "py-uds",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Maciej D\u0105browski <maciej.dabrowski@software-quality.pl>, UDS Package Development <uds-package-development@googlegroups.com>",
"keywords": "uds, unified-diagnostic-services, automotive, on-board-diagnostic, obd, vehicle-diagnostic, iso14229, iso-14229, iso15765, iso-15765",
"author": null,
"author_email": "Maciej D\u0105browski <maciej.dabrowski@software-quality.pl>, UDS Package Development <uds-package-development@googlegroups.com>",
"download_url": null,
"platform": null,
"description": "***\r\nUDS\r\n***\r\n\r\n|CI| |SecurityScan| |BestPractices| |ReadTheDocs| |CodeCoverage|\r\n\r\n|LatestVersion| |PythonVersions| |PyPIStatus| |TotalDownloads| |MonthlyDownloads| |Licence|\r\n\r\nPython package for handling `Unified Diagnostic Services`_ (UDS) protocol defined by ISO 14229.\r\nIt supports different communication buses on both communication sides (client and server).\r\n\r\n\r\nDocumentation\r\n-------------\r\nUser documentation is hosted by ReadTheDocs portal and available under the following link: https://uds.readthedocs.io/\r\n\r\nSecurity policy for this package is defined in `SECURITY.md`_ file.\r\n\r\nIf you want to become a contributor, please read `CONTRIBUTING.md`_ file.\r\n\r\n\r\nWhy another UDS package?\r\n------------------------\r\nThere are a few already existing python packages to handle UDS protocol,\r\nso you might wonder why would you consider using this one?\r\n\r\nThis package is meant to support **multiple buses** (including CAN, LIN, Ethernet, K-Line, FlexRay) and **multiple\r\nbus managers** (e.g. `python-can`_).\r\nAdditionally, it handles both communication nodes (client and server), and contains detailed configuration to fully\r\ncontrol all timing and transmission parameters.\r\n\r\nThanks to all these features, this package can have multiple use-cases, including:\r\n\r\n- simple send-receive messages to/from any network\r\n- comprehensive node simulations\r\n- testing of UDS protocol communication implementation\r\n\r\nUnfortunately, all previously mentioned plans make the project a huge effort and at the time of writing,\r\nthe implementation process of these features is still ongoing (and probably the status will stay the same for at least\r\na couple more years).\r\nOn the other hand, the architecture to support all these features is already designed and some of the features\r\nare already implemented with others defined or planned.\r\n\r\nTo check the current implementation status, visit:\r\n\r\n- https://uds.readthedocs.io/en/stable/#features\r\n- https://uds.readthedocs.io/en/stable/pages/knowledge_base/osi_model.html#uds-functionalities\r\n\r\n\r\nAlternative options\r\n```````````````````\r\n\r\npython-udsoncan\r\n'''''''''''''''\r\nLink: https://github.com/pylessard/python-udsoncan\r\n\r\n- pros:\r\n - comprehensive documentation\r\n - handlers for multiple diagnostic services is implemented\r\n- cons:\r\n - only positive use case scenarios (where communication is in line with UDS standard) are supported\r\n - only CAN bus is supported\r\n - only Client side communication can be handled\r\n - limited communication parameters configuration\r\n\r\n\r\npython-uds\r\n''''''''''\r\nLink: https://github.com/richClubb/python-uds\r\n\r\n- pros:\r\n - CAN and LIN buses are supported\r\n- cons:\r\n - modest documentation\r\n - only a few communication interfaces are supported\r\n - only Client side communication can be handled\r\n - limited communication parameters configuration\r\n\r\n\r\nContact\r\n-------\r\n- e-mail: uds-package-development@googlegroups.com\r\n- group: `UDS package development`_\r\n- discord: https://discord.gg/y3waVmR5PZ\r\n\r\n\r\n.. _SECURITY.md: https://github.com/mdabrowski1990/uds/blob/main/SECURITY.md\r\n\r\n.. _CONTRIBUTING.md: https://github.com/mdabrowski1990/uds/blob/main/CONTRIBUTING.md\r\n\r\n.. _UDS package development: https://groups.google.com/g/uds-package-development/about\r\n\r\n.. _Unified Diagnostic Services: https://en.wikipedia.org/wiki/Unified_Diagnostic_Services\r\n\r\n.. _python-can: https://github.com/hardbyte/python-can\r\n\r\n.. |CI| image:: https://github.com/mdabrowski1990/uds/actions/workflows/testing.yml/badge.svg?branch=main\r\n :target: https://github.com/mdabrowski1990/uds/actions/workflows/testing.yml\r\n :alt: Continuous Integration Status\r\n\r\n.. |SecurityScan| image:: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml/badge.svg?branch=main\r\n :target: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml\r\n :alt: Security Scan Status\r\n\r\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/uds/badge/?version=latest\r\n :target: https://uds.readthedocs.io/\r\n :alt: ReadTheDocs Build Status\r\n\r\n.. |BestPractices| image:: https://bestpractices.coreinfrastructure.org/projects/4703/badge\r\n :target: https://bestpractices.coreinfrastructure.org/projects/4703\r\n :alt: CII Best Practices\r\n\r\n.. |CodeCoverage| image:: https://codecov.io/gh/mdabrowski1990/uds/branch/main/graph/badge.svg?token=IL7RYZ5ERC\r\n :target: https://codecov.io/gh/mdabrowski1990/uds\r\n :alt: Software Tests Coverage\r\n\r\n.. |LatestVersion| image:: https://img.shields.io/pypi/v/py-uds.svg\r\n :target: https://pypi.python.org/pypi/py-uds\r\n :alt: The latest Version of UDS package\r\n\r\n.. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/py-uds.svg\r\n :target: https://pypi.python.org/pypi/py-uds/\r\n :alt: Supported Python versions\r\n\r\n.. |PyPIStatus| image:: https://img.shields.io/pypi/status/py-uds.svg\r\n :target: https://pypi.python.org/pypi/py-uds/\r\n :alt: PyPI status\r\n\r\n.. |TotalDownloads| image:: https://pepy.tech/badge/py-uds\r\n :target: https://pepy.tech/project/py-uds\r\n :alt: Total PyPI downloads\r\n\r\n.. |MonthlyDownloads| image:: https://pepy.tech/badge/py-uds/month\r\n :target: https://pepy.tech/project/py-uds\r\n :alt: Monthly PyPI downloads\r\n\r\n.. |Licence| image:: https://img.shields.io/badge/License-MIT-blue.svg\r\n :target: https://lbesson.mit-license.org/\r\n :alt: License Type\r\n",
"bugtrack_url": null,
"license": null,
"summary": "UDS (Unified Diagnostic Services) protocol handler.",
"version": "1.0.0",
"project_urls": {
"Code Download": "https://github.com/mdabrowski1990/uds/archive/refs/heads/main.zip",
"Homepage": "https://github.com/mdabrowski1990/uds",
"Issues Tracking System": "https://github.com/mdabrowski1990/uds/issues",
"PyPI": "https://pypi.org/project/py-uds/",
"Releases and Changelogs": "https://github.com/mdabrowski1990/uds/releases",
"Repository": "https://github.com/mdabrowski1990/uds",
"Security Policy": "https://github.com/mdabrowski1990/uds/security/policy",
"User Documentation": "https://uds.readthedocs.io",
"Wiki": "https://github.com/mdabrowski1990/uds/wiki"
},
"split_keywords": [
"uds",
" unified-diagnostic-services",
" automotive",
" on-board-diagnostic",
" obd",
" vehicle-diagnostic",
" iso14229",
" iso-14229",
" iso15765",
" iso-15765"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b031267ecb3ffbea263af439bc442b858aeacc0d5cb37038d3f29518df4d13a9",
"md5": "ae041e1c14f35e1eb3fc6b9d83d7511a",
"sha256": "3a7c3c1ef8cf9fb014b7bcd4809c256c3e26a9ac8182a5e957bb0152a3d169f7"
},
"downloads": -1,
"filename": "py_uds-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae041e1c14f35e1eb3fc6b9d83d7511a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 86744,
"upload_time": "2024-10-03T18:40:00",
"upload_time_iso_8601": "2024-10-03T18:40:00.938549Z",
"url": "https://files.pythonhosted.org/packages/b0/31/267ecb3ffbea263af439bc442b858aeacc0d5cb37038d3f29518df4d13a9/py_uds-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 18:40:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mdabrowski1990",
"github_project": "uds",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "py-uds"
}
JSON
