From e7281c957c341a35e476197502c1173bdf4d28be Mon Sep 17 00:00:00 2001
From: 3djc <lesitewebdejc@hotmail.com>
Date: Sun, 9 Oct 2016 10:37:52 +0200
Subject: [PATCH] 3djc/add sdcard dir struct (#3894)

* Add taranis

* Add readme to folder structure

* Add templates

* Add directory structure for Horus

* remove snake for Horus

* No telem folder for Horus, use widgets instead

* Include some details on formats

* Improvement based on bsongis feedbacks

* Cosmetics

* sdcard version change required
---
 CMakeLists.txt                                    | 2 +-
 radio/sdcard/horus/FIRMWARE/readme.txt            | 2 ++
 radio/sdcard/horus/IMAGES/readme.txt              | 3 +++
 radio/sdcard/horus/LAYOUTS/readme.txt             | 1 +
 radio/sdcard/horus/LOGS/readme.txt                | 1 +
 radio/sdcard/horus/SCRIPTS/FUNCTIONS/readme.txt   | 1 +
 radio/sdcard/horus/SCRIPTS/MIXES/readme.txt       | 1 +
 radio/sdcard/horus/SCRIPTS/TEMPLATES/readme.txt   | 1 +
 radio/sdcard/taranis/EEPROM/readme.txt            | 2 ++
 radio/sdcard/taranis/FIRMWARE/readme.txt          | 2 ++
 radio/sdcard/taranis/IMAGES/readme.txt            | 3 +++
 radio/sdcard/taranis/LOGS/readme.txt              | 1 +
 radio/sdcard/taranis/SCREENSHOTS/readme.txt       | 1 +
 radio/sdcard/taranis/SCRIPTS/FUNCTIONS/readme.txt | 1 +
 radio/sdcard/taranis/SCRIPTS/MIXES/readme.txt     | 1 +
 radio/sdcard/taranis/SCRIPTS/TELEMETRY/readme.txt | 2 ++
 radio/sdcard/taranis/SCRIPTS/TEMPLATES/readme.txt | 1 +
 17 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 radio/sdcard/horus/FIRMWARE/readme.txt
 create mode 100644 radio/sdcard/horus/IMAGES/readme.txt
 create mode 100644 radio/sdcard/horus/LAYOUTS/readme.txt
 create mode 100644 radio/sdcard/horus/LOGS/readme.txt
 create mode 100644 radio/sdcard/horus/SCRIPTS/FUNCTIONS/readme.txt
 create mode 100644 radio/sdcard/horus/SCRIPTS/MIXES/readme.txt
 create mode 100644 radio/sdcard/horus/SCRIPTS/TEMPLATES/readme.txt
 create mode 100644 radio/sdcard/taranis/EEPROM/readme.txt
 create mode 100644 radio/sdcard/taranis/FIRMWARE/readme.txt
 create mode 100644 radio/sdcard/taranis/IMAGES/readme.txt
 create mode 100644 radio/sdcard/taranis/LOGS/readme.txt
 create mode 100644 radio/sdcard/taranis/SCREENSHOTS/readme.txt
 create mode 100644 radio/sdcard/taranis/SCRIPTS/FUNCTIONS/readme.txt
 create mode 100644 radio/sdcard/taranis/SCRIPTS/MIXES/readme.txt
 create mode 100644 radio/sdcard/taranis/SCRIPTS/TELEMETRY/readme.txt
 create mode 100644 radio/sdcard/taranis/SCRIPTS/TEMPLATES/readme.txt

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 23934e828..c62367298 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -8,7 +8,7 @@ set(VERSION_FAMILY ${VERSION_MAJOR}.${VERSION_MINOR})
 set(VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_REVISION}${VERSION_SUFFIX})
 message(STATUS "OpenTX ${VERSION}")
 
-set(SDCARD_REVISION "0002")
+set(SDCARD_REVISION "0003")
 set(SDCARD_VERSION  ${VERSION_MAJOR}.${VERSION_MINOR}V${SDCARD_REVISION})
 file(WRITE radio/sdcard/horus/opentx.sdcard.version ${SDCARD_VERSION})
 file(WRITE radio/sdcard/taranis/opentx.sdcard.version ${SDCARD_VERSION})
