Difference between revisions of "Location Object"
(→Methods) |
(Added missing hsmStatus property) |
||
| Line 20: | Line 20: | ||
===<code>sunset</code>=== | ===<code>sunset</code>=== | ||
The sunset of the location as a Date. | The sunset of the location as a Date. | ||
| + | ===<code>hsmStatus</code>=== | ||
| + | The current status of the Hubitat Safety Monitor. This is a String of one of the following values: armedAway, armingAway, armedHome, armingHome, armedNight, armingNight, disarmed, allDisarmed | ||
===<code>hubs</code>=== | ===<code>hubs</code>=== | ||
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. | ||
===<code>hub</code>=== | ===<code>hub</code>=== | ||
The Hub for this location. | The Hub for this location. | ||
| − | |||
==Methods== | ==Methods== | ||
Revision as of 14:25, 5 April 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.
hsmStatus
The current status of the Hubitat Safety Monitor. This is a String of one of the following values: armedAway, armingAway, armedHome, armingHome, armedNight, armingNight, disarmed, allDisarmed
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()
