feat: reset remote to defaults with button press on boot (#481)

Pressing and holding `volume up`, `top left button (circle)` and `dpad down` on boot will reset the configuration file to default and create a marker file for first time setup. The remote will reboot.

**How to reset the remote to factory defaults:**

Press and hold: `volume up`, `top left` and `dpad down` buttons while turning on the remote.
When the remote reboots, immediately release these buttons
The remote will start up with the setup wizard

Author: martonborzak

remote.pro

@@ -22,7 +22,7 @@
  #############################################################################/
 
 QT += qml quick websockets quickcontrols2 bluetooth
-CONFIG += c++14 disable-desktop
+CONFIG += c++17 disable-desktop
 #disable qtquickcompiler for QML debugging!
 CONFIG += qtquickcompiler
 
@@ -255,8 +255,10 @@ linux {
             sources/hardware/linux/arm/displaycontrol_yio.cpp \
             sources/hardware/linux/arm/drv2605.cpp \
             sources/hardware/linux/arm/mcp23017_interrupt.cpp
-    }
 
+        # needed for std::filesystem
+        LIBS += -lstdc++fs
+    }
 }
 
 # Android specific files (empty template for now)

sources/hardware/buttonhandler.cpp

@@ -30,11 +30,12 @@ static Q_LOGGING_CATEGORY(CLASS_LC, "hw.buttonhandler");
 ButtonHandler *ButtonHandler::s_instance = nullptr;
 
 ButtonHandler::ButtonHandler(InterruptHandler *interruptHandler, YioAPI *api, QObject *parent)
