Merge remote-tracking branch 'origin/issue_056' into issue_180

tonuino · Mar 25, 2024 · 9147a37 · 9147a37
2 parents 2a55b6e + b2c68e5
commit 9147a37
Show file tree

Hide file tree

Showing 8 changed files with 101 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -90,12 +90,13 @@ Die SD Karte (Ordner mp3 und advert) hat sich gegenüber der Version 3.1.6 geän
 
 # Change Log
 
-## Version 3.1.7 (17.03.2024)
+## Version 3.1.7 (28.03.2024)
 - [Issue 180](https://github.com/tonuino/TonUINO-TNG/issues/180): Play special shortcut on startup if a GPIO is set
 - [Issue 056](https://github.com/tonuino/TonUINO-TNG/issues/56): Implement headphone jack detection
 - [Issue 178](https://github.com/tonuino/TonUINO-TNG/issues/178): Use Nano Every optional with HW Serial connection to the DfPlayer
 
-## Version 3.1.7 (14.03.2024)
+## Version 3.1.7 (25.03.2024)
+- [Issue 182](https://github.com/tonuino/TonUINO-TNG/issues/182): Quiz game: do not repeat a question until no question remains
 - [Issue 176](https://github.com/tonuino/TonUINO-TNG/issues/176): Implement the memory game
 
 ## Version 3.1.6 (18.02.2024)

diff --git a/TonUINO-TNG.ino b/TonUINO-TNG.ino
@@ -35,7 +35,7 @@ void setup()
   LOG(init_log, s_error, F("TonUINO Version 3.1 - refactored by Boerge1\n"));
   LOG(init_log, s_error, F("created by Thorsten Voß and licensed under GNU/GPL."));
   LOG(init_log, s_error, F("Information and contribution at https://tonuino.de.\n"));
-  LOG(init_log, s_error, F("V3.1.7 17.03.24\n"));
+  LOG(init_log, s_error, F("V3.1.7 28.03.24\n"));
 
   Tonuino::getTonuino().setup();
 }

diff --git a/src/poti.hpp b/src/poti.hpp
@@ -11,7 +11,6 @@ class Poti: public CommandSource {
 public:
 
   Poti(const Settings& settings, Mp3& mp3);
-  virtual ~Poti() {}
   commandRaw getCommandRaw() override;
 
 private:

diff --git a/src/queue.hpp b/src/queue.hpp
@@ -3,6 +3,22 @@
 
 #include "array.hpp"
 
+inline void setBit  (uint8_t &v, uint8_t b) { v |=  (1<<b); }
+inline void clearBit(uint8_t &v, uint8_t b) { v &= ~(1<<b); }
+inline bool getBit  (uint8_t &v, uint8_t b) { return v & (1<<b); }
+
+template<uint8_t BITS>
+class bitfield {
+public:
+  void setBit  (uint8_t n) { uint8_t &v = bits[n/8]; ::setBit  (v, n%8); }
+  void clearBit(uint8_t n) { uint8_t &v = bits[n/8]; ::clearBit(v, n%8); }
+  bool getBit  (uint8_t n) { uint8_t &v = bits[n/8]; return ::getBit(v, n%8); }
+  void setAll  (uint8_t v) { for (uint8_t i = 0; i < BITS/8+1; ++i) bits[i] = v; }
+
+private:
+  uint8_t bits[BITS/8+1]{};
+};
+
 template<typename T>
 void swap(T &lhs, T &rhs) {
   const T t = lhs;

diff --git a/src/rotary_encoder.hpp b/src/rotary_encoder.hpp
@@ -19,7 +19,6 @@ class RotaryEncoder: public CommandSource {
 public:
 
   RotaryEncoder(const Settings& settings);
-  virtual ~RotaryEncoder() {}
   commandRaw getCommandRaw() override;
 
   static void changed();

diff --git a/src/settings.hpp b/src/settings.hpp
@@ -30,22 +30,22 @@ struct Settings {
   folderSettings getShortCut(uint8_t shortCut);
   void           setShortCut(uint8_t shortCut, const folderSettings& value);
 
-  uint32_t    cookie;
-  byte        version;
-  uint8_t     spkMaxVolume ;
-  uint8_t     spkMinVolume ;
-  uint8_t     spkInitVolume;
-  uint8_t     eq;
-  uint8_t     dummy;
-  uint32_t    standbyTimer;
-  uint8_t     invertVolumeButtons;
-  shortCuts_t shortCuts;
-  uint8_t     adminMenuLocked;
-  pin_t       adminMenuPin;
-  uint8_t     pauseWhenCardRemoved;
-  uint8_t     hpMaxVolume ;
-  uint8_t     hpMinVolume ;
-  uint8_t     hpInitVolume;
+  uint32_t    cookie              {};
+  byte        version             {};
+  uint8_t     spkMaxVolume        {};
+  uint8_t     spkMinVolume        {};
+  uint8_t     spkInitVolume       {};
+  uint8_t     eq                  {};
+  uint8_t     dummy               {};
+  uint32_t    standbyTimer        {};
+  uint8_t     invertVolumeButtons {};
+  shortCuts_t shortCuts           {};
+  uint8_t     adminMenuLocked     {};
+  pin_t       adminMenuPin        {};
+  uint8_t     pauseWhenCardRemoved{};
+  uint8_t     hpMaxVolume         {};
+  uint8_t     hpMinVolume         {};
+  uint8_t     hpInitVolume        {};
 };
 
 // emulates EEPROM.put() .get() and .update() on LGT8F328P platform

diff --git a/src/state_machine.cpp b/src/state_machine.cpp
@@ -857,6 +857,8 @@ void Quiz::entry() {
     a.push(3);
   }
 
+  remainingQuestions = 0;
+
   timer.start(timeout);
 
   if (numAnswer == 0)
@@ -902,7 +904,33 @@ void Quiz::react(command_e const &cmd_e) {
     case QuizState::playQuestion:
     case QuizState::playSolution:
     case QuizState::playWeiter:
-      question = random(0, numQuestion);
+      if (remainingQuestions == 0) {
+        remainingQuestions = numQuestion;
+        r.setAll(0xFF);
+      }
+      question = random(0, remainingQuestions);
+      LOG(state_log, s_debug, F("random: "), question, F(", remain: "), remainingQuestions);
+      {
+        uint8_t i = 0;
+        while (true) {
+          if (question == 0) {
+            while (not r.getBit(i)) ++i;
+            question = i;
+            r.clearBit(i);
+            LOG(state_log, s_debug, F("question: "), question);
+            break;
+          }
+          if (r.getBit(i++)) {
+            --question;
+          }
+        }
+      }
+      --remainingQuestions;
+      LOG(state_log, s_debug, F("r: "), lf_no);
+      for (uint8_t i = 0; i<numQuestion; ++i)
+        LOG(state_log, s_debug, r.getBit(i), lf_no);
+      LOG(state_log, s_debug, F(" "));
+
       trackQuestion = question*(numAnswer+numSolution+1)+1;
       a.shuffle();
       mp3.enqueueTrack(tonuino.getFolder(), trackQuestion);
@@ -947,6 +975,9 @@ void Quiz::react(command_e const &cmd_e) {
         mp3.enqueueTrack(tonuino.getFolder(), trackQuestion+actAnswer+1);
       }
     }
+    else {
+      mp3.increaseVolume();
+    }
     break;
   case command::next:
     if (quizState == QuizState::playAnswer) {
@@ -977,6 +1008,9 @@ void Quiz::react(command_e const &cmd_e) {
         mp3.enqueueTrack(tonuino.getFolder(), trackQuestion+actAnswer+1);
       }
     }
+    else {
+      mp3.decreaseVolume();
+    }
     break;
   case command::previous:
     if (quizState == QuizState::playAnswer) {

diff --git a/src/state_machine.hpp b/src/state_machine.hpp
@@ -136,14 +136,16 @@ class Quiz: public Base
 
   void finish();
 
-  uint8_t   numAnswer;
-  uint8_t   numSolution;
-  QuizState quizState;
-  uint8_t   question;
-  uint8_t   trackQuestion;
-  uint8_t   numQuestion;
-  uint8_t   actAnswer;
-  queue<uint8_t, 4> a;
+  uint8_t   numAnswer    {};
+  uint8_t   numSolution  {};
+  QuizState quizState    {};
+  uint8_t   question     {};
+  uint8_t   trackQuestion{};
+  uint8_t   numQuestion  {};
+  uint8_t   actAnswer    {};
+  queue<uint8_t, 4>     a{};
+  bitfield<128>         r{}; // max in buzzer mode (num answer = 0, num solution = 1)
+  uint8_t remainingQuestions{};
   static constexpr long timeout{ 5 * 60 * 1000l};
 };
 
@@ -157,8 +159,8 @@ class Memory: public Base
 
   void finish();
 
-  uint8_t     first;
-  uint8_t     second;
+  uint8_t     first {};
+  uint8_t     second{};
   static constexpr long timeout{ 5 * 60 * 1000l};
 };
 
@@ -248,7 +250,7 @@ class WriteCard : public SM_writeCard
     end_writeCard,
     run_waitCardRemoved,
   };
-  subState current_subState;
+  subState current_subState{};
 };
 
 class Admin_BaseSetting: public VoiceMenu_tonuino
@@ -280,10 +282,10 @@ class Admin_Allow: public VoiceMenu_tonuino
     allow,
     not_allow,
   };
-  subState current_subState;
-  Settings::pin_t pin;
-  uint8_t         pin_number;
-//  uint8_t         av, bv, cv;
+  subState        current_subState{};
+  Settings::pin_t pin             {};
+  uint8_t         pin_number      {};
+//  uint8_t         av{}, bv{}, cv{};
 };
 
 class Admin_Entry: public VoiceMenu_tonuino
@@ -310,7 +312,7 @@ class Admin_NewCard: public Amin_BaseWriteCard
     start_writeCard,
     run_writeCard,
   };
-  subState current_subState;
+  subState current_subState{};
 };
 
 class Admin_SimpleSetting: public Admin_BaseSetting
