Skip to main content

Python Libraries for Estim Unit (ErosTek ET312, Erostek ET232, Estim Systems 2B) Control

Project description

buttshock-py

Python implementation of serial based control of the following devices:

  • Erostek ET-312 Electrostimulation Device

  • Erostek ET-232 Electrostimulation Device

  • Estim Systems 2B Electrostimulation Device

docs

Documentation Status

tests

Travis CI build status Code health Code coverage

package

Latest PyPI version Latest PyPI version Latest PyPI version

Using pyserial 3.1.1 (thought may work with pyserial 2.6+, but untested)

Buttshock Project Goals

If you’re going to shock yourself in the butt (or other places) for sexual pleasure, don’t you want to be able to know exactly what and how you’re doing it? Even if you can’t understand it, wouldn’t it be nice for people that do to have access to the knowledge and data they need to make sure things are safe? Why is the best encryption open source, but electrostim toys are closed?

The Buttshock project exists to reverse engineer and document eletrostim devices so that any developer that wants to control their devices can, via their own code.

Some of the goals of this project include:

  • Documenting the communications protocols (serial or otherwise)

  • Reverse engineering the firmware (where possible)

  • Mapping the circuit boards and creating schematics

Python Implementation Details

This is a python implementation of the RS-232 control protocol for the ErosTek ET-312 electrostimulation box.

Documentation of the protocol is kept in the main documentation repo at:

https://github.com/metafetish/buttshock-protocol-docs

This library was developed and tested using a ET-312B running v1.6 firmware. The ET-232 and 2B libraries are untested, but please let us know if you’ve used them and they do/don’t work!

Requirements

buttshock-py requires the pyserial library if you want to actually connect via serial. However, it can pass packets for each box over whatever medium you like.

Repo Contents

This repo contains the following:

  • src - Source code for the library

  • examples - Example code that uses the library

License

tl;dr: BSD 3-Clause license

Copyright (c) 2016, Buttshock Project

See LICENSE file for full text.

Versions

0.2.0 (2016-07-05)

  • Change module layout to plan for new hardware implementations

  • Add documentation tree

  • More tests

0.1.2 (2016-07-05)

  • Fixed serial initialization issue

0.1.1 (2016-07-04)

  • CI/automation changes

0.1.0 (2016-07-04)

  • Initial Release

  • Basic ET-312 functionality

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

buttshock-0.2.0.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

buttshock-0.2.0-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file buttshock-0.2.0.tar.gz.

File metadata

  • Download URL: buttshock-0.2.0.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for buttshock-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d2a87c5e4ce08e7d473b7f027e0bbb08c487ea22a9a8b15381f56470683622ec
MD5 eea33b86877bbe2b3d924079528a033b
BLAKE2b-256 2692d3add64eaafd1986512b05bb664060fe947ee992361b2935fb00ff740d43

See more details on using hashes here.

File details

Details for the file buttshock-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for buttshock-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1cb519a3a5f8e3880455d53146f84f155429fadd37f76be53b0f304c83ad3d83
MD5 690ac8b0c04ffe96c14305eed8b9c774
BLAKE2b-256 dac2ed12475747e5f147132bcc1b7434712b13e4017073afd733cb79b634f2e4

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