Skip to main content

libximc

This is a python binding for libximc - cross-platform library for Standa 8SMC5-USB motor controllers.

8SMC5-based devices

Libximc manages hardware using interfaces: USB 2.0, RS232 and Ethernet, also uses a common and proven virtual serial port interface, so you can work with motor control modules through this library under Windows and Linux. macOS isn't supported yet.

This library also supports virtual devices. So you can make some tests without real hardware.

Installation

pip install libximc

Minimal new API example

import time
import libximc.highlevel as ximc

# Virtual device will be used by default.
# In case you have real hardware, set correct device URI here

device_uri = r"xi-emu:///ABS_PATH/virtual_controller.bin"  # Virtual device
# device_uri = r"xi-com:\\.\COM111"                        # Serial port
# device_uri = "xi-tcp://172.16.130.155:1820"              # Raw TCP connection
# device_uri = "xi-net://192.168.1.120/abcd"               # XiNet connection

axis = ximc.Axis(device_uri)
axis.open_device()

print("Launch movement...")
axis.command_right()

time.sleep(3)

print("Stop movement")
axis.command_stop()

print("Disconnect device")
axis.close_device()  # It's also called automatically by the garbage collector, so explicit closing is optional

print("Done")

Full new API example

See Colab notebook for full example: https://colab.research.google.com/drive/1xJawpc-0CIZLDlwkefzSgWrAyBVSlaMl

Detailed view on new API

We are glad to introduce new libximc highlevel API! You can access it via:

import libximc.highlevel as ximc

New API principles

  • All controller related functions are methods of an Axis class:

    # Axis constructor takes device URI as string (not bytes)
    axis = ximc.Axis("xi-emu:///home/user/virtual-device.bin")
    axis.device_open()  # Note: device must be opened manually
    
    axis.command_move(10, 0)
    
    # Note: device closing, axis.close_device(), is performed automatically by the garbage collector.
    

    Other libximc functions can be accessed via ximc itself, e.g. ximc.ximc_version().

  • As you could notice, there is no need to pass device_id to the commands any more. Axis class does it internally.

  • You don't need to pass the calibration_t structure to the *_calb functions. Instead, set calibrations via axis.set_calb(A, MicrostepMode) and then use any *_calb function:

    axis.set_calb(0.048, ximc.MicrostepMode.MICROSTEP_MODE_FRAC_256)
    
    axis.command_move_calb(12.3)
    
  • All flags' enumerations are placed in ximc. For example, to get EnumerationFlags use ximc.EnumerateFlags.<desired-flag>.

  • All C-legacy exit status codes are transformed to Python exceptions.

  • In case you want to get any available data structure from the controller, you don't need to create an empty data structure and pass it to corresponding function. Instead, use single-line instruction, like:

    # Example for move_settings. You can use your desired get_*() command
    move_settings = axis.get_move_settings()
    
  • ximc.enumerate_devices() returns list of dictionaries containing information about found devices. Hint: to get full information about devices, use flag ximc.EnumerationFlags.EnumerateFlags.ENUMERATE_PROBE:

    # Get full information while enumerating
    ximc.enumerate_devices(ximc.EnumerateFlags.ENUMERATE_PROBE)
    
  • Manufactures-only functions aren't supported.

  • Logging functions aren't supported.

I want to use the old version. What should I do?

If you want to use the old API (lowlevel libximc), don't worry. Just

import libximc.lowlevel as ximc  # Such an import provides you with the old version of the libximc binding

More information

If you have faced any issues while using the library and you have no idea how to solve them, contact technical support via:

Metadata

Release files for libximc 3.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for libximc 3.1.1
File Size Uploaded Provenance Actions
libximc-3.1.1.tar.gz 5.5 MB Without provenance Details for libximc-3.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for libximc 3.1.1
File Interpreter ABI Platform Actions
libximc-3.1.1-py3-none-any.whl Python 3 none any Details for libximc-3.1.1-py3-none-any.whl

Total release size: 11.1 MB

Release files / libximc-3.1.1.tar.gz

Download URL libximc-3.1.1.tar.gz
Size 5.5 MB
Tags Source
SHA-256 checksum
How to use checksums
1a633c794bb983264a27f75286c7b70066df2e9285d54238f3832f671e0989ed
BLAKE2b-256 checksum
How to use checksums
608e779db078b3f7f2af09535c5d6d955210ef62ff4e30e883ff3c41a34207c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.8

Release files / libximc-3.1.1-py3-none-any.whl

Download URL libximc-3.1.1-py3-none-any.whl
Size 5.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
1a2717be30f44ef67f7b5301cea990cea46f0cf09ce97246f66f346baf76bdf5
BLAKE2b-256 checksum
How to use checksums
8df7450f87b72f88281cf05e94fc8e591935a6b6dab7cec029a45660cb0c2c53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.8

Security for libximc 3.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page