Merge branch 'main' into jqln/tts

6 files changed, 117 insertions, 47 deletions

diff --git a/src/drivers/include/drivers/bluetooth.hpp b/src/drivers/include/drivers/bluetooth.hpp
index eaecfb2b..99c71e52 100644
--- a/src/drivers/include/drivers/bluetooth.hpp
+++ b/src/drivers/include/drivers/bluetooth.hpp
@@ -3,6 +3,7 @@
 
 #include <array>
 #include <atomic>
+#include <functional>
 #include <map>
 #include <mutex>
 #include <optional>
@@ -25,28 +26,68 @@
 namespace drivers {
 
 /*
- * A handle used to interact with the bluetooth state machine.
+ * A handle used to interact with the bluetooth state machine. This is the main
+ * API that the rest of the system should use to interact with Bluetooth.
  */
 class Bluetooth {
  public:
-  Bluetooth(NvsStorage& storage, tasks::WorkerPool&);
+  /*
+   * Callback invoked when an event is generated by the Bluetooth stack. This
+   * callback is invoked synchronously from a Bluetooth task context, so
+   * implementations should immediately hop to a different task to process the
+   * event.
+   */
+  using EventHandler = std::function<void(bluetooth::Event)>;
+
+  Bluetooth(NvsStorage&, tasks::WorkerPool&, EventHandler);
+
+  /* Enables or disables the entire Bluetooth stack. */
+  auto enable(bool en) -> void;
+  auto enabled() -> bool;
+
+  auto sources(OutputBuffers*) -> void;
+  auto softVolume(float) -> void;
+
+  enum class ConnectionState {
+    kConnected,
+    kConnecting,
+    kDisconnected,
+  };
+
+  auto connectionState() -> ConnectionState;
+
+  /*
+   * The 'paired' device is a device that will be preferred for connections.
+   * When Bluetooth is first enabled, we immediately try to connect to the
+   * paired device. If the paired device is seen during a scan, then we will
+   * also automatically connect to it.
+   */
+  auto pairedDevice() -> std::optional<bluetooth::MacAndName>;
+
+  /*
+   * Sets the preferred device. If a device is provided, a connection will be
+   * attempted immediately, even if the device has not been detected in a
+   * previous scan.
+   */
+  auto pairedDevice(std::optional<bluetooth::MacAndName> dev) -> void;
+
+  /* A list of devices that have previously been the paired device. */
+  auto knownDevices() -> std::vector<bluetooth::MacAndName>;
+  auto forgetKnownDevice(const bluetooth::mac_addr_t&) -> void;
+
+  /* Enables or disables scanning for nearby Bluetooth devices. */
+  auto discoveryEnabled(bool) -> void;
+  auto discoveryEnabled() -> bool;
+
+  /*
+   * A list of nearby devices that have been discovered since discovery was
+   * last enabled. This list may include the paired device, as well as devices
+   * that are also present in the known devices list.
+   */
+  auto discoveredDevices() -> std::vector<bluetooth::MacAndName>;
 
-  auto Enable() -> bool;
-  auto Disable() -> void;
-  auto IsEnabled() -> bool;
-
-  auto IsConnected() -> bool;
-  auto ConnectedDevice() -> std::optional<bluetooth::MacAndName>;
-
-  auto KnownDevices() -> std::vector<bluetooth::Device>;
-
-  auto SetPreferredDevice(std::optional<bluetooth::MacAndName> dev) -> void;
-  auto PreferredDevice() -> std::optional<bluetooth::MacAndName>;
-
-  auto SetSources(OutputBuffers*) -> void;
-  auto SetVolumeFactor(float) -> void;
-
-  auto SetEventHandler(std::function<void(bluetooth::Event)> cb) -> void;
+ private:
+  NvsStorage& nvs_;
 };
 
 namespace bluetooth {
@@ -56,7 +97,7 @@ struct Enable : public tinyfsm::Event {};
 struct Disable : public tinyfsm::Event {};
 
 struct ConnectTimedOut : public tinyfsm::Event {};
-struct PreferredDeviceChanged : public tinyfsm::Event {};
+struct PairedDeviceChanged : public tinyfsm::Event {};
 struct SourcesChanged : public tinyfsm::Event {};
 struct DeviceDiscovered : public tinyfsm::Event {
   const Device& device;
@@ -94,6 +135,8 @@ class Scanner {
   auto StopScanning() -> void;
   auto StopScanningNow() -> void;
 
+  auto enabled() -> bool;
+
   auto HandleGapEvent(const events::internal::Gap&) -> void;
 
  private:
@@ -103,25 +146,22 @@ class Scanner {
   auto HandleDeviceDiscovery(const esp_bt_gap_cb_param_t& param) -> void;
 };
 
+/*
+ * The main state machine for managing the state of the Bluetooth stack, and
+ * the current (if any) Bluetooth connection.
+ */
 class BluetoothState : public tinyfsm::Fsm<BluetoothState> {
  public:
-  static auto Init(NvsStorage& storage) -> void;
+  static auto Init(NvsStorage& storage, Bluetooth::EventHandler) -> void;
 
   static auto lock() -> std::lock_guard<std::mutex>;
 
-  static auto devices() -> std::vector<Device>;
-
-  static auto preferred_device() -> std::optional<bluetooth::MacAndName>;
-  static auto preferred_device(std::optional<bluetooth::MacAndName>) -> void;
+  static auto pairedDevice() -> std::optional<bluetooth::MacAndName>;
+  static auto pairedDevice(std::optional<bluetooth::MacAndName>) -> void;
 
-  static auto scanning() -> bool;
   static auto discovery() -> bool;
   static auto discovery(bool) -> void;
-
-  static auto sources() -> OutputBuffers*;
-  static auto sources(OutputBuffers*) -> void;
-
-  static auto event_handler(std::function<void(Event)>) -> void;
+  static auto discoveredDevices() -> std::vector<Device>;
 
   virtual ~BluetoothState(){};
 
@@ -131,7 +171,7 @@ class BluetoothState : public tinyfsm::Fsm<BluetoothState> {
   virtual void react(const events::Enable& ev){};
   virtual void react(const events::Disable& ev) = 0;
   virtual void react(const events::ConnectTimedOut& ev){};
-  virtual void react(const events::PreferredDeviceChanged& ev){};
+  virtual void react(const events::PairedDeviceChanged& ev){};
   virtual void react(const events::SourcesChanged& ev){};
 
   virtual void react(const events::DeviceDiscovered&);
@@ -146,10 +186,9 @@ class BluetoothState : public tinyfsm::Fsm<BluetoothState> {
   static Scanner* sScanner_;
 
   static std::mutex sFsmMutex;
-  static std::map<mac_addr_t, Device> sDevices_;
-  static std::optional<bluetooth::MacAndName> sPreferredDevice_;
-
-  static std::optional<bluetooth::MacAndName> sConnectingDevice_;
+  static std::map<mac_addr_t, Device> sDiscoveredDevices_;
+  static std::optional<bluetooth::MacAndName> sPairedWith_;
+  static std::optional<bluetooth::MacAndName> sConnectingTo_;
   static int sConnectAttemptsRemaining_;
 
   static std::function<void(Event)> sEventHandler_;
@@ -176,7 +215,7 @@ class Idle : public BluetoothState {
   void exit() override;
 
   void react(const events::Disable& ev) override;
-  void react(const events::PreferredDeviceChanged& ev) override;
+  void react(const events::PairedDeviceChanged& ev) override;
 
   void react(events::internal::Gap ev) override;
 
@@ -188,7 +227,7 @@ class Connecting : public BluetoothState {
   void entry() override;
   void exit() override;
 
-  void react(const events::PreferredDeviceChanged& ev) override;
+  void react(const events::PairedDeviceChanged& ev) override;
 
   void react(const events::ConnectTimedOut& ev) override;
   void react(const events::Disable& ev) override;
@@ -203,7 +242,7 @@ class Connected : public BluetoothState {
   void entry() override;
   void exit() override;
 
-  void react(const events::PreferredDeviceChanged& ev) override;
+  void react(const events::PairedDeviceChanged& ev) override;
   void react(const events::SourcesChanged& ev) override;
 
   void react(const events::Disable& ev) override;
diff --git a/src/drivers/include/drivers/bluetooth_types.hpp b/src/drivers/include/drivers/bluetooth_types.hpp
index d2e55ee5..05caee47 100644
--- a/src/drivers/include/drivers/bluetooth_types.hpp
+++ b/src/drivers/include/drivers/bluetooth_types.hpp
@@ -27,9 +27,12 @@ struct Device {
 };
 
 enum class SimpleEvent {
-  kKnownDevicesChanged,
   kConnectionStateChanged,
-  kPreferredDeviceChanged,
+  kPairedDeviceChanged,
+  kKnownDevicesChanged,
+  kDiscoveryChanged,
+  kDeviceDiscovered,
+
   // Passthrough events
   kPlayPause,
   kStop,
diff --git a/src/drivers/include/drivers/nvs.hpp b/src/drivers/include/drivers/nvs.hpp
index 88dd5ae0..e147c8c7 100644
--- a/src/drivers/include/drivers/nvs.hpp
+++ b/src/drivers/include/drivers/nvs.hpp
@@ -34,7 +34,7 @@ class Setting {
       dirty_ = true;
     }
   }
-  auto get() -> std::optional<T>& { return val_; }
+  auto get() -> std::optional<T> { return val_; }
 
   /* Reads the stored value from NVS and parses it into the correct type. */
   auto load(nvs_handle_t) -> std::optional<T>;
@@ -90,12 +90,19 @@ class NvsStorage {
   auto LraCalibration() -> std::optional<LraData>;
   auto LraCalibration(const LraData&) -> void;
 
+  auto FastCharge() -> bool;
+  auto FastCharge(bool) -> void;
+
   auto PreferredBluetoothDevice() -> std::optional<bluetooth::MacAndName>;
   auto PreferredBluetoothDevice(std::optional<bluetooth::MacAndName>) -> void;
 
   auto BluetoothVolume(const bluetooth::mac_addr_t&) -> uint8_t;
   auto BluetoothVolume(const bluetooth::mac_addr_t&, uint8_t) -> void;
 
+  auto BluetoothNames() -> std::vector<bluetooth::MacAndName>;
+  auto BluetoothName(const bluetooth::mac_addr_t&, std::optional<std::string>)
+      -> void;
+
   enum class Output : uint8_t {
     kHeadphones = 0,
     kBluetooth = 1,
@@ -106,6 +113,9 @@ class NvsStorage {
   auto ScreenBrightness() -> uint_fast8_t;
   auto ScreenBrightness(uint_fast8_t) -> void;
 
+  auto InterfaceTheme() -> std::optional<std::string>;
+  auto InterfaceTheme(std::string) -> void;
+
   auto ScrollSensitivity() -> uint_fast8_t;
   auto ScrollSensitivity(uint_fast8_t) -> void;
 
@@ -146,6 +156,7 @@ class NvsStorage {
   Setting<uint16_t> display_rows_;
   Setting<uint8_t> haptic_motor_type_;
   Setting<LraData> lra_calibration_;
+  Setting<uint8_t> fast_charge_;
 
   Setting<uint8_t> brightness_;
   Setting<uint8_t> sensitivity_;
@@ -154,7 +165,12 @@ class NvsStorage {
   Setting<int8_t> amp_left_bias_;
   Setting<uint8_t> input_mode_;
   Setting<uint8_t> output_mode_;
+
+  Setting<std::string> theme_;
+
   Setting<bluetooth::MacAndName> bt_preferred_;
+  Setting<std::vector<bluetooth::MacAndName>> bt_names_;
+
   Setting<uint8_t> db_auto_index_;
 
   util::LruCache<10, bluetooth::mac_addr_t, uint8_t> bt_volumes_;
diff --git a/src/drivers/include/drivers/pcm_buffer.hpp b/src/drivers/include/drivers/pcm_buffer.hpp
index 968c3398..4e5fa041 100644
--- a/src/drivers/include/drivers/pcm_buffer.hpp
+++ b/src/drivers/include/drivers/pcm_buffer.hpp
@@ -28,8 +28,12 @@ class PcmBuffer {
   PcmBuffer(size_t size_in_samples);
   ~PcmBuffer();
 
-  /* Adds samples to the buffer. */
-  auto send(std::span<const int16_t>) -> void;
+  /*
+   * Adds samples to the buffer. Returns the number of samples that were added,
+   * which may be less than the number of samples given if this PcmBuffer is
+   * close to full.
+   */
+  auto send(std::span<const int16_t>) -> size_t;
 
   /*
    * Fills the given span with samples. If enough samples are available in
diff --git a/src/drivers/include/drivers/samd.hpp b/src/drivers/include/drivers/samd.hpp
index 897e78d6..ff479225 100644
--- a/src/drivers/include/drivers/samd.hpp
+++ b/src/drivers/include/drivers/samd.hpp
@@ -10,6 +10,7 @@
 #include <optional>
 #include <string>
 
+#include "drivers/nvs.hpp"
 #include "freertos/FreeRTOS.h"
 #include "freertos/semphr.h"
 
@@ -17,9 +18,7 @@ namespace drivers {
 
 class Samd {
  public:
-  static auto Create() -> Samd* { return new Samd(); }
-
-  Samd();
+  Samd(NvsStorage& nvs);
   ~Samd();
 
   auto Version() -> std::string;
@@ -37,8 +36,14 @@ class Samd {
     kChargingFast,
     // The battery is full charged, and we are still plugged in.
     kFullCharge,
+    // Charging failed.
+    kFault,
+    // The battery status returned isn't a known enum value.
+    kUnknown,
   };
 
+  static auto chargeStatusToString(ChargeStatus) -> std::string;
+
   auto GetChargeStatus() -> std::optional<ChargeStatus>;
   auto UpdateChargeStatus() -> void;
 
@@ -68,6 +73,8 @@ class Samd {
   Samd& operator=(const Samd&) = delete;
 
  private:
+  NvsStorage& nvs_;
+
   uint8_t version_;
   std::optional<ChargeStatus> charge_status_;
   UsbStatus usb_status_;
diff --git a/src/drivers/include/drivers/touchwheel.hpp b/src/drivers/include/drivers/touchwheel.hpp
index 60902087..9cd925a6 100644
--- a/src/drivers/include/drivers/touchwheel.hpp
+++ b/src/drivers/include/drivers/touchwheel.hpp
@@ -39,7 +39,8 @@ class TouchWheel {
   auto Update() -> void;
   auto GetTouchWheelData() const -> TouchWheelData;
 
-  auto PowerDown() -> void;
+  auto Recalibrate() -> void;
+  auto LowPowerMode(bool en) -> void;
 
  private:
   TouchWheelData data_;