/
SIC standardized pre-defined messages

SIC standardized pre-defined messages

Owned by Thomas van Orden
Last updated: Feb 22, 2025 by l.brown2
2 min read

The SIC framework includes a number of predefined extended subclasses for common data types. This allows for inheritance. Make sure to use or extend these classes if the data type you will be working with matches one of these pre-defined types.

The messages can be found in https://github.com/Social-AI-VU/social-interaction-cloud/blob/main/sic_framework/core/message_python2.py .

Message class name

Description of use

Message class name

Description of use

JPEGCompressedImageMessage

Preferred way of sending any message containing an image. Uses lossy JPEG compression on WxHx3 images. Non-image content will be destroyed by this compression.

UncompressedImageMessage

Same as JPEGCompressedImageMessage, but without compression. This means that this message can be significantly slower. Only use this if the image data must be kept untouched. For example, if you want to send an array of depth values, because you don’t want those values to be changed (8cm might become 7.3cm with JPEGCompressedImageMessage).

AudioMessage

Preferred way of sending a message containing audio. The audio must contain pulse-code modulated (PCM) 16-bit signed integer waveform audio data.

BoundingBoxesMessage

Preferred way of sending any message containing a list of BoundingBox objects. The BoundingBox is a generic class for single bounding boxes in x,y,w,h-format. x,y represents top-left pixel. Bounding boxes can easily be drawn by calling draw_on_image.

Control requests and messages

To control a running component, system level requests can be sent. These requests will not be passed on to the message handlers (on_request and on_message). These requests should inherit from SICControlRequest.

  • SICPingRequest - A ping message to check if a component is active. Should be answered with a reply by sending back a SICPongMessage.

  • ConnectRequest - A request for a component to start listening to some some channel. The messages on this channel will be passed onto the on_message callback.

  • SICSuccessMessage - A message indicating succes, for example responding to a ConnectRequest.

  • SICStopRequest - A request for the component to shut down.

  • SICIgnoreRequestMessage - A message responding that the request is not accepted. TODO Deprecate?

Related content