Skip to main content

majordom-integration-sdk

Models, protocols, and tooling for building MajorDom integrations.

An integration bridges an external protocol or platform (Matter, Zigbee, HomeKit, a vendor cloud, …) into the MajorDom language. This SDK is the contract: the schemas, the AbstractController framework, the device-repository protocol, discovery services, and a standalone dev runner so you can build and test an integration without a running Hub. The Hub itself depends on this same package — first-party integrations use no private shortcut.

Install

pip install majordom-integration-sdk

Requires Python 3.12+.

Also a standalone IoT toolkit

You don't need MajorDom to get value from this package. majordom_integration_sdk.discovery ships three fully working, standardized device-discovery services you can drop into any async Python project:

  • Zeroconf / mDNS (ZeroconfDiscoveryService) — browse Bonjour/mDNS services with a clean listener protocol, and — unusually — reliable disappearance tracking: it augments raw zeroconf with an active cache-poll + confirm-evict loop so you get accurate "device went away" events, not just arrivals.
  • SSDP / UPnP (SSDPDiscoveryService) — flexible, per-listener configurable search targets and refresh behavior over raw sockets, without dragging in a full UPnP stack.
  • BLE (BLEDiscoveryService) — a uniform listener interface over Bleak for advertisement scanning.

All three share one register(listener, …) → cancel shape, run standalone (each module has a runnable __main__ demo), and are a solid reference for implementing standardized interfaces over messy IoT protocols even if you never touch MajorDom. The AbstractController framework and the DeviceRepositoryProtocol + in-memory/SQLite implementations are equally reusable as a small, typed device-modelling toolkit.

Documentation

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

The fastest way to start a new integration is the integration-template repository (Use this template → Create a new repository).

License

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


Development

Setup:

poetry install && poetry run poe install

This installs dependencies and the pre-commit hook that runs poe check.

Task Description
poe install Install deps and register the pre-commit hook
poe check Full quality pipeline (ruff, ty, pytest, poetry build/check)
poe check --ci Same, plus git diff --exit-code

Two long-lived branches: develop (integration branch, all work lands here) and master (protected, released). Releases are cut from develop via Actions → Release; see ParkerIndustries/workflows for the CI/CD.

Download files

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

Source Distribution

majordom_integration_sdk-0.1.4.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

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

majordom_integration_sdk-0.1.4-py3-none-any.whl (53.3 kB view details)

Uploaded Python 3

File details

Details for the file majordom_integration_sdk-0.1.4.tar.gz.

File metadata

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

File hashes

Hashes for majordom_integration_sdk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 23f6da2bdf7b4ee9928a1a33e6d371c6e5bf05aae0661b7d59656f16501e6418
MD5 63f4164fe0911acca893e2b04f2f4544
BLAKE2b-256 bc4d77684f9a0aafc83d4b89e617e2f268e5723b5e4b4935df486ee35d1e7258

See more details on using hashes here.

Provenance

The following attestation bundles were made for majordom_integration_sdk-0.1.4.tar.gz:

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

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_integration_sdk-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for majordom_integration_sdk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 518e4dbea8872b0f8c209e9dafbdee8c76ef63c32bdd5fd15e8d0802d7a625f9
MD5 a4195efae703276c72f72aa188e20958
BLAKE2b-256 3e5f88c065e80ef21497e1f4e4dadd5e05300cc446eb0cf666dedca361db88f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for majordom_integration_sdk-0.1.4-py3-none-any.whl:

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

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

Release history Release notifications | RSS feed

0.1.6

2 files

0.1.5

2 files

This release

0.1.4 This release

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page