python-can-sontheim
====================
|release| |python_implementation| |coverage| |downloads|
.. |release| image:: https://img.shields.io/pypi/v/python-can-sontheim.svg
:target: https://pypi.python.org/pypi/python-can-sontheim/
:alt: Latest Version on PyPi
.. |python_implementation| image:: https://img.shields.io/pypi/implementation/python-can-sontheim
:target: https://pypi.python.org/pypi/python-can-sontheim/
:alt: Supported Python implementations
.. |downloads| image:: https://pepy.tech/badge/python-can-sontheim
:target: https://pepy.tech/project/python-can-sontheim
:alt: Downloads on PePy
.. |coverage| image:: https://coveralls.io/repos/github/MattWoodhead/python-can-sontheim/badge.svg?branch=main
:target: https://coveralls.io/github/MattWoodhead/python-can-sontheim?branch=main
This module is a plugin for the python-can_. module, that allows the use of CAN interfaces that rely on the Sontheim Industrie Elektronik (SIE) MTAPI drivers (windows only). These include the SIE CANfox (including rebranded versions such as that by IFM), SIE CANUSB, etc.
Installation
------------
Install using pip::
$ pip install python-can-sontheim
Usage
-----
In general, useage is largely the same as with the main python-can_ library, using the interface designation of "sontheim". When integrating the sontheim interface into scripts, it is possible to import constants, device deisgnations etc from the python-can-sontheim module using "import can_sontheim". For the majority of the use cases, using an SIE interface is as simple as amending any python-can examples with the lines shown below:
Create python-can bus with the SIE CANfox USB interface:
.. code-block:: python
import can
from can_sontheim import devices
bus = can.Bus(interface="sontheim", channel=devices.CANfox.CAN1, bitrate=250000, echo=False)
Some examples are present in the python-can-sontheim/examples_ directory in the repository, and more complete documentation specific to the SIE interfaces and driver will be uploaded to this module in due course.
.. _python-can: https://python-can.readthedocs.org/en/stable/
.. _examples: https://github.com/MattWoodhead/python-can-sontheim/tree/main/examples
Raw data
{
"_id": null,
"home_page": "",
"name": "python-can-sontheim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "CANbus,Sontheim,python-can,CANfox",
"author": "",
"author_email": "Matt Woodhead <woody.w62@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/7f/65760ecc836c144967d6f96b57bc6da1b736f85a1aa725e58a6225fa793e/python-can-sontheim-0.1.3.tar.gz",
"platform": null,
"description": "python-can-sontheim\n====================\n|release| |python_implementation| |coverage| |downloads|\n\n.. |release| image:: https://img.shields.io/pypi/v/python-can-sontheim.svg\n :target: https://pypi.python.org/pypi/python-can-sontheim/\n :alt: Latest Version on PyPi\n\n.. |python_implementation| image:: https://img.shields.io/pypi/implementation/python-can-sontheim\n :target: https://pypi.python.org/pypi/python-can-sontheim/\n :alt: Supported Python implementations\n \n.. |downloads| image:: https://pepy.tech/badge/python-can-sontheim\n :target: https://pepy.tech/project/python-can-sontheim\n :alt: Downloads on PePy\n \n.. |coverage| image:: https://coveralls.io/repos/github/MattWoodhead/python-can-sontheim/badge.svg?branch=main\n :target: https://coveralls.io/github/MattWoodhead/python-can-sontheim?branch=main\n\n\nThis module is a plugin for the python-can_. module, that allows the use of CAN interfaces that rely on the Sontheim Industrie Elektronik (SIE) MTAPI drivers (windows only). These include the SIE CANfox (including rebranded versions such as that by IFM), SIE CANUSB, etc.\n\n\nInstallation\n------------\n\nInstall using pip::\n\n $ pip install python-can-sontheim\n\n\nUsage\n-----\n\nIn general, useage is largely the same as with the main python-can_ library, using the interface designation of \"sontheim\". When integrating the sontheim interface into scripts, it is possible to import constants, device deisgnations etc from the python-can-sontheim module using \"import can_sontheim\". For the majority of the use cases, using an SIE interface is as simple as amending any python-can examples with the lines shown below:\n\nCreate python-can bus with the SIE CANfox USB interface:\n\n.. code-block:: python\n\n import can\n from can_sontheim import devices\n\n bus = can.Bus(interface=\"sontheim\", channel=devices.CANfox.CAN1, bitrate=250000, echo=False)\n\nSome examples are present in the python-can-sontheim/examples_ directory in the repository, and more complete documentation specific to the SIE interfaces and driver will be uploaded to this module in due course.\n\n\n.. _python-can: https://python-can.readthedocs.org/en/stable/\n\n.. _examples: https://github.com/MattWoodhead/python-can-sontheim/tree/main/examples\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3 (LGPLv3)",
"summary": "A python-can interface driver for Sontheim Industrie Elektronik CAN bus interfaces",
"version": "0.1.3",
"split_keywords": [
"canbus",
"sontheim",
"python-can",
"canfox"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6c8d4fcfa76d0a91a27b6483726c00e9",
"sha256": "3e57835aad764d227864fe7c7efb1dc6dc49a1e936cb89f3701e941a03db3396"
},
"downloads": -1,
"filename": "python_can_sontheim-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c8d4fcfa76d0a91a27b6483726c00e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1382521,
"upload_time": "2023-01-01T10:23:24",
"upload_time_iso_8601": "2023-01-01T10:23:24.856390Z",
"url": "https://files.pythonhosted.org/packages/a7/33/7198f286c3162d21cae78e127d842bf6fb14b410f9c84f8c2a6c18892296/python_can_sontheim-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f3f7254f7e37088cd4d8669e4884cd8b",
"sha256": "cd03ff3cae71a6a0f43900d5fa43cf1907fd5c93902238a3509af5856a0bacdb"
},
"downloads": -1,
"filename": "python-can-sontheim-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "f3f7254f7e37088cd4d8669e4884cd8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1384331,
"upload_time": "2023-01-01T10:23:26",
"upload_time_iso_8601": "2023-01-01T10:23:26.379580Z",
"url": "https://files.pythonhosted.org/packages/e5/7f/65760ecc836c144967d6f96b57bc6da1b736f85a1aa725e58a6225fa793e/python-can-sontheim-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-01 10:23:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "python-can-sontheim"
}
JSON