Difference between revisions of "Hub Object"

From Hubitat Documentation
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
The Location object is composed of methods that allow you to interact with the settings and values of a location.  This object is available to Apps and Drivers via the Location object "getLocation().getHub()" method or simply using the property "location.hub".
 
  
==Properties==
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
===<code>id</code>===
 
Long: An id for the hub. (Usually the value is 1 but not guaranteed)
 
===<code>name</code>===
 
String: The name of the hub as a String.
 
===<code>data</code>===
 
Map: A Map of data for the hub
 
===<code>zigbeeId</code>===
 
String: The Zigbee EUI
 
===<code>zigbeeEui</code>===
 
String: The Zigbee EUI
 
===<code>hardwareID</code>===
 
String: The hardware ID of the hub
 
===<code>type</code>===
 
String: The type of hub, always returns "PHYSICAL"
 
===<code>localIP</code>===
 
String: The local ip address of the hub
 
===<code>localSrvPortTCP</code>===
 
String: The local tcp port of the hub (always returns 39501)
 
===<code>firmwareVersionString</code>===
 
String: The current firmware version that the hub is running.
 
===<code>uptime</code>===
 
BigInteger: The uptime of the hub in seconds.
 
  
==Methods==
+
<big>
===<code>updateSystemTime</code>===
+
This document is available at: http://docs2.hubitat.com/en/developer/hub-object
:Update the date/time of the Hub.
+
</big>
 
 
:;Signature
 
:: <code>boolean updateSystemTime(Date date)</code>
 
 
 
:;Parameters
 
::date - The date/time to update to.
 
 
 
:;Returns
 
::boolean - True if update time is successful, false otherwise.
 

Latest revision as of 19:35, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/developer/hub-object