collector.adoc

Collector

Object represents collector. Extends [class-netobj].

Instance attributes

_shared/netobj-attrs.adoc

autoBindScript: String

Source of the script for automatic binding.

isAutoBindEnabled: bool

Indicate if automatic binding is enabled.

isAutoUnbindEnabled: bool

Indicate if automatic unbinding is enabled.

Instance methods

_shared/netobj-methods.adoc

createCollector(name) ⇒ Collector

Create new collector under current object

Table 1. Parameters

name

String

New collector’s name

Return

Newly created collector of Collector class.

createContainer(name) ⇒ [class-container]

Create new container under current object

Table 2. Parameters

name

String

New container’s name

Return

Newly created container of [class-container] class.

createNode(name, primaryHostName, zoneUIN) ⇒ [class-node]

Create new node under current object.

Table 3. Parameters

name	String	Node name if second options is set or primary host name or IP address.
primaryHostName	String	Optional. Primary host name or IP address.
zoneUIN	Integer	Optional. New node’s zone UIN.

Return

Newly created node of [class-node] class or NULL if failed to create

createSensor(name, deviceClass, gateway, modbusUnitId) ⇒ [class-sensor]

Create new sensor under current object.

Table 4. Parameters

name	String	Sensor name
deviceClass	Integer	Sensor device class, one of the following values. Optional, SensorDeviceClass::Other if omitted.
gateway	[class-netobj]	Gateway used for communication sensor. Optional.
modbusUnitId	Integer	MODBUS Unit ID. Optional.

Return

Newly created sensor of [class-sensor] class or NULL if failed to create

setAutoBindMode(enableBind, enableUnbind): void

Set automatic bind mode for the container.

Table 5. Parameters

enableBind	Boolean	Script should be used for automatic binding.
enableUnbind	Boolean	Script should be used for automatic unbinding.

setAutoBindScript(script): void

Update automatic binding script source.

Table 6. Parameters

script

String

Script source.