Sign inSign up

3rdman/osc2activemq

By 3rdman

•Updated about 7 years ago

Forward OSC messages to ActiveMQ

Image
0

1.5K

3rdman/osc2activemq repository overview

⁠Summary

This image can be use to transform and publish OSC (Open Sound Control)⁠ messages to Apache ActiveMQ⁠ topics as part of a real-time data processing pipeline that uses IanniX⁠ for sensor data simulation, for example.

If you are interested in more details, please visit the project overview⁠ and the post about visual sensor data simulation⁠

Example command for running the latest version:

docker run -d -p 5103:5103/udp --env BrokerUri="activemq:tcp://192.168.100.222:61616" --env Verbosity=3 --env OscAddressMode=topic --name osc2activemq 3rdman/osc2activemq:latest

Watch the container log/output:

docker logs -f osc2activemq

⁠Supported Operating Systems

  • Linux (amd64)
  • Windows (amd64)

⁠Supported tags

  • latest
  • 0.0.4

⁠Quick reference

⁠Forwarded message format

The received OSC data is transformed into a string that has the following structure:

  • Data position index in squared brackets, starting at 0
  • followed by a column character (:) to separate the index from the actual data
  • followed by the data string
  • the data string is terminated by the character(s) set via the OscDataSeparator parameter. The default is a semicolon (;)

Example: [0]:2019-06-20 11:45:54.515;[1]:2;[2]:78.69386;

Note: If the OscAddressMode is set to DATA, then the OSC address is added at the beginning of the data string with the index set to "address".

For example: [address]:/cursor;[0]:2019-06-20 11:45:54.515;[1]:2;[2]:78.69386;

⁠Available Configuration Parameters

⁠OscPort

Sets the UDP port that is used to listen for incoming OSC messages

Default: 5103

⁠OscAddressMode

Defines how the OSC address is forwarded to ActiveMQ.

Available options are:

  • ignore

Just ignores the OSC address completely and does not forward it to ActiveMQ

  • data

Adds the OSC address at the beginning of the message that is sent to ActiveMQ

  • topic

Creates a separate ActiveMQ topic for each individual OSC address

Default: IGNORE

⁠OscDataSeparator

See the section about forwarded message format above

Default: ;

⁠BrokerUri

Use this to set the broker URI of your ActiveMQ instance.

For example: activemq:tcp://192.168.222.111:61616

The default is activemq:tcp://127.0.0.1:61616, which will result in a send error, as the docker image does not contain a local ActiveMQ instance.

⁠BrokerTopic

Sets the ActiveMQ topic to which the messages should be published to.

If the OscAddressMode is set to TOPIC, then BrokerTopic is used a base topic to which the OSC address is appended by replacing every slash (/) of the original OSC address with a dot (.)

For example: OscStream.cursor. Where OscStream is the BrokerTopic and the OSC address is /cursor

Default: OscStream

⁠Verbosity

Defines how much information is sent to stdout and therefore can be watched in real-time via docker logs -f

  • 0 : Just displays the start-up message, without any additional information about received and sent data.

  • 1 : Displays a summary of received and sent messages every second

  • 2 : Writes a dot for each message received/sent

  • 3 : Prints a timestamp with the summary of received/sent messages so far.

  • 4 : Show the message details

Default: 0

Tag summary

Content type

Image

Digest

Size

69.6 MB

Last updated

about 7 years ago

docker pull 3rdman/osc2activemq