Documentation

Signed-off-by: stas.bucik <[email protected]>

Author: sb-lxn

bindings/python/src/pipeline/CommonBindings.cpp

@@ -225,7 +225,7 @@ void CommonBindings::bind(pybind11::module& m, void* pCallstack) {
 
     // M8FsyncRole enum bindings
     m8FsyncRole.value("AUTO_DETECT", M8FsyncRole::AUTO_DETECT)
-        .value("MASTER_WITHOUT_OUTPUT", M8FsyncRole::MASTER_WITHOUT_OUTPUT)
+        .value("STANDALONE_NO_M8_FUNCTION", M8FsyncRole::STANDALONE_NO_M8_FUNCTION)
         .value("MASTER_WITH_OUTPUT", M8FsyncRole::MASTER_WITH_OUTPUT)
         .value("SLAVE", M8FsyncRole::SLAVE);
 

include/depthai/common/M8FsyncRoles.hpp

@@ -11,18 +11,29 @@ namespace dai {
  * It will choose between MASTER_WITH_OUTPUT and SLAVE.
  */
 enum class M8FsyncRole : int32_t {
+    // This role is only used in setM8FsyncRole() function.
+    // It signals to the device to automatically detect M8 Fsync configuration.
     AUTO_DETECT = -1,
-    MASTER_WITHOUT_OUTPUT,
+
+    // Standalone mode.
+    // STM generates Fsync signal, doesn't output it through M8 connector.
+    STANDALONE_NO_M8_FUNCTION,
+
+    // Fsync master.
+    // STM generates Fsync signal and outputs it through M8 connector.
     MASTER_WITH_OUTPUT,
+
+    // Fsync slave.
+    // Device must lock onto an external Fsync signal on the M8 connector.
     SLAVE,
 };
 
 inline std::string toString(M8FsyncRole role) {
     switch(role) {
         case M8FsyncRole::AUTO_DETECT:
             return "AUTO DETECT";
-        case M8FsyncRole::MASTER_WITHOUT_OUTPUT:
-            return "MASTER, NO OUTPUT";
+        case M8FsyncRole::STANDALONE_NO_M8_FUNCTION:
+            return "STANDALONE, NO M8 FUNCTION";
         case M8FsyncRole::MASTER_WITH_OUTPUT:
             return "MASTER, WITH OUTPUT";
         case M8FsyncRole::SLAVE:

src/device/DeviceBase.cpp

@@ -1708,6 +1708,7 @@ bool DeviceBase::startPipelineImpl(const Pipeline& pipeline) {
     bool success = false;
     std::string errorMsg;
 
+    // Initialize the device (M8 Fsync slaves need to lock onto the signal first)    
     std::tie(success, errorMsg) = pimpl->rpcCall(std::chrono::seconds(60), "waitForDeviceReady").as<std::tuple<bool, std::string>>();
 
     if (!success) {