This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

kHole - Python Libraries for controlling and reading the Minna kGoal Bluetooth Kegelcizer

Project Description

kHole (Python Version)

Reverse engineered drivers for the Minna kGoal kegel exerciser.

Description

The kGoal is a Bluetooth LE Kegelcizer device, made to communicate with iPhone and android phones. The kHole project aims to make the device accessible to other platforms, such as desktop, arduino, Raspberry Pi, and other bluetooth accessible systems.

Protocol

In terms of communication, the kGoal is a fairly simple device, It uses BTLE to connect to a host, with no pairing or long term key exchange. After this, the host can do the following things:

  • Request the values of 2 internal sensors
  • Set whether vibration feedback happens via “Squeeze Pillow” or “Control Arm”

That’s pretty much it.

To read information from the device, issue a characteristic read request to handle 0x2a. This should return a 19 byte value, similar to the one below:

00 01 04 01 9b 07 67 00 00 00 00 00 00 00 00 00 00 00

The important values are:

  • bytes 3-4 (0x019b in example) - This is the big-endian calibrated sensor reading, starting from 0 based on the last calibration setting and going up. Calibration can be reset by hitting the button on the top of the toy, which makes the LED turn green.
  • bytes 5-6 (0x0767 in example) - This is the big-endian uncalibrated sensor reading. It’ll always report the same range no matter the calibration setting.

Python Implementation

The python implementation in the library allows access to the aforementioned functionality. As it is using pybluez, it will currently only work on linux. But who doesn’t do their kegels near a linux box these days?

License

kHole-py is BSD licensed.

Copyright (c) 2016, Metafetish All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Versions

0.1.0 (2016-08-20)

  • Initial Release as package
  • Basic coverage of known functionality
Release History

Release History

This version
History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
khole-0.1.1-py2-none-any.whl (6.5 kB) Copy SHA256 Checksum SHA256 py2 Wheel Aug 21, 2016
khole-0.1.1.tar.gz (3.9 kB) Copy SHA256 Checksum SHA256 Source Aug 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting