ManagerLedring

Access this instance at HomeyAPIV2.ledring.

Extends

Instance Properties

homey

homey: HomeyAPIV3

The Homey of the Manager.

Type

uri

uri: String

The URI of the Item, e.g. homey:manager:bar.

Type

  • String

Instance Methods

addListener

addListener(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

connect

(async) connect(): Promise.<void>

Connect to this manager's Socket.io namespace.

Returns

Promise.<void>

destroy

destroy()

Destroy this Manager by cleaning up all references, unbinding event listeners and disconnecting from the Socket.io namespace.

disconnect

(async) disconnect(): Promise.<void>

Disconnect from this manager's Socket.io namespace.

Returns

Promise.<void>

emit

emit(event, …data)

Parameters

Name Type Description
event 		string
data 		any <repeatable>

getOptionBrightness

(async) getOptionBrightness(): Promise.<any>

Scopes

SYSTEM_READONLY

HTTP

GET /api/manager/ledring/option/brightness

Returns

Promise.<any>

getOptionScreensaver

(async) getOptionScreensaver(): Promise.<any>

Scopes

SYSTEM_READONLY

HTTP

GET /api/manager/ledring/option/screensaver

Returns

Promise.<any>

getScreensavers

(async) getScreensavers(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/ledring/screensaver/

Returns

Promise.<any>

getState

(async) getState(): Promise.<any>

Scopes

SYSTEM_READONLY

HTTP

GET /api/manager/ledring/state

Returns

Promise.<any>

isConnected

isConnected(): Boolean

If this manager's namespace is connected to Socket.io.

Returns

Boolean

off

off(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

on

on(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

once

once(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

removeAllListeners

removeAllListeners(eventopt)

Parameters

Name Type Description
event 		string <optional>

removeListener

removeListener(event, callback)

Shortcut to EventEmitter#off

Parameters

Name Type Description
event 		string
callback 		function

setOptionBrightness

(async) setOptionBrightness(opts): Promise.<any>

Scopes

SYSTEM

HTTP

PUT /api/manager/ledring/option/brightness

Parameters

Name Type Description
opts 		object
value 		number

In body
}

Returns

Promise.<any>

setOptionScreensaver

(async) setOptionScreensaver(opts): Promise.<any>

Scopes

SYSTEM

HTTP

PUT /api/manager/ledring/option/screensaver

Parameters

Name Type Description
opts 		object
value 		object

In body
}

Returns

Promise.<any>

unsetOptionBrightness

(async) unsetOptionBrightness(): Promise.<any>

Scopes

SYSTEM

HTTP

DELETE /api/manager/ledring/option/brightness

Returns

Promise.<any>

unsetOptionScreensaver

(async) unsetOptionScreensaver(): Promise.<any>

Scopes

SYSTEM

HTTP

DELETE /api/manager/ledring/option/screensaver

Returns

Promise.<any>