InkHUD refactoring

src/BluetoothStatus.h

@@ -30,15 +30,15 @@ class BluetoothStatus : public Status
     BluetoothStatus() { statusType = STATUS_TYPE_BLUETOOTH; }
 
     // New BluetoothStatus: connected or disconnected
-    BluetoothStatus(ConnectionState state)
+    explicit BluetoothStatus(ConnectionState state)
     {
         assert(state != ConnectionState::PAIRING); // If pairing, use constructor which specifies passkey
         statusType = STATUS_TYPE_BLUETOOTH;
         this->state = state;
     }
 
     // New BluetoothStatus: pairing, with passkey
-    BluetoothStatus(std::string passkey) : Status()
+    explicit BluetoothStatus(const std::string &passkey) : Status()
     {
         statusType = STATUS_TYPE_BLUETOOTH;
         this->state = ConnectionState::PAIRING;

src/graphics/niche/Drivers/Backlight/LatchingBacklight.cpp

@@ -40,13 +40,11 @@ void LatchingBacklight::setPin(uint8_t pin, bool activeWhen)
 // Ensures the backlight is off
 int LatchingBacklight::beforeDeepSleep(void *unused)
 {
-    // We shouldn't need to guard the block like this
-    // Contingency for:
-    // - settings corruption: settings.optionalMenuItems.backlight guards backlight code in MenuApplet
-    // - improper use in the future
+    // Contingency only
+    // - pin wasn't set
     if (pin != (uint8_t)-1) {
         off();
-        pinMode(pin, INPUT); // High impedence - unnecessary?
+        pinMode(pin, INPUT); // High impedance - unnecessary?
     } else
         LOG_WARN("LatchingBacklight instantiated, but pin not set");
     return 0; // Continue with deep sleep

src/graphics/niche/Drivers/EInk/EInk.cpp

@@ -12,7 +12,7 @@ EInk::EInk(uint16_t width, uint16_t height, UpdateTypes supported)
 }
 
 // Used by NicheGraphics implementations to check if a display supports a specific refresh operation.
-// Whether or the update type is supported is specified in the constructor
+// Whether or not the update type is supported is specified in the constructor
 bool EInk::supports(UpdateTypes type)
 {
     // The EInkUpdateTypes enum assigns each type a unique bit. We are checking if that bit is set.

src/graphics/niche/Drivers/EInk/EInk.h

@@ -31,7 +31,7 @@ class EInk : private concurrency::OSThread
     virtual void begin(SPIClass *spi, uint8_t pin_dc, uint8_t pin_cs, uint8_t pin_busy, uint8_t pin_rst = -1) = 0;
     virtual void update(uint8_t *imageData, UpdateTypes type) = 0; // Change the display image
     void await();                                                  // Wait for an in-progress update to complete before proceeding
-    bool supports(UpdateTypes type);                               // Can display perfom a certain update type
+    bool supports(UpdateTypes type);                               // Can display perform a certain update type
     bool busy() { return updateRunning; }                          // Display able to update right now?
 
     const uint16_t width; // Public so that NicheGraphics implementations can access. Safe because const.
@@ -47,8 +47,8 @@ class EInk : private concurrency::OSThread
 
     const UpdateTypes supportedUpdateTypes; // Capabilities of a derived display class
     bool updateRunning = false;             // see EInk::busy()
-    uint32_t updateBegunAt;                 // For initial pause before polling for update completion
-    uint32_t pollingInterval;               // How often to check if update complete (ms)
+    uint32_t updateBegunAt = 0;             // For initial pause before polling for update completion
+    uint32_t pollingInterval = 0;           // How often to check if update complete (ms)
 };
 
 } // namespace NicheGraphics::Drivers

src/graphics/niche/Drivers/EInk/GDEY0154D67.cpp

@@ -4,7 +4,7 @@
 
 using namespace NicheGraphics::Drivers;
 
