Classes

Properties

read-only static

CONNECTION_STATE  Number

Connection status.

Properties

Name Type Optional Description

INIT

Number

 

Initialised or initialisation is running

CONNECTING

Number

 

Connection is being established

OPEN

Number

 

Connected

CLOSING

Number

 

Connection is closed

CLOSED

Number

 

Connection is closed

DESTROYED

Number

 

Object is already enabled

read-only static

DATE_TYPE  Number

Date types.

Properties

Name Type Optional Description

WEEKDAY

Number

 

Days of the week

RANGE

Number

 

Time period

DAY

Number

 

Single day (with placeholder)

read-only static

EVENT_FILTER  Number

Types of days.

Properties

Name Type Optional Description

ALWAYS

Number

 

Always

NORMAL

Number

 

Only normal days (not a public holiday or holiday)

HOLIDAY

Number

 

Public holiday

VACATION

Number

 

Holidays

NEVER

Number

 

Never

read-only static

TIME_TYPE  Number

Time types.

Properties

Name Type Optional Description

TIME

Number

 

Time

SUNRISE

Number

 

Sunrise

SUNSET

Number

 

Sunset

Method

static

createConnection(user, pw[, options]) → Object

Returns an instance of the class HomeServerConnector._Connection.

Example

Call

var conn = HomeServerConnector.createConnection("user1", "pw1", {"host": "192.168.123.234", "port": 443, "protocol": "wss"});

Parameters

Name Type Optional Description

user

String

 

User name for logging into the HS.

pw

String

 

Password for the user.

options

Object

Yes

Connection information:
If no information is provided, the corresponding values of the called embedded HTML page is used.

Properties

Name Type Optional Description

options.host

String

Yes

IP address of the HS.

options.port

Number

Yes

Port of the HS.

options.protocol

String

Yes

Protocol used to address the HS. Is either "ws" or "wss" (default value).

Returns

Object Instance of the class HomeServerConnector._Connection.