Plugin Commands: Messaging Server

Application Framework CLI Command Reference

plugin messaging-server append [message:-1]

• Append an additional string to the message contained in the message plugin
  • message - OCTET_STRING - the string to append to the current message

plugin messaging-server cancel [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

• Cancel the message.
  • nodeId - INT16U - The destination of the message.
  • srcEndpoint - INT8U - The source endpoint of the message.
  • dstEndpoint - INT8U - The destination endpoint of the message.

plugin messaging-server confirm not

• Set the message confirmation to not used.

plugin messaging-server confirm req

• Set message confirmation to required.

plugin messaging-server display [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

• Display the message.
  • nodeId - INT16U - The destination of the message.
  • srcEndpoint - INT8U - The source endpoint of the message.
  • dstEndpoint - INT8U - The destination endpoint of the message.

plugin messaging-server id [messageId:4]

• Set the message id for the message contained in the messaging plugin
  • messageId - INT32U - message id

plugin messaging-server importance critical

• Set the message importance to critical.

plugin messaging-server importance high

• Set the message importance to high.

plugin messaging-server importance low

• Set the message importance to low.

plugin messaging-server importance medium

• Set the message importance to medium.

plugin messaging-server invalid [endpoint:1]

• Set the message validity to invalid.
  • endpoint - INT8U - The relevant endpoint.

plugin messaging-server message [message:-1]

• Set the message used by the message plugin.
  • message - OCTET_STRING - The message to set

plugin messaging-server print [endpoint:1]

• Print the message info.
  • endpoint - INT8U - The relevant endpoint.

plugin messaging-server relative-time [time:4] [duration:4]

• Set the relative time on the message.
  • time - INT32U - number of minutes to add to the message time above the current time
  • duration - INT32U - duration in minutes for the message to be valid

plugin messaging-server time [time:4] [duration:2]

• Set the start time and duration for the message used by the message plugin.
  • time - INT32U - start time
  • duration - INT16U - duration

plugin messaging-server transmission both

• Set the message control bit mask in the message to normal and anonymous.

plugin messaging-server transmission ipan

• Set the message control bit mask in the message to anonymous.

plugin messaging-server transmission normal

• Sets the message control bit mask to normal transmission.

plugin messaging-server valid [endpoint:1]

• Set the message validity to valid.
  • endpoint - INT8U - The relevant endpoint.