Merge branch 'main' of https://github.com/fablab-bergamo/fab-o-matic

fablab-bergamo · May 25, 2024 · e33a228 · e33a228
2 parents d659806 + 9b68943
commit e33a228
Show file tree

Hide file tree

Showing 26 changed files with 468 additions and 343 deletions.
diff --git a/conf/conf.hpp b/conf/conf.hpp
@@ -5,20 +5,22 @@
 #include <string>
 #include <chrono>
 
-#include "MachineConfig.hpp"
+#include "MachineID.hpp"
 
 namespace fabomatic
 {
   using namespace std::chrono_literals;
 
   namespace conf::default_config
   {
-    static constexpr std::string_view mqtt_server = "fabpi2.local";
-    static constexpr std::string_view mqtt_switch_topic = "";
+    static constexpr std::string_view mqtt_server{"fabpi2.local"};
+    static constexpr std::string_view mqtt_switch_topic{""};
+    static constexpr std::string_view mqtt_switch_on_message{"on"};
+    static constexpr std::string_view mqtt_switch_off_message{"off"};
     static constexpr MachineID machine_id{1};
-    static constexpr std::string_view machine_name = "MACHINE1";
-    static constexpr MachineType machine_type = MachineType::Printer3D;
-    static constexpr std::string_view hostname = "BOARD"; // Machine ID will be added to the hostname in order to form unique hostnames
+    static constexpr std::string_view machine_name{"MACHINE1"};
+    static constexpr MachineType machine_type{MachineType::Printer3D};
+    static constexpr std::string_view hostname{"BOARD"}; // Machine ID will be added to the hostname in order to form unique hostnames
 
   } // namespace conf::default_config
 
@@ -60,10 +62,8 @@ namespace fabomatic
 
   namespace conf::buzzer
   {
-    static constexpr unsigned short LEDC_PWM_CHANNEL{2}; /* Esp32 pwm channel for beep generation */
     static constexpr auto STANDARD_BEEP_DURATION{250ms}; /* Single beep duration, typical value 200ms. Set to 0 to disable beeps. */
     static constexpr auto NB_BEEPS{3};                   /* Number of beeps every time the function is callsed */
-    static constexpr unsigned int BEEP_HZ{660};          /* Beep frequency in Hz */
 
   } // namespace conf::buzzer
 

diff --git a/include/AuthProvider.hpp b/include/AuthProvider.hpp
@@ -18,7 +18,7 @@ namespace fabomatic
   private:
     WhiteList whitelist;
     mutable CachedCards cache;
-    mutable size_t cache_idx = 0;
+    mutable size_t cache_idx{0};
     [[nodiscard]] auto uidInWhitelist(card::uid_t uid) const -> std::optional<WhiteListEntry>;
     [[nodiscard]] auto uidInCache(card::uid_t uid) const -> std::optional<CachedCard>;
     [[nodiscard]] auto searchCache(card::uid_t candidate_uid) const -> std::optional<CachedCard>;
@@ -28,7 +28,7 @@ namespace fabomatic
     AuthProvider() = delete;
     AuthProvider(WhiteList whitelist);
     [[nodiscard]] auto tryLogin(card::uid_t uid, FabBackend &server) const -> std::optional<FabUser>;
-    void setWhitelist(WhiteList list);
+    auto setWhitelist(WhiteList list) -> void;
     auto saveCache() const -> bool;
     auto loadCache() -> void;
   };

diff --git a/include/BoardLogic.hpp b/include/BoardLogic.hpp
@@ -75,6 +75,7 @@ namespace fabomatic
     [[nodiscard]] auto getMachineForTesting() -> Machine &;
     [[nodiscard]] auto getMachine() const -> const Machine &;
     [[nodiscard]] auto authorize(const card::uid_t uid) -> bool;
+    [[nodiscard]] auto getHostname() const -> const std::string;
 
     // copy reference
     BoardLogic &operator=(const BoardLogic &board) = delete;

diff --git a/include/FabBackend.hpp b/include/FabBackend.hpp
@@ -41,7 +41,7 @@ namespace fabomatic
 
     bool online{false};
     bool answer_pending{false};
-    int32_t channel{-1};
+    int16_t channel{-1};
 
     auto messageReceived(String &topic, String &payload) -> void;
 

diff --git a/include/FabUser.hpp b/include/FabUser.hpp
@@ -21,10 +21,10 @@ namespace fabomatic
       FabAdmin,
     };
 
-    card::uid_t card_uid = card::INVALID;
+    card::uid_t card_uid {card::INVALID};
     std::string holder_name{""};
-    bool authenticated = false;
-    UserLevel user_level = UserLevel::Unknown;
+    bool authenticated {false};
+    UserLevel user_level {UserLevel::Unknown};
 
     FabUser() = default;
 

diff --git a/include/LCDWrapper.hpp b/include/LCDWrapper.hpp
@@ -17,13 +17,13 @@ namespace fabomatic
     LCDWrapper(const pins_config::lcd_config &config);
 
     using DisplayBuffer = std::array<std::array<char, conf::lcd::COLS>, conf::lcd::ROWS>;
