pyryse
Local (no-cloud) async Python client for RYSE SmartShade motorized shades, driven through a RYSE SmartBridge over its LAN HTTP API.
Built to back the Home Assistant integration
ha-ryse-local, but usable on its
own. Not affiliated with or endorsed by RYSE; "RYSE", "SmartBridge" and
"SmartShade" are trademarks of their owner.
Install
pip install pyryse
Usage
import aiohttp
from pyryse import RyseBridge
async def main():
async with aiohttp.ClientSession() as session:
bridge = RyseBridge("192.168.0.123", session)
device = await bridge.async_get_device()
for gear in device.gears:
print(gear.name, gear.position, gear.position_state.name,
gear.online, gear.battery)
# Move a shade. Bridge scale: 0 = open, 100 = closed.
await bridge.async_set_position(device.gears[0].id, 0) # open
If your bridge has local security enabled, pass the serial:
RyseBridge(host, session, serial="...").
Moving several shades at once
The bridge silently drops a command when several arrive together: it answers
200, but one shade never moves. RyseBridge therefore sends commands (POST
requests) one at a time, at least command_interval seconds apart (default
0.5). Concurrent calls such as asyncio.gather(*(bridge.async_set_position(g, 0) for g in gears)) are queued automatically, so callers need no delays of their
own. Reads are not throttled. Use one RyseBridge per bridge, since the queue
is per instance.
Position convention
The bridge's position is the inverse of Home Assistant's cover scale:
0= fully open100= fully closed
pyryse reports the bridge's native values unchanged; invert in your consumer
if you need HA semantics. See docs/PROTOCOL.md for the full
reverse-engineered API.
Per-gear settings
Speed and obstacle detection are per shade.
from pyryse import PowerType
gear_id = device.gears[0].id
# Speed, on the RYSE app's 0-100% scale.
await bridge.async_set_speed_percent(gear_id, 10)
print(await bridge.async_get_speed_percent(gear_id))
# Obstacle detection.
await bridge.async_set_obstacle_detection(gear_id, True)
print(await bridge.async_get_obstacle_detection(gear_id))
# Read-only helpers on a Gear from async_get_device():
gear = device.gears[0]
gear.speed_percent # app percentage, or None
gear.obstacle_detection_enabled # bool, or None
gear.power_source is PowerType.BATTERY
- Speed: the bridge accepts 40-100, and the app shows 0-100% over that
range (
app % = (bridge - 40) / 60 * 100).async_set_speedtakes the raw bridge value and raisesValueErroroutside 40-100, since the bridge answers with a bare HTTP 405.speed_to_percentandpercent_to_speedconvert. Not every percentage survives a round trip: the bridge has 61 values for 101 percentages. - Power type:
PowerType.BATTERY(2),AC_ADAPTER(0) andUSB_CHARGER(1). These are inferred from watching one shade's power source change; RYSE doesn't document them. Unrecognised values givePowerType.UNKNOWN. - Timing: settings take a few seconds to apply, so a read right after a write may show the old value.
Routines (the app's name for scenes) are not available through the local API. Their endpoints are not known.
Wi-Fi
The bridge supports Wi-Fi and Ethernet at once, so these work over either.
# Current Wi-Fi connection (no password is exposed by the API).
status = await bridge.async_get_wifi_status()
print(status.ssid, status.connected, status.ip_address)
# Scan for nearby networks.
for net in await bridge.async_wifi_scan():
print(net.ssid, net.security, net.signal, net.quality_percent)
# Join a network. Ethernet stays up regardless, so a wrong value only
# affects the Wi-Fi link on a wired bridge.
await bridge.async_set_wifi_config("MySSID", password="...", security="WPA2")
License
MIT
Metadata
Release files for pyryse 0.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyryse-0.4.2.tar.gz | 18.4 kB | With provenance | Details for pyryse-0.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyryse-0.4.2-py3-none-any.whl | Python 3 | none | any | Details for pyryse-0.4.2-py3-none-any.whl |
Total release size: 30.3 kB
Release files / pyryse-0.4.2.tar.gz
| Download URL | pyryse-0.4.2.tar.gz |
|---|---|
| Size | 18.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c669cbae131671d96dacebd5d8d0571e38ce2e5626f9165a97389a19067fe21
|
|
BLAKE2b-256 checksum How to use checksums |
dbd89367418e5c741ab35ba161b127093d605e9b564f4510e46d05d15e5e5a7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logRelease files / pyryse-0.4.2-py3-none-any.whl
| Download URL | pyryse-0.4.2-py3-none-any.whl |
|---|---|
| Size | 11.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
54166eb4876d63c19b5e50bb6a58d626055b9a9e383d4e59981f54f14534f243
|
|
BLAKE2b-256 checksum How to use checksums |
4c537edecf0e4b889909417e5defa7968acdcca2b2355a8b95ec4ae5d8e21e01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logSecurity for pyryse 0.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for pyryse-0.4.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.