-    : QObject(parent), m_itnerruptHandler(interruptHandler), m_api(api) {
+    : QObject(parent), m_itnerruptHandler(interruptHandler), m_api(api), m_resetButtonsPressed(false) {
     s_instance = this;
 
     // connect to interrupt handler
     connect(m_itnerruptHandler, &InterruptHandler::interruptEvent, this, &ButtonHandler::onInterrupt);
+    m_resetButtonsPressed = m_itnerruptHandler->m_wasResetPress;
 
     // connect to API
     connect(m_api, &YioAPI::buttonPressed, this, &ButtonHandler::onYIOAPIPressed);

sources/hardware/buttonhandler.h

@@ -65,6 +65,8 @@ class ButtonHandler : public QObject {
     explicit ButtonHandler(InterruptHandler* interruptHandler, YioAPI* api, QObject* parent = nullptr);
     virtual ~ButtonHandler();
 
+    bool resetButtonsPressed() { return m_resetButtonsPressed; }
+
     static ButtonHandler* getInstance() { return s_instance; }
     static QObject*       getQMLInstance(QQmlEngine* engine, QJSEngine* scriptEngine);
 
@@ -76,9 +78,7 @@ class ButtonHandler : public QObject {
     static ButtonHandler* s_instance;
     InterruptHandler*     m_itnerruptHandler;
     YioAPI*               m_api;
-
-    int m_buttonPressed  = -1;
-    int m_buttonReleased = -1;
+    bool                  m_resetButtonsPressed;
 
  private slots:  // NOLINT open issue: https://github.com/cpplint/cpplint/pull/99
     void onInterrupt(int event);

sources/hardware/interrupthandler.h

@@ -65,6 +65,8 @@ class InterruptHandler : public Device {
 
     Q_INVOKABLE virtual void shutdown() = 0;
 
+    bool m_wasResetPress = false;
+
  signals:
     void interruptEvent(int event);
 

sources/hardware/linux/arm/mcp23017_handler.h

@@ -22,17 +22,17 @@
 
 #pragma once
 
-#include <QLoggingCategory>
-#include <QString>
-#include <QtDebug>
-
 #include <stdbool.h>
 #include <stdint.h>
 #include <time.h>
 #include <unistd.h>
 #include <wiringPi.h>
 #include <wiringPiI2C.h>
 
+#include <QLoggingCategory>
+#include <QString>
+#include <QtDebug>
+
 #include "../../interrupthandler.h"
 
 #define MCP23017_ADDRESS 0x20
@@ -122,6 +122,16 @@ class MCP23017 {
         return true;
     }
 
+    bool readReset() {
+        // read initial state to determine if reset is needed
+        int gpioB = wiringPiI2CReadReg8(m_i2cFd, MCP23017_GPIOB);
+        if (!(gpioB & 0x040) && !(gpioB & 0x080) && !(gpioB & 0x04)) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
     int readInterrupt() {
         int intfA = wiringPiI2CReadReg8(m_i2cFd, MCP23017_INTFA);
         int gpioA = wiringPiI2CReadReg8(m_i2cFd, MCP23017_GPIOA);

sources/hardware/linux/arm/mcp23017_interrupt.cpp

@@ -102,6 +102,10 @@ bool Mcp23017InterruptHandler::setupGPIO() {
     notifier->addPath(m_gpioValueDevice);
     connect(notifier, &QFileSystemWatcher::fileChanged, this, &Mcp23017InterruptHandler::interruptHandler);
 
+    if (mcp.readReset()) {
+        m_wasResetPress = true;
+    }
+
     return true;
 }
 

sources/main.cpp

@@ -30,6 +30,9 @@
 #include <QQmlContext>
 #include <QQuickWindow>
 #include <QtDebug>
+#if defined(Q_PROCESSOR_ARM)
+#include <filesystem>
+#endif
 
 #include "bluetooth.h"
 #include "commandlinehandler.h"
@@ -94,8 +97,8 @@ int main(int argc, char* argv[]) {
     bool configError = false;
     if (!QFile::exists(cmdLineHandler.configFile())) {
         qFatal("App configuration file not found: %s", cmdLineHandler.configFile().toLatin1().constData());
-        return 1;
     }
+
     Config* config = new Config(&engine, cmdLineHandler.configFile(), cmdLineHandler.configSchemaFile(), appPath);
     if (!config->readConfig()) {
         qCCritical(CLASS_LC).noquote() << "Invalid configuration!" << endl << config->getError();
@@ -207,6 +210,47 @@ int main(int argc, char* argv[]) {
     ButtonHandler* buttonHandler = new ButtonHandler(hwFactory->getInterruptHandler(), yioapi);
     qmlRegisterSingletonType<ButtonHandler>("ButtonHandler", 1, 0, "ButtonHandler", &ButtonHandler::getQMLInstance);
 
+#if defined(Q_PROCESSOR_ARM)
+    // reset combination was pressed on startup (only on the remote hardware)
+    if (buttonHandler->resetButtonsPressed()) {
+        QString defaultConfigPath = qEnvironmentVariable(Environment::ENV_YIO_APP_DIR, appPath) + "/config.json";
+
+        if (QFile::exists(defaultConfigPath)) {
+            // create marker file
+            QFile file("/firstrun");
+            if (file.open(QIODevice::WriteOnly)) {
+                file.close();
+
+                // make a copy of existing configuration
+                if (!std::filesystem::copy_file("/boot/config.json", "/boot/config.json.old",
+                                                std::filesystem::copy_options::overwrite_existing)) {
+                    qCCritical(CLASS_LC) << "Error backing up existing configuration.";
+                } else {
+                    if (!std::filesystem::copy_file(defaultConfigPath.toStdString(), "/boot/config.json",
+                                                    std::filesystem::copy_options::overwrite_existing)) {
+                        qCCritical(CLASS_LC) << "Error copying default configuration.";
+                    } else {
+                        // reset wifi settings
+                        wifiControl->clearConfiguredNetworks();
+
+                        // reboot
+                        Launcher().launch("reboot");
+
+                        return -1;
+                    }
+                }
+            } else {
+                qCCritical(CLASS_LC) << "Error writing firstrun marker file";
+                notifications.add(
+                    true, QGuiApplication::tr("An error occured while restoring to defaults. Please try again."));
+            }
+        } else {
+            qCCritical(CLASS_LC) << "Default config file not found. Cannot restore to defaults.";
+            notifications.add(true, QGuiApplication::tr("Default config file not found. Cannot restore to defaults."));
+        }
+    }
+#endif
+
     // STANDBY CONTROL
     StandbyControl* standbyControl =
         new StandbyControl(displayControl, hwFactory->getProximitySensor(), hwFactory->getLightSensor(),
@@ -216,7 +260,7 @@ int main(int argc, char* argv[]) {
     qmlRegisterSingletonType<StandbyControl>("StandbyControl", 1, 0, "StandbyControl", &StandbyControl::getQMLInstance);
 
     // SOFTWARE UPDATE
-    QVariantMap     appUpdCfg = config->getSettings().value("softwareupdate").toMap();
+    QVariantMap     appUpdCfg      = config->getSettings().value("softwareupdate").toMap();
     SoftwareUpdate* softwareUpdate = new SoftwareUpdate(appUpdCfg, hwFactory->getBatteryFuelGauge());
     qmlRegisterSingletonType<SoftwareUpdate>("SoftwareUpdate", 1, 0, "SoftwareUpdate", &SoftwareUpdate::getQMLInstance);
 

translations/en_US.ts

@@ -710,6 +710,19 @@ to set up YIO remote</source>
         <translation type="unfinished"></translation>
     </message>
 </context>
+<context>
+    <name>QGuiApplication</name>
+    <message>
+        <location filename="../sources/main.cpp" line="242"/>
+        <source>An error occured while restoring to defaults. Please try again.</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="../sources/main.cpp" line="246"/>
+        <source>Default config file not found. Cannot restore to defaults.</source>
+        <translation type="unfinished"></translation>
+    </message>
+</context>
 <context>
     <name>QObject</name>
     <message>