Skip to main content

Info

Communicate over CAN or LIN via NI-XNET hardware with Python.

Author

NI

PyPI Documentation License Language versions Build Unit-test Coverage
>>> import nixnet
>>> with nixnet.FrameInStreamSession('CAN1') as input_session:
>>>     input_session.intf.can_term = constants.CanTerm.ON
>>>     input_session.intf.baud_rate = 125000

>>>     frames = input_session.frames.read(count)
>>>     for frame in frames:
>>>         print('Received frame:')
>>>         print(frame)

Quick Start

Running nixnet requires NI-XNET or NI-XNET Runtime. Visit the ni.com/downloads to download the latest version of NI-XNET.

nixnet can be installed with pip:

$ python -m pip install nixnet~=1.0.0

Now you should be able to move onto the Examples.

Resources

Product Support

The nixnet package and NI-XNET are supported by NI. For support, open a request through the NI support portal at ni.com.

Bugs / Feature Requests

We welcome all kinds of contributions. If you have a bug to report or a feature request for nixnet, feel free to open an issue on Github or contribute the change yourself.

Status

nixnet package is created and maintained by NI.

  • The following support is included:
    • CAN and LIN protocol

    • Frames, Signals, and frame/signal conversion

    • Database APIs

    • For a complete list of supported features and functions, see the documentation.

  • See the enhancement issues for potential future work.

  • Breaking API changes will be kept to a minimum. If a breaking change is made, it will be planned through breaking-change isssues and communicated via semver and the release notes.

  • Known issues.

nixnet currently supports

  • Windows operating system.

  • CPython 3.9+ and PyPy3.

  • NI-XNET 15.5+

License

nixnet is licensed under an MIT-style license (see LICENSE). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.

Release files for nixnet 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nixnet 1.0.0
File Size Uploaded
nixnet-1.0.0.tar.gz 126.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nixnet 1.0.0
File Interpreter ABI Platform
nixnet-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 276.4 kB

Release files / nixnet-1.0.0.tar.gz

Download URL nixnet-1.0.0.tar.gz
Size 126.3 kB
Tags Source
SHA-256 checksum
How to use checksums
fc78cfee01d53026306e6fee4c6c783d0b2b9d919889874f53f7f2aeed561d63
BLAKE2b-256 checksum
How to use checksums
f6aadcdcbb0b2e23433dcc20a8bf0bbfbacf30356c28fe0a8829640fd5aa2d00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.9.13 Windows/10

Release files / nixnet-1.0.0-py3-none-any.whl

Download URL nixnet-1.0.0-py3-none-any.whl
Size 150.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a4acee8c95de30fe2b0a16ce065e2c1c3230fbde5d2cc6d1892a1a32b5b6b8ef
BLAKE2b-256 checksum
How to use checksums
99c836b12b33a424ff91c9b8848f3c72d52ba684fdd582afc2a9be3d7e126144
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.9.13 Windows/10
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page