|
|
| (2 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | =Overview=
| |
| | | | |
| | + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| | | | |
| − | =Methods=
| + | <big> |
| − | | + | This document is available at: http://docs2.hubitat.com/en/developer/driver/driver-object |
| − | ==Hubitat Provided Methods==
| + | </big> |
| − | | |
| − | ===<code>sendHubCommand</code>===
| |
| − | :Use this method to send a HubAction immediately.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void sendHubCommand(HubAction hubAction)</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::hubAction - The HubAction object to send.
| |
| − | | |
| − | :;Returns
| |
| − | :: none
| |
| − | | |
| − | ===<code>addChildDevice</code>===
| |
| − | :Creates a new child device and returns that device from the method call.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Map properties = [:])</code>
| |
| − | :: <code>ChildDeviceWrapper addChildDevice(String typeName, String deviceNetworkId, Map properties = [:])</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::namespace - The namespace of the child driver to add as a child device (optional, if not specified it will default the the namespace of the parent)
| |
| − | ::typeName - The name of the child driver to add as a child device
| |
| − | ::deviceNetworkId - unique identifier for this device
| |
| − | ::properties - optional parameters for this child device. Possible values listed below
| |
| − | | |
| − | :;Properties
| |
| − | ::boolean isComponent - true or false, if true, device will still show up in device list but will not be able to be deleted or edited in the UI. If false, device can be modified/deleted on the UI.
| |
| − | ::String name - name of child device, if not specified, driver name is used.
| |
| − | ::String label - label of child device, if not specified it is left blank.
| |
| − | | |
| − | :;Returns | |
| − | ::ChildDeviceWrapper | |
| − | | |
| − | ===<code>getChildDevices</code>===
| |
| − | :Gets a list of all child devices for this device.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>List<ChildDeviceWrapper> getChildDevices()</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::None
| |
| − | | |
| − | :;Returns
| |
| − | ::List<ChildDeviceWrapper>
| |
| − | | |
| − | ===<code>getChildDevice</code>===
| |
| − | :Gets a specific child device with the device network id specified.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>ChildDeviceWrapper getChildDevice(String deviceNetworkId)</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::deviceNetworkId - The unique identifier for the device
| |
| − | | |
| − | :;Returns
| |
| − | ::ChildDeviceWrapper
| |
| − | | |
| − | ===<code>deleteChildDevice</code>===
| |
| − | :Deletes a specific child device with the device network id sepcified.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void deleteChildDevice(String deviceNetworkId)</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::deviceNetworkId - The unique identifier for the device
| |
| − | | |
| − | :;Returns
| |
| − | ::None
| |
| − | | |
| − | ===<code>getParent</code>===
| |
| − | :Returns the parent Device (ParentDeviceWrapper) or App (InstalledAppWrapper) when called from a child device.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>Object getParent()</code>
| |
| − | '''Returns:'''
| |
| − | The ParentDeviceWrapper or InstalledAppWrapper
| |
| − | | |
| − | ===<code>getDataValue</code>===
| |
| − | :Get a data value that was set for this device.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>String getDataValue(String name)</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::name - The String value of the data item.
| |
| − | | |
| − | :;Returns
| |
| − | ::String - The value of the data.
| |
| − | | |
| − | ===<code>updateDataValue</code>===
| |
| − | :Update or create a data value for this device.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void updateDataValue(String name, String value)</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::name - The name of the data item to store.
| |
| − | ::value - The value of the data item to store.
| |
| − | | |
| − | :;Returns
| |
| − | ::None.
| |
| − | | |
| − | ===<code>removeDataValue</code>===
| |
| − | :Remove a data value from a device.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void removeDataValue(String name)</code> (Since 2.2.1)
| |
| − | | |
| − | :;Parameters
| |
| − | ::name - The name of the data item to remove.
| |
| − | | |
| − | :;Returns
| |
| − | ::None.
| |
| − | | |
| − | ==User defined methods==
| |
| − | | |
| − | ===<code>installed</code>===
| |
| − | :This method is called when the device is first created.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void installed()</code>
| |
| − | | |
| − | ===<code>updated</code>===
| |
| − | :This method is called when the preferences of a device are updated.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void updated()</code>
| |
| − | | |
| − | ==<code>Additional to be documented</code>==
| |
| − | Map getState()
| |
| − | Zwave getZwave()
| |
| − | Zigbee getZigbee()
| |
| − | String getDeviceDataByName(String name)
| |
| − | HubAction response(String cmd)
| |
| − | HubAction response(hubitat.zwave.Command cmd)
| |
| − | HubMultiAction response(List cmds)
| |
| − | Short getZwaveHubNodeId()
| |
| − | void sendEvent(Map properties)
| |
| − | List<Event> eventsSince(Date startDate, Map options = null)
| |
| − | void telnetConnect(Map options, String ip, int port, String username, String password)
| |
| − | void telnetConnect(String ip, int port, String username, String password)
| |
| − | void telnetClose()
| |
| − | Map createEvent(Map options)
| |
| − | List<String> delayBetween(List<String> cmds, Long delay)
| |
| − | List<String> delayBetween(List<String> cmds)
| |
