Difference between revisions of "Location Object"
(→Methods) |
|||
| Line 31: | Line 31: | ||
===<code>getTimeFormat</code>=== | ===<code>getTimeFormat</code>=== | ||
===<code>getModes</code>=== | ===<code>getModes</code>=== | ||
| + | :Get a list of modes for the location. | ||
| + | |||
| + | :;Signature | ||
| + | :: <code>List<Mode> getModes()</code> | ||
| + | |||
===<code>getMode</code>=== | ===<code>getMode</code>=== | ||
| + | :Get the current mode of the location. | ||
| + | |||
| + | :;Signature | ||
| + | :: <code>String getMode()</code> | ||
| + | |||
===<code>setMode</code>=== | ===<code>setMode</code>=== | ||
===<code>currentMode</code>=== | ===<code>currentMode</code>=== | ||
Revision as of 14:21, 12 February 2020
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".
Contents
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.
hub
The Hub for this location.
Methods
getFormattedLatitude
getFormattedLongitude
getTimeFormat
getModes
- Get a list of modes for the location.
- Signature
List<Mode> getModes()
getMode
- Get the current mode of the location.
- Signature
String getMode()