-// Map the display controller IC's output to the conected panel
+// Map the display controller IC's output to the connected panel
 void GDEY0154D67::configScanning()
 {
     // "Driver output control"

src/graphics/niche/Drivers/EInk/LCMEN2R13EFC1.cpp

@@ -98,6 +98,7 @@ void LCMEN213EFC1::begin(SPIClass *spi, uint8_t pin_dc, uint8_t pin_cs, uint8_t
     reset();
 }
 
+// Display an image on the display
 void LCMEN213EFC1::update(uint8_t *imageData, UpdateTypes type)
 {
     this->updateType = type;
@@ -161,13 +162,6 @@ void LCMEN213EFC1::sendCommand(const uint8_t command)
 
 void LCMEN213EFC1::sendData(uint8_t data)
 {
-    // spi->beginTransaction(spiSettings);
-    // digitalWrite(pin_dc, HIGH); // DC pin HIGH indicates data, instead of command
-    // digitalWrite(pin_cs, LOW);
-    // spi->transfer(data);
-    // digitalWrite(pin_cs, HIGH);
-    // digitalWrite(pin_dc, HIGH);
-    // spi->endTransaction();
     sendData(&data, 1);
 }
 

src/graphics/niche/Drivers/EInk/LCMEN2R13EFC1.h

@@ -45,21 +45,24 @@ class LCMEN213EFC1 : public EInk
     void configFull(); // Configure display for FULL refresh
     void configFast(); // Configure display for FAST refresh
     void writeNewImage();
-    void writeOldImage();
+    void writeOldImage(); // Used for "differential update", aka FAST refresh
 
     void detachFromUpdate();
     bool isUpdateDone();
     void finalizeUpdate();
 
   protected:
-    uint8_t bufferOffsetX; // In bytes. Panel x=0 does not always align with controller x=0. Quirky internal wiring?
-    uint8_t bufferRowSize; // In bytes. Rows store 8 pixels per byte. Rounded up to fit (e.g. 122px would require 16 bytes)
-    uint32_t bufferSize;   // In bytes. Rows * Columns
-    uint8_t *buffer;
-    UpdateTypes updateType;
-
-    uint8_t pin_dc, pin_cs, pin_busy, pin_rst;
-    SPIClass *spi;
+    uint8_t bufferOffsetX = 0; // In bytes. Panel x=0 does not always align with controller x=0. Quirky internal wiring?
+    uint8_t bufferRowSize = 0; // In bytes. Rows store 8 pixels per byte. Rounded up to fit (e.g. 122px would require 16 bytes)
+    uint32_t bufferSize = 0;   // In bytes. Rows * Columns
+    uint8_t *buffer = nullptr;
+    UpdateTypes updateType = UpdateTypes::UNSPECIFIED;
+
+    uint8_t pin_dc = -1;
+    uint8_t pin_cs = -1;
+    uint8_t pin_busy = -1;
+    uint8_t pin_rst = -1;
+    SPIClass *spi = nullptr;
     SPISettings spiSettings = SPISettings(6000000, MSBFIRST, SPI_MODE0);
 };
 

src/graphics/niche/Drivers/EInk/README.md

@@ -3,7 +3,7 @@
 A driver for E-Ink SPI displays. Suitable for re-use by various NicheGraphics UIs.
 
 Your UI should use the class `NicheGraphics::Drivers::EInk` .
-When you set up a hardware variant, you will use one of specific display model classes, which extend the EInk class.
+When you set up a hardware variant, you will use one of the specific display model classes, which extend the EInk class.
 
 An example setup might look like this:
 
@@ -30,7 +30,7 @@ void setupNicheGraphics()
 
 ## Methods
 
-### `update(uint8_t *imageData, UpdateTypes type, bool async=true)`
+### `update(uint8_t *imageData, UpdateTypes type)`
 
 Update the image on the display
 
@@ -39,7 +39,6 @@ Update the image on the display
   - `FULL`
   - `FAST`
   - (Other custom types may be possible)
-- _`async`_ whether to wait for update to complete, or continue code execution
 
 The imageData is a 1-bit image. X-Pixels are 8-per byte, with the MSB being the leftmost pixel. This was not an InkHUD design decision; it is the raw format accepted by the E-Ink display controllers ICs.
 
@@ -63,6 +62,10 @@ uint8_t xBits = (7-x) % 8;
 image[yByte + xByte] |= (1 << xBits); // Set pixel x=12, y=2
 ```
 
+### `await()`
+
+Wait for an in-progress update to complete before continuing
+
 ### `supports(UpdateTypes type)`
 
 Check if display supports a specific update type. `true` if supported.
@@ -75,7 +78,7 @@ Check if display is already performing an `update()`. `true` if already updating
 
 ### `width()`
 
-Width of the display, in pixels. Note: most displays are portait. Your UI will need to implement rotation in software.
+Width of the display, in pixels. Note: most displays are portrait. Your UI will need to implement rotation in software.
 
 ### `height()`
 

src/graphics/niche/Drivers/EInk/SSD16XX.cpp

@@ -30,7 +30,7 @@ void SSD16XX::begin(SPIClass *spi, uint8_t pin_dc, uint8_t pin_cs, uint8_t pin_b
     pinMode(pin_busy, INPUT);
 
     // If using a reset pin, hold high
-    // Reset is active low for solmon systech ICs
+    // Reset is active low for Solomon Systech ICs
     if (pin_rst != 0xFF)
         pinMode(pin_rst, INPUT_PULLUP);
 
@@ -72,13 +72,6 @@ void SSD16XX::sendCommand(const uint8_t command)
 
 void SSD16XX::sendData(uint8_t data)
 {
-    // spi->beginTransaction(spiSettings);
-    // digitalWrite(pin_dc, HIGH); // DC pin HIGH indicates data, instead of command
-    // digitalWrite(pin_cs, LOW);
-    // spi->transfer(data);
-    // digitalWrite(pin_cs, HIGH);
-    // digitalWrite(pin_dc, HIGH);
-    // spi->endTransaction();
     sendData(&data, 1);
 }
 

src/graphics/niche/Drivers/EInk/SSD16XX.h

@@ -39,21 +39,24 @@ class SSD16XX : public EInk
     virtual void configUpdateSequence(); // Tell controller IC which operations to run
 
     virtual void writeNewImage();
-    virtual void writeOldImage();
+    virtual void writeOldImage(); // Image which can be used at *next* update for "differential refresh"
 
     virtual void detachFromUpdate();
     virtual bool isUpdateDone() override;
     virtual void finalizeUpdate() override;
 
   protected:
-    uint8_t bufferOffsetX; // In bytes. Panel x=0 does not always align with controller x=0. Quirky internal wiring?
-    uint8_t bufferRowSize; // In bytes. Rows store 8 pixels per byte. Rounded up to fit (e.g. 122px would require 16 bytes)
-    uint32_t bufferSize;   // In bytes. Rows * Columns
-    uint8_t *buffer;
-    UpdateTypes updateType;
-
-    uint8_t pin_dc, pin_cs, pin_busy, pin_rst;
-    SPIClass *spi;
+    uint8_t bufferOffsetX = 0; // In bytes. Panel x=0 does not always align with controller x=0. Quirky internal wiring?
+    uint8_t bufferRowSize = 0; // In bytes. Rows store 8 pixels per byte. Rounded up to fit (e.g. 122px would require 16 bytes)
+    uint32_t bufferSize = 0;   // In bytes. Rows * Columns
+    uint8_t *buffer = nullptr;
+    UpdateTypes updateType = UpdateTypes::UNSPECIFIED;
+
+    uint8_t pin_dc = -1;
+    uint8_t pin_cs = -1;
+    uint8_t pin_busy = -1;
+    uint8_t pin_rst = -1;
+    SPIClass *spi = nullptr;
     SPISettings spiSettings = SPISettings(4000000, MSBFIRST, SPI_MODE0);
 };
 

src/graphics/niche/Drivers/README.md

@@ -1,3 +1,3 @@
 # NicheGraphics - Drivers
 
-Common drivers which can be used by various NicheGrapihcs UIs
+Common drivers which can be used by various NicheGraphics UIs

src/graphics/niche/FlashData.h

@@ -119,7 +119,7 @@ template <typename T> class FlashData
         // Calculate a hash of the data
         uint32_t hash = getHash(data);
 
-        f.write((uint8_t *)data, sizeof(T));     // Write the actualy data
+        f.write((uint8_t *)data, sizeof(T));     // Write the actual data
         f.write((uint8_t *)&hash, sizeof(hash)); // Append the hash
 
         // f.flush();

src/graphics/niche/Fonts/FreeSans6pt8bCyrillic.h

@@ -4,7 +4,7 @@ Uses Windows-1251 encoding to map translingual Cyrillic characters to range betw
 https://en.wikipedia.org/wiki/Windows-1251
 
 Cyrillic characters present to the firmware as UTF8.
-A Niche Graphics implementation needs to identify these, and subsitute the appropriate Windows-1251 char value.
+A NicheGraphics implementation needs to identify these, and substitute the appropriate Windows-1251 char value.
 
 */