Skip to main content

NI-XNET Python API

Project description

Info

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

Author

National Instruments

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~=0.3.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 National Instruments.

  • 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 2.7.0+, 3.4+, PyPy2, 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nixnet-0.3.0.tar.gz (143.9 kB view details)

Uploaded Source

Built Distribution

nixnet-0.3.0-py2.py3-none-any.whl (150.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nixnet-0.3.0.tar.gz.

File metadata

  • Download URL: nixnet-0.3.0.tar.gz
  • Upload date:
  • Size: 143.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nixnet-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a1fa201131ef6b53315d6acb11bad0dbb472e508516c02dcddd7f09ce1c5bb53
MD5 b38a0e5c5fa1188a9ba1f88a5b95a8ed
BLAKE2b-256 3e07c8626149bc79008770892b5a6aa818fdd90140edf029dc2c6caa119eb6ef

See more details on using hashes here.

File details

Details for the file nixnet-0.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for nixnet-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ddd57b3500a06df46a30be3f25de9147f7091d001c5954900d3b9ce83859634e
MD5 51e7876e361f53cc01338b2bee7031d8
BLAKE2b-256 4557714ddd4c5afbb4b4af8e18e0281fbcccb07bfcb4c544991075b7f6c0ad3e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page