Merge branch 'support/use_optimised_partitions_csv' into 'master'

Changed default partion csv file to partions_4mb_optimised.csv See merge request app-frameworks/esp-rainmaker!480
espressif · Oct 15, 2024 · f98cf1e · f98cf1e
2 parents 86f0c19 + 66160cd
commit f98cf1e
Show file tree

Hide file tree

Showing 8 changed files with 77 additions and 42 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,12 @@
 # Changes
 
+## 27-Sep-2024: Modified esp-rainmaker examples to use partitions_4mb_optimised.csv
+ - RainMaker examples now use `partitions_4mb_optimised.csv` by default instead of `partitions.csv` and it is recommended to use the same in any new RainMaker projects.
+ - The fctry partition address is different for this partition table. So, if the host claiming is used, please pass the new address using:
+ ```bash
+esp-rainmaker-cli claim $ESPPORT --address 0x3fa000
+ ```
+
 ## 7-Aug-2024: Enabled ESP-Insights command response feature
  - With ESP-Insights updated to the newer component, the command response feature from rainmaker can be used.
  - To use the same, in addition to enabling esp-insights, please set below option from menuconfig:

diff --git a/examples/fan/sdkconfig.defaults b/examples/fan/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y

diff --git a/examples/gpio/sdkconfig.defaults b/examples/gpio/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y

diff --git a/examples/homekit_switch/sdkconfig.defaults b/examples/homekit_switch/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y

diff --git a/examples/led_light/sdkconfig.defaults b/examples/led_light/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y

diff --git a/examples/multi_device/sdkconfig.defaults b/examples/multi_device/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y

diff --git a/examples/switch/sdkconfig.defaults b/examples/switch/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y

diff --git a/examples/temperature_sensor/sdkconfig.defaults b/examples/temperature_sensor/sdkconfig.defaults
@@ -1,11 +1,15 @@
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
-CONFIG_PARTITION_TABLE_SINGLE_APP=
-CONFIG_PARTITION_TABLE_TWO_OTA=
+
+#
+# Use partition table which makes use of flash to the fullest
+# Can be used for other platforms as well. But please keep in mind that fctry partition address is
+# different than default, and the new address needs to be specified to `rainmaker.py claim`
+#
 CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
-CONFIG_PARTITION_TABLE_OFFSET=0x8000
-CONFIG_PARTITION_TABLE_MD5=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_4mb_optimised.csv"
+
+# To accomodate security features
+CONFIG_PARTITION_TABLE_OFFSET=0xc000
 
 # mbedtls
 CONFIG_MBEDTLS_DYNAMIC_BUFFER=y