HubAction Object

Constructors

Create a HubAction object. While protocol is optional, it is recommended that it be provided. If it is not specified the system will attempt to determine the protocol to use.

Signature:

HubAction()
HubAction(String request)
HubAction(String request, Protocol protocol, String dni)
HubAction(String request, Protocol protocol, String dni, Map options)
HubAction(String request, Protocol protocol)
HubAction(String request, Protocol protocol, Map options)
HubAction(Map params)
HubAction(Map params, String dni)
HubAction(Map params, String dni, Map options)

Parameters:

request

The command to send as a String, this can be a ZigBee, Z-Wave or Lan message to send.

protocol

The protocol to use when sending the message. See the Protocol documentation for more info.

dni

The device network Id to use when sending the message.

options

Optional settings when sending the command. Possible values are callback, destinationAddress, destinationPort, type, secureCode, encoding. See examples for usage.

• callback - This option can be specified in order to pass the response from the HubAction back to a specific method. If this option is not specified the response will be handed to the parse method of a Device or will be discarded if this HubAction was called from an App.
• destinationAddress
• destinationPort
• type
• secureCode - Used as part of a wake on lan request.
• encoding

params

a list of parameters for sending a Lan message.

Examples:

//Create and send a Z-Wave message
def hubAction = new hubitat.device.HubAction(new hubitat.zwave.commands.basicv1.BasicGet().format(), hubitat.device.Protocol.ZWAVE)
sendHubCommand(hubAction)

// Protocol.LAN examples

// Send UDP Message
new HubAction("My UDP Message", Protocol.LAN, [type: HubAction.Type.LAN_TYPE_UDPCLIENT])

// Send Binary UDP Message 
new HubAction("48756269746174", Protocol.LAN, [type: HubAction.Type.LAN_TYPE_UDPCLIENT, encoding: HubAction.Encoding.HEX_STRING])

// Send Wake On Lan to mac address 00:11:22:33:44:55
new HubAction("wake on lan 00:11:22:33:44:55", Protocol.LAN)

// Send Wake On Lan to mac address 00:11:22:33:44:55 with secure code
new HubAction("wake on lan 00:11:22:33:44:55", Protocol.LAN, [secureCode: "112233"])

getAction

Can be used to get the request value of the HubAction.

Signature

String getAction()

getCallbackMethod

Signature:

String getCallbackMethod()

getURI

Signature:

URI getURI()