.. _isaacsim_hsb_nodes_HSBCameraHelper_1:

.. _isaacsim_hsb_nodes_HSBCameraHelper:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: HSB Camera Helper
    :keywords: lang-en omnigraph node internal nodes h-s-b-camera-helper


HSB Camera Helper
=================

.. <description>

Helper node to read RGB data from a render product for HSB publishing

.. </description>


Installation
------------

To use this node enable :ref:`isaacsim.hsb.nodes<ext_isaacsim_hsb_nodes>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Data Plane Id (*inputs:dataPlaneId*)", "``uint``", "HSB data plane ID", "0"
    "Data Plane Type (*inputs:dataPlaneType*)", "``token``", "HSB data plane: coe (Camera-over-Ethernet) or linux (RoCE/UDP). Use coe for COE players.", "coe"
    "", "Metadata", "*allowedTokens* = coe,linux", ""
    "Exec In (*inputs:execIn*)", "``execution``", "Triggering this causes the sensor pipeline to be generated", "None"
    "Ip Address (*inputs:ipAddress*)", "``string``", "HSB target IP address", "127.0.0.1"
    "Render Product Path (*inputs:renderProductPath*)", "``token``", "Path of the render product used for capturing data", ""
    "Reset Simulation Time On Stop (*inputs:resetSimulationTimeOnStop*)", "``bool``", "If True the simulation time will reset when stop is pressed, False means time increases monotonically. This setting is ignored if useSystemTime is enabled.", "True"
    "Sensor Id (*inputs:sensorId*)", "``uint``", "HSB sensor ID", "0"
    "Type (*inputs:type*)", "``token``", "Sensor type: vb1940_csi_coe (3p4b COE/AGX Thor) or vb1940_csi_linux (4p5b RoCE/linux_vb1940_player)", "vb1940_csi_coe"
    "", "Metadata", "*allowedTokens* = vb1940_csi_coe,vb1940_csi_linux", ""
    "Use System Time (*inputs:useSystemTime*)", "``bool``", "If True, system timestamp will be included in messages. If False, simulation timestamp will be included in messages", "False"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Exec Out (*outputs:execOut*)", "``execution``", "The output execution port", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "isaacsim.hsb.nodes.HSBCameraHelper"
    "Version", "1"
    "Extension", "isaacsim.hsb.nodes"
    "Icon", "ogn/icons/isaacsim.hsb.nodes.HSBCameraHelper.svg"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "HSB Camera Helper"
    "Categories", "internal"
    "Generated Class Name", "OgnHSBCameraHelperDatabase"
    "Python Module", "isaacsim.hsb.nodes"

