Namespace: stash

stash

Properties:
Name Type Description
version string The Version of the STASH-Library
debug boolean If set to true, outputs for debugging purposes are logged.
enableHistory boolean If set to true, the history of all devices is saved locally.
enableHistoryToLocalStore boolean If set to true, the history of all devices is saved in the locale store.
Source:

Methods

(inner) addEndpoint(name, endpointAddress, version) → {Endpoint}

Adds an endpoint, tries to connect to it and, if successful, saves its devices in a list of device objects.
Parameters:
Name Type Description
name string The name of an endpoint.
endpointAddress string The internet address of an endpoint.
version string The version of an endpoint, currently "obix.v1", "obix.v2", "simple.v1" are supported.
Source:
Returns:
Returns a new endpoint.
Type
Endpoint

(inner) addEndpoint(name, endpointAddress) → {Endpoint}

Adds an endpoint (obix.v1 version), tries to connect to it and, if successful, saves its devices in a list of device objects.
Parameters:
Name Type Description
name string The name of an endpoint.
endpointAddress string The internet address of an Endpoint.
Source:
Returns:
Returns a new Endpoint.
Type
Endpoint

(inner) discoverEndpoints((callback), (error_callaback))

Triggers a search for endpoints found via network discovery
Parameters:
Name Type Description
(callback) requestCallback An optional callback function which is called with the discovered endpoints as parameter after the discovery finished successfully.
(error_callaback) requestCallback An optional error callback function which is called with the error as parameter if the discovery failed.
Source:
Returns:
true if the discovery of endpoints using NSD could be triggered false if there was an error triggering the discovery

(inner) getDevices() → {Array}

Returns all devices from all endpoints.
Source:
Returns:
Type
Array

(inner) getDiscoveredEndpoints()

Source:

(inner) getEndpoint(name) → {Endpoint}

Returns a certain endpoint.
Parameters:
Name Type Description
name string The name of an endpoint.
Source:
Returns:
Type
Endpoint

(inner) getEndpoints() → {Array}

Returns all added endpoints.
Source:
Returns:
Type
Array

(inner) removeEndpoint(name)

Removes a certain endpoint.
Parameters:
Name Type Description
name string The name of an endpoint.
Source: