diff --git a/lib/obp60task/Create_new_pages.txt b/lib/obp60task/Create_new_pages.txt deleted file mode 100644 index b318985..0000000 --- a/lib/obp60task/Create_new_pages.txt +++ /dev/null @@ -1,6 +0,0 @@ -Craete new page for OBP60 -1. Create page under /lib/obp60task/PageXXXX.cpp -2. Set page name in PageXXXX.cpp on file name -3. Register new page in /lib/obp60task/obp60task.cpp line 242 (registerAllPages) -4. Add new page in /lib/obp60task/config.json for each page type or add new page to gen_set.py and run it to auto-generate the relevant section of config.json - diff --git a/lib/obp60task/README b/lib/obp60task/README new file mode 100644 index 0000000..8e14fc0 --- /dev/null +++ b/lib/obp60task/README @@ -0,0 +1,82 @@ +Development information +======================= + +This file contains some hints concerning building the firmware as well as +developing and debugging it. + + +Git commands +------------ +Some useful commands are + +git status +git fetch upstream +git diff --name-status upstream/master +git checkout upstream/master platformio.ini + +# how to reset my Repo to match norbert's status + +git remote add upstream https://github.com/norbert-walter/esp32-nmea2000-obp60 +git fetch upstream +git checkout master +git reset --hard upstream/master +git push origin master --force + + +New pages +--------- +To create a new page for OBP60 the following steps are necessary: + + 1. Create a page under /lib/obp60task/PageXXXX.cpp + 2. Set page name in PageXXXX.cpp on file name + 3. Register new page in /lib/obp60task/obp60task.cpp in function + 'registerAllPages' + 4. Add new page in /lib/obp60task/config.json for each page type or add + new page to gen_set.py and run it to auto-generate the relevant + section of config.json + 5. Copy the changes in config.json to config_obp40.json and rename + strings accordingly. E.g. obp60 to obp40. + + +Using Gitpod +------------ + +Open web page: +https://gitpod.io/#https://github.com/norbert-walter/esp32-nmea2000-obp60/tree/master/lib/obp60task + +Input in terminal: +cd /workspace/esp32-nmea2000-obp60 +bash /workspace/esp32-nmea2000-obp60/lib/obp60task/run_installing_tools +bash /workspace/esp32-nmea2000-obp60/lib/obp60task/run_obp60_s3 +bash /workspace/esp32-nmea2000-obp60/lib/obp60task/run_obp40_s3 + +Compile result for OBP60: +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/bootloader.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/firmware.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/partitions.bin + +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-all.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-dev-all.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-dev-update.bin + +/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-all.bin, ready to flash to offset 0x0000 + +Compile result for OBP40 (CrowPanel 4.2): + +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/bootloader.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/firmware.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/partitions.bin + +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-all.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-dev-all.bin +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-dev-update.bin + +/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-all.bin, ready to flash to offset 0x0000 + + +Debugging tool +-------------- + +log.txt = text file with error messages from terminal console + +tools/decoder.py -p ESP32S3 -t ~/.platformio/packages/toolchain-xtensa-esp32s3/ -e .pio/build/obp60_s3/firmware.elf log.txt diff --git a/lib/obp60task/Using_Gitpod.txt b/lib/obp60task/Using_Gitpod.txt deleted file mode 100644 index 1f93298..0000000 --- a/lib/obp60task/Using_Gitpod.txt +++ /dev/null @@ -1,38 +0,0 @@ -Using Gitpod -############ - -Open web page: -https://gitpod.io/#https://github.com/norbert-walter/esp32-nmea2000-obp60/tree/master/lib/obp60task - -Input in terminal: -cd /workspace/esp32-nmea2000-obp60 -bash /workspace/esp32-nmea2000-obp60/lib/obp60task/run_installing_tools -bash /workspace/esp32-nmea2000-obp60/lib/obp60task/run_obp60_s3 -bash /workspace/esp32-nmea2000-obp60/lib/obp60task/run_obp40_s3 - -Compile result for OBP60 -######################## - -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/bootloader.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/firmware.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/partitions.bin - -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-all.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-dev20231220-all.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-dev20231220-update.bin - -/workspace/esp32-nmea2000-obp60/.pio/build/obp60_s3/obp60_s3-all.bin, ready to flash to offset 0x0000 - -Compile result for OBP40 (CrowPanel 4.2) -######################################## - -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/bootloader.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/firmware.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/partitions.bin - -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-all.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-dev20231220-all.bin -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-dev20231220-update.bin - -/workspace/esp32-nmea2000-obp60/.pio/build/obp40_s3/obp40_s3-all.bin, ready to flash to offset 0x0000 - diff --git a/lib/obp60task/debugging.txt b/lib/obp60task/debugging.txt deleted file mode 100644 index c0a22e0..0000000 --- a/lib/obp60task/debugging.txt +++ /dev/null @@ -1,6 +0,0 @@ -Debugging tool -############## - -log.txt = text file with error messages from terminal console - -tools/decoder.py -p ESP32S3 -t ~/.platformio/packages/toolchain-xtensa-esp32s3/ -e .pio/build/obp60_s3/firmware.elf log.txt \ No newline at end of file diff --git a/lib/obp60task/git_commands.txt b/lib/obp60task/git_commands.txt deleted file mode 100644 index 39d3fda..0000000 --- a/lib/obp60task/git_commands.txt +++ /dev/null @@ -1,12 +0,0 @@ -git status -git fetch upstream -git diff --name-status upstream/master -git checkout upstream/master platformio.ini - -# how to reset my Repo to match norbert'status - -git remote add upstream https://github.com/norbert-walter/esp32-nmea2000-obp60 -git fetch upstream -git checkout master -git reset --hard upstream/master -git push origin master --force \ No newline at end of file