Skip to main content

Wrapper for AMTI USB Device library. Currently only supported on Windows Systems for 32 and 64 bit versions of the SDK. Use 64 bit dll if running 64 bit python interpreter and vice versa with 32 bit dll.

Project description

AMTIUSBDeviceWrapper

Description

A digestable wrapper API for communication with AMTI GEN 5 and Optima USB Devices in python that simplifies AMTI's API.

Getting Started

Dependencies

  • Windows 7 64/32-bit and later
  • Python V 3.9.13 and later
  • AMTI USB Device SDK V 1.3

Installation

  • Place AMTI DLL where convenient
  • Recommended install
python3 -m pip install amtiusbdevicewrapper

Execution

Ignore build step if installing from pypi.

  • Build and install the package
git clone https://github.com/Lenz-Lab/AMTIUSBDeviceWrapper
py -m build # Windows
# or...
python -m build # Unix

# Install the package
pip install C:/some-dir/AMTIUSBDeviceWrapper/amtiusbdevicewrapper-<>.whl
  • Simple Initialization and Data Acquisition at 500 Hz Example
# Import and load library
from AMTIUSBDeviceWrapper import AMTIUSBDevice as amti
amti.AMTIUSBDevice.InitializeLibrary(dll_path=<path_to_dll>)

# Initialize and setup amti device for data acquisition
amti_device = amti.AMTIUSBDevice("gen5")
amti_device.init() # Default settings
amti_device.broadcastAcquisitionRate(rate=500)

amti_device.broadcastStart()
sleep(0.01) # wait 10 ms for signal conditioners to acquire data

# Get data matrix
data, sample_num = amti_device.getData(opt=1) # opt 1->caller allocates memory

amti_device.broadcastStop()

Help

Ensure that you are using a version of python compatible with this package. IO specific exceptions are likely a result of an incorrect path.

Authors

Jordy Larrea Rodriguez (CasuallyAlive)

Version History

  • 1.1
    • Supports all basic functionality for interfacing Gen5 signal conditioners
    • Passes all tests
  • 1.0
    • Data acquisition is functional
    • Broadcast functions nonspecific to AMTI parameter configuration are functional
    • MISC bug fixes
  • 0.2
    • C++ API handle is closed without issues
    • initialization functions pass tests
    • Various bug fixes and optimizations
    • See commit change or See release history
  • 0.1
    • Initial Release

License

This project is licensed under the Creative Commons Zero License.

Acknowledgments

References

  • The AMTI USB Device Software Development Kit Reference Manual, v1.3.0, AMTI Force and Motion, March 2017. Accessed: April 09, 2023. Available: AMTI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amtiusbdevicewrapper-1.1.2.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

amtiusbdevicewrapper-1.1.2-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file amtiusbdevicewrapper-1.1.2.tar.gz.

File metadata

  • Download URL: amtiusbdevicewrapper-1.1.2.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for amtiusbdevicewrapper-1.1.2.tar.gz
Algorithm Hash digest
SHA256 baec8954838372c67da28c0c45cecc50a938142ecc48154e4079cf44ca9e7993
MD5 b531c8de201693b20fd765f1c6f0fd2d
BLAKE2b-256 ec7544e7bbe5beba442d247efe544028eacb44946b83ae9fcf4a0c62926a0fda

See more details on using hashes here.

File details

Details for the file amtiusbdevicewrapper-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for amtiusbdevicewrapper-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7fb7053b45b08c110996aa806226bdf6e2b77d6b6626beed2d6791819d8f6d40
MD5 2543e00f2941439bb98002be46d680df
BLAKE2b-256 4a87921b745e6c4af025c9fbc0f9ba123c515de0b1777181017e45e25f62913b

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