portapack-mayhem/mayhem-firmware

(Vote) Fine tune of sdcard structure and naming

Open

#1,980 opened on Mar 12, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)C (877 forks)auto 404
enhancementhelp wantednew app ideaquestion

Repository metrics

Stars
 (5,160 stars)
PR merge metrics
 (Avg merge 6d 15h) (29 merged PRs in 30d)

Description

This is an ongoing fine-tune plan of #1967. We will do it after made out specific decisions and merged. You can click "Edit" button to add new options or edit current. (Regarding PRs #1967 & #1968, and earlier draft PRs #1953 & #1956)

way 0 (current)

(folders in bold below are included in downloaded SDcard image)

root: /ADSB /AIS /APPS /APRS /AUDIO /BLERX /BLETX /CAPTURES /DEBUG /FIRMWARE /FREQMAN /GPS /LOGS /LOOKINGGLASS /PLAYLIST /REMOTES /SAMPLES /SCREENSHOTS /SETTINGS /SPECTRUM /SPLASH /SSTV /WAV /WHIPCALC _PPTEST.DAT debug_log.txt splash.bmp

  • Note: Current (2.00) firmware does not show the bold highlighting in FileManager as shown above (this was just to show which folders are in the SD card image in this ticket), but perhaps firmware should do this as an alternative way of distinguishing between user and system folders (BUT some system folders will still contain "user" files)

pros: users familiar with this organization; folder locations same for all firmware versions; wiki doesn't have to explain "if firmware version is >2.00 then the folder is located elsewhere"; SD card access is rather slow so this file organization may be slightly faster (fewest levels of directories to traverse).

cons: root dir looks extremely complicated; some folders include a mix of files that came from the original SD card image on the website plus files created later; when user unzips new SD card image there is a possibility of overwriting a changed file when merging

way 1 (u-foka)

root: /SYS /USR

  • rename blob folder to /SYS, and put /FIRMWARE and /APPS into it
  • add /FW_BACKUP under /USR

pros: The logic is more clear

cons: User would not be able to easily update/upgrade blob files by simple delete and paste new one

way 2 (HTotoo)

root: /SYS /USR /FIRMWARE

  • let /FIRMWARE stay root
  • rename blob folder to /SYS, and put /APPS into it

pros:

cons:

way 3 (u-foka + spamnoob)

root: /RES /USR /BIN

  • keep blob folder name /RES
  • move /APPS and /FIRMWARE into root/BIN

pros: user can easily update/upgrade blob files by simple delete and paste new one

cons: root dir looks complicated

way 4 (spamnoob) (implementation of #1967 & #1968)

root: /RES /USR /APPS /FIRMWARE

  • keep blob folder name /RES
  • keep /APPS and /FIRMWARE stay in root

pros: user can easily update/upgrade blob files by simple delete and paste new one

cons: root dir looks extremely complicated

way 5 (Gull)

root: /SYS /USR

  • All provided files in RES or SYS
  • All user generated files in USR

Contributor guide