Skip to main content

Python library for controlling SAL Pixie BLE mesh wall switches

Project description

PiggsyDust

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.2.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

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

pigsydust-0.2.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pigsydust-0.2.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for pigsydust-0.2.0.tar.gz
Algorithm Hash digest
SHA256 caf1c546d9238fbf40a5226350a741aa0c4761687adc9bf3ee036435b564a593
MD5 4a4dc46d00e9aefd8466027eb3b6220c
BLAKE2b-256 c68371762532d55dd0db1fd5604ea9230b36cc44a90567eeaf45818323bed657

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pigsydust-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for pigsydust-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6190f6f7a6f04285421f79c16d002e7c3948bc49e4dbad0b7810b3c159529f3b
MD5 9d66a43fb17e93b6a1779bef77e207a1
BLAKE2b-256 a843411ce51e4752762f719683be670434fa5ada0a6d3f530558a063098ddca7

See more details on using hashes here.

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