Add abstraction layer between SerialPABotBase and the programs.

Author: Mysticial

ClientSource/Connection/BotBase.h

@@ -73,7 +73,7 @@ class BotBaseController{
 
 
 
-class ControllerContext : public CancellableScope{
+class ControllerContext0 : public CancellableScope{
 public:
     virtual void wait_for_all_requests() const = 0;
     virtual void cancel_now() = 0;
@@ -82,7 +82,7 @@ class ControllerContext : public CancellableScope{
 
 
 //  A wrapper for BotBase that allows for asynchronous cancelling.
-class BotBaseControllerContext final : public ControllerContext{
+class BotBaseControllerContext final : public ControllerContext0{
 public:
     using ControllerType = BotBaseController;
 

ClientSource/Connection/PABotBaseConnection.h

@@ -15,9 +15,7 @@
 #define PokemonAutomation_PABotBaseConnection_H
 
 #include <memory>
-#include <string>
 #include <deque>
-#include "Common/Compiler.h"
 #include "Common/Microcontroller/MessageProtocol.h"
 #include "BotBase.h"
 #include "MessageSniffer.h"

SerialPrograms/CMakeLists.txt

@@ -802,6 +802,8 @@ file(GLOB MAIN_SOURCES
     Source/NintendoSwitch/Commands/NintendoSwitch_Messages_Superscalar.h
     Source/NintendoSwitch/Controllers/NintendoSwitch_Controller.cpp
     Source/NintendoSwitch/Controllers/NintendoSwitch_Controller.h
+    Source/NintendoSwitch/Controllers/NintendoSwitch_SerialPABotBase.cpp
+    Source/NintendoSwitch/Controllers/NintendoSwitch_SerialPABotBase.h
     Source/NintendoSwitch/DevPrograms/BoxDraw.cpp
     Source/NintendoSwitch/DevPrograms/BoxDraw.h
     Source/NintendoSwitch/DevPrograms/TestProgramComputer.cpp

SerialPrograms/SerialPrograms.pro

@@ -397,6 +397,7 @@ SOURCES += \
     Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Routines.cpp \
     Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Superscalar.cpp \
     Source/NintendoSwitch/Controllers/NintendoSwitch_Controller.cpp \
+    Source/NintendoSwitch/Controllers/NintendoSwitch_SerialPABotBase.cpp \
     Source/NintendoSwitch/DevPrograms/BoxDraw.cpp \
     Source/NintendoSwitch/DevPrograms/TestProgramComputer.cpp \
     Source/NintendoSwitch/DevPrograms/TestProgramSwitch.cpp \
@@ -1528,6 +1529,7 @@ HEADERS += \
     Source/NintendoSwitch/Commands/NintendoSwitch_Messages_PushButtons.h \
     Source/NintendoSwitch/Commands/NintendoSwitch_Messages_Superscalar.h \
     Source/NintendoSwitch/Controllers/NintendoSwitch_Controller.h \
+    Source/NintendoSwitch/Controllers/NintendoSwitch_SerialPABotBase.h \
     Source/NintendoSwitch/DevPrograms/BoxDraw.h \
     Source/NintendoSwitch/DevPrograms/TestProgramComputer.h \
     Source/NintendoSwitch/DevPrograms/TestProgramSwitch.h \

SerialPrograms/Source/CommonTools/Async/InterruptableCommands.tpp

@@ -134,9 +134,10 @@ bool AsyncCommandSession<ControllerType>::cancel(std::exception_ptr exception) n
     if (m_current != nullptr){
         m_current->context.cancel(std::move(exception));
     }else{
-        try{
-            m_controller.stop_all_commands();
-        }catch (...){}
+        //  REMOVE: Check that this can actually be deleted.
+//        try{
+//            m_controller.stop_all_commands();
+//        }catch (...){}
     }
     m_cv.notify_all();
     return false;

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.cpp

@@ -16,10 +16,12 @@
 #include "Common/NintendoSwitch/NintendoSwitch_ControllerDefs.h"
 #include "ClientSource/Libraries/MessageConverter.h"
 #include "ClientSource/Connection/SerialConnection.h"
+//#include "ClientSource/Connection/BotBase.h"
 #include "ClientSource/Connection/PABotBase.h"
 #include "CommonFramework/Globals.h"
 #include "CommonFramework/Options/Environment/ThemeSelectorOption.h"
 #include "NintendoSwitch/Commands/NintendoSwitch_Commands_Device.h"
+#include "NintendoSwitch/Commands/NintendoSwitch_Messages_Device.h"
 #include "SerialPABotBase_Globals.h"
 #include "SerialPABotBase_Handle.h"
 #include "SerialPABotBase_Descriptor.h"
@@ -380,7 +382,9 @@ void BotBaseHandle::thread_body(){
         }
     });
 
+    //  REMOVE
     BotBaseControllerContext context(*m_botbase);
+
     while (true){
         if (m_state.load(std::memory_order_acquire) != State::READY){
             break;
@@ -390,7 +394,13 @@ void BotBaseHandle::thread_body(){
         std::string error;
         try{
 //            cout << "system_clock()" << endl;
-            uint32_t wallclock = NintendoSwitch::system_clock(context);
+            pabb_MsgAckRequestI32 response;
+            context.issue_request_and_wait(
+                NintendoSwitch::DeviceRequest_system_clock()
+            ).convert<PABB_MSG_ACK_REQUEST_I32>(context.controller().logger(), response);
+            uint32_t wallclock = response.data;
+
+//            uint32_t wallclock = NintendoSwitch::system_clock(context);
 //            cout << "system_clock() - done" << endl;
             str = ticks_to_time(TICKS_PER_SECOND, wallclock);
         }catch (InvalidConnectionStateException&){

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Device.cpp

@@ -11,15 +11,15 @@ namespace PokemonAutomation{
 namespace NintendoSwitch{
 
 
-uint32_t system_clock(SwitchControllerContext& context){
+uint32_t system_clock(BotBaseControllerContext& context){
     pabb_MsgAckRequestI32 response;
     context.issue_request_and_wait(
         DeviceRequest_system_clock()
     ).convert<PABB_MSG_ACK_REQUEST_I32>(context.controller().logger(), response);
     return response.data;
 }
-void set_leds(SwitchControllerContext& context, bool on){
-    context.issue_request(DeviceRequest_set_leds(on));
+void set_leds(BotBaseControllerContext& context, bool on){
+    context.issue_request_and_wait(DeviceRequest_set_leds(on));
 }
 
 

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_Device.h

@@ -7,14 +7,14 @@
 #ifndef PokemonAutomation_NintendoSwitch_Commands_Device_H
 #define PokemonAutomation_NintendoSwitch_Commands_Device_H
 
-#include "NintendoSwitch/Controllers/NintendoSwitch_Controller.h"
+#include "ClientSource/Connection/BotBase.h"
 
 namespace PokemonAutomation{
 namespace NintendoSwitch{
 
 
-uint32_t system_clock   (SwitchControllerContext& context);
-void set_leds           (SwitchControllerContext& context, bool on);
+uint32_t system_clock   (BotBaseControllerContext& context);
+void set_leds           (BotBaseControllerContext& context, bool on);
 
 
 

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.cpp

@@ -95,6 +95,7 @@ void pbf_mash_button(SwitchControllerContext& context, Button button, uint16_t t
 #endif
 }
 
+#if 0
 void start_program_flash(SwitchControllerContext& context, uint16_t ticks){
     for (uint16_t c = 0; c < ticks; c += 50){
         set_leds(context, true);
@@ -103,6 +104,7 @@ void start_program_flash(SwitchControllerContext& context, uint16_t ticks){
         pbf_wait(context, 25);
     }
 }
+#endif
 void grip_menu_connect_go_home(SwitchControllerContext& context){
     pbf_press_button(context, BUTTON_L | BUTTON_R, 10, 40);
     pbf_press_button(context, BUTTON_A, 10, 140);
@@ -131,6 +133,8 @@ void pbf_controller_state(
     uint8_t right_x, uint8_t right_y,
     uint16_t ticks
 ){
+    context->send_controller_state(context, button, position, left_x, left_y, right_x, right_y, ticks);
+#if 0
     // divide the controller state into smaller chunks of 255 ticks
     while (ticks > 0){
         uint16_t curr_ticks = std::min(ticks, (uint16_t)255);
@@ -139,6 +143,7 @@ void pbf_controller_state(
         );
         ticks -= curr_ticks;
     } // end while loop, and function 
+#endif
 }
 
 static std::string button_to_string(Button button){

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.h

@@ -57,7 +57,7 @@ void pbf_move_right_joystick    (SwitchControllerContext& context, uint8_t x, ui
 //  The buttons also include clicking joysticks: BUTTON_LCLICK, BUTTON_RCLICK.
 void pbf_mash_button            (SwitchControllerContext& context, Button button, uint16_t ticks);
 
-void start_program_flash        (SwitchControllerContext& context, uint16_t ticks);
+//void start_program_flash        (SwitchControllerContext& context, uint16_t ticks);
 void grip_menu_connect_go_home  (SwitchControllerContext& context);