feat!: add ble state 'initiating' (#723)

* add ble state 'initiating' * process comment * process review comment * Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * process review comments --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
philips-software · Oct 24, 2024 · bcfe895 · bcfe895
1 parent e53ecba
commit bcfe895
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 25 deletions.
diff --git a/services/ble/Gap.cpp b/services/ble/Gap.cpp
@@ -148,9 +148,14 @@ namespace services
             });
     }
 
-    void GapCentralDecorator::Connect(hal::MacAddress macAddress, GapDeviceAddressType addressType)
+    void GapCentralDecorator::Connect(hal::MacAddress macAddress, GapDeviceAddressType addressType, infra::Duration initiatingTimeout)
     {
-        GapCentralObserver::Subject().Connect(macAddress, addressType);
+        GapCentralObserver::Subject().Connect(macAddress, addressType, initiatingTimeout);
+    }
+
+    void GapCentralDecorator::CancelConnect()
+    {
+        GapCentralObserver::Subject().CancelConnect();
     }
 
     void GapCentralDecorator::Disconnect()
@@ -259,6 +264,8 @@ namespace infra
             stream << "Scanning";
         else if (state == services::GapState::advertising)
             stream << "Advertising";
+        else if (state == services::GapState::initiating)
+            stream << "Initiating";
         else
             stream << "Connected";
 

diff --git a/services/ble/Gap.hpp b/services/ble/Gap.hpp
@@ -2,6 +2,7 @@
 #define SERVICES_GAP_HPP
 
 #include "hal/interfaces/MacAddress.hpp"
+#include "infra/timer/Timer.hpp"
 #include "infra/util/EnumCast.hpp"
 #include "infra/util/Observer.hpp"
 
@@ -24,7 +25,8 @@ namespace services
         standby,
         scanning,
         advertising,
-        connected
+        connected,
+        initiating
     };
 
     enum class GapAdvertisingEventType : uint8_t
@@ -309,7 +311,8 @@ namespace services
         : public infra::Subject<GapCentralObserver>
     {
     public:
-        virtual void Connect(hal::MacAddress macAddress, GapDeviceAddressType addressType) = 0;
+        virtual void Connect(hal::MacAddress macAddress, GapDeviceAddressType addressType, infra::Duration initiatingTimeout) = 0;
+        virtual void CancelConnect() = 0;
         virtual void Disconnect() = 0;
         virtual void SetAddress(hal::MacAddress macAddress, GapDeviceAddressType addressType) = 0;
         virtual void StartDeviceDiscovery() = 0;
@@ -328,7 +331,8 @@ namespace services
         void StateChanged(GapState state) override;
 
         // Implementation of GapCentral
-        void Connect(hal::MacAddress macAddress, GapDeviceAddressType addressType) override;
+        void Connect(hal::MacAddress macAddress, GapDeviceAddressType addressType, infra::Duration initiatingTimeout) override;
+        void CancelConnect() override;
         void Disconnect() override;
         void SetAddress(hal::MacAddress macAddress, GapDeviceAddressType addressType) override;
         void StartDeviceDiscovery() override;

diff --git a/services/ble/Gap.proto b/services/ble/Gap.proto
@@ -19,6 +19,7 @@ message State
         scanning = 1;
         connected = 2;
         advertising = 3;
+        initiating = 4;
     }
     Event value = 1;
 }
@@ -107,6 +108,7 @@ message ConnectionParameters
 {
     Address address = 1;
     AddressType addressType = 2;
+    uint32 initiatingTimeoutInMs = 3;
 }
 
 message Passkey
@@ -183,14 +185,15 @@ service GapCentral
     rpc StartDeviceDiscovery(Nothing) returns (Nothing) { option (method_id) = 1; }
     rpc StopDeviceDiscovery(Nothing) returns (Nothing) { option (method_id) = 2; }
     rpc Connect(ConnectionParameters) returns (Nothing) { option (method_id) = 3; }
