Skip to main content

Data Model

The KNX Clarity data model is designed around the real-world relationships in KNX building automation projects.

Entity Relationship Overview

Organization
├── Members (Users with roles)
├── Customers
└── Projects
├── Rooms
│ └── Devices
│ └── Group Addresses
├── ETS Files (versioned)
├── Service Cases
│ └── Comments
├── Escrow Records
└── Transfer Requests

Core Entities

Organization

The top-level entity representing a KNX integrator company. All data is scoped to an organization.

Project

A building automation project, linked to a customer and containing all technical data (rooms, devices, group addresses) as well as business data (service cases, escrow records).

Device

A KNX device installed in a room, with properties like manufacturer, model, and KNX individual address.

Group Address

A KNX group address used for communication between devices. Includes the address notation (e.g., "1/2/3"), datapoint type, and descriptive metadata.

ETS File

Versioned ETS project files uploaded to the platform. Each version is stored in S3 with metadata in the database.

Service Case

A support ticket linked to a project, with priority levels, status tracking, and threaded comments.