License, Copyright, and Trademark

The content contained in this repository is the intellectual property of Snap One, LLC, (formerly known as Wirepath Home Systems, LLC), and use without a valid license from Snap One is strictly prohibited. The user of this repository shall keep all content contained herein confidential and shall protect this content in whole or in part from disclosure to any and all third parties except as specifically authorized in writing by Snap One.

License and Intellectual Property Disclaimer

The content in this repository is provided in connection with Snap One products. No license, express or implied, by estoppal or otherwise, to any intellectual property rights is granted by this document or in this repository. Except as provided in Snap Oneʼs terms and conditions for the license of such products, Snap One and its affiliates assume no liability whatsoever and disclaim any express or implied warranty, relating to the sale and/or use of Snap One products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Snap One products are not intended for use in medical, lifesaving, or life sustaining applications.

Information regarding third-party products is provided solely for educational purposes. Snap One is not responsible for the performance or support of third-party products and does not make any representations or warranties whatsoever regarding the quality, reliability, functionality or compatibility of these products. The reader is advised that third parties can have intellectual property rights that can be relevant to this repository and the technologies discussed herein, and is advised to seek the advice of competent legal counsel regarding the intellectual property rights of third parties, without obligation of Snap One.

Snap One retains the right make changes to this repository or related product specifications and descriptions in this repository, at any time, without notice. Snap One makes no warranty for the use of this repository and assumes no responsibility for any errors that can appear in the repository nor does it make a commitment to update the content contained herein.

Copyright

The above copyright notice applies to all content in this repository unless otherwise stated explicitly herein that a third-party’s copyright applies.

No part of this publication may be reproduced, photocopied, stored on a retrieval system, or transmitted without the express written consent of the publisher.

Trademarks

Snap One and Snap One Logo, Control4 and the Control4 logo, and DriverWorks are trademarks or registered trademarks of Snap One, LLC. Other product and company names mentioned in this repository may be the trademarks or registered trademarks of their respective owners.

Derivative Works

To the extent that you create any “Derivative Work” (meaning any work that is based upon one or more preexisting versions of the work provided to you in this repository, such as an enhancement or modification, revision, translation, abridgement, condensation, expansion, collection, compilation or any other form in which such preexisting works may be recast, modified, transformed or adapted, explicitly including without limitation, any updates or changes to Snap One, LLC’s software code or intellectual property) such Derivative Work shall be owned by Snap One, LLC and all right, title and interest in and to each such Derivative Work shall automatically vest in Snap One, LLC. To the extent any Derivative Work does not automatically vest in Snap One, LLC by operation of law, you hereby assign such Derivative Work to Snap One, LLC with full title guarantee. Snap One, LLC shall have no obligation to grant you any right in any such Derivative Work.

Contact Us

Snap One, LLC 11734 S. Election Road Salt Lake City, UT 84020 USA

http://www.control4.com

Introduction

This documentation includes content that details the functions that make up the Satellite Receiver Control Proxy which is supported in the DriverWorks Software Development Kit.

Proxies (Commands)

A proxy driver is an interface to the Control4 system for a set of devices that share common functionality. For instance, most Satellite Receivers have common controls such as SEARCH, SET CHANNEL and Volume UP. The Satellite Receiver proxy allows for a common user interface to control all Satellite Receivers. The Control4 system (Director) sends information to and receives information from the proxy drivers. The proxy drivers send information to and receives information from the protocol drivers. Remember, your DriverWorks driver interacts with the proxy driver which then interacts with the system. As a driver developer you will be relying on this proxy to provide status (notification) to the Control4 system for the device you are controlling. You will also receive commands from the system that you will act on to control the device. These commands and notifications are at the heart of what you will be implementing in your driver. Essentially your driver is becoming the go-between from the Control4 system and your device with the proxy driver giving structure to the commands and notifications which you will be implementing. Your driver can facilitate communications with multiple types of proxies for a single device. As an example, a Security System driver will utilize both the Security proxy and the Contacts proxy. These additional proxies are configured in the <connections> section of the .c4z.

Protocol (Notifications)

Two similar devices may have the same functionality but utilize a very different command set. A protocol driver provides the device-specific information needed to communicate with the Control4 system. In the case of DriverWorks, the DriverWorks driver is the protocol driver. When combined with the device-specific.c4Z file it provides the custom code necessary to implement the 2-way device driver. In the case of DriverWorks, the DriverWorks driver is the protocol driver. When combined with the device-specific.c4Z file it provides the custom code necessary to implement the 2-way device driver.

