Skip to content

How to set up a custom device

elral edited this page Sep 9, 2023 · 28 revisions

First of all, it is assumed that you have properbly installed PlatformIO under VSCode. If not, it is the right time to do this. Next clone the firmware reposority and create a new branch for your custom device. Follow the next steps carefully!

  1. A new folder under /CustomDevices is required. The foldername should be your (company)Name. This helps to have a better overview between multiple custom device from different users.
  2. Copy the _template folder into your newly created folder from step 1 and rename this folder to your device name.
  3. Rename MyCustomClass.cpp and MyCustomClass.h to a name which fits to your custom device.
  4. Rename MyCustomDevice_platformio.ini to a name which fits to your custom device (see step 3).
  5. Adapt the include path's from MyCustomClass.cpp, MFCustomDevice.h and MFCustomDevice.cpp from #include MyCustomClass.h to #include YourChangedName.h

Installation

User Interface

Clone this wiki locally