Skip to content

Commit

Permalink
Merge branch 'espressif:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
@mathertel
mathertel authored May 23, 2023
2 parents af722b3 + 3ec5f4e commit 95fac64
Show file tree
Hide file tree
Showing 6 changed files with 343 additions and 29 deletions.
192 changes: 192 additions & 0 deletions boards.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12265,6 +12265,198 @@ m5stack-core2.menu.EraseFlash.all.upload.erase_cmd=-e

##############################################################

m5stack-cores3.name=M5Stack-CoreS3
m5stack-cores3.vid.0=0x303a
m5stack-cores3.pid.0=0x1001

m5stack-cores3.bootloader.tool=esptool_py
m5stack-cores3.bootloader.tool.default=esptool_py

m5stack-cores3.upload.tool=esptool_py
m5stack-cores3.upload.tool.default=esptool_py
m5stack-cores3.upload.tool.network=esp_ota

m5stack-cores3.upload.maximum_size=1310720
m5stack-cores3.upload.maximum_data_size=327680
m5stack-cores3.upload.flags=
m5stack-cores3.upload.extra_flags=
m5stack-cores3.upload.use_1200bps_touch=false
m5stack-cores3.upload.wait_for_upload_port=false

m5stack-cores3.serial.disableDTR=false
m5stack-cores3.serial.disableRTS=false

m5stack-cores3.build.tarch=xtensa
m5stack-cores3.build.bootloader_addr=0x0
m5stack-cores3.build.target=esp32s3
m5stack-cores3.build.mcu=esp32s3
m5stack-cores3.build.core=esp32
m5stack-cores3.build.variant=m5stack_cores3
m5stack-cores3.build.board=M5STACK_CORES3

m5stack-cores3.build.usb_mode=1
m5stack-cores3.build.cdc_on_boot=0
m5stack-cores3.build.msc_on_boot=0
m5stack-cores3.build.dfu_on_boot=0
m5stack-cores3.build.f_cpu=240000000L
m5stack-cores3.build.flash_size=4MB
m5stack-cores3.build.flash_freq=80m
m5stack-cores3.build.flash_mode=dio
m5stack-cores3.build.boot=qio
m5stack-cores3.build.boot_freq=80m
m5stack-cores3.build.partitions=default
m5stack-cores3.build.defines=
m5stack-cores3.build.loop_core=
m5stack-cores3.build.event_core=
m5stack-cores3.build.psram_type=qspi
m5stack-cores3.build.memory_type={build.boot}_{build.psram_type}

m5stack-cores3.menu.JTAGAdapter.default=Disabled
m5stack-cores3.menu.JTAGAdapter.default.build.copy_jtag_files=0
m5stack-cores3.menu.JTAGAdapter.builtin=Integrated USB JTAG
m5stack-cores3.menu.JTAGAdapter.builtin.build.openocdscript=esp32s3-builtin.cfg
m5stack-cores3.menu.JTAGAdapter.builtin.build.copy_jtag_files=1
m5stack-cores3.menu.JTAGAdapter.external=FTDI Adapter
m5stack-cores3.menu.JTAGAdapter.external.build.openocdscript=esp32s3-ftdi.cfg
m5stack-cores3.menu.JTAGAdapter.external.build.copy_jtag_files=1
m5stack-cores3.menu.JTAGAdapter.bridge=ESP USB Bridge
m5stack-cores3.menu.JTAGAdapter.bridge.build.openocdscript=esp32s3-bridge.cfg
m5stack-cores3.menu.JTAGAdapter.bridge.build.copy_jtag_files=1

m5stack-cores3.menu.PSRAM.disabled=Disabled
m5stack-cores3.menu.PSRAM.disabled.build.defines=
m5stack-cores3.menu.PSRAM.disabled.build.psram_type=qspi
m5stack-cores3.menu.PSRAM.enabled=QSPI PSRAM
m5stack-cores3.menu.PSRAM.enabled.build.defines=-DBOARD_HAS_PSRAM
m5stack-cores3.menu.PSRAM.enabled.build.psram_type=qspi
m5stack-cores3.menu.PSRAM.opi=OPI PSRAM
m5stack-cores3.menu.PSRAM.opi.build.defines=-DBOARD_HAS_PSRAM
m5stack-cores3.menu.PSRAM.opi.build.psram_type=opi

m5stack-cores3.menu.FlashMode.qio=QIO 80MHz
m5stack-cores3.menu.FlashMode.qio.build.flash_mode=dio
m5stack-cores3.menu.FlashMode.qio.build.boot=qio
m5stack-cores3.menu.FlashMode.qio.build.boot_freq=80m
m5stack-cores3.menu.FlashMode.qio.build.flash_freq=80m
m5stack-cores3.menu.FlashMode.qio120=QIO 120MHz
m5stack-cores3.menu.FlashMode.qio120.build.flash_mode=dio
m5stack-cores3.menu.FlashMode.qio120.build.boot=qio
m5stack-cores3.menu.FlashMode.qio120.build.boot_freq=120m
m5stack-cores3.menu.FlashMode.qio120.build.flash_freq=80m
m5stack-cores3.menu.FlashMode.dio=DIO 80MHz
m5stack-cores3.menu.FlashMode.dio.build.flash_mode=dio
m5stack-cores3.menu.FlashMode.dio.build.boot=dio
m5stack-cores3.menu.FlashMode.dio.build.boot_freq=80m
m5stack-cores3.menu.FlashMode.dio.build.flash_freq=80m
m5stack-cores3.menu.FlashMode.opi=OPI 80MHz
m5stack-cores3.menu.FlashMode.opi.build.flash_mode=dout
m5stack-cores3.menu.FlashMode.opi.build.boot=opi
m5stack-cores3.menu.FlashMode.opi.build.boot_freq=80m
m5stack-cores3.menu.FlashMode.opi.build.flash_freq=80m

m5stack-cores3.menu.FlashSize.4M=4MB (32Mb)
m5stack-cores3.menu.FlashSize.4M.build.flash_size=4MB
m5stack-cores3.menu.FlashSize.8M=8MB (64Mb)
m5stack-cores3.menu.FlashSize.8M.build.flash_size=8MB
m5stack-cores3.menu.FlashSize.8M.build.partitions=default_8MB
m5stack-cores3.menu.FlashSize.16M=16MB (128Mb)
m5stack-cores3.menu.FlashSize.16M.build.flash_size=16MB
#m5stack-cores3.menu.FlashSize.32M=32MB (256Mb)
#m5stack-cores3.menu.FlashSize.32M.build.flash_size=32MB

m5stack-cores3.menu.LoopCore.1=Core 1
m5stack-cores3.menu.LoopCore.1.build.loop_core=-DARDUINO_RUNNING_CORE=1
m5stack-cores3.menu.LoopCore.0=Core 0
m5stack-cores3.menu.LoopCore.0.build.loop_core=-DARDUINO_RUNNING_CORE=0

m5stack-cores3.menu.EventsCore.1=Core 1
m5stack-cores3.menu.EventsCore.1.build.event_core=-DARDUINO_EVENT_RUNNING_CORE=1
m5stack-cores3.menu.EventsCore.0=Core 0
m5stack-cores3.menu.EventsCore.0.build.event_core=-DARDUINO_EVENT_RUNNING_CORE=0

m5stack-cores3.menu.USBMode.hwcdc=Hardware CDC and JTAG
m5stack-cores3.menu.USBMode.hwcdc.build.usb_mode=1
m5stack-cores3.menu.USBMode.default=USB-OTG (TinyUSB)
m5stack-cores3.menu.USBMode.default.build.usb_mode=0

m5stack-cores3.menu.CDCOnBoot.default=Disabled
m5stack-cores3.menu.CDCOnBoot.default.build.cdc_on_boot=0
m5stack-cores3.menu.CDCOnBoot.cdc=Enabled
m5stack-cores3.menu.CDCOnBoot.cdc.build.cdc_on_boot=1

m5stack-cores3.menu.MSCOnBoot.default=Disabled
m5stack-cores3.menu.MSCOnBoot.default.build.msc_on_boot=0
m5stack-cores3.menu.MSCOnBoot.msc=Enabled (Requires USB-OTG Mode)
m5stack-cores3.menu.MSCOnBoot.msc.build.msc_on_boot=1