@@ -333,13 +335,13 @@ class Admin_ModCard: public Amin_BaseWriteCard
   void entry() final;
   void react(command_e const &) final;
 private:
-  pmode_t mode;
   enum subState: uint8_t {
     start_writeCard,
     run_writeCard,
   };
-  subState current_subState;
-  bool     readyToWrite;
+  pmode_t mode             {};
+  subState current_subState{};
+  bool     readyToWrite    {};
 };
 
 class Admin_ShortCut: public Admin_BaseSetting
@@ -353,8 +355,8 @@ class Admin_ShortCut: public Admin_BaseSetting
     run_setupCard,
     end_setupCard,
   };
-  subState current_subState;
-  uint8_t  shortcut;
+  subState current_subState{};
+  uint8_t  shortcut        {};
 };
 
 class Admin_StandbyTimer: public Admin_BaseSetting
@@ -378,9 +380,9 @@ class Admin_CardsForFolder: public Amin_BaseWriteCard
     start_writeCard,
     run_writeCard,
   };
-  subState current_subState;
-  uint8_t special;
-  uint8_t special2;
+  subState current_subState{};
+  uint8_t special          {};
+  uint8_t special2         {};
 };
 
 class Admin_InvButtons: public Admin_BaseSetting
@@ -408,9 +410,9 @@ class Admin_LockAdmin: public Admin_BaseSetting
     get_pin,
     finished,
   };
-  subState current_subState;
-  Settings::pin_t pin;
-  uint8_t         pin_number;
+  subState        current_subState{};
+  Settings::pin_t pin             {};
+  uint8_t         pin_number      {};
 };
 
 class Admin_PauseIfCardRemoved: public Admin_BaseSetting
@@ -432,7 +434,7 @@ class Admin_MemoryGameCards: public Amin_BaseWriteCard
     start_writeCard,
     run_writeCard,
   };
-  subState current_subState;
+  subState current_subState{};
 };
 #endif