Codecore Logo
Quick Search
»
Advanced Search »

Nuvo Essentia E6D Driver

RSS
Image
Interfaces with a Nuvo Essentia E6D.

Manufacturer: Nuvo Technologies

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : The name of the serial port that the Nuvo is connected to. Ex. COM1

Events

Zone Source Changed

Occurs when a zone's source 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.

Zone Power State Changed

Occurs when a zone's power state 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.

Zone Mute State Changed

Occurs when a zone's mute state 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.

Zone Volume Changed

Occurs when a zone's volume 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.

Macro Executed

Occurs when a macro is executed, which can be caused by a button press on a display pad, or the sending of an rs-232 macro command.

Whenever Filter:

  • Zone : (optional) The zone number (1-12). For macros in which the zone # does not apply, the zone will be zero (0).
  • Macro : (optional) The name of the macro.
  • State : (optional) The state of the Zone. (ON/OFF)
  • MacroID : (optional) The number of a named macro reference by either IR or Display Pad
  • Source : (optional) The source number (1-6).

EventArgs:

  • String State : The status of the Zone. (ON/OFF)
  • Number Source : The source number (1-6).
  • Number Zone : The zone number (1-12). For macros in which the zone # does not apply, the zone will be zero (0).
  • String Macro : The name of the macro.
  • Number MacroID : The number of a named macro reference by either IR or Display Pad.

Instance Properties

FirmwareVersion

Gets the firmware version.

Accessibility : Read Only

Type: String

Connected

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

Accessibility : Read Only

Type: Boolean

ZoneSources

Gets the source number for each zone.

Accessibility : Read Only

Type: Array

ZoneSourceNames

Gets the current source name for all zones.

Accessibility : Read Only

Type: Array

ZonePowerStates

Gets all the zone power states.

Accessibility : Read Only

Type: Array

ZoneMuteStates

Gets all the zone mute states.

Accessibility : Read Only

Type: Array

ZoneVolumes

Gets all zone volumes

Accessibility : Read Only

Type: Array

ZoneNames

Gets all the zone names.

Accessibility : Read Only

Type: Array

SourceNames

Gets all the source names.

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

SendRawCommand ( String )

Sends a command that may otherwise not be supported by the driver.

Syntax

void SendRawCommand( String command )

Parameters

command : The command string to send. The driver will append the command with a carriage-return .

TurnAllZonesOff

Turn all zones off.

Syntax

void TurnAllZonesOff( )

Parameters

none

TurnZoneOn ( Number )

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

Syntax

void TurnZoneOn( Number zoneNumber )

Parameters

zoneNumber : The zone number to power on. (1-12)

TurnZoneOff ( Number )

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

Syntax

void TurnZoneOff( Number zoneNumber )

Parameters

zoneNumber : The zone number to power off. (1-12)

ToggleZonePower ( Number )

Toggle the specified zone on and off.

Syntax

void ToggleZonePower( Number zoneNumber )

Parameters

zoneNumber : The zone number to toggle the power.

ToggleZoneMute ( Number )

Turns the mute on and off for a zone

Syntax

void ToggleZoneMute( Number zoneNumber )

Parameters

zoneNumber : The zone number to toggle muting. (1-12)

MuteZone ( Number )

Turn the mute on for a zone.

Syntax

void MuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number to mute. (1-12)

UnmuteZone ( Number )

Turn the mute off for a zone.

Syntax

void UnmuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number to unmute. (1-12)

SetZoneVolume ( Number, Number )

Change the Volume for a Zone.

Syntax

void SetZoneVolume( Number zoneNumber, Number volume )

Parameters

zoneNumber : The zone number to set the volume of. (1-12)
volume : Volume (0=Quietest, 79=Loudest)

IncrementZoneVolume ( Number )

Increase the Volume for a Zone. This is the same as pushing the VOL+ button on the DisplayPad.

Syntax

void IncrementZoneVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number to increment the volume of. (1-12)

DecrementZoneVolume ( Number )

Decrement the Volume for a Zone. This is the same as pushing the VOL- button on the DisplayPad.

Syntax

void DecrementZoneVolume( Number zoneNumber )

Parameters

zoneNumber : The zone number to decrement the volume of. (1-12)

SetZoneSource ( Number, Number )

Sets the source for a zone to the specified source.

Syntax

void SetZoneSource( Number zoneNumber, Number sourceNumber )

Parameters

zoneNumber : The zone number. (1-12)
sourceNumber : The source number. (1-6)

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-12)

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.