m5stack-cores3.menu.DFUOnBoot.default=Disabled
m5stack-cores3.menu.DFUOnBoot.default.build.dfu_on_boot=0
m5stack-cores3.menu.DFUOnBoot.dfu=Enabled (Requires USB-OTG Mode)
m5stack-cores3.menu.DFUOnBoot.dfu.build.dfu_on_boot=1

m5stack-cores3.menu.UploadMode.default=UART0 / Hardware CDC
m5stack-cores3.menu.UploadMode.default.upload.use_1200bps_touch=false
m5stack-cores3.menu.UploadMode.default.upload.wait_for_upload_port=false
m5stack-cores3.menu.UploadMode.cdc=USB-OTG CDC (TinyUSB)
m5stack-cores3.menu.UploadMode.cdc.upload.use_1200bps_touch=true
m5stack-cores3.menu.UploadMode.cdc.upload.wait_for_upload_port=true

m5stack-cores3.menu.PartitionScheme.default=Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)
m5stack-cores3.menu.PartitionScheme.default.build.partitions=default
m5stack-cores3.menu.PartitionScheme.defaultffat=Default 4MB with ffat (1.2MB APP/1.5MB FATFS)
m5stack-cores3.menu.PartitionScheme.defaultffat.build.partitions=default_ffat
m5stack-cores3.menu.PartitionScheme.default_8MB=8M with spiffs (3MB APP/1.5MB SPIFFS)
m5stack-cores3.menu.PartitionScheme.default_8MB.build.partitions=default_8MB
m5stack-cores3.menu.PartitionScheme.default_8MB.upload.maximum_size=3342336

m5stack-cores3.menu.CPUFreq.240=240MHz (WiFi)
m5stack-cores3.menu.CPUFreq.240.build.f_cpu=240000000L
m5stack-cores3.menu.CPUFreq.160=160MHz (WiFi)
m5stack-cores3.menu.CPUFreq.160.build.f_cpu=160000000L
m5stack-cores3.menu.CPUFreq.80=80MHz (WiFi)
m5stack-cores3.menu.CPUFreq.80.build.f_cpu=80000000L
m5stack-cores3.menu.CPUFreq.40=40MHz
m5stack-cores3.menu.CPUFreq.40.build.f_cpu=40000000L
m5stack-cores3.menu.CPUFreq.20=20MHz
m5stack-cores3.menu.CPUFreq.20.build.f_cpu=20000000L
m5stack-cores3.menu.CPUFreq.10=10MHz
m5stack-cores3.menu.CPUFreq.10.build.f_cpu=10000000L

m5stack-cores3.menu.UploadSpeed.921600=921600
m5stack-cores3.menu.UploadSpeed.921600.upload.speed=921600
m5stack-cores3.menu.UploadSpeed.115200=115200
m5stack-cores3.menu.UploadSpeed.115200.upload.speed=115200
m5stack-cores3.menu.UploadSpeed.256000.windows=256000
m5stack-cores3.menu.UploadSpeed.256000.upload.speed=256000
m5stack-cores3.menu.UploadSpeed.230400.windows.upload.speed=256000
m5stack-cores3.menu.UploadSpeed.230400=230400
m5stack-cores3.menu.UploadSpeed.230400.upload.speed=230400
m5stack-cores3.menu.UploadSpeed.460800.linux=460800
m5stack-cores3.menu.UploadSpeed.460800.macosx=460800
m5stack-cores3.menu.UploadSpeed.460800.upload.speed=460800
m5stack-cores3.menu.UploadSpeed.512000.windows=512000
m5stack-cores3.menu.UploadSpeed.512000.upload.speed=512000

