Skip to main content

Welcome to the relayr Python Library. The repository provides Python developers with programmatic access points to the relayr platform.

These include access to the relayr cloud via the relayr API as well as direct connection to the relayr WunderBar sensors, via Bluetooth Low Energy (using BlueZ on Linux, still very experimental).

Installation

You can install the library using one of the following methods, with the help of Pip:

  1. You can download the very latest version of the repository from GitHub:

    pip install git+https://github.com/relayr/python-sdk
  2. You could also use the following to install the package from the Python Package Index:

    pip install relayr

Examples

Receive a 10 second data stream, from one of your WunderBar sensors (device). In the example below the device does not have to be a public one in order to be used. You can obtain your device IDs from the relayr Dashboard My Devices section:

MQTT style (new)

import time
from relayr import Client
from relayr.dataconnection import MqttStream
c = Client(token='<my_access_token>')
dev = c.get_device(id='<my_device_id>')
def mqtt_callback(topic, payload):
    print('%s %s' % (topic, payload))
stream = MqttStream(mqtt_callback, [dev])
stream.start()
time.sleep(10)
stream.stop()

PubNub style (old)

import time
from relayr import Client
c = Client(token='<my_access_token>')
dev = c.get_device(id='<my_device_id>').get_info()
user = c.get_user()
app = c.get_app()
def pubnub_callback(message, channel):
    print(repr(message), type(message))
conn = user.connect_device(app, dev, pubnub_callback)
conn.start()
time.sleep(10)
conn.stop()

Switch a device’s LED on/off

from relayr import Client
c = Client(token='<my_access_token>')
d = c.get_device(id='<my_device_id>')
d.switch_led_on(True)

Documentation

For references to the full documenation for the Python library please visit our Developer Dashboard Python section!

Metadata

Release files for relayr 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for relayr 0.2.4
File Size Uploaded
relayr-0.2.4.tar.gz 228.6 kB Details

Release files / relayr-0.2.4.tar.gz

Download URL relayr-0.2.4.tar.gz
Size 228.6 kB
Tags Source
SHA-256 checksum
How to use checksums
18ae78f85147b98bf88157edfde331a9e0ab699957714fdae1b6de4aed1a8ab8
BLAKE2b-256 checksum
How to use checksums
4ca6ea2501473f096594f94bf72a34f55645f55e13b1be1b20780ed82d0990b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2.4 This release

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page