Change ESP32's timing behavior from periodic ticks to cooldown.

Author: Mysticial

SerialPrograms/Source/Controllers/Controller.h

@@ -7,7 +7,6 @@
 #ifndef PokemonAutomation_Controllers_Controller_H
 #define PokemonAutomation_Controllers_Controller_H
 
-#include <string>
 #include "Common/Compiler.h"
 #include "Common/Cpp/AbstractLogger.h"
 #include "Common/Cpp/Time.h"
@@ -18,6 +17,7 @@ class QKeyEvent;
 namespace PokemonAutomation{
 
 enum class ControllerType;
+enum class ControllerPerformanceClass;
 class ControllerFeatures;
 
 
@@ -44,11 +44,16 @@ class AbstractController{
 
     virtual ControllerType controller_type() const = 0;
     virtual const ControllerFeatures& controller_features() const = 0;
+    virtual ControllerPerformanceClass performance_class() const = 0;
 
     //  If the controller is polled at a fixed interval, this is that interval.
     //  Otherwise, returns zero.
     virtual Milliseconds ticksize() const = 0;
 
+    //  The minimum amount of time between two state reports. This effectively
+    //  limits how quickly you can change states.
+    virtual Milliseconds cooldown() const = 0;
+
     //  Some controllers are imprecise. This returns the variation.
     //  Zero means "tick precise".
     virtual Milliseconds timing_variation() const = 0;

SerialPrograms/Source/Controllers/ControllerTypes.h

@@ -46,6 +46,13 @@ enum class ControllerFeature{
 };
 
 
+enum class ControllerPerformanceClass{
+    Unknown,
+    SerialPABotBase_Wired_125Hz,
+    SerialPABotBase_Wireless_ESP32,
+    SysbotBase,
+};
+
 
 
 

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.cpp

@@ -66,7 +66,6 @@ SerialPABotBase_Connection::SerialPABotBase_Connection(
     std::string error;
     try{
         set_status_line0("Connecting...", COLOR_DARKGREEN);
-
         std::unique_ptr<SerialConnection> connection(new SerialConnection(port->systemLocation().toStdString(), PABB_BAUD_RATE));
         m_botbase.reset(new PABotBase(m_logger, std::move(connection), nullptr));
     }catch (const ConnectionException& e){

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Superscalar.cpp

@@ -125,6 +125,13 @@ void ssf_issue_scroll(
         delay*8ms, hold*8ms, cool*8ms
     );
 }
+void ssf_issue_scroll(
+    ProControllerContext& context,
+    DpadPosition direction,
+    Milliseconds delay
+){
+    context->issue_system_scroll(&context, direction, delay, 2*delay, delay);
+}
 void ssf_issue_scroll(
     ProControllerContext& context,
     DpadPosition direction,

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Superscalar.h

@@ -38,7 +38,7 @@ void ssf_press_button(
 void ssf_press_button(
     ProControllerContext& context,
     Button button,
-    Milliseconds delay, Milliseconds hold = 5*8ms, Milliseconds cool = 3*8ms
+    Milliseconds delay = 24ms, Milliseconds hold = 48ms, Milliseconds cool = 24ms
 );
 
 void ssf_press_dpad(
@@ -49,7 +49,7 @@ void ssf_press_dpad(
 void ssf_press_dpad(
     ProControllerContext& context,
     DpadPosition position,
-    Milliseconds delay, Milliseconds hold = 5*8ms, Milliseconds cool = 3*8ms
+    Milliseconds delay, Milliseconds hold = 48ms, Milliseconds cool = 24ms
 );
 
 
@@ -99,7 +99,12 @@ void ssf_issue_scroll(
 void ssf_issue_scroll(
     ProControllerContext& context,
     DpadPosition direction,
-    Milliseconds delay, Milliseconds hold = 5*8ms, Milliseconds cool = 3*8ms
+    Milliseconds delay
+);
+void ssf_issue_scroll(
+    ProControllerContext& context,
+    DpadPosition direction,
+    Milliseconds delay, Milliseconds hold, Milliseconds cool
 );
 
 
@@ -116,44 +121,40 @@ void ssf_issue_scroll(
 inline void ssf_press_button_ptv(
     ProControllerContext& context,
     Button button,
-    Milliseconds delay = 3*8ms,
-    Milliseconds hold = 5*8ms,
-    Milliseconds cool = 3*8ms
+    Milliseconds delay = 24ms,
+    Milliseconds hold = 48ms,
+    Milliseconds cool = 24ms
 ){
-    ssf_press_button(
-        context, button,
-        delay + context->timing_variation(),
-        hold + context->timing_variation(),
-        cool + context->timing_variation()
-    );
+    Milliseconds tv = context->timing_variation();
+    if (delay > 0ms) delay += tv;
+    if (hold > 0ms) hold += tv;
+    if (cool > 0ms) cool += tv;
+    ssf_press_button(context, button, delay, hold, cool);
 }
 inline void ssf_press_dpad_ptv(
     ProControllerContext& context,
     DpadPosition position,
-    Milliseconds delay = 3*8ms,
-    Milliseconds hold = 5*8ms,
-    Milliseconds cool = 3*8ms
+    Milliseconds delay = 24ms,
+    Milliseconds hold = 48ms,
+    Milliseconds cool = 24ms
 ){
-    ssf_press_dpad(
-        context, position,
-        delay + context->timing_variation(),
-        hold + context->timing_variation(),
-        cool + context->timing_variation()
-    );
+    Milliseconds tv = context->timing_variation();
+    if (delay > 0ms) delay += tv;
+    if (hold > 0ms) hold += tv;
+    if (cool > 0ms) cool += tv;
+    ssf_press_dpad(context, position, delay, hold, cool);
 }
 inline void ssf_issue_scroll_ptv(
     ProControllerContext& context,
     DpadPosition direction,
-    Milliseconds delay = 3*8ms,
-    Milliseconds hold = 5*8ms,
-    Milliseconds cool = 3*8ms
+    Milliseconds delay = 24ms,
+    Milliseconds hold = 48ms,
+    Milliseconds cool = 24ms
 ){
-    ssf_issue_scroll(
-        context, direction,
-        delay + context->timing_variation(),
-        hold + context->timing_variation(),
-        cool + context->timing_variation()
-    );
+    Milliseconds tv = context->timing_variation();
+    if (delay > 0ms) delay += tv;
+    if (hold > 0ms) hold += tv;
+    ssf_issue_scroll(context, direction, delay, hold, cool);
 }
 
 
@@ -220,7 +221,7 @@ void ssf_do_nothing     (JoyconContext& context, Milliseconds duration);
 void ssf_press_button(
     JoyconContext& context,
     Button button,
-    Milliseconds delay, Milliseconds hold = 3*15ms, Milliseconds cool = 2*15ms
+    Milliseconds delay, Milliseconds hold = 48ms, Milliseconds cool = 24ms
 );
 void ssf_press_joystick(
     JoyconContext& context,

SerialPrograms/Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_PokkenController.h

@@ -46,10 +46,16 @@ class SerialPABotBase_PokkenController final :
     virtual const ControllerFeatures& controller_features() const override{
         return m_supported_features;
     }
+    virtual ControllerPerformanceClass performance_class() const override{
+        return ControllerPerformanceClass::SerialPABotBase_Wired_125Hz;
+    }
 
     virtual Milliseconds ticksize() const override{
         return Milliseconds(8);
     }
+    virtual Milliseconds cooldown() const override{
+        return Milliseconds(8);
+    }
     virtual Milliseconds timing_variation() const override{
         return Milliseconds::zero();
     }

SerialPrograms/Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessController.cpp

@@ -72,16 +72,36 @@ void SerialPABotBase_WirelessController::issue_report(
     //  This loop can block indefinitely if the command queue is full.
     ReverseLockGuard<std::mutex> lg(m_state_lock);
 
-    //  Divide the controller state into smaller chunks of 255 ticks.
+    //  We will not do any throttling or timing adjustments here. We'll defer
+    //  to the microcontroller to do that for us.
+
+    //  Divide the controller state into smaller chunks of 65535 milliseconds.
     Milliseconds time_left = std::chrono::duration_cast<Milliseconds>(duration);
+
+//    time_left = (time_left + 14ms) / 15ms * 15ms;
+
+//    time_left = std::max(time_left, 15ms);
     while (time_left > Milliseconds::zero()){
-        Milliseconds current_ms = std::min(time_left, 255 * 15ms);
-        uint8_t current_ticks = (uint8_t)milliseconds_to_ticks_15ms(current_ms.count());
+        Milliseconds current = std::min(time_left, 65535ms);
+        time_left -= current;
+
+#if 0
+        //  Make sure the last block isn't too small.
+        if (0ms < time_left && time_left < 15ms){
+            time_left += current;
+            current = time_left / 2;
+            time_left -= current;
+        }
+#endif
+//        cout << "current = " << current.count() << endl;
+
         m_serial->issue_request(
-            SerialPABotBase::MessageControllerStateButtons(current_ticks * 15, buttons),
+            SerialPABotBase::MessageControllerStateButtons(
+                (uint16_t)current.count(),
+                buttons
+            ),
             cancellable
         );
-        time_left -= current_ms;
     }
 }
 

SerialPrograms/Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessController.h

@@ -35,8 +35,11 @@ class SerialPABotBase_WirelessController : public SerialPABotBase_Controller{
     Milliseconds ticksize() const{
         return Milliseconds(15);
     }
+    Milliseconds cooldown() const{
+        return Milliseconds(15);
+    }
     Milliseconds timing_variation() const{
-        return Milliseconds::zero();
+        return Milliseconds(0);
     }
 
 
@@ -55,7 +58,8 @@ class SerialPABotBase_WirelessController : public SerialPABotBase_Controller{
         //  I suspect the need to offset by 151 from 2048 -> 1897 is Nintendo's
         //  way to alleviate the joycon drift problem.
         const uint16_t min = 1897;
-        const uint16_t max = 320;
+//        const uint16_t max = 320;
+        const uint16_t max = 275;   //  REMOVE: TODO: Fix the clipping for real.
 
         const double lo = 1 - min / 2048.;
         const double hi = 1 - max / 2048.;

SerialPrograms/Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessJoycon.h

@@ -42,10 +42,16 @@ class SerialPABotBase_WirelessJoycon final :
     virtual const ControllerFeatures& controller_features() const override{
         return m_supported_features;
     }
+    virtual ControllerPerformanceClass performance_class() const override{
+        return ControllerPerformanceClass::SerialPABotBase_Wireless_ESP32;
+    }
 
     virtual Milliseconds ticksize() const override{
         return SerialPABotBase_WirelessController::ticksize();
     }
+    virtual Milliseconds cooldown() const override{
+        return SerialPABotBase_WirelessController::cooldown();
+    }
     virtual Milliseconds timing_variation() const override{
         return SerialPABotBase_WirelessController::timing_variation();
     }

SerialPrograms/Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessProController.cpp

@@ -45,12 +45,13 @@ void SerialPABotBase_WirelessProController::push_state(const Cancellable* cancel
         .vibrator = 0x00,
     };
 
-
+    Button all_buttons = BUTTON_NONE;
     for (size_t c = 0; c < TOTAL_BUTTONS; c++){
         if (!m_buttons[c].is_busy()){
             continue;
         }
         Button button = (Button)((ButtonFlagType)1 << c);
+        all_buttons |= button;
         switch (button){
         //  Right
         case BUTTON_Y:          report.button3 |= 1 << 0; break;
@@ -103,6 +104,17 @@ void SerialPABotBase_WirelessProController::push_state(const Cancellable* cancel
     }
 
     issue_report(cancellable, report, duration);
+
+#if 0
+    m_logger.log(
+        "push_state(): (" + button_to_string(all_buttons) +
+        "), dpad(" + dpad_to_string(m_dpad.position) +
+        "), LJ(" + std::to_string(m_left_joystick.x) + "," + std::to_string(m_left_joystick.y) +
+        "), RJ(" + std::to_string(m_right_joystick.x) + "," + std::to_string(m_right_joystick.y) +
+        "), hold = " + std::to_string(std::chrono::duration_cast<Milliseconds>(duration).count()) + "ms",
+        COLOR_DARKGREEN
+    );
+#endif
 }