What’s New

What’s New in 3.4.2

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.4.2.

What’s New in 3.4.1

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.4.1.

What’s New in 3.4.0

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.4.0.

What’s New in 3.3.2

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.3.2.

What’s New in 3.3.1

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.3.1.

What’s New in 3.3.0

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.3.0.

What’s New in 3.2.3

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.2.3.

What’s New in 3.2.2

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.2.2.

What’s New in 3.2.1

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.3.1.

What’s New in 3.2.0

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.2.0.

What was New in 3.1.2

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.1.2.

What was New in 3.1.0

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.1.0.

What was New in O.S.3

There were no modifications to the Satellite Receiver Proxy in conjunction with O.S. Release 3.0.0

Satellite Receiver Capabilities

audio_consumer_count

Count of number of audio consumers (inputs) of the device. This value must match the number of connections in the driver.

Signature

<audio_consumer_count></audio_consumer_count>

Parameter	Description
int	Number of audio consumers.

Example

<capabilities>
   <audio_consumer_count>8</audio_consumer_count>
</capabilities>

audio_provider_count

Count of number of audio providers (outputs) of the device. This value must match the number of connections in the driver.

Signature

<audio_provider_count></audio_provider_count>

Parameter	Description
int	Number of audio providers.

Example

<capabilities>
   <audio_provider_count>8</audio_provider_count>
</capabilities>

can_downclass

Specifies if the A/V switch can down convert. For example: S-Video -> Composite

Signature

<can_downclass></can_downclass>

Parameter	Description
bool	True/False

Example

<capabilities>
   <can_downclass>true</can_downclass>
</capabilities>

can_switch_separately

Device specific capability that must be set to True to in order for an AV Switch’s Composer Pro interface reflecting independent audio and video signal switching.

Signature

<can_switch_separately></can_switch_separately>

Parameter	Description
bool	True/False

Example

<capabilities>
   <can_switch_separately>true</can_switch_separately>
</capabilities>

Usage Note

This capability is not related with the requires separate switching capability. A setting of True or False will have no impact on requires separate switching.

can_switch

Device specific capability that when set to True designates switching capability on the receiver.

Signature

<can_switch></can_switch>

Parameter	Description
bool	True/False

Example

<capabilities>
   <can_switch>true</can_switch>
</capabilities>

can_upclass

Specifies if the A/V switch can up convert. For example: Composite -> S-Video

Signature

<can_upclass></can_upclass>

Parameter	Description
bool	True/False

Example

<capabilities>
   <can_upclass>true</can_upclass>
</capabilities>

has_audio_signal_sense

Specifies AV switching is capable of sensing audio on an input. This is useful in triggering programming in ComposerPro based on the this setting.

Signature

<has_audio_signal_sense></has_audio_signal_sense>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_audio_signal_sense>true</has_audio_signal_sense>
</capabilities>

has_discrete_balance_control

Capable of directly specifying a balance setting.

Signature

<has_discrete_balance_control></has_discrete_balance_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_discrete_balance_control>true</has_discrete_balance_control>
</capabilities>

has_discrete_bass_control

Capable of directly specifying a bass setting.

Signature

<has_discrete_bass_control></has_discrete_bass_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_discrete_bass_control>true</has_discrete_bass_control>
</capabilities>

has_discrete_loudness_control

Capable of directly specifying a loudness setting.

Signature

<has_discrete_loudness_control></has_discrete_loudness_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_discrete_loudness_control>true</has_discrete_loudness_control>
</capabilities>

has_discrete_mute_control

Capable of directly specifying mute ON or OFF setting.

Signature

<has_discrete_ mute_control></has_discrete_ mute_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_discrete_mute_control>true</has_discrete_mute_control>
</capabilities>

has_discrete_treble_control

Capable of directly specifying a treble setting.

Signature

<has_discrete_treble_control></has_discrete_treble_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_discrete_treble_control>true</has_discrete_treble_control>
</capabilities>

has_discrete_volume_control

Capable of directly specifying a volume setting.

Signature

<has_discrete_volume_control></has_discrete_volume_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_discrete_volume_control>true</has_discrete_volume_control>
</capabilities>

has_toggle_loudness_control

Capable of toggling ON/OFF loudness control.

Signature

<has_toggle_loudness_control></has_toggle_loudness_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_toggle_loudness_control>true</has_toggle_loudness_control>
</capabilities>

has_toggle_mute_control

Capable of handling ON/OFF mute control.

