Documentation

How to build, use and extend Tinkerbus, and how to use the online product index.

Tinkerbus is an open-source tool for KNX installations. It works with ETS 6 project files, talks to the bus through a KNXnet/IP gateway, and can load a device from a project.

Start here:

The documentation describes what the source tree does today. Where something is not implemented, or implemented but not tested on hardware, the page says so.


Overview

What Tinkerbus is, how it compares with ETS 6, what is open, and common questions.

Getting started

Build Tinkerbus from source, start it, and open a project.

The application

One page for each section of the Tinkerbus desktop application.

Command line tools

Reference for knxproj, knxprobe, knxdownload, knxprogram and knxcap.

Programming devices

How Tinkerbus loads a project device into a real device, the safety checks, and which devices are verified.

Online index

knxprod-index, the service at index.tinkerbus.org that lists manufacturer product data and serves checked copies.

Reference

File formats, the settings file, and the protocols and data types Tinkerbus supports.

Architecture and contributing

How the Tinkerbus source tree is organised, how it is tested, and how to contribute.

Legal

Independence from the KNX Association, trademarks, licence, warranty and responsible use.