ESM Component¶
- uci_component ESM¶
uci_component <type> ESM sensor <string-value> mode_uuid ... default_mode_uuid ... Part Commands ... uci_component Commands ... end_uci_component
Overview¶
ESM is the corresponding UCI component to WSF_ESM_SENSOR. Linking an ESM component to an WSF_ESM_SENSOR allows the sensor to send UCI messages.
Commands¶
- sensor <string-value>¶
The name of the sensor to link to.
- mode_uuid <mode-name> <uuid-value>¶
Sets the capability (mode) UUID to the given value. This command is equivalent to the “capability_uuid” command.
Note
The UUID should be in the format ‘########-####-####-####-############’, where # is an uppercase alphanumeric value [A-Z0-9].
- default_mode_uuid <uuid-value>¶
Sets the mode at index 0 to the given UUID value.
Note
The UUID should be in the format ‘########-####-####-####-############’, where # is an uppercase alphanumeric value [A-Z0-9].
Part Commands¶
- update_message_interval <time-value>¶
The interval that the component will send update messages
- capability_uuid <capability-name> <uuid-value>¶
Sets the capability UUID to the given value.
Note
The UUID should be in the format ‘########-####-####-####-############’, where # is an uppercase alphanumeric value [A-Z0-9].
Message Types¶
All message types are able to be sent via script methods.
Activity¶
UCI_ESM_ActivityMessage will be sent on the following events:
When a UCI_ESM_CommandMessage is received and accepted
When a UCI_ESM_Command is completed
On sensor turned on/off
On sensor mode de/activated
On update interval
Capability¶
UCI_ESM_CapabilityMessage will be sent on the following events:
On update interval
CapabilityStatus¶
UCI_ESM_CapabilityStatusMessage will be sent on the following events:
When a UCI_ESM_SettingsCommandMessage is received and accepted
On sensor turned on/off
On sensor mode de/activated
On update interval
Command¶
UCI_ESM_CommandMessage will be sent on the following events:
Script only
CommandStatus¶
UCI_ESM_CommandStatusMessage will be sent on the following events:
When a UCI_ESM_CommandMessage is received and handled (one per command in message)
When a UCI_ESM_SettingsCommandMessage is received and handled
Note
Not yet implemented in script
ControlRequest¶
UCI_ControlRequestMessage will be sent on the following events:
Script only
ControlRequestStatus¶
UCI_ControlRequestStatusMessage will be sent on the following events:
When a ControlRequestMessage is received and handled (one per controlee in message)
ControlStatus¶
UCI_ControlStatusMessage will be sent on the following events:
When a ControlRequestMessage is received and handled (one per controlee in message)
On update interval
Entity¶
UCI_EntityMessage will be sent on the following events:
On sensor track initiated
On sensor track updated
SettingsCommand¶
UCI_ESM_SettingsCommandMessage will be sent on the following events:
Script only
SettingsCommandStatus¶
UCI_ESM_SettingsCommandStatusMessage will be sent on the following events:
When a UCI_ESM_SettingsCommandMessage is received and handled
Note
Not yet implemented in script
SubsystemStatus¶
UCI_SubsystemStatusMessage will be sent on the following events:
On sensor turned on/off
On update interval
SystemStatus¶
UCI_SystemStatusMessage will be sent on the following events:
On sensor turned on/off
On update interval
Note
Not yet implemented in script
