Skip to main content

A10SA Script

Project description

PyPI Status Python Version License

Read the documentation at https://a10sa-script.readthedocs.io/ Tests Codecov

pre-commit Black

Library for manipulating Vorze A10 sex toy scripts.

Features

  • Read/Write/Convert supported script formats.

  • Export scripts as Buttplug Protocol command sequences.

Experimental features

Experimental features are not fully tested, use at your own risk.

  • Control Vorze devices directly via BluetoothLE (tested with CycloneSA, untested for UFOSA, PistonSA).

  • Control linear/funscript devices via Buttplug Protocol (requires Intiface Central, tested with Handy).

Bluetooth functionality requires installation with ``[ble]`` dependencies.

Supported Formats

  • Vorze CSV

  • Afesta/LPEG VCSX (.bin)

  • Funscript JSON

Requirements

  • Python 3.11+

Installation

You can install A10SA Script via pip from PyPI:

$ pip install a10sa-script

Optional dependencies can also be installed to enable experimental feature support:

$ pip install a10sa-script[ble]

Usage

Convert VCSX Vorze_CycloneSA.bin to script_cyclone.csv:

>>> from a10sa_script.script import VCSXCycloneScript, VorzeRotateScript
>>> with open("Vorze_CycloneSA.bin", "rb") as f:
...     vcsx = VCSXCycloneScript.load(f)
>>> with open("script_cyclone.csv", "wb") as f:
...     VorzeRotateScript(vcsx.commands).dump(f)

Convert CSV script_piston.csv to script.funscript:

>>> from a10sa_script.script import VorzeLinearScript, FunscriptScript
>>> with open("script_piston.csv", "rb") as f:
...     csv = VorzeLinearScript.load(f)
>>> with open("script.funscript", "wb") as f:
...     FunscriptScript.from_vorze(csv).dump(f)

Convert funscript script.funscript to script_piston.csv:

>>> from a10sa_script.script import VorzeLinearScript, FunscriptScript
>>> with open("script.funscript", "rb") as f:
...     funscript = FunscriptScript.load(f)
>>> with open("script_piston.csv", "wb") as f:
...     funscript.to_vorze().dump(f)

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, A10SA Script is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

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

a10sa_script-1.1.0.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

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

a10sa_script-1.1.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file a10sa_script-1.1.0.tar.gz.

File metadata

  • Download URL: a10sa_script-1.1.0.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.26.2 CPython/3.12.3 Linux/6.14.0-1017-azure

File hashes

Hashes for a10sa_script-1.1.0.tar.gz
Algorithm Hash digest
SHA256 3721c30d361048bb324fc424520c9fc546a23f0a1a0cf0ffa04038758cb22648
MD5 a93df087bece0dc436974c91112bb64f
BLAKE2b-256 489747d6ebd859ac704dd7c4d02e1ceb8d92d84ec511e9af157a47e6e517a1be

See more details on using hashes here.

File details

Details for the file a10sa_script-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: a10sa_script-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.26.2 CPython/3.12.3 Linux/6.14.0-1017-azure

File hashes

Hashes for a10sa_script-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 25e4e877f1446898f1471f0de38927942f36d7855334c4a5d5a8ba90973bd1a7
MD5 f0d903900f12fa425af50097cf5ceba6
BLAKE2b-256 2c93757f626b275490fd152cad7cf05fb5be75bd17fa929ac7f3ba500b2c19c4

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