Refactor common nocli parts (#154)

Author: abeltrano

linux/tools/nocli/Main.cxx

@@ -11,7 +11,8 @@ int
 main(int argc, char* argv[])
 {
     auto cliData = std::make_shared<nearobject::cli::NearObjectCliDataLinux>();
-    nearobject::cli::NearObjectCli cli{ cliData };
+    auto cliHandler = std::make_shared<nearobject::cli::NearObjectCliHandler>();
+    nearobject::cli::NearObjectCli cli{ cliData, cliHandler };
 
     // Parse the arguments.
     int result = cli.Parse(argc, argv);

tools/cli/CMakeLists.txt

@@ -7,10 +7,11 @@ set(NO_CLI_DIR_PUBLIC_INCLUDE_PREFIX ${NO_CLI_DIR_PUBLIC_INCLUDE}/nearobject/cli
 target_sources(nocli-core
     PRIVATE
         ${CMAKE_CURRENT_LIST_DIR}/NearObjectCli.cxx
-        ${CMAKE_CURRENT_LIST_DIR}/NearObjectCliData.cxx
+        ${CMAKE_CURRENT_LIST_DIR}/NearObjectCliHandler.cxx
         ${CMAKE_CURRENT_LIST_DIR}/NearObjectCliUwbSessionEventCallbacks.cxx
     PUBLIC
         ${NO_CLI_DIR_PUBLIC_INCLUDE_PREFIX}/NearObjectCli.hxx
+        ${NO_CLI_DIR_PUBLIC_INCLUDE_PREFIX}/NearObjectCliHandler.hxx
         ${NO_CLI_DIR_PUBLIC_INCLUDE_PREFIX}/NearObjectCliData.hxx
         ${NO_CLI_DIR_PUBLIC_INCLUDE_PREFIX}/NearObjectCliUwbSessionEventCallbacks.hxx
 )

tools/cli/Main.cxx

@@ -0,0 +1,30 @@
+
+#include <nearobject/cli/NearObjectCliHandler.hxx>
+#include <nearobject/cli/NearObjectCliUwbSessionEventCallbacks.hxx>
+#include <uwb/UwbDevice.hxx>
+#include <uwb/UwbSession.hxx>
+
+using namespace nearobject::cli;
+
+std::shared_ptr<uwb::UwbDevice>
+NearObjectCliHandler::ResolveUwbDevice(const nearobject::cli::NearObjectCliData& /*cliData */) noexcept
+{
+    // Default implementation does not know how to resolve a device. OS-specific
+    // implementations are expected to sub-class and override this function.
+    return nullptr;
+}
+
+void
+NearObjectCliHandler::HandleStartRanging(std::shared_ptr<uwb::UwbDevice> uwbDevice, uwb::protocol::fira::UwbSessionData& sessionData) noexcept
+{
+    auto callbacks = std::make_shared<nearobject::cli::NearObjectCliUwbSessionEventCallbacks>();
+    auto session = uwbDevice->CreateSession(callbacks);
+    session->Configure(sessionData);
+    session->StartRanging();
+}
+
+void
+NearObjectCliHandler::HandleStopRanging() noexcept
+{
+    // TODO
+}

tools/cli/NearObjectCli.cxx

@@ -6,31 +6,31 @@
 using namespace nearobject::cli;
 
 void
-NearObjectCliUwbSessionEventCallbacks::OnSessionEnded(::uwb::UwbSession * /* session */, ::uwb::UwbSessionEndReason /* reason */)
+NearObjectCliUwbSessionEventCallbacks::OnSessionEnded(::uwb::UwbSession* /* session */, ::uwb::UwbSessionEndReason /* reason */)
 {
     std::cout << "Session Ended" << std::endl;
 }
 
 void
-NearObjectCliUwbSessionEventCallbacks::OnRangingStarted(::uwb::UwbSession * /* session */)
+NearObjectCliUwbSessionEventCallbacks::OnRangingStarted(::uwb::UwbSession* /* session */)
 {
     std::cout << "Ranging Started" << std::endl;
 }
 
 void
-NearObjectCliUwbSessionEventCallbacks::OnRangingStopped(::uwb::UwbSession * /* session */)
+NearObjectCliUwbSessionEventCallbacks::OnRangingStopped(::uwb::UwbSession* /* session */)
 {
     std::cout << "Ranging Stopped" << std::endl;
 }
 
 void
-NearObjectCliUwbSessionEventCallbacks::OnPeerPropertiesChanged(::uwb::UwbSession * /* session */, const std::vector<::uwb::UwbPeer> /* peersChanged */)
+NearObjectCliUwbSessionEventCallbacks::OnPeerPropertiesChanged(::uwb::UwbSession* /* session */, const std::vector<::uwb::UwbPeer> /* peersChanged */)
 {
     std::cout << "Peer Properties Changed" << std::endl;
 }
 
 void
-NearObjectCliUwbSessionEventCallbacks::OnSessionMembershipChanged(::uwb::UwbSession * /* session */, const std::vector<::uwb::UwbPeer> /* peersAdded */, const std::vector<::uwb::UwbPeer> /* peersRemoved */)
+NearObjectCliUwbSessionEventCallbacks::OnSessionMembershipChanged(::uwb::UwbSession* /* session */, const std::vector<::uwb::UwbPeer> /* peersAdded */, const std::vector<::uwb::UwbPeer> /* peersRemoved */)
 {
     std::cout << "Session Membership Changed" << std::endl;
 }

tools/cli/NearObjectCliData.cxx

@@ -2,16 +2,16 @@
 #ifndef NEAR_OBJECT_CLI_HXX
 #define NEAR_OBJECT_CLI_HXX
 
+#include <functional>
 #include <memory>
 
 #include <CLI/CLI.hpp>
-
-#include "NearObjectCliData.hxx"
+#include <nearobject/cli/NearObjectCliHandler.hxx>
+#include <nearobject/cli/NearObjectCliData.hxx>
+#include <uwb/UwbDevice.hxx>
 
 namespace nearobject::cli
 {
-struct NearObjectCliData;
-
 /**
  * @brief Near object command-line (nocli) top-level object.
  *
@@ -25,8 +25,9 @@ public:
      * @brief Construct a new NearObjectCli object.
      *
      * @param cliData An instance to store the parsed data.
+     * @param cliHandler An instance to handle parsed command requests.
      */
-    explicit NearObjectCli(std::shared_ptr<NearObjectCliData> cliData);
+    NearObjectCli(std::shared_ptr<NearObjectCliData> cliData, std::shared_ptr<NearObjectCliHandler> cliHandler);
 
     /**
      * @brief Get a reference to the parser. The parser will be configured with
@@ -89,6 +90,21 @@ public:
     GetRangeStopApp() noexcept;
 
 private:
+    /**
+     * @brief Obtain a reference to the resolved uwb device.
+     *
+     * This is only valid if the selected command requires a uwb device. The
+     * device is resolved using the names in the following order:
+     *
+     *  1. Device name as selected from a device probe request via command line.
+     *  2. Device name as specified on the command line.
+     *  3. Default device name (first device found).
+     *
+     * @return std::shared_ptr<uwb::UwbDevice> 
+     */
+    std::shared_ptr<uwb::UwbDevice>
+    GetUwbDevice() noexcept;
+
     /**
      * @brief Create an initialize the command line parser. This will create a
      * parser and configure it with all common options and flags.
@@ -98,11 +114,51 @@ private:
     std::unique_ptr<CLI::App>
     CreateParser() noexcept;
 
+    /**
+     * @brief Add the 'uwb' sub-command.
+     *
+     * @param parent The parent app to add the command to.
+     * @return CLI::App*
+     */
+    CLI::App*
+    AddSubcommandUwb(CLI::App* parent);
+
+    /**
+     * @brief Add the 'uwb range' sub-command.
+     *
+     * @param parent The parent app to add the command to.
+     * @return CLI::App*
+     */
+    CLI::App*
+    AddSubcommandUwbRange(CLI::App* parent);
+
+    /**
+     * @brief Add the 'uwb range start' sub-command.
+     *
+     * @param parent
+     * @return CLI::App*
+     */
+    CLI::App*
+    AddSubcommandUwbRangeStart(CLI::App* parent);
+
+    /**
+     * @brief Add the 'uwb range stop' sub-command.
+     *
+     * @param parent The parent app to add the command to.
+     * @return CLI::App*
+     */
+    CLI::App*
+    AddSubcommandUwbRangeStop(CLI::App* parent);
+
 private:
-    std::unique_ptr<CLI::App> m_cliApp;
     std::shared_ptr<NearObjectCliData> m_cliData;
+    std::shared_ptr<NearObjectCliHandler> m_cliHandler;
+
+    // Resolved device instance, if applicable to the selected command.
+    std::shared_ptr<uwb::UwbDevice> m_uwbDevice;
 
-    // the following are helper references to the subcommands of m_cliApp, the memory is managed by CLI11
+    std::unique_ptr<CLI::App> m_cliApp;
+    // The following are helper references to the subcommands of m_cliApp, the memory is managed by CLI11.
     CLI::App* m_uwbApp;
     CLI::App* m_rangeApp;
     CLI::App* m_rangeStartApp;

tools/cli/NearObjectCliHandler.cxx

@@ -2,7 +2,9 @@
 #ifndef NEAR_OBJECT_CLI_DATA_HXX
 #define NEAR_OBJECT_CLI_DATA_HXX
 
-#include <map>
+#include <string>
+#include <unordered_map>
+
 #include <uwb/protocols/fira/UwbSessionData.hxx>
 
 namespace nearobject::cli
@@ -12,20 +14,7 @@ namespace nearobject::cli
  */
 struct NearObjectCliData
 {
-    std::unordered_map<std::string, uwb::protocol::fira::DeviceRole> DeviceRoleMap;
-    std::unordered_map<std::string, uwb::protocol::fira::RangingMethod> RangingMethodMap;
-    std::unordered_map<std::string, uwb::protocol::fira::MeasurementReportMode> MeasurementReportModeMap;
-    std::unordered_map<std::string, uwb::protocol::fira::RangingConfiguration> RangingConfigurationMap;
-    std::unordered_map<std::string, uwb::protocol::fira::StsConfiguration> StsConfigurationMap;
-    std::unordered_map<std::string, uwb::protocol::fira::MultiNodeMode> MultiNodeModeMap;
-    std::unordered_map<std::string, uwb::protocol::fira::RangingMode> RangingModeMap;
-    std::unordered_map<std::string, uwb::protocol::fira::SchedulingMode> SchedulingModeMap;
-    std::unordered_map<std::string, uwb::protocol::fira::Channel> ChannelMap;
-    std::unordered_map<std::string, uwb::protocol::fira::StsPacketConfiguration> StsPacketConfigurationMap;
-    std::unordered_map<std::string, uwb::protocol::fira::ConvolutionalCodeConstraintLength> ConvolutionalCodeConstraintLengthMap;
-    std::unordered_map<std::string, uwb::protocol::fira::PrfMode> PrfModeMap;
-    std::unordered_map<std::string, uwb::UwbMacAddressFcsType> UwbMacAddressFcsTypeMap;
-    std::unordered_map<std::string, uwb::protocol::fira::ResultReportConfiguration> ResultReportConfigurationMap;
+    virtual ~NearObjectCliData() = default;
 
     std::string MacVersionString;
     std::string PhyVersionString;

tools/cli/NearObjectCliUwbSessionEventCallbacks.cxx

@@ -0,0 +1,57 @@
+
+#ifndef NEAR_OBJECT_CLI_HANDLER_HXX
+#define NEAR_OBJECT_CLI_HANDLER_HXX
+
+#include <memory>
+
+#include <nearobject/cli/NearObjectCliData.hxx>
+#include <uwb/protocols/fira/UwbSessionData.hxx>
+#include <uwb/UwbDevice.hxx>
+
+namespace nearobject::cli
+{
+/**
+ * @brief Class which handles and executes resolved command-line requests. The
+ * command line driver will invoke the function associated with the command line
+ * request. Multiple distinct actions may be invoked simultaneously.
+ */
+struct NearObjectCliHandler
+{
+    NearObjectCliHandler() = default;
+
+    virtual ~NearObjectCliHandler() = default;
+
+    /**
+     * @brief Invoked by the command line driver when a UWB device is required
+     * for the selected nocli operation. This function must resolve and return
+     * an instance of the appropriate UWB device to use for the operation.
+     * 
+     * @param cliData The parsed command-line arguments.
+     * @return std::shared_ptr<uwb::UwbDevice> 
+     */
+    virtual std::shared_ptr<uwb::UwbDevice>
+    ResolveUwbDevice(const nearobject::cli::NearObjectCliData& cliData) noexcept;
+
+    /**
+     * @brief Invoked by command-line driver when the request is to start a
+     * ranging session.
+     * 
+     * @param uwbDevice The resolved uwb device to start the ranging session on.
+     * @param sessionData The data to configure the ranging session.
+     */
+    virtual void
+    HandleStartRanging(std::shared_ptr<uwb::UwbDevice> uwbDevice, uwb::protocol::fira::UwbSessionData& sessionData) noexcept;
+
+    /**
+     * @brief Invoked by the command-line driver when the request is to stop an ongoing ranging session. 
+     * 
+     * TODO: this will need to change to accept a session id. Or, prior state
+     * saved may allow this to remain argumentless.
+     */
+    virtual void
+    HandleStopRanging() noexcept;
+};
+
+} // namespace nearobject::cli
+
+#endif // NEAR_OBJECT_CLI_HANDLER_HXX