nixnet 0.1.0.dev6

NI-XNET Python API

Info	Communicate over CAN or LIN via NI-XNET hardware with Python.
Author	National Instruments

>>> 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)

Installation

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

Or easy_install from setuptools:

$ python -m easy_install nixnet

You also can download the project source and run:

$ python setup.py install

Resources

• Examples.

• Documentation.

• Source.

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 is still early in its development with all the bugs, unimplemented features, and API changes that go along with that.

The areas that are more mature include:

• FrameInStreamSession with reading and writing bytes, raw frames, and can frames.

• FrameOutStreamSession with writing bytes, raw frames, and can frames.

• FrameInQueuedSession with reading bytes, raw frames, and can frames.

• FrameOutQueuedSession with writing bytes, raw frames, and can frames.

• FrameInSinglePointSession with reading bytes, raw frames, and can frames.

• FrameOutSinglePointSession with writing bytes, raw frames, and can frames.

• SignalInSinglePointSession with reading values (timestamps are available but less mature).

• SignalOutSinglePointSession with writing values.

nixnet currently supports

• Windows operating system.

• CPython 2.7.7+, 3.4+, PyPy2, and PyPy3.

You can checkout the issues page for more details.

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.