Difference between revisions of "HubAction Object"
(Created page with "==<code>Constructors</code>== Create a HubAction object. While protocol is optional, it is recommended that it be provided. If it is not specified the system will attempt t...") |
|||
Line 13: | Line 13: | ||
HubAction(Map params, String dni) | HubAction(Map params, String dni) | ||
HubAction(Map params, String dni, Map options) | 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. Possible values are callback, destinationAddress, destinationPort, type, secureCode, encoding. See examples for usage. | ||
+ | options - Optional settings when sending the command. | ||
+ | params - a list of parameters for sending a Lan message. | ||
'''Examples:''' | '''Examples:''' |
Revision as of 15:06, 25 February 2019
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. Possible values are callback, destinationAddress, destinationPort, type, secureCode, encoding. See examples for usage. options - Optional settings when sending the command. 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)
getAction
Can be used to get the request value of the HubAction.
Signature
String getAction()
getCallbackMethod
Signature:
String getCallbackMethod()
getURI
Signature:
URI getURI()