m5stack-cores3.menu.DebugLevel.none=None
m5stack-cores3.menu.DebugLevel.none.build.code_debug=0
m5stack-cores3.menu.DebugLevel.error=Error
m5stack-cores3.menu.DebugLevel.error.build.code_debug=1
m5stack-cores3.menu.DebugLevel.warn=Warn
m5stack-cores3.menu.DebugLevel.warn.build.code_debug=2
m5stack-cores3.menu.DebugLevel.info=Info
m5stack-cores3.menu.DebugLevel.info.build.code_debug=3
m5stack-cores3.menu.DebugLevel.debug=Debug
m5stack-cores3.menu.DebugLevel.debug.build.code_debug=4
m5stack-cores3.menu.DebugLevel.verbose=Verbose
m5stack-cores3.menu.DebugLevel.verbose.build.code_debug=5

m5stack-cores3.menu.EraseFlash.none=Disabled
m5stack-cores3.menu.EraseFlash.none.upload.erase_cmd=
m5stack-cores3.menu.EraseFlash.all=Enabled
m5stack-cores3.menu.EraseFlash.all.upload.erase_cmd=-e

##############################################################

m5stack-timer-cam.name=M5Stack-Timer-CAM

m5stack-timer-cam.bootloader.tool=esptool_py
Expand Down
3 changes: 0 additions & 3 deletions cores/esp32/HardwareSerial.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -365,9 +365,6 @@ void HardwareSerial::begin(unsigned long baud, uint32_t config, int8_t rxPin, in
}
break;
#endif
default:
log_e("Bad UART Number");
return;
}
}

Expand Down
17 changes: 17 additions & 0 deletions docs/source/faq.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,20 @@ How to compile libs with different debug level?
-----------------------------------------------

The short answer is ``esp32-arduino-lib-builder/configs/defconfig.common:44``. A guide explaining the process can be found here <guides/core_debug>

SPIFFS mount failed
-------------------
When you come across and error like this:

.. code-block:: shell
E (588) SPIFFS: mount failed, -10025
[E][SPIFFS.cpp:47] begin(): Mounting SPIFFS failed! Error: -1
Try enforcing format on fail in your code by adding ``true`` in the ``begin`` method such as this:

.. code-block:: c++

SPIFFS.begin(true);

See the method prototype for reference: ``bool begin(bool formatOnFail=false, const char * basePath="/spiffs", uint8_t maxOpenFiles=10, const char * partitionLabel=NULL);``
49 changes: 31 additions & 18 deletions docs/source/tutorials/preferences.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,9 @@ Like so:

.. code-block:: arduino
String myString = myPreferences.getString("myStringKey");
float myFloat = myPreferences.getFloat("pi");
This will retrieve the String value from the namespace key ``"myStringKey"`` and assign it to the String type variable ``myString``.
This will retrieve the float value from the namespace key ``"pi"`` and assign it to the float type variable ``myFloat``.


