scadable 2.0.2

Official Python SDK for the Scadable IoT platform.

Scadable Python SDK

The official Python SDK for the Scadable IoT platform. Check gateway status, list devices, and stream live telemetry in 3 lines of code.

Install

pip install scadable

Quick Start

from scadable import Scadable

client = Scadable(api_key="sk_live_...")

# List gateways
for gw in client.gateways.list():
    print(f"{gw.name}: {gw.status}")

# Get gateway detail
gw = client.gateways.get("gateway-id")
print(gw.name, gw.status)

# List devices on a gateway
for device in client.gateways.devices("gateway-id"):
    print(f"{device.name} [{device.status}]")

Stream Live Telemetry

import asyncio
from scadable import AsyncScadable

async def main():
    client = AsyncScadable(api_key="sk_live_...")

    async with client.gateways.stream("gateway-id") as stream:
        async for event in stream:
            print(event.type, event.data)

asyncio.run(main())

Authentication

Pass your API key directly or set it as an environment variable:

# Direct
client = Scadable(api_key="sk_live_...")

# Environment variable
# export SCADABLE_API_KEY=sk_live_...
client = Scadable()

API keys are created in the Scadable Dashboard under project settings.

Error Handling

from scadable import Scadable, AuthenticationError, NotFoundError

client = Scadable(api_key="sk_live_...")

try:
    gw = client.gateways.get("bad-id")
except NotFoundError:
    print("Gateway not found")
except AuthenticationError:
    print("Invalid API key")

Requirements

• Python 3.10+
• Dependencies: httpx, pydantic, websockets

License

Apache 2.0