[bot] update built doc

ROS/ifm3d-ros/CHANGELOG.html

@@ -88,24 +88,76 @@
   <div class="section" id="changelog-for-package-ifm3d-ros">
 <h1>Changelog for package ifm3d-ros<a class="headerlink" href="#changelog-for-package-ifm3d-ros" title="Permalink to this headline"></a></h1>
 <div class="section" id="id1">
-<h2>1.0<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
+<h2>1.1<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
 <div class="section" id="id2">
-<h3>1.0.2<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
+<h3>1.1.2<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p>Fix the IP parameter that was not being used</p></li>
+<li><p>Update Dockerfiles for building the ROS node inside a Docker software container environment: removed glog build and runtime libs</p></li>
 </ul>
 </div>
 <div class="section" id="id3">
-<h3>1.0.1<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
+<h3>1.1.1<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
+<ul>
+<li><p>Update camera nodelet for ifm3d &gt;= v1.2.3
+* Switch from looped image retrieval to callback based image retrieval
+* Updated schema mask handling: uint based schema mask replaced with default 2D and 3D bufferID based lists
+Between ifm3d API version 0.93 and 1.1 the internal handling of the amplitude and distance image and the point cloud has changed: The previously automatically applied masking based on the confidence image is no longer applied. As a result, more image pixels are displayed as valid pixels.
+If you want to apply a binary mapping to these images, use the confidence image as provided in the ROS node and apply the mask <cite>confidence&amp;1</cite> for backward compatibility.</p></li>
+<li><p>Nodelet interface changes:
+* additional parameters:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>xyz_image_stream: boolean value - Enable / disable publishing and streaming of point cloud topic / messages.</p></li>
+<li><p>confidence_image_stream: boolean value - Enable / disable publishing and streaming of confidence image topic / messages</p></li>
+<li><p>radial_distance_image_stream: boolean value - Enable / disable publishing and streaming of radial distance image topic / messages</p></li>
+<li><p>radial_distance_noise_stream: boolean value - Enable / disable publishing and streaming of radial distance noise image topic / messages</p></li>
+<li><p>amplitude_image_stream: boolean value - Enable / disable publishing and streaming of amplitude image topic / messages</p></li>
+<li><p>extrinsic_image_stream: boolean value - Enable / disable publishing and streaming of extrinsics topic / messages</p></li>
+<li><p>intrinsic_image_stream: boolean value - Enable / disable publishing and streaming of intrinsics topic / messages</p></li>
+<li><p>rgb_image_stream: boolean value - Enable / disable publishing and streaming of 2D RGB image topic / messages</p></li>
+</ul>
+</div></blockquote>
+<ul class="simple">
+<li><p>Updated the default launch files for 2D RGB / 3D TOF cameras accordingly</p></li>
+<li><p>Added support for JSON schema dump service</p></li>
+<li><p>ifm3d-ros logging:
+* Reduced level of logging messages
+* Changed default behavior of info log messages: NODELET_INFO_STREAM replaced by NODELET_INFO_ONCE</p></li>
+<li><p>Removed:
+* Compressed amplitude stream: only amplitude publisher is used
+* Unit vector publisher</p></li>
+</ul>
+</li>
+<li><p>Robustness improvements:
+* Only publish data to image streams if API frames include the corresponding image data</p></li>
+</ul>
+</div>
+<div class="section" id="id4">
+<h3>1.1.0<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
+<ul class="simple">
+<li><p>UNRELEASED</p></li>
+</ul>
+</div>
+</div>
+<div class="section" id="id5">
+<h2>1.0<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
+<div class="section" id="id6">
+<h3>1.0.2<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
+<ul class="simple">
+<li><p>Fix the IP parameter that was not being used</p></li>
+</ul>
+</div>
+<div class="section" id="id7">
+<h3>1.0.1<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Removed dependency to OpenCV and PCL.</p></li>
 <li><p>The RGB jpeg image is published in a compressed format.</p></li>
 <li><p>Removed the god_bad pixel publisher and the XYZ publisher (use <cite>cloud`</cite> instead).</p></li>
 <li><p>The <cite>/cloud</cite> topic is published as <cite>sensor_msgs::PointCloud2</cite> instead of <cite>pcl::PointCloud&lt;ifm3d::PointT&gt;</cite></p></li>
 </ul>
 </div>
-<div class="section" id="id4">
-<h3>1.0.0<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
+<div class="section" id="id8">
+<h3>1.0.0<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
 <p>Breaking changes:
 * Restructure the ifm3d-ros package into independent subpackages. Please check your path declarations again, especially for the launch files and messages and services.</p>
 <p>Changes between ifm3d_ros 0.6.x and 1.0.0:
@@ -124,27 +176,27 @@ <h3>1.0.0<a class="headerlink" href="#id4" title="Permalink to this headline">
 * This version of the ifm3d-ros package only works with the O3R camera platform.</p>
 </div>
 </div>
-<div class="section" id="id5">
-<h2>0.6<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
-<div class="section" id="id6">
-<h3>0.6.2<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
+<div class="section" id="id9">
+<h2>0.6<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h2>
+<div class="section" id="id10">
+<h3>0.6.2<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
 <p>Changes between ifm3d_ros 0.6.1 and 0.6.2</p>
 <ul class="simple">
 <li><p>Updated maintainer email address</p></li>
 <li><p>Added ifm3d-core dependency in preparation for submission to the ROS index</p></li>
 </ul>
 </div>
-<div class="section" id="id7">
-<h3>0.6.1<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
+<div class="section" id="id11">
+<h3>0.6.1<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Added support syncing the system and camera clocks at startup. Side-effect,
 is we can now stamp the images with the camera-side capture time and not the
 host-side reception time.</p></li>
 <li><p>Added the <cite>SyncClocks</cite> Service</p></li>
 </ul>
 </div>
-<div class="section" id="id8">
-<h3>0.6.0.<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
+<div class="section" id="id12">
+<h3>0.6.0.<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Added a image transport plugin _blacklist_ to the nodlet launch file. This
 prevents many of the errors seen in the terminal when running <cite>rosbag -a</cite> to
@@ -153,16 +205,16 @@ <h3>0.6.0.<a class="headerlink" href="#id8" title="Permalink to this headline">
 </ul>
 </div>
 </div>
-<div class="section" id="id9">
-<h2>0.5<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h2>
-<div class="section" id="id10">
-<h3>0.5.1<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
+<div class="section" id="id13">
+<h2>0.5<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h2>
+<div class="section" id="id14">
+<h3>0.5.1<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Added support for Ubuntu 18.04 and ROS Melodic</p></li>
 </ul>
 </div>
-<div class="section" id="id11">
-<h3>0.5.0<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
+<div class="section" id="id15">
+<h3>0.5.0<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Converted primary data publisher to a nodelet architecture</p></li>
 <li><p>Provide the <cite>dump</cite> and <cite>config</cite> scripts to call into the exposed ROS services
@@ -171,38 +223,38 @@ <h3>0.5.0<a class="headerlink" href="#id11" title="Permalink to this headline">
 </ul>
 </div>
 </div>
-<div class="section" id="id12">
-<h2>0.4<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h2>
-<div class="section" id="id13">
-<h3>0.4.2<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
+<div class="section" id="id16">
+<h2>0.4<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h2>
+<div class="section" id="id17">
+<h3>0.4.2<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Now requires ifm3d 0.9.0 and by association the more modernized tooling
 (C++14, cmake 3.5, dropped support for 14.04/Indigo, etc.)</p></li>
 </ul>
 </div>
-<div class="section" id="id14">
-<h3>0.4.1<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
+<div class="section" id="id18">
+<h3>0.4.1<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h3>
 <ul class="simple">
 <li><p>Now publishing extrinsics on a topic</p></li>
 </ul>
 </div>
 </div>
-<div class="section" id="id15">
-<h2>0.3<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h2>
+<div class="section" id="id19">
+<h2>0.3<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h2>
 <ul class="simple">
 <li><p>Added <cite>Dump</cite> Service</p></li>
 <li><p>Added <cite>Config</cite> Service</p></li>
 <li><p>Added <cite>Trigger</cite> Service</p></li>
 </ul>
 </div>
-<div class="section" id="id16">
-<h2>0.2<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h2>
+<div class="section" id="id20">
+<h2>0.2<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h2>
 <ul class="simple">
 <li><p>Updates to CMakeLists.txt to support Ubuntu 14.04 and ROS Indigo</p></li>
 </ul>
 </div>
-<div class="section" id="id17">
-<h2>0.1<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h2>
+<div class="section" id="id21">
+<h2>0.1<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h2>
 <p>This file has started tracking ifm3d_ros at 0.1.0</p>
 <ul class="simple">
 <li><p>Initial (alpha) release</p></li>

ROS/ifm3d-ros/README.html

@@ -62,12 +62,12 @@
 <li class="toctree-l2"><a class="reference external" href="https://api.ifm3d.com/stable/">ifm3d/ifm3dpy API</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="index.html">ROS: ifm3d-ros</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">ifm3d-ros overview</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#release-versions">Release versions</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#ifm3d-ros-for-the-o3r">ifm3d-ros for the O3R</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#software-compatibility-matrix">Software Compatibility Matrix</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#compatibility-matrix">Compatibility Matrix</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="#internal-ifm3d-ros-subpackage-version-structure">Internal ifm3d-ros subpackage version structure</a></li>
 </ul>
 </li>
+<li class="toctree-l4"><a class="reference internal" href="#changelogs">Changelogs</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#ifm3d-ros-for-the-o3r">ifm3d-ros for the O3R</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#organization-of-the-software">Organization of the software</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#building-and-installing-the-software">Building and installing the software</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="ifm3d_ros_driver/doc/noetic.html">Preparing your system</a></li>
@@ -122,35 +122,50 @@
 
   <div class="tex2jax_ignore mathjax_ignore section" id="ifm3d-ros">
 <h1>ifm3d-ros<a class="headerlink" href="#ifm3d-ros" title="Permalink to this headline"></a></h1>
-<div class="section" id="release-versions">
-<h2>Release versions<a class="headerlink" href="#release-versions" title="Permalink to this headline"></a></h2>
-<p>warning:: Note that the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch is generally in a work in progress, and you probably want to use a tagged <a class="reference external" href="https://github.com/ifm/ifm3d-ros/releases">release version</a> for production.</p>
+<p><em>This documentation is formatted to be read on www.ifm3d.com.</em></p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The ifm3d-ros package has had major changes recently. Please be aware that this might cause problems on your system for building pipelines based on our old build instructions.</p>
 </div>
-<div class="section" id="ifm3d-ros-for-the-o3r">
-<h2>ifm3d-ros for the O3R<a class="headerlink" href="#ifm3d-ros-for-the-o3r" title="Permalink to this headline"></a></h2>
-<p><strong>NOTE: The ifm3d-ros package has had major changes recently. Please be aware that this might cause problems on your system for building pipelines based on our old build instructions.</strong>
-We tried to ensure backward compatibility where ever possible. If you find any major breaks, please let us know.</p>
-<p>ifm3d-ros is a wrapper around <span class="xref myst">ifm3d</span> enabling the usage of the O3R camera platform (ifm ToF cameras) from within <a class="reference external" href="http://ros.org">ROS</a> software systems.
-<strong>Please make sure to use version 1.0.0 or above for O3R compatibility.</strong></p>
-<p><img alt="rviz1" src="../../_images/O3R_merged_point_cloud.png" /></p>
+<div class="section" id="compatibility-matrix">
+<h2>Compatibility Matrix<a class="headerlink" href="#compatibility-matrix" title="Permalink to this headline"></a></h2>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>Note that the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch is generally in a work in progress, and you probably want to use a tagged <a class="reference external" href="https://github.com/ifm/ifm3d-ros/releases">release version</a> for production.</p>
 </div>
-<div class="section" id="software-compatibility-matrix">
-<h2>Software Compatibility Matrix<a class="headerlink" href="#software-compatibility-matrix" title="Permalink to this headline"></a></h2>
 <table class="colwidths-auto docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p><strong>ifm3d-ros version</strong></p></th>
 <th class="head"><p><strong>ifm3d version</strong></p></th>
+<th class="head"><p><strong>embedded O3R FW version</strong></p></th>
 <th class="head"><p><strong>ROS distribution(s)</strong></p></th>
 </tr>
 </thead>
 <tbody>
-<tr class="row-even"><td><p>1.0.0</p></td>
-<td><p>0.91.0</p></td>
-<td><p>Noetic</p></td>
+<tr class="row-even"><td><p>1.1.2</p></td>
+<td><p>1.3.3</p></td>
+<td><p>1.0.14</p></td>
+<td><p>ROS Noetic</p></td>
+</tr>
+<tr class="row-odd"><td><p>1.1.1</p></td>
+<td><p>1.2.6</p></td>
+<td><p>1.0.14</p></td>
+<td><p>ROS Noetic</p></td>
+</tr>
+<tr class="row-even"><td><p>1.1.0 (unreleased)</p></td>
+<td><p>1.2.3</p></td>
+<td><p>1.0.x</p></td>
+<td><p>ROS Noetic</p></td>
 </tr>
 <tr class="row-odd"><td><p>1.0.1</p></td>
 <td><p>0.93.0</p></td>
-<td><p>Noetic</p></td>
+<td><p>0.14.23</p></td>
+<td><p>ROS Noetic</p></td>
+</tr>
+<tr class="row-even"><td><p>1.0.0</p></td>
+<td><p>0.91.0</p></td>
+<td><p>0.14.23</p></td>
+<td><p>ROS Noetic</p></td>
 </tr>
 </tbody>
 </table>
@@ -166,20 +181,50 @@ <h3>Internal ifm3d-ros subpackage version structure<a class="headerlink" href="#
 </tr>
 </thead>
 <tbody>
-<tr class="row-even"><td><p>1.0.0</p></td>
-<td><p>0.7.0</p></td>
-<td><p>0.1.0</p></td>
-<td><p>0.1.0</p></td>
+<tr class="row-even"><td><p>1.1.2</p></td>
+<td><p>1.1.1</p></td>
+<td><p>0.2.0</p></td>
+<td><p>0.2.0</p></td>
+</tr>
+<tr class="row-odd"><td><p>1.1.1</p></td>
+<td><p>1.1.1</p></td>
+<td><p>0.2.0</p></td>
+<td><p>0.2.0</p></td>
+</tr>
+<tr class="row-even"><td><p>1.1.0 (unreleased)</p></td>
+<td><p>1.1.0</p></td>
+<td><p>0.2.0</p></td>
+<td><p>0.2.0</p></td>
 </tr>
 <tr class="row-odd"><td><p>1.0.1</p></td>
 <td><p>1.0.1</p></td>
 <td><p>0.1.0</p></td>
 <td><p>0.1.0</p></td>
 </tr>
+<tr class="row-even"><td><p>1.0.0</p></td>
+<td><p>0.7.0</p></td>
+<td><p>0.1.0</p></td>
+<td><p>0.1.0</p></td>
+</tr>
 </tbody>
 </table>
 </div>
 </div>
+<div class="section" id="changelogs">
+<h2>Changelogs<a class="headerlink" href="#changelogs" title="Permalink to this headline"></a></h2>
+<ul class="simple">
+<li><p>ifm3d-ros: For changes between on the ifm3d-ros node source code, please see the respective information in the <a class="reference internal" href="CHANGELOG.html"><span class="doc std std-doc">CHANGELOG</span></a>.</p></li>
+<li><p>ifm3d: For changes between on the ifm3d API source code, please see the respective information in the <a class="reference external" href="https://github.com/ifm/ifm3d/blob/main/ChangeLog.md">ifm3d CHANGELOG</a>.</p></li>
+<li><p>O3R firmware: For changes between on the different FW versions, please see the respective information in the <a class="reference external" href="https://ifm3d.com/documentation/Firmware/index.html">FW release notes</a>.</p></li>
+</ul>
+</div>
+<div class="section" id="ifm3d-ros-for-the-o3r">
+<h2>ifm3d-ros for the O3R<a class="headerlink" href="#ifm3d-ros-for-the-o3r" title="Permalink to this headline"></a></h2>
+<p>ifm3d-ros is a wrapper around <span class="xref myst">ifm3d</span> enabling the usage of the O3R camera platform (ifm ToF cameras) from within <a class="reference external" href="http://ros.org">ROS</a> software systems.
+<strong>Please make sure to use version 1.0.0 or above for O3R compatibility.</strong></p>
+<p><img alt="rviz1" src="../../_images/O3R_merged_point_cloud.png" /></p>
+<p><strong>NOTE</strong> The confidence image handling inside the ifm3d API has changed which results in more valid pixels - for more information see the <a class="reference internal" href="Release_notes.html"><span class="doc std std-doc">Release Notes</span></a></p>
+</div>
 <div class="section" id="organization-of-the-software">
 <h2>Organization of the software<a class="headerlink" href="#organization-of-the-software" title="Permalink to this headline"></a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">ifm3d-ros</span></code> meta package provides three subpackages:</p>