sampleReadMe1-2

orbbec · Aug 15, 2024 · f8ab32e · f8ab32e
1 parent f846c43
commit f8ab32e
Show file tree

Hide file tree

Showing 21 changed files with 361 additions and 319 deletions.
diff --git a/docs/resource/color.jpg b/docs/resource/color.jpg
diff --git a/docs/resource/control1.png b/docs/resource/control1.png
diff --git a/docs/resource/control2.png b/docs/resource/control2.png
diff --git a/docs/resource/depth.png b/docs/resource/depth.png
diff --git a/docs/resource/hotplugin.png b/docs/resource/hotplugin.png
diff --git a/docs/resource/imu.png b/docs/resource/imu.png
diff --git a/docs/resource/infrared.png b/docs/resource/infrared.png
diff --git a/docs/resource/multistream.png b/docs/resource/multistream.png
diff --git a/examples/0.basic.enumerate/README.md b/examples/0.basic.enumerate/README.md
@@ -1,4 +1,4 @@
-# C++ Sample 0.basic.enumerate
+# C++ Sample: 0.basic.enumerate
 
 ## Overview
 

diff --git a/examples/0.basic.quick_start/README.md b/examples/0.basic.quick_start/README.md
@@ -1,4 +1,4 @@
-# C++ Sample: 0.basic.enumerate
+# C++ Sample: 0.basic.quick_start
 
 ## Overview
 

diff --git a/examples/1.stream.color/README.md b/examples/1.stream.color/README.md
@@ -1,4 +1,4 @@
-# C++ Sample 1.stream.color
+# C++ Sample: 1.stream.color
 
 ## Overview
 
@@ -53,4 +53,4 @@ Press the Esc key in the window to exit the program.
 
 ### Result
 
-![image](/docs/resource/enumerate.jpg)
+![result](/docs/resource/color.jpg)
diff --git a/examples/1.stream.depth/README.md b/examples/1.stream.depth/README.md
@@ -37,4 +37,4 @@ Press the Esc key in the window to exit the program.
 
 ### Result
 
-![image](Image/DepthViewer.png)
+![image](/docs/resource/depth.png)
diff --git a/examples/1.stream.imu/README.md b/examples/1.stream.imu/README.md
@@ -1,4 +1,4 @@
-# C++ Sample: 1.stream.depth
+# C++ Sample: 1.stream.imu
 
 ## Overview
 
@@ -65,4 +65,4 @@ Press the Esc key in the window to exit the program.
 
 ### Result
 
-![image](Image/DepthViewer.png)
+![image](/docs/resource/imu.png)
diff --git a/examples/1.stream.infrared/README.md b/examples/1.stream.infrared/README.md
@@ -62,4 +62,4 @@ Press the Esc key in the window to exit the program.
 
 ### Result
 
-![image](Image/DepthViewer.png)
+![image](/docs/resource/infrared.png)
diff --git a/examples/1.stream.multi_streams/README.md b/examples/1.stream.multi_streams/README.md
@@ -1,4 +1,4 @@
-# C++ Sample: 1.stream.infrared
+# C++ Sample: 1.stream.multi_streams
 
 ## Overview
 
@@ -75,4 +75,4 @@ Press the Esc key in the window to exit the program.
 
 ### Result
 
-![image](Image/DepthViewer.png)
+![image](/docs/resource/multistream.png)
diff --git a/examples/2.device.control/Image/SensorControl.png b/examples/2.device.control/Image/SensorControl.png
diff --git a/examples/2.device.control/README.md b/examples/2.device.control/README.md
@@ -1,58 +1,227 @@
-# C++ Sample Device Control
+# C++ Sample：2.device.control
 
+## Overview
 
-Function description: Demonstrate Device control operations
+The SDK can be used to modify camera-related parameters, including laser switch, laser level intensity, white balance switch, etc.
 
-This example is based on the C++ low level API for demonstration
+### Knowledge
 
-## 1. Get device list
-```cpp
-    // Create a Context.
-    ob::Context context;
+In order to protect the user, we can set the laser level. We have also made protection in the firmware. When people approach, our laser level intensity will automatically decrease.
 
-    // Query the list of connected devices
-    auto deviceList = context.queryDeviceList();
-```
+## code overview
 
