pygc3

Async client for the 2GIG GC3 panel's local automation API — the same header-authenticated HTTPS API the Elan SC100 used.

Transport + typed models only. HA state mapping, MQTT, and night-mode tracking live in the consumer, not here.

Install

pip install pygc3

Requires Python ≥3.11 and aiohttp.

Use

import asyncio
from pygc3 import GC3Client

async def main():
    async with GC3Client("192.168.1.25", pairing_key="123456",
                         api_key="<issued-token>") as gc3:
        status = await gc3.status()          # PanelStatus
        zones = await gc3.zones()            # list[Zone], console filtered out
        print(status.arm_state, len(zones))

        await gc3.arm(stay=True, night=True) # night = stay + instant entry
        await gc3.disarm("1234")

asyncio.run(main())

Pass an existing session to reuse Home Assistant's shared one (it won't be closed for you):

GC3Client(host, pairing_key, api_key, session=hass_session)

Enrolment (no api_key yet)

With the panel in System Pairing mode, enrol without a token — the panel issues one back:

async with GC3Client(host, pairing_key="123456") as gc3:  # no api_key
    issued = await gc3.pair("Home Assistant")

API

Errors: GC3AuthError (403 / bad key → reauth), GC3ConnectionError (unreachable / timeout → retry), GC3ResponseError (bad status or non-JSON), all subclasses of GC3Error.

TLS verification is off by default (verify_ssl=False) for the panel's self-signed cert.

Develop

python -m venv .venv && . .venv/bin/activate
pip install -e ".[test,dev]"
pytest --cov=pygc3      # 27 tests, ~98% coverage; HTTP faked via the session seam
mypy                    # strict, clean
ruff check src tests

Fixtures under tests/fixtures/ are real panel captures; the pairing fixture's 6-digit code is redacted to 000000.

Release

rm -rf dist build src/*.egg-info
python -m build          # sdist + wheel
twine check --strict dist/*
twine upload dist/*

Version lives in pyproject.toml and pygc3/__init__.__version__; bump both, update CHANGELOG.md, then tag pygc3-v<version>.

Licence

MIT — see LICENSE.