Skip to main content

Python SDK for the Zorb Engine

Project description

ZorbPy

Python library for integrating with the Somatic Zorb Engine

license Twitter

Installation

First install the Adafruit BluefruitLE library.

Please note that this library only currently supports macOS and Linux, as Windows is not currently supported by the underlying BLE package used for this library.

After installing the BluefruitLE library, installation of ZorbPy using pip is simple:

pip install zorb

Library Usage

For a quick example on how to use the ZorbPy library, please reference example.py.

To use the ZorbPy library, you must wrap the functionality of your program in a function that is passed to the zorb.run() function call.

Any usage of the functions provided by this library outside of the process started by zorb.run() will produce error behavior.

The ZorbPy library provides three main functionalities:

  • connecting to advertising Zorb devices

  • triggering presets on the Zorb device

  • directly controlling actuator intensity on the Zorb device

To connect to an advertising Zorb device:

zorb.connect()

To trigger one of the available presets:

zorb.triggerPattern(zorb.POINT_LEFT)

Note that preset haptic emojis are exist for the following emojis:

๐ŸŽŠ, ๐Ÿ‘ˆ, ๐Ÿ‘‰, ๐Ÿค›, ๐Ÿคœ, โฎ๏ธ, โญ๏ธ, ๐Ÿ™Œ, ๐Ÿ‘‹, ๐Ÿ˜ฏ, ๐Ÿ˜ณ, ๐Ÿ˜ฌ, ๐Ÿ˜Š, ๐Ÿ˜„, ๐Ÿคฃ

To directly set the actuator values:

duration = 100
top_left = 0
top_right = 0
bottom_left = 25
bottom_right = 25

zorb.writeActuators(duration, top_left, top_right, bottom_left, bottom_right)

Below is a more comprehensive example of a simple program that connects to a Zorb device, plays a confetti pattern upon successful connection, and then updates actuator values based on some hypothetical sensor output.

import zorb

def mainloop():
    # perform initial connection to Zorb device
    zorb.connect()

    # trigger confetti effect upon successful connection
    zorb.triggerPattern(zorb.CONFETTI)

    # enter infinte loop for updating Zorb device
    while True:
        top_left = hypothetical_sensor_1.val()
        top_right = hypothetical_sensor_2.val()
        bottom_left = hypothetical_sensor_3.val()
        bottom_right = hypothetical_sensor_4.val()
        zorb.writeActuators(10, top_left, top_right, bottom_left, bottom_right)
        time.sleep(0.01)


def main():
    zorb.run(mainloop)


if __name__ == '__main__':
    main()

Style Guide

Contributions to this project should conform to this Python Style Guide.

License

ZorbPy is released under the MIT license.

Project details


Download files

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

Files for zorb, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size zorb-0.1.5.tar.gz (5.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page