Repository structure - OpenKNX/OpenKNX GitHub Wiki

this defines the naming of the repositories within the OpenKNX Github space

Repository Types

Special repos

  • OpenKNX - main repo for general documentation, public project information
  • Organization - private repo for internal project information
  • .github - repo for the OpenKNX Github Organization readme.md (start page)

Device repos

  • contains hardware, software and documentation regarding one physical device
  • named like the device, see here
  • e.g. SA-REG4-8x230V

System repos

  • contains hardware, software and documentation regarding a OpenKNX system
  • one repo per system
  • e.g. OpenKNX-UP1

repos for common software parts

  • common sw/fw for realizing channels
  • driver libraries

tbd

repos for software

multiply-channels, Kaenx, ...

tbd

Tooling

  • KiCad libs
  • information about VSC / PlattformIO, Debugging etc... Toolchain

tbd