Difference between revisions of "Location Object"

From Hubitat Documentation
Jump to: navigation, search
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 "getLocation()" method or simply using the property "location".
 
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 "getLocation()" method or simply using the property "location".
  
Properties
+
==Properties==
 
==<code>id</code>==
 
==<code>id</code>==
 
A unique id for the location, as a Long.
 
A unique id for the location, as a Long.
Line 23: Line 23:
 
A list of hubs for this location as a List<Hub>.  In Hubitat there is only one Hub in the list.
 
A list of hubs for this location as a List<Hub>.  In Hubitat there is only one Hub in the list.
  
Methods
+
==Methods==
 
==<code>getFormattedLatitude</code>==
 
==<code>getFormattedLatitude</code>==
 
==<code>getFormattedLongitude</code>==
 
==<code>getFormattedLongitude</code>==

Revision as of 14:57, 22 April 2019

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 "getLocation()" method or simply using the property "location".

Properties

id

A unique id for the location, as a Long.

name

The name of the location as a String.

temperatureScale

The temperature scale of the location as a String (C or F).

timeZone

The time zone of the location as a TimeZone object.

zipCode

The zip code of the location as a String.

latitude

The latitude of the location as a BigDecimal.

longitude

The longitude of the location as a BigDecimal.

sunrise

The sunrise of the location as a Date.

sunset

The sunset of the location as a Date.

hubs

A list of hubs for this location as a List<Hub>. In Hubitat there is only one Hub in the list.

Methods

getFormattedLatitude

getFormattedLongitude

getTimeFormat

getModes

getMode

setMode

currentMode