ZMQ Publish Image#

Publishes a camera image (color or depth) via ZMQ as an Image protobuf message. The encoding input selects content type: rgba8/rgb8 for color, 32FC1 for depth. With useIpc (default) and a GPU source, pixels are shared zero-copy via CUDA IPC (same host); otherwise raw bytes are sent.

Installation#

To use this node enable isaacsim.zmq.nodes in the Extension Manager.

Inputs#

Name

Type

Descripton

Default

Buffer Size (inputs:bufferSize)

uint64

Size in bytes of the data buffer (0 if input is a GPU texture)

0

Cuda Device Index (inputs:cudaDeviceIndex)

int

Index of CUDA device where data resides (-1 for host/CPU data)

-1

Data (inputs:data)

uchar[]

CPU image data array (used when cudaDeviceIndex == -1 and dataPtr == 0)

[]

Data Ptr (inputs:dataPtr)

uint64

Pointer to raw image data (CUDA device pointer or host pointer)

0

Encoding (inputs:encoding)

token

Image encoding format. rgba8/rgb8 for color images, 32FC1 for depth images.

rgba8

Metadata

allowedTokens = rgba8,rgb8,32FC1

Exec In (inputs:execIn)

execution

The input execution port

None

Format (inputs:format)

uint64

GPU texture format identifier (informational; sizing uses encoding)

0

Height (inputs:height)

uint

Image height in pixels

0

Ip (inputs:ip)

string

Remote IP address of the ZMQ server

localhost

Port (inputs:port)

uint

Remote port number of the ZMQ server

5561

Timestamp (inputs:timeStamp)

double

Frame timestamp in seconds

0.0

Topic Name (inputs:topicName)

string

ZMQ topic published on (first multipart frame); defaults to the message type. Set a unique value (e.g. “robot_0/image”) to distinguish multiple data sources.

image

Use Ipc (inputs:useIpc)

bool

When true (default) and the source is on the GPU, share pixels zero-copy via CUDA IPC (same host only). When false, or for CPU data, send raw bytes (works cross-host).

True

Width (inputs:width)

uint

Image width in pixels

0

Outputs#

Name

Type

Descripton

Default

Exec Out (outputs:execOut)

execution

Fires every tick after the image is published

None

Metadata#

Name

Value

Unique ID

isaacsim.zmq.nodes.ZMQPublishImage

Version

1

Extension

isaacsim.zmq.nodes

Icon

ogn/icons/isaacsim.zmq.nodes.ZMQPublishImage.svg

Has State?

False

Implementation Language

C++

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

ZMQ Publish Image

Categories

isaacZmq

Generated Class Name

OgnZMQPublishImageDatabase

Python Module

isaacsim.zmq.nodes