-    bool begin() override;
-    void clear() override;
-    void showConnection(bool show) override;
-    void showPower(bool show) override;
-    void setRow(uint8_t row, const std::string_view &text) override;
 
-    void update(const BoardInfo &boardinfo, bool forced = false) override;
+    auto begin() -> bool override;
+    auto clear() -> void override;
+    auto showConnection(bool show) -> void override;
+    auto showPower(bool show) -> void override;
+    auto setRow(uint8_t row, const std::string_view &text) -> void override;
+    auto update(const BoardInfo &boardinfo, bool forced = false) -> void override;
 
   private:
     static constexpr auto HEIGHT_PX = 8;
@@ -41,7 +41,7 @@ namespace fabomatic
     static constexpr std::array<uint8_t, HEIGHT_PX> powered_off_char{0x0a, 0x04, 0x0a, 0x00, 0x1f, 0x1f, 0x0a, 0x0a};
     static constexpr std::array<uint8_t, HEIGHT_PX> powering_off_char{0x0e, 0x15, 0x15, 0x15, 0x17, 0x11, 0x11, 0x0e};
 
-    const pins_config::lcd_config config;
+    const pins_config::lcd_config &config;
 
     LcdDriver lcd;
     bool show_connection_status;
@@ -51,11 +51,11 @@ namespace fabomatic
     DisplayBuffer current;
     BoardInfo boardInfo;
 
-    void backlightOn() const;
-    void backlightOff() const;
-    void prettyPrint(const DisplayBuffer &buffer, const BoardInfo &bi) const;
+    auto backlightOn() const -> void;
+    auto backlightOff() const -> void;
+    auto prettyPrint(const DisplayBuffer &buffer, const BoardInfo &bi) const -> void;
     [[nodiscard]] auto needsUpdate(const BoardInfo &bi) const -> bool;
-    void createChar(uint8_t char_idx, const std::array<uint8_t, HEIGHT_PX> &values);
+    auto createChar(uint8_t char_idx, const std::array<uint8_t, HEIGHT_PX> &values) -> void;
   };
 } // namespace fabomatic
 

