Git Product home page Git Product logo

knxp_boilerplate's Introduction

knxp_boilerplate

Boilerplate for knx_platformio projects.

usage

This repo is a GitHub template. Make your own repo using this template and start building from there.

This template is provided to jump-start a project using knx_platformio, a framework for building KNX devices.

platformio.ini

Please find all necessary compiler options and supported defines for the boilerplate/library in the [env]section. It should be pretty self-explanatory. Note that envs are provided for ESP8266 as well as for ESP32. Also, -dev and -prod environments are provided using different build and deployment options. It is assumed that prod environments are updated Over The Air in this example.

xml-tools

To program your KNX device using ETS, you need a .knxprod file. This can be created using KaenX, which takes an XML file as input. To get you started with the XML file, xml-tools are provided.

mkxml.py takes a template XML file and a settings file and 'merges' the two. That should help you getting started with the XML file.

src

Contains knx_app.cpp which implements your app. It is based on the base-class _knxpp and contains an example of each function you're likely to override.

include

knx_app.h defines the application class and constants. It shows all methods you could potentially override with some documentation.

ToDo

Improve knxapp to showcase more usecases.

knxp_boilerplate's People

Contributors

erikmeinders avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.