python-ics 1!26.3.9

Python wrapper for interfacing to IntrepidCS Hardware.

Description

Python wrapper for interfacing to IntrepidCS Hardware.

Installing

• pip install python_ics

Platform specific Installation notes

Windows

• Windows requires icsneo40.dll to be installed in the PATH. This can be obtained through vspy3 or our hardware installation kit found here: https://cdn.intrepidcs.net/updates/files/RP1210KitInstall.zip

Linux

• Linux builds use libicsneo and are built against manylinux using cibuildwheel.
• libicsneolegacy.so is bundled with the wheel and python_ics will automatically use it.

MacOS

• Mac builds use libicsneo and are built using cibuildwheel
• libicsneolegacy.dylib is bundled with the wheel and python_ics will automatically use it.

Versioning

Starting with 1!26.3.9, python_ics versions track the Vehicle Spy version they were generated from (Vspy 3.26.3.9 → python_ics 26.3.9).

The 1! prefix is a PEP 440 epoch. Earlier releases used the icsneo40 DLL version (e.g. 923.11), which sorts above 26.x, so the epoch tells pip the scheme changed:

• pip install python_ics and pip install -U python_ics correctly resolve 1!26.3.9 as newer than 923.11.
• Exact pins must include the epoch: python_ics==1!26.3.9.
• Range pins work with or without it: python_ics>=1!26.3.

Release tagging: tags are v1!<version> (e.g. v1!26.3.9). Every future tag keeps the 1! prefix — a bare v26.x tag would sort below the historical 923.x releases and pip would ignore it.

Basic usage

import ics

devices = ics.find_devices()
print(f"Found {len(devices)} devices...")
for device in devices:
    # Print, open, load default settings, close
    print(device)
    device.open()
    device.load_default_settings()
    device.close()

Documentation

http://python-ics.readthedocs.io/

Building from source

• Building from source requires clang and clang-format to be present on the build machine.
• python_ics has submodules, please be sure to initial all submodules also.

PS > git clone [e-mail]:intrepidcs/python_ics.git

PS > cd python_ics

PS > git submodule update --init

PS > clang --version
clang version 11.1.0
Target: x86_64-pc-windows-msvc
Thread model: posix
InstalledDir: C:\Program Files\LLVM\bin

PS > clang-format --version
clang-format version 11.1.0

PS > python -m pip install .

Debugging on Windows with Visual Studio Code

• Build and install python_ics for debug. When installing python choose the following:
  • Customize Installation -> Advanced Options
    • Check Download debugging symbols
    • Check Download debug binaries
• Build python with debug:
  • Install Visual Studio 2019 build tools(NOTE: As of 2/5/24, it looks like MSVC 2022 does not build correctly with setuptools and debug configurations). You should be able to build from source already.
  • Create virtual environment and activate it (powershell):
    • python -m venv .venv
    • .\.venv\Scripts\Activate.ps1
  • Install dependencies:
    • python -m pip install -r requirements.txt
  • Set DEBUG environment variable:
    • $env:DEBUG = "1"
  • Build the extension:
    • python_d setup.py build --debug install --force
    • OUTDATED:
      • Build in debug (-g flag):
        • python setup.py build -g
      • Install into our virtual environment:
        • python setup.py install --force
  • Inside visual studio code:
    • Open the root python_ics directory
      • code C:\Path\To\python_ics
    • Make sure the python extension is installed (ctrl+shift+x)
      • Python
      • Python Debugger
    • Select the python interpreter from our virtual environment (bottom right with a python file open in the editor).
    • Open and place a breakpoint in src/icsdebug.py
    • launch "Python: Debug icsdebug.py"
      • Note the PID that is outputted to terminal (Can also add os.getpid() to watch window)
    • Place a breakpoint inside the function you'd like to debug in methods.cpp
    • launch "Debugger Attach" (launch.json) and enter the pid when prompted.
    • enjoy!

License - MIT

Copyright (c) Intrepid Control Systems, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.