diff --git a/include/Led.hpp b/include/Led.hpp
@@ -12,7 +12,7 @@ namespace fabomatic
   class Led
   {
   public:
-    enum class Status : uint8_t
+    enum class Status
     {
       Off,
       On,
@@ -21,9 +21,9 @@ namespace fabomatic
 
     Led() = default;
 
-    void set(Status status);
-    void setColor(uint8_t r, uint8_t g, uint8_t b);
-    void update();
+    auto set(Status status) -> void;
+    auto setColor(uint8_t r, uint8_t g, uint8_t b) -> void;
+    auto update() -> void;
 
   private:
     Adafruit_NeoPixel pixel{1, pins.led.pin, pins.led.neopixel_config};

diff --git a/include/MQTTtypes.hpp b/include/MQTTtypes.hpp
@@ -147,10 +147,10 @@ namespace fabomatic::ServerMQTT
     bool is_valid = false;       /* True if the machine has a valid ID */
     bool maintenance = true;     /* True if the machine needs maintenance */
     bool allowed = false;        /* True if the machine can be used by anybody */
-    uint16_t logoff = 0;         /* Timeout in minutes */
+    uint16_t logoff{0};         /* Timeout in minutes */
     std::string name{""};        /* Name of the machine from server DB */
-    uint8_t type = 0;            /* Type of the machine */
-    uint16_t grace = 0;          /* Grace period in minutes */
+    uint8_t type{0};             /* Type of the machine */
+    uint16_t grace{0};           /* Grace period in minutes */
     std::string description{""}; /* Description of the expired maintenance */
     MachineResponse() = delete;
     MachineResponse(bool rok) : Response(rok){};

diff --git a/include/MachineConfig.hpp b/include/MachineConfig.hpp
@@ -1,51 +1,26 @@
 #ifndef MACHINECONFIG_HPP_
 #define MACHINECONFIG_HPP_
 
-#include "pins.hpp"
 #include <chrono>
 #include <cstdint>
 #include <string>
 
+#include "pins.hpp"
+#include "MachineID.hpp"
+#include "conf.hpp"
+
 namespace fabomatic
 {
-  enum class MachineType : uint8_t
-  {
-    Invalid = 0,
-    Printer3D = 1,
-    Laser = 2,
-    Cnc = 3,
-    PrinterResin = 4,
-    Other = 5
-  };
-
-  struct MachineID
-  {
-    uint16_t id;
-
-    constexpr MachineID() : id(0) {}
-    constexpr MachineID(uint16_t id) : id(id) {}
-    // Add conversion operator to uint16_t to use in print, streams...
-    constexpr operator uint16_t() const { return id; }
-  };
   struct MachineConfig
   {
     MachineID machine_id{0};
     MachineType machine_type{MachineType::Invalid};
     std::string machine_name{""};
-    struct RelayConfig
-    {
-      const uint8_t pin{NO_PIN};
-      const bool active_low{false};
-    } relay_config;
-    struct MQTTConfig
-    {
-      const std::string topic{""};
-      const std::string on_message{"on"};
-      const std::string off_message{"off"};
-    } mqtt_config;
+    const pins_config::relay_config &relay_config;
+    const std::string mqtt_switch_topic{""};
 
     /// @brief Time after which the active user on the machine shall be logged-off
-    std::chrono::seconds autologoff;
+    std::chrono::seconds autologoff{conf::machine::DEFAULT_AUTO_LOGOFF_DELAY};
 
     /// @brief Time after which the active user on the machine shall be logged-off
     std::chrono::seconds grace_period;
@@ -55,8 +30,9 @@ namespace fabomatic
                   std::chrono::seconds autologoff,
                   std::chrono::seconds grace_period) : machine_id(id), machine_type(type),
                                                        machine_name(name),
-                                                       relay_config{relay.ch1_pin, relay.active_low},
-                                                       mqtt_config{topic}, autologoff(autologoff),
+                                                       relay_config{relay},
+                                                       mqtt_switch_topic(topic),
+                                                       autologoff(autologoff),
                                                        grace_period{grace_period} {};
 
     [[nodiscard]] auto toString() const -> const std::string;

diff --git a/include/MachineID.hpp b/include/MachineID.hpp
@@ -0,0 +1,26 @@
+#ifndef MACHINE_ID_HPP
+#define MACHINE_ID_HPP
+
+#include <cstdint>
+
+enum class MachineType : uint8_t
+{
+  Invalid = 0,
+  Printer3D = 1,
+  Laser = 2,
+  Cnc = 3,
+  PrinterResin = 4,
+  Other = 5
+};
+
+struct MachineID
+{
+  uint16_t id;
+
+  constexpr MachineID() : id(0) {}
+  constexpr MachineID(uint16_t id) : id(id) {}
+  // Add conversion operator to uint16_t to use in print, streams...
+  constexpr operator uint16_t() const { return id; }
+};
+
+#endif // MACHINE_ID_HPP
diff --git a/include/OTA.hpp b/include/OTA.hpp
@@ -0,0 +1,24 @@
+#ifndef OTA_HPP
+#define OTA_HPP
+
+#include "ArduinoOTA.h"
+#include <WiFiManager.h>
+
+#include "secrets.hpp"
+
+// For ArduinoOTA
+const char *const ssid = fabomatic::secrets::credentials::ssid.data();
+const char *const password = fabomatic::secrets::credentials::password.data();
+
+namespace fabomatic
+{
+
+  /// @brief Open the ArduinoOTA configuration portal
+  /// @param force_reset true to discard saved settings and restore compile-time settings
+  /// @param disable_portal true to skip portal opening (used at boot time)
+  auto openConfigPortal(bool force_reset, bool disable_portal) -> void;
+
+  auto setupOTA() -> void;
+
+} // namespace fabomatic
+#endif // #ifndef OTA_HPP
diff --git a/include/card.hpp b/include/card.hpp
@@ -55,7 +55,7 @@ namespace fabomatic::card
     return retVal;
   }
 
-  inline void print(uint64_t uid)
+  inline auto print(uint64_t uid) -> void
   {
     ESP_LOGI(TAG, "Card UID = %s", card::uid_str(uid).c_str());
   }

diff --git a/include/mock/MockLcdLibrary.hpp b/include/mock/MockLcdLibrary.hpp
diff --git a/include/mock/MockMQTTBroker.hpp b/include/mock/MockMQTTBroker.hpp
@@ -31,8 +31,8 @@ namespace fabomatic
 
   private:
     std::mutex mutex;
-    std::string topic = "";
-    std::string payload = "";
+    std::string topic{""};
+    std::string payload{""};
     struct query
     {
       std::string source_topic{""};

diff --git a/include/mock/MockMrfc522.hpp b/include/mock/MockMrfc522.hpp
@@ -33,16 +33,17 @@ namespace fabomatic
 
     auto PICC_IsNewCardPresent() -> bool;
     auto PICC_ReadCardSerial() -> bool;
-    void reset();
+    auto reset() -> void;
     auto PCD_Init() -> bool;
     auto PICC_WakeupA(byte *bufferATQA, byte &bufferSize) -> bool;
     auto PCD_PerformSelfTest() -> bool;
     auto getDriverUid() const -> MockMrfc522::UidDriver;
-    void PCD_SetAntennaGain(MFRC522Constants::PCD_RxGain gain);
-    void PCD_DumpVersionToSerial();
+    auto PCD_SetAntennaGain(MFRC522Constants::PCD_RxGain gain) -> void;
+    auto PCD_DumpVersionToSerial() -> void;
 
-    void setUid(const std::optional<card::uid_t> &uid, const std::optional<std::chrono::milliseconds> &max_delay);
-    void resetUid();
+    auto setUid(const std::optional<card::uid_t> &uid,
+                const std::optional<std::chrono::milliseconds> &max_delay) -> void;
+    auto resetUid() -> void;
 
     static constexpr auto RxGainMax = MFRC522::PCD_RxGain::RxGain_max;
   };