Signature

<has_toggle_mute_control></has_toggle_mute_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_toggle_mute_control>true</has_toggle_mute_control>
</capabilities>

has_up_down_balance control

Capable of directly specifying a balance setting.

Signature

<has_up_down_balance_control></has_up_down_balance_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_up_down_balance_control>true</has_up_down_balance_control>
</capabilities>

has_up_down_bass_control

Capable of directly specifying a bass setting.

Signature

<has_up_down_bass_control></has_up_down_bass_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_up_down_bass_control>true</has_up_down_bass_control>
</capabilities>

has_up_down_treble_control

Capable of directly specifying a treble setting.

Signature

<has_up_down_treble_control></has_up_down_treble_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_up_down_treble_control>true</has_up_down_treble_control>
</capabilities>

has_up_down_volume_control

Has capability of handling volume UP and DOWN adjustments.

Signature

<has_up_down_volume_control></has_up_down_volume_control>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_up_down_volume_control>true</has_up_down_volume_control>
</capabilities>

has_video_signal_sense

Specifies AV switching is capable of sensing video on an input. This is useful in triggering programming in ComposerPro based on the this setting.

Signature

<has_video_signal_sense></has_video_signal_sense>

Parameter	Description
bool	True/False

Example

<capabilities>
   <has_video_signal_sense>true</has_video_signal_sense>
</capabilities>

video_consumer_count

Count of number of vidoe consumers (inputs) of the device. This value must match the number of connections in the driver.

Signature

<video_consumer_count></video_consumer_count>

Parameter	Description
int	Number of video consumers.

Example

<capabilities>
   <video_consumer_count>8</video_consumer_count>
</capabilities>

video_provider_count

Count of number of video providers (outputs) of the device. This value must match the number of connections in the driver.

Signature

<video_provider_count></video_provider_count>

Parameter	Description
int	Number of audio providers.

Example

<capabilities>
   <video_provider_count>8</video_provider_count>
</capabilities>

Satellite Receiver Protocol Notifications

AUDIO_PARAMETER_CHANGED

Audio parameter has changed

Name

AUDIO_PARAMETER_CHANGED ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID value

Returns

None

BALANCE_LEVEL_CHANGED

Selected balance level has changed.

Name

BALANCE_LEVEL_CHANGED ()

Parameter	Description
int	Level
int	Output Binding ID

Returns

None

BASS_LEVEL_CHANGED

Selected bass level has changed

Name

BASS_LEVEL_CHANGED ()

Parameter	Description
int	Level
int	Output Binding ID

Returns

None

INPUT_OUTPUT_CHANGED

Selected inputs & outputs have changed.

Name

INPUT_OUTPUT_CHANGED ()

Parameter	Type	Description
OUTPUT	INT	OutputBindingID
INPUT	INT	Input Binding ID

Returns

None

LOUDNESS_CHANGED

Loudness state (On/Off) has changed.

Name

LOUDNESS_CHANGED ()

Parameter	Type	Description
LOUDNESS	BOOL	True/False
Output indingID	INT	Output Binding ID value

Returns

None

MUTE_CHANGED

MUTE state (On/Off) has changed.

Name

MUTE_CHANGED ()

Parameter	Type	Description
output	INT	Output Binding ID
MUTE	BOOL	True/False

Name

TREBLE_LEVEL_CHANGED ()

Parameter	Description
int	Level
int	Output Binding ID

Returns

None

VOLUME_LEVEL_CHANGED

Selected volume level has changed.

Name

VOLUME_LEVEL_CHANGED ()

Parameter	Description
int	Level
int	Output Binding ID

Returns

None

SURROUND_MODE_CHANGED

Surround mode setting has changed.

Name

SURROUND_MODE_CHANGED ()

Parameter	Type	Description
output	INT	Output Binding ID
SURROUND MODE	INT	Surround Mode ID value

Returns

None

Pulses the ‘-’ button.

Name

DASH ()

Parameter

None

Returns

None

DISCONNECT_OUTPUT

Disconnect (turn off) selected output on device.

Name

DISCONNECT_OUTPUT ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Name

EMIT_CODE ()

Parameter	Type	Description
IRCodeID	INT	IR Code value

Returns

None

EMIT_MACRO

Emit IR/Serial code macro (used by AVGen IR/Serial Proxy)

Name

EMIT_MACRO ()

Parameter	Type	Description
s MacroCodeName	STR	Macro Code Name

None

PIP

Pulse menu PIP button.

