Skip to content

README.md

Latest commit

 

History

History
61 lines (41 loc) · 2.51 KB

README.md

File metadata and controls

61 lines (41 loc) · 2.51 KB

TcMenu and IoAbstraction IDE/toolchain project

Summary

This project is a shell that can be used to work with and build our libraries for either platformIo or PicoSDK with CMake. You can choose to use this, or take inspiration from it and roll your own core project. To use with platformIO simply open in a suitable IDE in the top level directory, it has a platformio.ini. To use with CMake, simply open the cmakeProject directory with a suitable IDE.

Although this is mainly aimed at users and developers of tcMenu based applications, it also serves as a getting started point for you to develop source and build both libraries within an IDE using platformIO or PicoSDK Cmake.

Initial set up:

  1. Clone this repo
  2. Create a lib and mbed_lib directory under the cmakeProject directory (this makes it easy to host both options in one solution)
  3. Clone IoAbstraction, LiquidCrystalIO, TaskManagerIO, tcMenu, SimpleCollections, TcMenuLog and tcUnicodeHelper into the lib directory
  4. Clone AdafruitGFXNativePort into the mbed_lib directory
  5. Set up either platformio.ini with the right parameters for your board, or configure Cmake and import the cmakeProject directory into an IDE.

Library Setup

Required libraries in cmakeProject/lib

Required libraries in cmakeProject/mbed_lib

Commands to execute in order to prepare

From the cmakeProject directory

mkdir lib
cd lib
git clone https://github.com/TcMenu/TaskManagerIO.git
git clone https://github.com/TcMenu/IoAbstraction.git
git clone https://github.com/TcMenu/tcMenuLib.git tcMenu
git clone https://github.com/TcMenu/tcUnicodeHelper.git
git clone https://github.com/TcMenu/SimpleCollections.git
git clone https://github.com/TcMenu/LiquidCrystalIO.git
git clone https://github.com/TcMenu/TcMenuLog.git

cd ..
mkdir mbed_lib
git clone https://github.com/TcMenu/Adafruit-GFX-mbed-fork.git

For use with platformIO

Just import the platformio.ini into your IDE and build.

PicoSDK Cmake specific notes

The getting started guide is here.

ESP32 IDF using CMake

The getting started guide is here.