Information for Developers - OpenKNX/OpenKNX GitHub Wiki

Setup Environment and Build first firmware

If you want to setup your environment please follow the steps 1 to 3 under Software Development.
Pleas make sure you also read Information for Users.

---

General

• Naming Conventions
  If you want to create a new repo please use our naming conventions.
• Repository structure
  This is how we organize our repos.
• OpenKNX Working Model
  Regeln zur Zusammenarbeit im OpenKNX Projekt

Software Developement

• Installation of OpenKNX development environment for PlatformIO (PIO)
  Get your environment ready for building openknx firmware.
  You will set up Powershell and Git CLI.
• Getting (cloning) an OpenKNX Project from Github
  Clone your first OpenKNX repo and restore a build system with our powershell scripts.
• Building an OpenKNX project locally on your PC
  Build and upload your first firmware with the builtin PlatformIO tasks.
• In Circuit Debugging
  Some helpful information if you want to debug your device.
• Hinweise zum Arduino-Pico Core
• Versionierung von Modulen (OFM)
  Get information about our versioning tools.
• FunctionProperties Liste von OpenKNX FunctionProperty IDs und Beschreibung

KNX Product Database (knxprod)

• OpenKNXproducer
  Here you have full control of your knxprod by writing direct in xml.
  You can multiply channels and use other openknx modules.
• Kaenx-Creator
  Create your knxprod with a UI.
  Don't mind the memory or ids they will be calculated automaticly.
• Information about KnxProd
  ApplicationNumber, ApplicationVersion, Loadprocedures , OrderNumber, OpenKNXproducer

Hardware Deveopement

• Hardware Toolchain
  A list of tools we use.
  (KiCAD, FreeCAD, ...)
• OpenKNX KiCad Lib
  A lib of our PCBs (NanoBCU, ...) to use in KiCAD.