uci_interface

uci_interface … end_uci_interface

uci_interface
  message_topic ...
  service_name ...
  service_descriptor ...
end_uci_interface

Overview

The uci_interface block provides configuration data for use when connecting and communicating Universal Command and Control Interface (UCI) messages over the UCI Abstract Service Bus (ASB). Options are provided to subscribe to supported UCI messages using various topics, specify the UCI service name used by the ASB, and the service descriptor associated with the UCI service name.

Warning

A uci_interface block must be provided in order to utilize UCI messaging; otherwise the simulation will execute without it.

Commands

message_topic <Message-Type> <string>

Publish / subscribe to a given UCI message with the supplied topic name.

The message types currently supported are the following:

• UCI_AMTI_ActivityMessage

• UCI_AMTI_CapabilityMessage

• UCI_AMTI_CapabilityStatusMessage

• UCI_AMTI_CommandMessage

• UCI_AMTI_CommandStatusMessage

• UCI_AMTI_SettingsCommandMessage

• UCI_AMTI_SettingsCommandStatusMessage

• UCI_ControlRequestMessage

• UCI_ControlRequestStatusMessage

• UCI_ControlStatusMessage

• UCI_EntityMessage

• UCI_ESM_ActivityMessage

• UCI_ESM_CapabilityMessage

• UCI_ESM_CapabilityStatusMessage

• UCI_ESM_CommandMessage

• UCI_ESM_CommandStatusMessage

• UCI_ESM_SettingsCommandMessage

• UCI_ESM_SettingsCommandStatusMessage

• UCI_POST_ActivityMessage

• UCI_POST_CapabilityMessage

• UCI_POST_CapabilityStatusMessage

• UCI_POST_CommandMessage

• UCI_POST_CommandStatusMessage

• UCI_POST_SettingsCommandMessage

• UCI_POST_SettingsCommandStatusMessage

• UCI_StrikeActivityMessage

• UCI_StrikeCapabilityMessage

• UCI_StrikeCapabilityStatusMessage

• UCI_StrikeCommandMessage

• UCI_StrikeCommandStatusMessage

• UCI_StrikeSettingsCommandMessage

• UCI_StrikeSettingsCommandStatusMessage

• UCI_SubsystemStatusMessage

• UCI_SystemStatusMessage

Note

The topic names of message publishers and subscribers must be identical.

Note

By default, these inputs do not need to be provided; connections are automatically made with the message name as the topic name. For example, the UCI “Entity” message is associated with the “Entity” topic name.

Example:

message_topic Entity tracks

service_name <string>

Specifies the name of the UCI service identifier that is associated with the UCI interface’s Abstract Bus. This service name is embedded into the xml as part of the service identifier for all transmitted messages over the Abstract Bus.

Warning

The supplied service name must match a corresponding service name as specified in the ActiveMQ configuration file.

Default: None (Must be specified)

Example:

service_name sense

service_descriptor <string>

Specifies an arbitrary descriptive label to that is associated with the UCI service identifier. This label is embedded into the xml as part of the service identifier for all transmitted messages over the Abstract Bus.

Default: uci