Skip to main content

Python library for controlling SAL Pixie BLE mesh wall switches

Project description

Pigsydust

A Python library for controlling SAL Pixie / Telink BLE mesh wall switches - fully offline, no cloud, no hub, no app dependency.

PyPI

Features

  • Full protocol implementation - login, session key derivation, AES-CCM encryption/decryption
  • Device control - on/off, LED indicator control (blue/orange/purple), find-me blink
  • Status monitoring - broadcast queries, real-time push notifications (0xDB/0xDC)
  • Cross-platform - macOS (CoreBluetooth) and Linux (BlueZ via raw HCI)
  • Home Assistant integration - see ha-pigsydust

Install

pip install pigsydust

On Linux, the process needs CAP_NET_RAW (or run as root / --privileged in Docker) for the raw HCI socket used to receive BLE notifications.

Quick Start

import asyncio
from pigsydust import PixieClient

async def main():
    client = PixieClient("AA:BB:CC:DD:EE:FF")
    await client.connect()
    await client.login("Smart Light", "12345678")

    await client.turn_on(1)

    status = await client.query_status()
    for addr, ds in status.items():
        print(f"Device {addr}: {'ON' if ds.is_on else 'OFF'}")

    await client.disconnect()

asyncio.run(main())

API

Method Description
connect() Establish BLE connection (scans on macOS, direct on Linux)
login(name, password) Authenticate with the mesh
turn_on(addr) / turn_off(addr) Control a device, group, or broadcast (0xFFFF)
query_status() Poll all devices and return dict[int, DeviceStatus]
set_led_blue(addr, on) Toggle blue indicator LED
set_led_orange(addr, level) Set orange indicator LED brightness (0-15)
set_led_purple(addr, level) Set purple (both) indicator LED
reset_led(addr) Clear indicator LEDs
find_me(addr) Flash device LED for 15 seconds
on_status_update(callback) Register for real-time push notifications
disconnect() Disconnect and clean up

Mesh credentials

All nodes in a Pixie mesh share two values:

  • Mesh name - typically "Smart Light" (the firmware default)
  • Mesh password - the numeric string shown in the Pixie app's "Share Home" screen

Protocol reference

See docs/PROTOCOL-REFERENCE.md for the complete reverse-engineered protocol specification.

License

MIT

Project details


Download files

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

Source Distribution

pigsydust-0.6.2.tar.gz (48.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pigsydust-0.6.2-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file pigsydust-0.6.2.tar.gz.

File metadata

  • Download URL: pigsydust-0.6.2.tar.gz
  • Upload date:
  • Size: 48.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pigsydust-0.6.2.tar.gz
Algorithm Hash digest
SHA256 0dca30dfc3cff93ac05f1f592211971aa519ae47063de8b53111fa23e928697b
MD5 4b9a9c3677cb2dac44785750ac1e5178
BLAKE2b-256 bca651a740cb6b47f8fc799597c56faaf5560c122893af3c3a2e2f0417330731

See more details on using hashes here.

Provenance

The following attestation bundles were made for pigsydust-0.6.2.tar.gz:

Publisher: release.yml on tcslater/pigsydust-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pigsydust-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: pigsydust-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pigsydust-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a1ace3d5678b478baff541cc30a8a95eacbe00605c649fec9bba66434f9cbce3
MD5 8f6c0777dd9397b7c12b84468e50802e
BLAKE2b-256 ff76bdf806c7bb6512fe84356158fce57f040efa866e1abf0cb3a259c8121bd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pigsydust-0.6.2-py3-none-any.whl:

Publisher: release.yml on tcslater/pigsydust-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page