pygemstone 0.0.3

Python library for Gemstone Lights permanent-Christmas-lights controllers (AWS-backed cloud API)

pygemstone

Standalone Python library for Gemstone Lights permanent-Christmas-light controllers.

Gemstone's mobile app talks to an AWS Amplify backend (Cognito + API Gateway + AppSync) in us-west-2, so this library is essentially:

• a Cognito SRP login wrapper (delegated to pycognito)
• an aiohttp REST client for the public endpoints that control the lights (/deviceControl/onState, /deviceControl/play/pattern, etc.)

Status: alpha — under active reverse-engineering of the iOS com.gemstone.lights app. APIs will change.

Features

• Async login / token refresh (via Cognito User Pool SRP)
• Account & home group:
  • account_profile() — your user profile
  • homegroups() / homegroup_users(hg)
  • invitations(status="pending") — pending invites (raw dict; schema unknown)
• Devices:
  • devices(hg) — list controllers
  • device_state(id) / set_on_state(id, on) / play_pattern(id, p)
  • device_groups(hg) — multi-device zones (raw dict; schema unknown)
• Pattern catalogue:
  • folders() / folder_patterns(page=N) / save_folder(id, body)
  • swatches() — colour palettes
  • downloadable_folders(page=N) / downloadable_patterns(page=N) — Gemstone-curated catalogue
• Autopilot / scheduling:
  • events_settings(hg) — daily on/off window + enabled categories
  • subscribed_events(hg, page=N) — date-bound holiday/event subscriptions
  • events_categories() — full catalogue of holiday / sport / event categories
• Timers:
  • timers_by_homegroup(hg) — scheduled on/off timers with optional pattern
• Misc:
  • announcements() — in-app announcements

A note on AppSync (real-time)

The library ships an AppSync GraphQL HTTP + WebSocket transport (pygemstone.appsync.AppSyncClient), but two iOS-app captures show the official app never opens a GraphQL connection — only unauthenticated /ping healthchecks. State updates propagate via REST polling of /deviceControl/currentlyPlaying. The AppSync auth scheme is therefore unknown and the transport is currently un-runnable against the real backend; it's kept as scaffolding for if Gemstone ever flips real-time on.

Planned

• Cognito global sign-out (currently only clears local tokens)
• Schedule/event subscribe + unsubscribe mutations
• Timer create / update / delete (only list is currently captured)

Installation

pip install pygemstone

Usage

import asyncio
from pygemstone import GemstoneClient

async def main():
    async with GemstoneClient("[e-mail]", "...") as gc:
        await gc.login()
        for group in await gc.homegroups():
            print(group.name)
            for device in await gc.devices(group.id):
                state = await device.refresh()
                print(" ", device.name, "on" if state.on_state else "off")
                if not state.on_state:
                    await device.turn_on()

asyncio.run(main())

CLI

A small CLI is provided for manual testing:

python -m pygemstone login
python -m pygemstone list
python -m pygemstone state <DEVICE_ID>
python -m pygemstone on <DEVICE_ID>
python -m pygemstone off <DEVICE_ID>

Credentials are read from GEMSTONE_EMAIL / GEMSTONE_PASSWORD env vars, or a .env file in the working directory.

Security note

Like the other Amplify-based IoT services, Gemstone's Cognito user pool id and app client id are public values that any decompiled IPA / packet capture exposes — they're shipped in const.py as defaults. Do not commit credential files, JWT tokens, or mitmproxy .flows files.

Reverse-engineering notes

The endpoint catalogue was derived from a mitmproxy --mode wireguard capture of the official iOS app. Notes are kept private (the capture contains a live Cognito session); the public endpoint shape is in const.py.

License

MIT — see LICENSE.