update experimental note for usage of O3D O3X device

ifm · Aug 2, 2023 · a664cf0 · a664cf0
1 parent dbe40d2
commit a664cf0
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 3 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -6,15 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+**NOTE** : O3D and O3X support is currently experimental- Use at your own risk!.
+
 ### Added
+- Add support for O3D3xx and O3X devices
 - Extend Ports() to return app port
 - Extend Port() to return information of given app port
 
 ### Changed
 - Updated Cxxopts library to version 3.1.1 and used through FetchContent
 
-### Added
-- Add support for O3D3xx and O3X devices
+
 
 ## 1.3.3 - 2023-06-22
 

diff --git a/README.md b/README.md
@@ -19,13 +19,15 @@ Comprehensive documentation is available on [ifm3d.com](https://ifm3d.com/).
 ⚠️ Note that the `main` branch is generally in a work in progress state and you probably want to use a
 tagged [release version](https://github.com/ifm/ifm3d/releases) for production.
 
+⚠️ Note that O3D and O3X support is currently experimental- Use at your own risk!.
+
 ### Current Revision
 
 The table below show the compatibility between the current ifm3d version and the firmware versions for the O3X, O3D and O3R devices. Other combinations than the ones listed below might work but have not been thoroughly tested.
 
 | ifm3d version | Supported O3D Firmware Version | Supported O3X Firmware Version | Supported O3R Firmware Version | Supported Ubuntu Linux Version | Notes | 
 | ------------- | ------------------------------ | ------------------------------ | -------------------- | ------------------------------ | ----- |
-| 1.2.6 | Not supported, please use ifm3d 0.20.x | Not tested, please use ifm3d 0.20.x | 1.0.14 | 20.04, 22.04 | See the changelog and the migrating guide. |
+| 1.3.4 | 1.30.5309 | 1.1.190 | 1.0.14 | 20.04, 22.04 | See the changelog and the migrating guide. |
 
 > Note that a full compatibility matrix is available [here](ifm3d/doc/sphinx/content/swcompat:ifm3d%20Software%20Compatibility%20Matrix) for older versions.
 ## Organization of the Software

diff --git a/modules/device/include/ifm3d/device/o3d.h b/modules/device/include/ifm3d/device/o3d.h
@@ -12,6 +12,8 @@ namespace ifm3d
 {
   /**
    * Device specialization for O3D
+   *
+   * Note that O3D support is currently experimental- Use at your own risk!.
    */
   class IFM3D_DEVICE_EXPORT O3D : public LegacyDevice
   {

diff --git a/modules/device/include/ifm3d/device/o3x.h b/modules/device/include/ifm3d/device/o3x.h
@@ -12,6 +12,8 @@ namespace ifm3d
 {
   /**
    * Device specialization for O3X
+   *
+   * Note that O3X support is currently experimental- Use at your own risk!.
    */
   class IFM3D_DEVICE_EXPORT O3X : public LegacyDevice
   {

diff --git a/modules/pybind11/src/bindings/o3d.h b/modules/pybind11/src/bindings/o3d.h
@@ -20,6 +20,8 @@ bind_o3d(pybind11::module_& m)
     m, "O3D",
     R"(
       Class for managing an instance of an O3D Camera
+
+      Note that O3D support is currently experimental- Use at your own risk!.
     )");
 
   o3d.def(

diff --git a/modules/pybind11/src/bindings/o3x.h b/modules/pybind11/src/bindings/o3x.h
@@ -19,6 +19,8 @@ bind_o3x(pybind11::module_& m)
     m, "O3X",
     R"(
       Class for managing an instance of an O3X Camera
+
+      Note that O3X support is currently experimental- Use at your own risk!.
     )");
 
   o3x.def(
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,8 @@ namespace ifm3d @@
     {
       /**
        * Device specialization for O3D
+       *
+       * Note that O3D support is currently experimental- Use at your own risk!.
        */
       class IFM3D_DEVICE_EXPORT O3D : public LegacyDevice
       {
@@ Expand Down @@