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.2

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.

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.2.tar.gz (147.6 kB view details)

Uploaded Source

Built Distribution

nixnet-0.3.2-py2.py3-none-any.whl (152.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nixnet-0.3.2.tar.gz
  • Upload date:
  • Size: 147.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.6.8

File hashes

Hashes for nixnet-0.3.2.tar.gz
Algorithm Hash digest
SHA256 e5bb9bf1d63a8d97d2616c029d849e5ee7e51a05a8b58155b665866fd7060de6
MD5 ae9df13fd1352c2dfa490783318f454b
BLAKE2b-256 120785f17789bbd9436c5a0ce9d047a4201e0315750ca11aa9580fbe6dce46cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nixnet-0.3.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 152.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.6.8

File hashes

Hashes for nixnet-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9666be43316d3466094dac8b5ba4baba248b065409deaa28fbac2246d749daee
MD5 971229a74807e482579646b982270fec
BLAKE2b-256 fb86be8ce7d7b0964a5de5ea0b8fbcd4ada197f307b27fe246dbfc9bb5475a3a

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