Homey

The Homey instance holds all the Managers, System Events and generic properties. You can access the Homey instance through this.homey on App, Driver and Device, it is also passed into your api handlers.

By reading Homey.platform and Homey.platformVersion, your app can determine which product your app is running on.

Product platform platformVersion
Homey Cloud cloud 1
Homey (Early 2016) local 1
Homey (Early 2018) local 1
Homey (Early 2019) local 1
Homey Pro (Early 2019) local 1
Homey Pro (Early 2023) local 2

Note: on older software versions either platform or platformVersion might be undefined. In such case, assume platform equals local and platformVersion equals 1.

Example

// register system events
this.homey.on('memwarn', () => console.log('memwarn!'));

// access a Manager
const latitude = this.homey.geolocation.getLatitude();
console.log('Latitude: ', latitude);

Extends

Instance Properties

api

api: ManagerApi

Type

app

app: App

A pointer to the App's instance.

Type

apps

apps: ManagerApps

Type

arp

arp: ManagerArp

Type

audio

audio: ManagerAudio

Type

ble

ble: ManagerBLE

Type

clock

clock: ManagerClock

Type

cloud

cloud: ManagerCloud

Type

discovery

discovery: ManagerDiscovery

Type

drivers

drivers: ManagerDrivers

Type

env

env: any

The env.json environment variables

Type

  • any

flow

flow: ManagerFlow

Type

geolocation

geolocation: ManagerGeolocation

Type

i18n

i18n: ManagerI18n

Type

images

images: ManagerImages

Type

insights

insights: ManagerInsights

Type

ledring

ledring: ManagerLedring

Type

manifest

manifest: any

The app.json manifest

Type

  • any

nfc

nfc: ManagerNFC

Type

notifications

notifications: ManagerNotifications

Type

platform

platform: 'local'|'cloud'

The platform of the Homey that is running this app (local or cloud)

This property may be undefined on older Homey Pro versions

Type

  • 'local' | 'cloud'

platformVersion

platformVersion: 1|2

The platform's version of the Homey that is running this app (1 or 2)

This property may be undefined on older Homey Pro versions

Type

  • 1 | 2

rf

rf: ManagerRF

Type

settings

settings: ManagerSettings

Type

speechInput

speechInput: ManagerSpeechInput

Type

speechOutput

speechOutput: ManagerSpeechOutput

Type

version

version: string

The software version of the Homey that is running this app

Type

  • string

zigbee

zigbee: ManagerZigBee

Type

zwave

zwave: ManagerZwave

Type

Instance Methods

__

__(key, tagsopt): string

Shortcut to ManagerI18n#__

Parameters

Name Type Description
key 		string | Object

translation string or Object
tags 		Object <optional>

values to interpolate into the translation

Returns

string

Examples

this.homey.__('errors.device_unavailable');
this.homey.__({ en: 'My String', nl: 'Mijn tekst' });

clearInterval

clearInterval(timeoutId)

Alias to clearInterval

Parameters

Name Type Description
timeoutId 		any

clearTimeout

clearTimeout(timeoutId)

Alias to clearTimeout

Parameters

Name Type Description
timeoutId 		any

error

error(…args)

Emits the __error event with args as parameters.

Parameters

Name Type Description
args 		* <repeatable>

hasPermission

hasPermission(permission): boolean

Parameters

Name Type Description
permission 		string

Returns

boolean

log

log(…args)

Emits the __log event with args as parameters.

Parameters

Name Type Description
args 		* <repeatable>

setInterval

setInterval(callback, ms, …args): NodeJS.Timer

Alias to setInterval that ensures the interval is correctly disposed of when the Homey instance gets destroyed

Parameters

Name Type Description
callback 		function
ms 		number
args 		any <repeatable>

Returns

NodeJS.Timer

setTimeout

setTimeout(callback, ms, …args): NodeJS.Timer

Alias to setTimeout that ensures the timout is correctly disposed of when the Homey instance gets destroyed

Parameters

Name Type Description
callback 		function
ms 		number
args 		any <repeatable>

Returns

NodeJS.Timer

Events

cpuwarn

.on('cpuwarn')

This event is fired when the app is using too much CPU. When the app does not behave within reasonable amount of time, the app is killed.

Parameters

Name Type Description
data 		object
count 		number

The number of warnings already sent.
limit 		number

The number of maximum warnings until the app is killed.
}

memwarn

.on('memwarn')

This event is fired when the app is using too much memory. When the app does not behave within reasonable amount of time, the app is killed.

Parameters

Name Type Description
data 		object
count 		number

The number of warnings already sent.
limit 		number

The number of maximum warnings until the app is killed.
}

unload

.on('unload')

This event is fired when the app is being stopped.