Skip to main content

KNX Clarity Documentation

Welcome to the documentation site for KNX Clarity — a cloud platform for managing KNX smart-building projects. These docs cover both how to use KNX Clarity as an integrator, building owner, or service technician, and how the platform is built underneath for anyone contributing to the codebase.

The web application lives at app.knx-clarity.com.

For end users — User Guide​

If you're here to use KNX Clarity, start with the user guide.

The full User Guide is in the sidebar on the left.

For contributors — Developer Guide​

If you're building on KNX Clarity — reviewing the design, contributing to the repo, or preparing for the upcoming public API — the developer guide covers:

  • Architecture overview — technology stack, repository layout, and data-flow diagram.
  • Data model — the entities that make up a KNX Clarity organisation and how they relate to each other.

Programmatic API — coming post-beta​

A public REST API and a TypeScript SDK (@knx-clarity/sdk) are on the roadmap for after the public beta. Until the server side of the API is live, programmatic access is not available — please use the web app for now.

The previous draft of the SDK and REST API documentation is archived in the repository (not deleted) and will be restored once the endpoints ship. If you have an integration use case you'd like us to prioritise, open an issue at the GitHub repository.

Contributing​

All of the KNX Clarity source lives in the knx-project-cloud monorepo — the web app, the Amplify Gen 2 backend, the CDK infrastructure, and these docs. Pull requests and issues are welcome.

Public beta

KNX Clarity is in public beta. Features may change and screenshots may briefly fall out of sync with the latest build. If you spot a stale screenshot or an out-of-date instruction, please open an issue or a pull request — the user guide lives at docs/developer/docs/user-guide/ in the monorepo.