Location

A Location represents a user’s geo-location, such as “Home” or “office”. Locations do not have to have a SmartThings hub, but generally do.

All SmartApps and Device Handlers are injected with a location property that is the Location into which the SmartApp is installed.

---

contactBookEnabled

true if this location has contact book enabled (has contacts), false otherwise.

Signature:

Boolean contactBookEnabled

Returns:

true if this location has contact book enabled (has contacts), false otherwise.

---

currentMode

The current Mode for the Location.

Signature:

Mode currentMode

Returns:

Mode - The current mode for the Location.

Example:

log.debug "location.currentMode: ${location.currentMode}"

---

id

The unique internal system identifier for the Location.

Signature:

String id

Returns:

String - the unique internal system identifier for the Location.

Example:

log.debug "location.id: ${location.id}"

---

hubs

The list of Hubs for this location. Currently only Hub can be installed into a Location, thought this API returns a List to allow for future expandability.

Signature:

List<Hub> hubs

Returns:

List <Hub> - the Hubs for this Location.

Example:

log.debug "Hubs: ${location.hubs*.id}"

---

latitude

Geographical latitude of the location. Southern latitudes are negative. Requires that location services are enabled in the mobile app.

Signature:

BigDecimal latitude

Returns:

BigDecimal - the latitude for the Location.

Example:

log.debug "location.latitude: ${location.latitude}"

---

longitude

Geographical longitude of the location. Western longitudes are negative. Requires that location services are enabled in the mobile app.

Signature:

BigDecimal longitude

Returns:

BigDecimal - the longitude for the Location.

Example:

log.debug "location.longitude: ${location.longitude}"

---

mode

The current Mode name for the Location.

Signature:

String mode

Returns:

String - the name of the current Mode for the Location.

Example:

log.debug "location mode name: ${location.mode}"

---

modes

List of Modes for the Location.

Signature:

List<Mode> modes

Returns:

List <Mode> - the List of Modes for the Location.

Example:

log.debug "Modes for this location: ${location.modes}"

---

name

The name of the Location, as assigned by the user.

Signature:

String name

Returns:

String - the name of the Location as assigned by the user.

Example:

log.debug "The name of this location is: ${location.name}"

---

setMode()

Set the mode for this location.

Signature:

void setMode(String mode) void setMode(Mode mode)

Returns:

void

Warning

setMode() will raise an error if the specified mode does not exist for the location. You should verify the mode exists as in the example below.

Example:

def modeToSetTo = "Home"
if (location.modes?.find {it.name == modeToSetTo}) {
    location.setMode("Home")
}

temperatureScale

The temperature scale (“F” for fahrenheit, “C” for celsius) for this location.

Signature:

String temperatureScale

Returns:

String - the temperature scale set for this location. Either “F” for fahrenheit or “C” for celsius.

Example:

def tempScale = location.temperatureScale
log.debug "Temperature scale for this location is $tempScale"

timeZone

The time zone for the Location. Requires that location services are enabled in the mobile application.

Signature:

TimeZone timeZone

Returns:

TimeZone - the time zone for the Location.

Example:

log.debug "The time zone for this location is: ${location.timeZone}"

---

zipCode

The ZIP code for the Location, if in the USA. Requires that location services be enabled in the mobile application.

Signature:

String zipCode

Returns:

String - the ZIP code for the Location.

Example:

log.debug "The zip code for this location: ${location.zipCode}"

---