Skip to main content

ETS files

KNX Clarity stores every exported .knxproj file as a versioned attachment on the owning project. Each version is parsed once by a Lambda and the extracted rooms, devices, and group addresses are written to the project so that you can browse them in the web UI without opening ETS.

Uploading a file

Open the project detail, switch to the ETS files tab, and click Upload. A file picker appears; choose a .knxproj (ETS 5 or ETS 6 format, up to 200 MB), optionally add a comment, and click Upload.

ETS upload dialog with a file-drop area labelled 'Drop .knxproj here or click to browse', a comment text input, and Cancel / Upload buttons.

During upload you'll see a progress bar. When the upload completes:

  1. The file is stored in the project's S3 prefix.
  2. A background Lambda parses the zip, extracts the XML, and upserts the project's rooms, devices, and group addresses.
  3. The version row moves from parsing to ready.

Parsing usually completes in under 10 seconds for a typical single-family home. Larger commercial projects can take up to a minute; refresh the tab if it looks stuck.

Versioning

Every upload creates a new version, never overwrites the previous one. Version numbers are dense (v1, v2, v3, …) and assigned server-side, so two technicians can upload simultaneously without a collision.

ETS version list showing rows for v3 (ready, uploaded 2 hours ago, 14.2 MB), v2 (ready, 1 week ago), v1 (ready, 2 months ago). Each row has a download button and a 'view parsed' link.

Each row shows:

  • Version number
  • Original filename
  • File size
  • Uploader name
  • Upload timestamp
  • Comment (if any)
  • Parse status

Downloading

Click the download button on any version to fetch the original .knxproj. Downloads are currently served as a signed S3 URL valid for 15 minutes — if the link expires, click download again.

Beta limitation

Cross-organisation downloads (when you're reviewing a project that was transferred to you from another org) are on the short-list for the next beta release and are currently gated to the uploading user's identity. If you need urgent access to a file your colleague uploaded, either re-upload from an ETS backup on your own machine or ask them to share it over your usual out-of-band channel.

What the parser extracts

EntityStored inShown under
Roomsrooms tableRooms & devices → tree
Devicesdevices tableRooms & devices → device list
Group addressesgroup_addressesGroup addresses tab
ManufacturersMatched to catalogLinked from device rows

Anything ETS knows about but KNX Clarity does not yet surface in the UI (bus couplers, parameters, communication objects, scenes) is not lost — it stays in the parsed JSON blob in S3 and becomes available the moment we ship a page for it.

Replacing a corrupt upload

If a version ended up in error status (parser failure, truncated upload, wrong file format) the row shows a red status badge with the short error message. Click ⋮ → Delete version to remove it, then upload again. Deleting an error version leaves the earlier parsed state untouched.

Comment convention

We recommend writing a one-line comment on every upload explaining what changed since the previous version. This becomes the project's audit trail and is the first thing a service technician opens months later. Good examples:

  • Added 3x dimmer in kitchen, reassigned GA 1/2/15 to the island
  • Fixed typo in EG-WC switch name
  • Initial commissioning export