diff --git a/radio/sdcard/horus/FIRMWARE/readme.txt b/radio/sdcard/horus/FIRMWARE/readme.txt
new file mode 100644
index 000000000..4ba9522c9
--- /dev/null
+++ b/radio/sdcard/horus/FIRMWARE/readme.txt
@@ -0,0 +1,2 @@
+You can put firmware for your modules or radio in this folder.
+Files in this folder are NOT automaticaly applied.
diff --git a/radio/sdcard/horus/IMAGES/readme.txt b/radio/sdcard/horus/IMAGES/readme.txt
new file mode 100644
index 000000000..a8412eabd
--- /dev/null
+++ b/radio/sdcard/horus/IMAGES/readme.txt
@@ -0,0 +1,3 @@
+2.2 : BMP renamed to IMAGES for consistency between Taranis and Horus.
+You can put your model and other graphic files in this directory.
+Format include bmp and png (including png with transparancy).
diff --git a/radio/sdcard/horus/LAYOUTS/readme.txt b/radio/sdcard/horus/LAYOUTS/readme.txt
new file mode 100644
index 000000000..b7428fc58
--- /dev/null
+++ b/radio/sdcard/horus/LAYOUTS/readme.txt
@@ -0,0 +1 @@
+Horus layout definitions go in this directory.
diff --git a/radio/sdcard/horus/LOGS/readme.txt b/radio/sdcard/horus/LOGS/readme.txt
new file mode 100644
index 000000000..f9c005b26
--- /dev/null
+++ b/radio/sdcard/horus/LOGS/readme.txt
@@ -0,0 +1 @@
+Logs files created by "SD Logs" special function will be stored in this directory.
diff --git a/radio/sdcard/horus/SCRIPTS/FUNCTIONS/readme.txt b/radio/sdcard/horus/SCRIPTS/FUNCTIONS/readme.txt
new file mode 100644
index 000000000..e14fc62df
--- /dev/null
+++ b/radio/sdcard/horus/SCRIPTS/FUNCTIONS/readme.txt
@@ -0,0 +1 @@
+This directory is for lua functions scripts.
diff --git a/radio/sdcard/horus/SCRIPTS/MIXES/readme.txt b/radio/sdcard/horus/SCRIPTS/MIXES/readme.txt
new file mode 100644
index 000000000..8a5e2e738
--- /dev/null
+++ b/radio/sdcard/horus/SCRIPTS/MIXES/readme.txt
@@ -0,0 +1 @@
+This directory is for lua mixer scripts.
diff --git a/radio/sdcard/horus/SCRIPTS/TEMPLATES/readme.txt b/radio/sdcard/horus/SCRIPTS/TEMPLATES/readme.txt
new file mode 100644
index 000000000..5bbb8b87f
--- /dev/null
+++ b/radio/sdcard/horus/SCRIPTS/TEMPLATES/readme.txt
@@ -0,0 +1 @@
+This directory is for template lua scripts.
diff --git a/radio/sdcard/taranis/EEPROM/readme.txt b/radio/sdcard/taranis/EEPROM/readme.txt
new file mode 100644
index 000000000..52977efaf
--- /dev/null
+++ b/radio/sdcard/taranis/EEPROM/readme.txt
@@ -0,0 +1,2 @@
+EEprom backups go in this folder.
+EEprom backups can be generated from VERSION screen in RADIO SETUP
diff --git a/radio/sdcard/taranis/FIRMWARE/readme.txt b/radio/sdcard/taranis/FIRMWARE/readme.txt
new file mode 100644
index 000000000..4ba9522c9
--- /dev/null
+++ b/radio/sdcard/taranis/FIRMWARE/readme.txt
@@ -0,0 +1,2 @@
+You can put firmware for your modules or radio in this folder.
+Files in this folder are NOT automaticaly applied.
diff --git a/radio/sdcard/taranis/IMAGES/readme.txt b/radio/sdcard/taranis/IMAGES/readme.txt
new file mode 100644
index 000000000..1ceddccf8
--- /dev/null
+++ b/radio/sdcard/taranis/IMAGES/readme.txt
@@ -0,0 +1,3 @@
+2.2 : BMP renamed to IMAGES for consistency between Taranis and Horus.
+You can put your model BMP and other graphic files in this directory.
+BMP color depth must be set to 4 bits.
diff --git a/radio/sdcard/taranis/LOGS/readme.txt b/radio/sdcard/taranis/LOGS/readme.txt
new file mode 100644
index 000000000..f9c005b26
--- /dev/null
+++ b/radio/sdcard/taranis/LOGS/readme.txt
@@ -0,0 +1 @@
+Logs files created by "SD Logs" special function will be stored in this directory.
diff --git a/radio/sdcard/taranis/SCREENSHOTS/readme.txt b/radio/sdcard/taranis/SCREENSHOTS/readme.txt
new file mode 100644
index 000000000..8b89b3c6c
--- /dev/null
+++ b/radio/sdcard/taranis/SCREENSHOTS/readme.txt
@@ -0,0 +1 @@
+Screenshots created by "Screenshot" special function will be stored in this directory.
diff --git a/radio/sdcard/taranis/SCRIPTS/FUNCTIONS/readme.txt b/radio/sdcard/taranis/SCRIPTS/FUNCTIONS/readme.txt
new file mode 100644
index 000000000..e14fc62df
--- /dev/null
+++ b/radio/sdcard/taranis/SCRIPTS/FUNCTIONS/readme.txt
@@ -0,0 +1 @@
+This directory is for lua functions scripts.
diff --git a/radio/sdcard/taranis/SCRIPTS/MIXES/readme.txt b/radio/sdcard/taranis/SCRIPTS/MIXES/readme.txt
new file mode 100644
index 000000000..8a5e2e738
--- /dev/null
+++ b/radio/sdcard/taranis/SCRIPTS/MIXES/readme.txt
@@ -0,0 +1 @@
+This directory is for lua mixer scripts.
diff --git a/radio/sdcard/taranis/SCRIPTS/TELEMETRY/readme.txt b/radio/sdcard/taranis/SCRIPTS/TELEMETRY/readme.txt
new file mode 100644
index 000000000..26b887558
--- /dev/null
+++ b/radio/sdcard/taranis/SCRIPTS/TELEMETRY/readme.txt
@@ -0,0 +1,2 @@
+This directory is for lua telemetry scripts.
+Those scripts can be selected using DISPLAY page.
diff --git a/radio/sdcard/taranis/SCRIPTS/TEMPLATES/readme.txt b/radio/sdcard/taranis/SCRIPTS/TEMPLATES/readme.txt
new file mode 100644
index 000000000..5bbb8b87f
--- /dev/null
+++ b/radio/sdcard/taranis/SCRIPTS/TEMPLATES/readme.txt
@@ -0,0 +1 @@
+This directory is for template lua scripts.