Name

PIP ()

Parameter	Type	Description
MacroCodeName	STR	Name of Macro Code

Parameter	Description
int	Output Binding ID

Returns

None

PULSE_TREBLE_UP

Pulse treble up.

Name

PULSE_TREBLE_UP ()

Parameter	Description
int	Output Binding ID

Returns

None

PULSE_VOL_DOWN

Pulse volume level down.

Name

PULSE_VOL_DOWN

Parameter	Description
int	Output Binding ID

Name

PULSE_VOL_UP

Parameter	Description
int	Output Binding ID

SET_BALANCE

Set balance to a specified position.

Name

SET_BALANCE ()

Parameter	Type	Description
Level	INT	Level value
OutputBindingID	INT	Output Binding ID

Returns

None

SET_BALANCE_UP

Set balance to a specified position.

Name

SET_BALANCE ()

Parameter	Type	Description
Level	INT	Level value
OutputBindingID	INT	Output Binding ID

Returns

None

SET_BASS_LEVEL

Set bass to a specified level.

Name

SET_BASS_LEVEL

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Returns

None

SET_CHANNEL

Tune device to the specified channel.

Name

SET_CHANNEL ()

Parameter	Type	Description
CHANNEL	STR	Channel value in string format.

Returns

None

Example

The examples to the right detail the table of information that is received from the proxy when a channel is selected:

FM:
ReceivedFromProxy:  SET_CHANNEL
BindingID           5002
CHANNEL             96.3
INPUT               3028
OUTPUT              0

AM:
ReceivedFromProxy: SET_CHANNEL
INPUT              3027
BindingID          5002
CHANNEL            1100
INPUT              3027
OUTPUT             0

In the FM example, channel 96.3 has been selected in the tuner protocol. The 96.3 value is passed into the data table as a string.

It is important to note that if the bandwidth type (AM, FM) is not provided (and the proxy in question is not TV) a manner in which to identify the bandwidth type will need to be developed. An example of this code follows:


if tParams['BANDTYPE'] == nil then
       if (string.find(tParams['CHANNEL'],"%p") ~= nil) then
        tParams['BANDTYPE'] = 'FM'
        local ChannelLen = string.len(tParams['CHANNEL'] )
        local ChannelFix = string.sub(tParams['CHANNEL'],1,ChannelLen-2) .. '.' .. string.sub(tParams['CHANNEL'],ChannelLen-1,ChannelLen-1)
        tParams ['CHANNEL'] = ChannelFix
       else
        tParams['BANDTYPE'] = 'AM'
      end
    end

SET_LOUDNESS

Turn loudness on.

Name

SET_LOUDNESS ()

Parameter	Description
int	Level
int	Output Binding ID

Returns

None

SET_OUTPUT_INPUT

Specify input and output selection of device.

Name

SET_OUTPUT_INPUT ()

Parameter	Type	Description
InputBindingID	INT	Input Binding ID
OutputBindingID	INT	Output Binding ID

Returns

None

SET_UP_DOWN_SWAP

Swap page UP/DOWN buttons (used by AVGen). TRUE to enable swap, FALSE to disable.

Name

POUND ()

Parameter	Type	Description
SWAPFLAG	BOOL	True/False

Returns

None

SET_VOLUME_LEVEL

Set volume to a specified level.

Name

SET_VOLUME_LEVEL ()

Parameter	Type	Description
Level	INT	Level value
OutputBindingID	INT	Output Binding ID value

Returns

None

SET_PRESET

Set specified tuning preset

Name

SET_PRESET ()

Parameter	Type	Description
PresetNum	INT	Preset Number

Returns

None

SET_TREBLE_LEVEL

Set treble to a specified level.

Name

SET_TREBLE_LEVEL ()

Parameter	Type	Description
Level	INT	Level
Output Binding ID	INT	Output Binding ID

Name

START_TREBLE_DOWN ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Returns

None

START_TREBLE_UP

Start ramping treble up.

Name

START_TREBLE_UP ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Returns

None

START_VOL_DOWN

Start ramping volume down.

Name

START_TREBLE_DOWN ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Returns

None

STOP_TREBLE_UP

Stop ramping the treble up.

Name

STOP_TREBLE_UP ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Name

STOP_VOL_DOWN ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Returns

None

STOP_VOL_UP

Stop ramping the volume up.

Name

STOP_VOL_UP ()

Parameter	Type	Description
OutputBindingID	INT	Output Binding ID

Parameters

None

Returns

None