Skip to main content

Python library for interfacing with an AnySkin sensor

Project description

# AnySkin Sensor Library This is a python library to interface with [AnySkin](https://any-skin.github.io) sensors. Much of this is adapted and streamlined from the [reskin_sensor](https://github.com/raunaqbhirangi/reskin_sensor) library. We provide two classes for interfacing with [AnySkin](https://openreview.net/forum?id=87_OJU4sw3V). The AnySkinBase class is good for standalone data collection: it blocks code execution while data is being collected. The AnySkinProcess class can be used for non-blocking background data collection. Data can be buffered in the background while you run the rest of your code.

Latest stable release is v1.0.0

## Installation

This package can be installed using pip: ` pip install anyskin ` Alternatively, if you would like the latest (potentially unstable) version, 1. Clone this repository: ` git clone https://github.com/raunaqbhirangi/anyskin.git --recursive ` 2. Install this package: ` pip install -e . `

## Usage: Quick Setup This guide assumes you are using the AnySkin startup kit.

  1. Connect the magnetometer circuit board to the microcontroller using the provided QWIIC cable.

  2. Insert the circuit board into the fingertip slot and pull the skin over the printed 3D tip.

  3. Connect the microcontroller (Adafruit QT Py) to your computer using a USB-C cable. The startup kit comes with pre-loaded arduino code. If you would like to change the uploaded code, refer to the [arduino](./arduino) folder.

4. Find the dev path/COM port your microcontroller is connected to. The simplest way to do this is: <br><br> <b>Linux:</b> ls /dev/ | grep -e ACM -e USB. This is generally /dev/ttyACM0 or /dev/ttyUSB0. <br>If you get a can’t open device “<port>”: Permission denied error, modify permissions to allow read and write on that port: sudo chmod a+rw <port> <br> <b>MacOS:</b> ls /dev/ | grep cu.usb. This is generally cu.usbmodem*. <br> <b>Windows:</b> Open Device Manager. Click View and select Show Hidden Devices. Locate Ports (COM & LPT). Note the COM port corresponding to the QT Py. <br><br>If you have no other devices connected, this should give you a single path. If you see multiple, disconnect the microcontroller and run the command again. Reconnect the microcontroller and re-run the command. The additional path is your <port>.

  1. Run the visualizer with the <port> identified in the previous step: <br>`anyskin_viz <port>`

## Credits This package is maintained by [Raunaq Bhirangi](https://www.cs.cmu.edu/~rbhirang/). We would also like to cite the [reskin_sensor](https://github.com/raunaqbhirangi/reskin_sensor) library from which much of this library is derived.

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

anyskin-1.0.0.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anyskin-1.0.0-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

Details for the file anyskin-1.0.0.tar.gz.

File metadata

  • Download URL: anyskin-1.0.0.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for anyskin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a81e541df04f8967ef7ab3a40c3edab64cbe577f1c9df3d7cd5b7dea9822d214
MD5 30f6cf4cf339100c34bf2121acb6745b
BLAKE2b-256 465d191ebf1685bf31f4fe9bf9b6c1e5fdd93f9dbdfe80ae766d747bb6e67db5

See more details on using hashes here.

File details

Details for the file anyskin-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: anyskin-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for anyskin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2cc113d44b6e0f9668372a0208375a7598da0e250914546251356520b0dc04b0
MD5 718fd7ea6e973bcdeb6bf00f5729a925
BLAKE2b-256 dfd673f1e4a2aec7116e3eac196191a0795c7835f1dde3bd4dee8e260b0c630a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page