Bindings: icsneopy: Add install instructions

master
Thomas Stoddard 2026-04-28 19:26:02 +00:00 committed by Kyle Schwarz
parent 79ff19015a
commit 0cb30cfc5b
5 changed files with 42 additions and 3 deletions

View File

@ -6,7 +6,7 @@ Prerequisites
=============
- Python 3.8 or higher
- icsneopy library installed
- icsneopy installed (see :doc:`installation`)
- CAN hardware device connected
:download:`Download complete example <../../examples/python/can/can_complete_example.py>`

View File

@ -8,7 +8,7 @@ Prerequisites
=============
- Python 3.8 or higher
- icsneopy library installed
- icsneopy installed (see :doc:`installation`)
- Intrepid Control Systems Device
:download:`Download complete example <../../examples/python/ethernet/ethernet_complete_example.py>`

View File

@ -5,7 +5,7 @@ FlexRay Getting Started
Prerequisites
=============
- icsneopy library installed
- icsneopy installed (see :doc:`installation`)
- FlexRay hardware device connected (e.g., Fire3 Flexray)
- Proper FlexRay bus termination (100Ω on each channel end)

View File

@ -5,6 +5,7 @@ icsneopy
.. toctree::
:maxdepth: 2
installation
can_getting_started
ethernet_getting_started
flexray_getting_started

View File

@ -0,0 +1,38 @@
============
Installation
============
icsneopy is available on PyPI at https://pypi.org/project/icsneopy/ and can be installed with pip:
.. code-block:: bash
pip install icsneopy
Pre-release
===========
For the latest features, install with the ``--pre`` flag to include pre-release versions:
.. code-block:: bash
pip install --pre icsneopy
Upgrading
=========
To upgrade an existing installation:
.. code-block:: bash
pip install --pre --upgrade icsneopy
Linux udev Rules
================
Linux users may want to install the included udev rules to run icsneopy-based
applications without root. The rules file can be found in the libicsneo source
repository at https://github.com/intrepidcs/libicsneo/.
.. code-block:: bash
sudo cp 99-intrepidcs.rules /etc/udev/rules.d/