.. _isaacsim_ucx_nodes_UCXCameraHelper_1:

.. _isaacsim_ucx_nodes_UCXCameraHelper:

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

:orphan:

.. meta::
    :title: UCX Camera Helper
    :keywords: lang-en omnigraph node isaacUcx nodes u-c-x-camera-helper


UCX Camera Helper
=================

.. <description>

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

.. </description>


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

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


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

    "Exec In (*inputs:execIn*)", "``execution``", "Triggering this causes the sensor pipeline to be generated", "None"
    "Frame Skip Count (*inputs:frameSkipCount*)", "``uint``", "Specifies the number of simulation frames to skip between each message publish. (e.g. Set to 0 to publish each frame. Set 1 to publish every other frame)", "0"
    "Port (*inputs:port*)", "``uint64``", "UCX port to publish", "13337"
    "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"
    "Send Cuda Buffer (*inputs:sendCudaBuffer*)", "``bool``", "When true, passes the raw CUDA buffer to UCX for transport. UCX selects the transport automatically. Receiver must set tensor_buffer_size. When false, copies frame data to CPU before sending.", "True"
    "Tag (*inputs:tag*)", "``uint64``", "UCX tag for message identification. Default is FNV-1a 32-bit hash of 'isaac.Image'.", "270059627"
    "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.ucx.nodes.UCXCameraHelper"
    "Version", "1"
    "Extension", "isaacsim.ucx.nodes"
    "Icon", "ogn/icons/isaacsim.ucx.nodes.UCXCameraHelper.svg"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "UCX Camera Helper"
    "Categories", "isaacUcx"
    "Generated Class Name", "OgnUCXCameraHelperDatabase"
    "Python Module", "isaacsim.ucx.nodes"

