Skip to main content

HomeKit integration for MajorDom — bridges HomeKit accessories into the MajorDom language.

Project description

integration-homekit

A MajorDom integration — bridges Apple HomeKit accessories into the MajorDom language.

Built for the MajorDom Hub, but it doesn't need it: this is a standalone, standardized library for HomeKit that you can use on its own (see Run it standalone below). Built on the MajorDom Integration SDK. The entry point is HomeKitController (majordom_homekit/controller.py), which the Hub — or the SDK's dev runner — instantiates and drives through its lifecycle: discovery → pairing → commands → teardown.

Documentation

Full integration-author docs — the controller lifecycle, data models, storing data, discovery, and a worked example — live at docs.majordom.io.

Development

poetry install && poetry run poe install
Task Description
poe check Full quality pipeline (ruff, ty, pytest, poetry build/check)
poe check --ci Same, plus git diff --exit-code

Work lands on develop; master is protected and released via Actions → Release. Tests drive the controller with the SDK's test doubles against an in-process fake HAP accessory server — no real accessory required (see tests/).

Run it standalone (without the Hub)

majordom-homekit is a standalone library — import it into your own app, or run just this integration interactively (discover, pair, control, and inspect devices from a prompt) with no Hub. It discovers IP accessories over mDNS (BLE accessories need a BLE adapter); no external service is required.

See Standalone mode for the interactive CLI, watch mode, and the programmatic API.

About this integration

  • Protocol / platform: Apple HomeKit Accessory Protocol (HAP) via the parker-aiohomekit fork of aiohomekit.
  • Transport(s): IP (Wi-Fi / Ethernet, discovered via mDNS); BLE for BLE accessories.
  • Supported devices: HomeKit-compatible accessories — lights, plugs, switches, sensors, locks.
  • Credentials needed to pair: code (the accessory's 8-digit HomeKit setup code).

Required harness

  • Hardware adapters: a BLE adapter only if pairing BLE accessories; IP accessories need none.
  • Third-party software services: none — aiohomekit speaks HAP directly.
  • OS / permissions: mDNS on the LAN for discovery; BLE access for BLE accessories.

Protocol stack (OSI)

OSI layer Protocol Implemented by
Application (7) HAP characteristics / services this integration (via aiohomekit)
Session (5) Pair-Setup / Pair-Verify (SRP, Ed25519) library (aiohomekit)
Transport (4) TCP (IP) / GATT (BLE) OS
Network + below (1–3) IP over Wi-Fi / Ethernet (or BLE) OS

Progress

  • Discovery services registered (mDNS via zeroconf_discovery_service; BLE where applicable); cancel closures called in stop
  • Discovery listeners fire and call controller_did_receive_discovery
  • Re-discovery of already-paired accessories on reconnect (controller_did_connect_device)
  • Device pairing (HAP pair-setup with the setup code)
  • Device schema mapped: services/characteristics → parameter list with per-parameter metadata
  • Hub → Device control (send_command)
  • Device → Hub event subscription (controller_did_receive_events)
  • identify
  • unpair
  • fetch
  • Availability tracking while running (controller_did_lose_device / last_error)
  • Graceful shutdown in stop
  • Tests pass against a fake HAP accessory server (tests/)

Notes

Uses the parker-aiohomekit fork of aiohomekit; note its Python upper bound (<3.14).

License

See LICENSE. For commercial licensing or partnership inquiries regarding MajorDom, contact us via parker-industries.org/partnership.

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

majordom_homekit-0.1.5.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

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

majordom_homekit-0.1.5-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file majordom_homekit-0.1.5.tar.gz.

File metadata

  • Download URL: majordom_homekit-0.1.5.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for majordom_homekit-0.1.5.tar.gz
Algorithm Hash digest
SHA256 cc82a1bb50e50583638a27b8d8db5723968b3d0289c05cf47392df086769d44f
MD5 0d4096e7777b92d24e65527beba3e71d
BLAKE2b-256 95cb761a1338eccf18ea2b5f6eb0f40bbf31123dc2fab30b2f16cabca166b31e

See more details on using hashes here.

Provenance

The following attestation bundles were made for majordom_homekit-0.1.5.tar.gz:

Publisher: release.yml on MajorDom-Systems/integration-homekit

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

File details

Details for the file majordom_homekit-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for majordom_homekit-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d64ba799801e06da9bb4422de19e2ded9616d20eb1a8d66240f6f4c6cf71ed6a
MD5 6632340dc2a1fadb618860defbe5272c
BLAKE2b-256 01f2c97a9c05ef5d77e9a671fcc9cd85d4ca8aa9f4645ded665da8a68ff44ebb

See more details on using hashes here.

Provenance

The following attestation bundles were made for majordom_homekit-0.1.5-py3-none-any.whl:

Publisher: release.yml on MajorDom-Systems/integration-homekit

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