-Get device and output device information
-```cpp
-    if(deviceList->getCount() > 0) {
-        if(deviceList->getCount() <= 1) {
-            // If a single device is plugged in, the first one is selected by default
-            device = deviceList->getDevice(0);
+1. Get camera related information and output
+
+    ```cpp
+        // select a device to operate
+        std::shared_ptr<ob::Device> device = nullptr;
+        if(deviceList->getCount() > 0) {
+            if(deviceList->getCount() <= 1) {
+                // If a single device is plugged in, the first one is selected by default
+                device = deviceList->getDevice(0);
+            }
+            else {
+                device = selectDevice(deviceList);
+            }
+            auto deviceInfo = device->getDeviceInfo();
+            std::cout << "\n------------------------------------------------------------------------\n";
+            std::cout << "Current Device: "
+                    << " name: " << deviceInfo->getName() << ", vid: 0x" << std::hex << deviceInfo->getVid() << ", pid: 0x" << std::setw(4)
+                    << std::setfill('0') << deviceInfo->getPid() << ", uid: 0x" << deviceInfo->getUid() << std::dec << std::endl;
+        }
+        else {
+            std::cout << "Device Not Found" << std::endl;
+            isSelectDevice = false;
+            break;
+        }
+    ```
+
+2. Get the relevant parameters stored in the container and reorder them by id
+
+    ```cpp
+        // Get property list
+        std::vector<OBPropertyItem> getPropertyList(std::shared_ptr<ob::Device> device) {
+        std::vector<OBPropertyItem> propertyVec;
+        propertyVec.clear();
+        uint32_t size = device->getSupportedPropertyCount();
+        for(uint32_t i = 0; i < size; i++) {
+            OBPropertyItem property_item = device->getSupportedProperty(i);
+            if(isPrimaryTypeProperty(property_item) && property_item.permission != OB_PERMISSION_DENY) {
+                propertyVec.push_back(property_item);
+            }
+        }
+        return propertyVec;
+        }
+    ```
+
+    ```cpp
+        std::vector<OBPropertyItem> propertyList = getPropertyList(device);
+        std::sort(propertyList.begin(), propertyList.end(), [](const OBPropertyItem &a, const OBPropertyItem &b) { return a.id < b.id; });
+    ```
+
+3. Print interactive information in the terminal. You can use get and set to set and obtain camera related parameters.
+
+    ```cpp
+        std::string choice;
+        std::getline(std::cin, choice);
+
+        if(choice != "?") {
+            std::istringstream       ss(choice);
+            std::string              tmp;
+            std::vector<std::string> controlVec;
+            while(ss >> tmp) {
+                controlVec.push_back(tmp);
+            }
+
+            if(controlVec.size() <= 0)
+                continue;
+
+            // exit the program
+            if(controlVec.at(0) == "exit") {
+                isSelectProperty = false;
+                isSelectDevice   = false;
+                break;
+            }
+
+            // Check if it matches the input format
+            if(controlVec.size() <= 1 || (controlVec.at(1) != "get" && controlVec.at(1) != "set") || controlVec.size() > 3
+                || (controlVec.at(1) == "set" && controlVec.size() < 3)) {
+                std::cout << "Property control usage: [property index] [set] [property value] or [property index] [get]" << std::endl;
+                continue;
+            }
+            size_t size     = propertyList.size();
+            size_t selectId = std::atoi(controlVec.at(0).c_str());
+            if(selectId >= size) {
+                std::cout << "Your selection is out of range, please reselect: " << std::endl;
+                continue;
+            }
+
+            bool isGetValue   = controlVec.at(1) == "get" ? true : false;
+            auto propertyItem = propertyList.at(selectId);
+
+            if(isGetValue) {
+                // get property value
+                getPropertyValue(device, propertyItem);
+            }
+            else {
+                // set property value
+                setPropertyValue(device, propertyItem, controlVec.at(2));
+            }
         }
         else {
-            device = selectDevice(deviceList);
-        }
-        auto deviceInfo = device->getDeviceInfo();
-        std::cout << "\n------------------------------------------------------------------------\n";
-        std::cout << "Current Device: "
-                    << " name: " << deviceInfo->name() << ", vid: 0x" << std::hex << deviceInfo->vid() << ", pid: 0x" << std::setw(4) << std::setfill('0')
-                    << deviceInfo->pid() << ", uid: 0x" << deviceInfo->uid() << std::dec << std::endl;
-    }
-```
-
-## 2. Follow the prompts to get all properties
-```cpp
-    std::cout << "Input \"?\" to get all properties." << std::endl;
-    std::getline(std::cin, choice);
-```
-
-## 3. Input parameter prompt
-```cpp
-    std::cout << "Property control usage: [property index] [set] [property value] or [property index] [get]" << std::endl;
-```
-
-## 4. Get property
-```cpp
-    getPropertyValue(device, propertyItem);
-```
-
-## 5. Set property
-```cpp
-    setPropertyValue(device, propertyItem, controlVec.at(2));
-```
-
-## 6. expected Output
-
-![image](Image/SensorControl.png)
+            printfPropertyList(device, propertyList);
+            std::cout << "Please select property.(Property control usage: [property number] [set/get] [property value])" << std::endl;
+        }
+    ```
+
+4. Use the get command to obtain camera-related property values
+
+    ```cpp
+       // get property value
+        void getPropertyValue(std::shared_ptr<ob::Device> device, OBPropertyItem propertyItem) {
+            try {
+                bool  bool_ret  = false;
+                int   int_ret   = 0;
+                float float_ret = 0.0f;
+
+                switch(propertyItem.type) {
+                case OB_BOOL_PROPERTY:
+                    try {
+                        bool_ret = device->getBoolProperty(propertyItem.id);
+                    }
+                    catch(...) {
+                        std::cout << "get bool property failed." << std::endl;
+                    }
+                    std::cout << "property name:" << propertyItem.name << ",get bool value:" << bool_ret << std::endl;
+                    break;
+                case OB_INT_PROPERTY:
+                    try {
+                        int_ret = device->getIntProperty(propertyItem.id);
+                    }
+                    catch(...) {
+                        std::cout << "get int property failed." << std::endl;
+                    }
+                    std::cout << "property name:" << propertyItem.name << ",get int value:" << int_ret << std::endl;
+                    break;
+                case OB_FLOAT_PROPERTY:
+                    try {
+                        float_ret = device->getFloatProperty(propertyItem.id);
+                    }
+                    catch(...) {
+                        std::cout << "get float property failed." << std::endl;
+                    }
+                    std::cout << "property name:" << propertyItem.name << ",get float value:" << float_ret << std::endl;
+                    break;
+                default:
+                    break;
+                }
+            }
+            catch(...) {
+                std::cout << "get property failed: " << propertyItem.name << std::endl;
+            }
+        }
+    ```
+
+5. Use the set command to set camera-related property values
+
+    ```cpp
+        // set properties
+        void setPropertyValue(std::shared_ptr<ob::Device> device, OBPropertyItem propertyItem, std::string strValue) {
+            try {
+                int   int_value   = 0;
+                float float_value = 0.0f;
+                int   bool_value  = 0;
+                switch(propertyItem.type) {
+                case OB_BOOL_PROPERTY:
+                    bool_value = std::atoi(strValue.c_str());
+                    try {
+                        device->setBoolProperty(propertyItem.id, bool_value);
+                    }
+                    catch(...) {
+                        std::cout << "set bool property fail." << std::endl;
+                    }
+                    std::cout << "property name:" << propertyItem.name << ",set bool value:" << bool_value << std::endl;
+                    break;
+                case OB_INT_PROPERTY:
+                    int_value = std::atoi(strValue.c_str());
+                    try {
+                        device->setIntProperty(propertyItem.id, int_value);
+                    }
+                    catch(...) {
+                        std::cout << "set int property fail." << std::endl;
+                    }
+                    std::cout << "property name:" << propertyItem.name << ",set int value:" << int_value << std::endl;
+                    break;
+                case OB_FLOAT_PROPERTY:
+                    float_value = static_cast<float>(std::atof(strValue.c_str())) ;
+                    try {
+                        device->setFloatProperty(propertyItem.id, float_value);
+                    }
+                    catch(...) {
+                        std::cout << "set float property fail." << std::endl;
+                    }
+                    std::cout << "property name:" << propertyItem.name << ",set float value:" << float_value << std::endl;
+                    break;
+                default:
+                    break;
+                }
+            }
+            catch(...) {
+                std::cout << "set property failed: " << propertyItem.name << std::endl;
+            }
+        }
+    ```
+
+## Run Sample
+
+Select the camera you want to operate. If it is a single device, skip the selection.
+You can enter the command ? to get all the properties of the camera, including setting the maximum and minimum values, etc.
+You can enter set to set command to setto set parameters, for example 6 set 0 (note the space)
+You can enter the get command to set parameters, for example, 6 get (note the space)
+Press the Esc key in the window to exit the program.
+
+### Result
+
+![image](/docs/resource/control1.png)
+
+![image](/docs/resource/control2.png)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ Press the Esc key in the window to exit the program.

		### Result

		![image](Image/DepthViewer.png)
		![image](/docs/resource/depth.png)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -62,4 +62,4 @@ Press the Esc key in the window to exit the program.

		### Result

		![image](Image/DepthViewer.png)
		![image](/docs/resource/infrared.png)