Module: plugins/polling-updater

Uses a SOAP endpoint in the cloud API to continuously poll for available updates.

The SOAP endpoint (/ethComet.asmx) is undocumented, but is the one used by the client web application. The difference to the client web application is that this implementation uses a proper SOAP API interface (in contrast to hand-building the XML to be transmitted, and to parsing the returned XML with a regex), and that it calls a different method at that endpoint.

This updater can operate in two modes. In the default mode, only those tag objects previously registered are updated, and all other data updates returned by the polling API are ignored. In discovery mode, data updates for which no matching tag object is registered will result in new tag objects to be created on the fly, and for each of these a data event is emitted by the updater (instead of by the registered tag).

This updater should receive updates resulting from armed sensors going below or above their configured thresholds, or detecting motion. The one caveat is that there is a short wait time (see UPDATE_LOOP_WAIT), and an exponentially increasing wait time after errors (see WAIT_AFTER_ERROR) until the next poll is issued. Updates falling into this time period will only be caught at the next regular update interval configured for a tag.

Source:

Classes

PollingTagUpdater

Members

(inner, constant) API_BASE_URI :string

the base URI of the polling API endpoint

Type:
  • string
Default Value:
  • https://www.mytaglist.com
Source:

(inner, constant) MAX_UPDATE_LOOP_WAIT :number

the maximum time to wait between subsequent calls of the polling endpoint (in milliseconds)

Type:
  • number
Source:

(inner, constant) UPDATE_LOOP_WAIT :number

the time to wait between subsequent calls of the polling endpoint (in milliseconds)

Type:
  • number
Default Value:
  • 10
Source:

(inner, constant) WAIT_AFTER_ERROR :number

the minimum time to wait between subsequent calls of the polling endpoint after an error occurred (in milliseconds)

Type:
  • number
Default Value:
  • 1000
Source:

(inner, constant) WSDL_URL_PATH :string

the path (relative to API_BASE_URI) of the WSDL endpoint description for polling

Type:
  • string
Default Value:
  • /ethComet.asmx?WSDL
Source: