AthomCloudAPI.Homey

Properties:
Name Type Description
_id string
name string Human-readable name
ipInternal string IP in local network (not cached)
ipExternal string External IP (not cached)
ipExternalCountry string External IP Country (not cached)
localUrl string HTTP URL to connect to homey locally
localUrlSecure string HTTPS URL to connect to homey locally
remoteUrl string HTTPS URL to connect to homey remotely
apiVersion number API level to use for this Homey
softwareVersion string Installed software version
language string Configured language
state string Power status
geolocation object Location information
users Array.<object> Authorized users (not cached)
Properties
Name Type Description
user AthomCloudAPI.User
userId string The user's ID
role string User's assumed role on Homey
role string Current user's assumed role on Homey
token string Current user\'s Homey access token (V1-only)
apps Array.<object> Installed apps (not cached)
Properties
Name Type Description
id string App ID
version string Installed version
channel string Subscribed channel
devices Array.<object> Installed devices
Properties
Name Type Description
driverId string Driver ID
count number Number of installed devices

Members

resourceId

Returns the oAuth2 resource ID of this Homey

Methods

async authenticate(optsopt) → {HomeyAPI}

Logs in to this Homey
Parameters:
Name Type Attributes Description
opts object <optional>
Properties
Name Type Attributes Description
strategy Array.<string> <optional>
A list of connection strategies ('localSecure'|'local'|'cloud'|'mdns')
token string <optional>
A custom bearer token
Returns:
HomeyAPI - An HomeyAPI instance to communicate with this homey