Codecore Logo
Quick Search
»
Advanced Search »

Rain8net Driver

RSS
The Rain8net is a modular 8-zone sprinkler controller module that is driven by a RS232 serial port. Up to 2048 zones are possible by adding expansion modules.

Manufacturer: WGL & Associates

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : The name of the serial port that the driver is connected to. Ex. COM1
  • Module Address(es) : Enter each Rain8 module address in use as a comma delimited string. For example if you use modules 1 and 2 you would enter: 1,2
  • Ignore On Command if Rain Switch Is On : If checked, commands to turn on a zone will be ignored if the rain sensor is activated.
  • Indicate if the rain switch attached is normally open or close. : If checked, the rain switch is of type normally closed, otherwise normally open.

Events

Output States Changed

Occurs when the output state status changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Rain Switch Changed

Occurs when the rains switch status changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Instance Properties

OutputStates

Get all the zone states.

Accessibility : Read Only

Type: Array

OutputNames

Get the zone names. The Rain8net does not provide configurable names so they are predefined.

Accessibility : Read Only

Type: Array

Connected

Gets a value indicating if a connection is established with the Rain8net.

Accessibility : Read Only

Type: Boolean

InputStates

Gets the rain switch state of all modules.

Accessibility : Read Only

Type: Array

InputNames

Get the rain switch names for all modules. Rain8 does not provide configurable names so they are automatically generated.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

TurnOnOutput ( Number )

Turn on the specified zone if it is not already on.

Syntax

void TurnOnOutput( Number zoneNumber )

Parameters

zoneNumber : Zone Number

TurnOnOutputByModule ( Number, Number )

Turn on the specified module zone if it is not already on.

Syntax

void TurnOnOutputByModule( Number moduleAddress, Number zoneNumber )

Parameters

moduleAddress : Module Address (1-256)
zoneNumber : Zone Number (1-8)

TurnOffOutput ( Number )

Turn on the specified zone if it is not already off.

Syntax

void TurnOffOutput( Number zoneNumber )

Parameters

zoneNumber : Zone Number

TurnOffOutputByModule ( Number, Number )

Turn off the specified module zone if it is not already off.

Syntax

void TurnOffOutputByModule( Number moduleAddress, Number zoneNumber )

Parameters

moduleAddress : Module Address (1-256)
zoneNumber : Zone Number (1-8)

TurnOffAllZonesByModule ( Number )

Turn off all the zones on a specified module.

Syntax

void TurnOffAllZonesByModule( Number moduleAddress )

Parameters

moduleAddress : Module Address Number

TurnOffAllZones

Turn off all the zones on all modules.

Syntax

void TurnOffAllZones( )

Parameters

none

ClearFlowMeterCounter ( Number )

Clear the flow meter counter on a specified module.

Syntax

void ClearFlowMeterCounter( Number moduleAddress )

Parameters

moduleAddress : Module Address Number

GetActiveZoneCount ( Number )

Get the number of active zones on a module.

Syntax

Number GetActiveZoneCount( Number moduleAddress )

Parameters

moduleAddress : Module Address Number

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.