-    rpc Disconnect(Nothing) returns (Nothing) { option (method_id) = 4; }
-    rpc Pair(Nothing) returns (Nothing) { option (method_id) = 5; }
-    rpc SetSecurityMode(SecurityModeAndLevel) returns (Nothing) { option (method_id) = 6; }
-    rpc SetIoCapabilities(IoCapabilities) returns (Nothing) { option (method_id) = 7; }
-    rpc AuthenticateWithPasskey(UInt32Value) returns (Nothing) { option (method_id) = 8; }
-    rpc NumericComparisonConfirm(BoolValue) returns (Nothing) { option (method_id) = 9; }
-    rpc RemoveAllBonds(Nothing) returns (Nothing) { option (method_id) = 10; }
-    rpc SetDeviceDiscoveryFilter(DeviceDiscoveryFilter) returns (Nothing) { option (method_id) = 11; }
+    rpc CancelConnect(Nothing) returns (Nothing) { option (method_id) = 4; }
+    rpc Disconnect(Nothing) returns (Nothing) { option (method_id) = 5; }
+    rpc Pair(Nothing) returns (Nothing) { option (method_id) = 6; }
+    rpc SetSecurityMode(SecurityModeAndLevel) returns (Nothing) { option (method_id) = 7; }
+    rpc SetIoCapabilities(IoCapabilities) returns (Nothing) { option (method_id) = 8; }
+    rpc AuthenticateWithPasskey(UInt32Value) returns (Nothing) { option (method_id) = 9; }
+    rpc NumericComparisonConfirm(BoolValue) returns (Nothing) { option (method_id) = 10; }
+    rpc RemoveAllBonds(Nothing) returns (Nothing) { option (method_id) = 11; }
+    rpc SetDeviceDiscoveryFilter(DeviceDiscoveryFilter) returns (Nothing) { option (method_id) = 12; }
 }
 
 service GapPeripheralResponse

diff --git a/services/ble/test/TestGapCentral.cpp b/services/ble/test/TestGapCentral.cpp
@@ -3,9 +3,8 @@
 #include "infra/util/test_helper/MemoryRangeMatcher.hpp"
 #include "services/ble/test_doubles/GapCentralMock.hpp"
 #include "services/ble/test_doubles/GapCentralObserverMock.hpp"
-#include "services/ble/test_doubles/GapPeripheralMock.hpp"
-#include "services/ble/test_doubles/GapPeripheralObserverMock.hpp"
 #include "gmock/gmock.h"
+#include <chrono>
 
 namespace services
 {
@@ -34,12 +33,14 @@ namespace services
     TEST_F(GapCentralDecoratorTest, forward_all_state_changed_events_to_observers)
     {
         EXPECT_CALL(gapObserver, StateChanged(GapState::connected));
+        EXPECT_CALL(gapObserver, StateChanged(GapState::initiating));
         EXPECT_CALL(gapObserver, StateChanged(GapState::scanning));
         EXPECT_CALL(gapObserver, StateChanged(GapState::standby));
 
         gap.NotifyObservers([](GapCentralObserver& obs)
             {
                 obs.StateChanged(GapState::connected);
+                obs.StateChanged(GapState::initiating);
                 obs.StateChanged(GapState::scanning);
                 obs.StateChanged(GapState::standby);
             });
@@ -61,8 +62,11 @@ namespace services
     {
         hal::MacAddress macAddress{ 0, 1, 2, 3, 4, 5 };
 
-        EXPECT_CALL(gap, Connect(MacAddressContentsEqual(macAddress), services::GapDeviceAddressType::publicAddress));
-        decorator.Connect(macAddress, services::GapDeviceAddressType::publicAddress);
+        EXPECT_CALL(gap, Connect(MacAddressContentsEqual(macAddress), services::GapDeviceAddressType::publicAddress, infra::Duration{ 0 }));
+        decorator.Connect(macAddress, services::GapDeviceAddressType::publicAddress, std::chrono::seconds(0));
+
+        EXPECT_CALL(gap, CancelConnect());
+        decorator.CancelConnect();
 
         EXPECT_CALL(gap, Disconnect());
         decorator.Disconnect();
@@ -176,13 +180,8 @@ namespace services
     {
         infra::StringOutputStream::WithStorage<128> stream;
 
-        services::GapState stateStandby = services::GapState::standby;
-        services::GapState stateScanning = services::GapState::scanning;
-        services::GapState stateAdvertising = services::GapState::advertising;
-        services::GapState stateConnected = services::GapState::connected;
-
-        stream << stateStandby << " " << stateScanning << " " << stateAdvertising << " " << stateConnected;
+        stream << services::GapState::standby << " " << services::GapState::scanning << " " << services::GapState::advertising << " " << services::GapState::connected << " " << services::GapState::initiating;
 
-        EXPECT_EQ("Standby Scanning Advertising Connected", stream.Storage());
+        EXPECT_EQ("Standby Scanning Advertising Connected Initiating", stream.Storage());
     }
 }
diff --git a/services/ble/test_doubles/GapCentralMock.hpp b/services/ble/test_doubles/GapCentralMock.hpp
@@ -10,7 +10,8 @@ namespace services
         : public GapCentral
     {
     public:
-        MOCK_METHOD(void, Connect, (hal::MacAddress macAddress, GapDeviceAddressType addressType));
+        MOCK_METHOD(void, Connect, (hal::MacAddress macAddress, GapDeviceAddressType addressType, infra::Duration initiatingTimeout));
+        MOCK_METHOD(void, CancelConnect, ());
         MOCK_METHOD(void, Disconnect, ());
         MOCK_METHOD(void, SetAddress, (hal::MacAddress macAddress, GapDeviceAddressType addressType));
         MOCK_METHOD(void, StartDeviceDiscovery, ());