Codecore Logo
Quick Search
»
Advanced Search »

Octava Matrix Switch Driver

RSS
This is a driver for the Octava 4x4 Matrix switch using the RS-232 connection

Manufacturer: Octava

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : (optional) The name of the serial port that the Matrix Switch is connected to. Ex. COM1
  • Command Delay : (optional) Delay in milliseconds before a subsequent command can be sent
  • ZoneNames : (optional) Enter the name of each zone.
  • SourceNames : (optional) Enter the name of each source.

Events

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

Connected

Gets a value indicating if a connection is established with the Octava Matrix.

Accessibility : Read Only

Type: Boolean

ZoneNames

An array containing the Name for each zone.

Accessibility : Read Only

Type: Array

SourceNames

An array containing the Name for each source.

Accessibility : Read Only

Type: Array

ZoneSourceNames

Gets the current source name for all zones.

Accessibility : Read Only

Type: Array

ZoneSources

Gets the current source name for all zones.

Accessibility : Read Only

Type: Array

ZonePlugStatus

Gets the current plug status for all zones.

Accessibility : Read Only

Type: Array

SourcePlugStatus

Gets the current plug status for all sources.

Accessibility : Read Only

Type: Array

ZoneOutputType

Gets the current zone output type (CAT/HDMI).

Accessibility : Read Only

Type: Array

SmartScanStatus

Gets the current Smart Scan Status (ON/OFF).

Accessibility : Read Only

Type: String

LEDStatus

Gets the current LED (ON/OFF).

Accessibility : Read Only

Type: String

PowerStatus

Gets the current Power Status (ON/OFF).

Accessibility : Read Only

Type: String

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

refreshPortStatus

Refreshes Port Status

Syntax

void refreshPortStatus( )

Parameters

none

CycleZoneSource ( Number )

Cycles through each of the available sources for a zone. When the last source is reached, the next source is the first available source.

Syntax

void CycleZoneSource( Number zoneNumber )

Parameters

zoneNumber : The zone number. (1-4)

SetPower ( Boolean )

Set Power On or Off

Syntax

void SetPower( Boolean state )

Parameters

state : true for On and false for Off

SetLED ( Boolean )

Set LED On or Off

Syntax

void SetLED( Boolean state )

Parameters

state : true for On and false for Off

SetSmartScan ( Boolean )

Set SmartScan On or Off

Syntax

void SetSmartScan( Boolean smartScan )

Parameters

smartScan : true for On and false for Off

SetOutputType ( Number, String )

Set Zone Type to HDMI/CAT5

Syntax

void SetOutputType( Number zoneId, String zoneType )

Parameters

zoneId : Output 1, 2, 3, 4
zoneType : HDMI or CAT

SetZoneSource ( Number, Number )

Set Zone to Source

Syntax

void SetZoneSource( Number zoneId, Number sourceId )

Parameters

zoneId : Zone 1, 2, 3, or 4
sourceId : Source 1, 2, 3, or 4

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.