Versionprep/v3.0.0 - Changelog polish (#452)

* changelog updated for new version of libDaisy.

* updated for most recent changes.

* updated changelog for PRs #448 and #451

* added note about removal of Configure()

Co-authored-by: stephenhensley <[email protected]>

CHANGELOG.md

@@ -6,9 +6,42 @@
 
 ### Features
 
-* msd: added the ability to read/write USB drives
+### Bug Fixes
+
+### Other
+
+### Migrating
+
+## v3.0.0
+
+### Breaking Changes
+
+* fatfs: the `dsy_fatfs_init()` function has been replaced with the `FatFSInterface` class that allows for multi-volume filesystem use with SDMMC and/or USB drives.
+  * The previous global variables `SDPath`, `SDFatFS`, `SDFile`, and `retSD` have been removed as they could not be used effectively with the addition of multi-volume support.
+  * The path, and FATFS objects can be acquired from the new `FatFSInteface` objects, and any `FIL` object(s) can be placed in AXI SRAM (or any other memory with USB).
+* namespace: new namespace "seed" was added for new pinout Daisy Seed pinout mappings.
+  * This isn't a breaking change on it's own, but when `using namespace seed;` a variable cannot be named, `seed` else it will throw ambiguity errors.
+
+### Features
+
 * bootloader: the bootloader can now be flashed directly from libDaisy using `make program-boot`
+  * apps can be built by overwriting `LDSCRIPT` with one of the new (\_sram.lds, or \_qspi.lds) linker scripts, and adding `-DBOOT_APP` to the `C_DEFS` within the user makefile.
+  * once the bootloader is on the device, apps compiled with the above changes can be flashed to the bootloader using `make program-app`
+  * this process is subject to change, and will be improved and documented in the coming weeks.
 * driver: added support for the MAX11300 ADC/DAC/GPI/GPO device
+* usb_midi: added `MidiUsbTransport` class for easy usb midi functionality via `MidiUsbHandler`
+* ui: addition of `CanvasDescriptor::screenSaverTimeout` setting turns off display after as many milliseconds. Useful for preventing screen burn-in on sensitive displays like OLEDs.
+* usb_host: basic support for Mass Storage USB host class has been added.
+* fatfs: interface has been reworked, and now supports mounting SDMMC, and/or USB drives. Multi-volume usage with simultaneous use of both is supported.
+* core: added new C++ `Pin` type that is constexpr friendly, and backwards compatible with existing C-style `dsy_gpio_pin` type.
+  * the old, `dsy_gpio_pin` and it's accompanying functions should no longer be used, and will be removed in a later version of the library.
+* gpio: added new C++ API for access to GPIO
+  * the old, `dsy_gpio` and it's accompanying functions should no longer be used, and will be removed in a later version of the library.
+* seed: new pinout consts have been added using the new type. This is to simplify addressing pins on Daisy Seed, and the names are shared with the Arduino Integration.
+  * These constants live in the `daisy::seed` namespace.
+  * Digital pins D0-D30 have been added, these return the equivalent pin as `DaisySeed::GetPin(int pinno)`
+  * Analog pins A0-A11 map to the ADC accessible pins labeled as "ADCn" in the pinout diagram.
+  * The `Ax` analog pin constants can be used when using digital functions, and vice-versa.
 
 ### Bug fixes
 
@@ -19,11 +52,98 @@
 
 ### Other
 
-* Switch: Use `System::GetNow()` rather than the update rate to calculate `TimeHeldMs()`.  
+* switch: Use `System::GetNow()` rather than the update rate to calculate `TimeHeldMs()`.  
+  * This has also been applied to the `Encoder` class (since it uses `Switch` internally).
+* usb host: ST Middleware for USB Host support has been added to the Middlewares folder
+* fatfs: changed default `FS_LOCK` to 0, allowing for more simultaneously open FIL objects.
+* seed: the contents of `DaisySeed::Configure()` have been moved into the `DaisySeed::Init()` function, leaving it empty. This function can now be omitted.
+  * the function was left in place to preserve backwards compatibility, and will be removed in a future version.
 
 ### Migrating
 
-* Backwards compatability will be maintained until the next breaking change, at which point the `update_rate` argument will be removed from `Switch::Init`.
+* switch/encoder: Backwards compatability for Initializing switches/encoders will be maintained until the next breaking change, at which point the `update_rate` argument will be removed from `Switch::Init`, and `Encoder::Init`.
+* fatfs: If file locking was being used, `FS_LOCK` will have to be changed back to a non-zero, positive value.
+
+#### FatFS
+
+Existing code using SDMMC for FatFS only requires a small change to replace the previous `dsy_fatfs_init()` function:
+
+```c++
+FatFSInterface fsi;
+
+int main(void) {
+  // Daisy, SDMMC, etc. initialization unchanged
+  // before:
+  dsy_fatfs_init();
+  . . .
+  // now:
+  fsi.Init(FatFSInterface::Config::Media::SDMMC);
+
+  // and instead of the global FATFS object you can now:
+  FATFS& fs = fsi.GetSDFileSystem();
+
+  // and instead of the global SDPath object you can now:
+  const char* rootpath = fsi.GetSDPath();
+
+  // and then file system works as usual now
+  f_mount(&fs, rootpath, 1);
+  . . .
+}
+```
+
+#### GPIO
+
+The new `GPIO` class, and `Pin` type have been added to replace the previous C versions.
+
+The C versions will remain in place for some time to support backwards compatibility, and give people time to migrate.
+
+To make this easier, the new `Pin` type can be automatically converted to the old, `dsy_gpio_pin` to use with classes that have not been updated yet (like Switch, Encoder, etc.)
+
+Here's an example comparing the new and old versions of dealing with GPIO (only one of the many initialization methods is shown here):
+
+```c++
+//////////////////////////////////////////
+// Initialization:
+//////////////////////////////////////////
+// Old:
+dsy_gpio_pin pa1 = {DSY_GPIOA, 1};
+dsy_gpio gpio1;
+gpio1.mode = DSY_GPIO_OUTPUT_PP;
+gpio1.pull = DSY_GPIO_NOPULL;
+gpio1.pin = pa1;
+dsy_gpio_init(&gpio1);
+
+// New:
+Pin pa1 = Pin(PORTA, 1);
+GPIO gpio1;
+gpio1.Init(pa1, GPIO::Mode::OUTPUT, GPIO::Pull::NOPULL);
+
+//////////////////////////////////////////
+// Read
+//////////////////////////////////////////
+// Old:
+uint8_t state = dsy_gpio_read(&gpio1);
+// New:
+bool state = gpio1.Read();
+
+//////////////////////////////////////////
+// Write
+//////////////////////////////////////////
+// Old:
+dsy_gpio_write(&gpio1, 1); // HIGH
+dsy_gpio_write(&gpio1, 0); // LOW
+// New:
+gpio1.Write(true); // HIGH
+gpio1.Write(false); // LOW
+
+//////////////////////////////////////////
+// Toggle
+//////////////////////////////////////////
+// Old:
+dsy_gpio_toggle(&gpio1);
+// New:
+gpio1.Toggle();
+```
 
 ## v2.0.1
 
@@ -57,7 +177,6 @@
 * util: added new VoctCalibration helper class for calibrating ADC inputs
 * seed: added support for Daisy Seed 1.1 (aka Daisy Seed rev5) hardware. Pin-compatible, with same form factor. WM8731 Codec instead of AK4556.
 * bootloader: added `program-app` make target to upload code to the daisy bootloader
-* usb_midi: added `MidiUsbTransport` class for easy usb midi functionality
 
 ### Bug fixes