Summary
Expand Down Expand Up @@ -277,9 +277,10 @@ When started, the system has no way of knowing which of the above conditions is
// not the complete setup(), but in setup(), include this...
stcPrefs.begin("STCPrefs", RO_MODE); // Open our namespace (or create it
// if it doesn't exist) in in RO mode.
// if it doesn't exist) in RO mode.
bool tpInit = stcPrefs.isKey("nvsInit"); // Test for the existence of the "already initialized" key.
bool tpInit = stcPrefs.isKey("nvsInit"); // Test for the existence
// of the "already initialized" key.
if (tpInit == false) {
// If tpInit is 'false', the key "nvsInit" does not yet exist therefore this
Expand All @@ -289,13 +290,15 @@ When started, the system has no way of knowing which of the above conditions is
// The .begin() method created the "STCPrefs" namespace and since this is our
// first-time run we will create our keys and store the initial "factory default" values.
// first-time run we will create
// our keys and store the initial "factory default" values.
stcPrefs.putUChar("curBright", 10);
stcPrefs.putString("talChan", "one");
stcPrefs.putLong("talMax", -220226);
stcPrefs.putBool("ctMde", true);
stcPrefs.putBool("nvsInit", true); // Create the "already initialized" key and store a value.
stcPrefs.putBool("nvsInit", true); // Create the "already initialized"
// key and store a value.
// The "factory defaults" are created and stored so...
stcPrefs.end(); // Close the namespace in RW mode and...
Expand Down Expand Up @@ -456,10 +459,12 @@ This is best explained with an example. Here the ``Bytes`` methods are used to s
Serial.begin(115200);
delay(250);
mySketchPrefs.begin("myPrefs", RW_MODE); // open (or create) the namespace "myPrefs" in RW mode
mySketchPrefs.begin("myPrefs", RW_MODE); // open (or create) the namespace
// "myPrefs" in RW mode
mySketchPrefs.clear(); // delete any previous keys in this namespace
// Create an array of test values. We're using hex numbers throughout to better show how the bytes move around.
// Create an array of test values. We're using hex numbers
// throughout to better show how the bytes move around.
int16_t myArray[] = { 0x1112, 0x2122, 0x3132, 0x4142, 0x5152, 0x6162, 0x7172 };
Serial.println("Printing myArray...");
Expand All @@ -468,22 +473,28 @@ This is best explained with an example. Here the ``Bytes`` methods are used to s
}
Serial.println("\r\n");
// In the next statement, the second sizeof() needs to match the data type of the elements of myArray
Serial.print("The number of elements in myArray is: "); Serial.println( sizeof(myArray) / sizeof(int16_t) );
Serial.print("But the size of myArray in bytes is: "); Serial.println( sizeof(myArray) );
// In the next statement, the second sizeof() needs
// to match the data type of the elements of myArray
Serial.print("The number of elements in myArray is: ");
Serial.println( sizeof(myArray) / sizeof(int16_t) );
Serial.print("But the size of myArray in bytes is: ");
Serial.println( sizeof(myArray) );
Serial.println("");
Serial.println("Storing myArray into the Preferences namespace \"myPrefs\" against the key \"myPrefsBytes\".");
Serial.println(
"Storing myArray into the Preferences namespace \"myPrefs\" against the key \"myPrefsBytes\".");
// Note: in the next statement, to store the entire array, we must use the
// size of the arrray in bytes, not the number of elements in the array.
mySketchPrefs.putBytes( "myPrefsBytes", myArray, sizeof(myArray) );
Serial.print("The size of \"myPrefsBytes\" is (in bytes): "); Serial.println( mySketchPrefs.getBytesLength("myPrefsBytes") );
Serial.print("The size of \"myPrefsBytes\" is (in bytes): ");
Serial.println( mySketchPrefs.getBytesLength("myPrefsBytes") );
Serial.println("");
int16_t myIntBuffer[20] = {}; // No magic about 20. Just making a buffer (array) big enough.
int16_t myIntBuffer[20] = {}; // No magic about 20. Just making a buffer (array) big enough.
Serial.println("Retrieving the value of myPrefsBytes into myIntBuffer.");
Serial.println(" - Note the data type of myIntBuffer matches that of myArray");
mySketchPrefs.getBytes( "myPrefsBytes", myIntBuffer, mySketchPrefs.getBytesLength("myPrefsBytes") );
mySketchPrefs.getBytes("myPrefsBytes", myIntBuffer,
mySketchPrefs.getBytesLength("myPrefsBytes"));
Serial.println("Printing myIntBuffer...");
// In the next statement, sizeof() needs to match the data type of the elements of myArray
Expand All @@ -492,9 +503,11 @@ This is best explained with an example. Here the ``Bytes`` methods are used to s
}
Serial.println("\r\n");
Serial.println("We can see how the data from myArray is actually stored in the namespace as follows.");
uint8_t myByteBuffer[40] = {}; // No magic about 40. Just making a buffer (array) big enough.
mySketchPrefs.getBytes( "myPrefsBytes", myByteBuffer, mySketchPrefs.getBytesLength("myPrefsBytes") );
Serial.println(
"We can see how the data from myArray is actually stored in the namespace as follows.");
uint8_t myByteBuffer[40] = {}; // No magic about 40. Just making a buffer (array) big enough.
mySketchPrefs.getBytes("myPrefsBytes", myByteBuffer,
mySketchPrefs.getBytesLength("myPrefsBytes"));
Serial.println("Printing myByteBuffer...");
for (int i = 0; i < mySketchPrefs.getBytesLength("myPrefsBytes"); i++) {
Expand Down
Loading

0 comments on commit 95fac64

Please sign in to comment.