DF Solutions Interface

(c) 2010-2013 My Device.

www.mydevice.com.au

This driver provides 2-way feedback and control for DF Solutions multi-room AV controller.

Note:

Please report any bugs found to bugs@mydevice.com.au. Include driver version number and steps to reproduce the issue where possible.

Driver Configuration Settings:

Server Settings:

Description - Functionally beneign. If you have multiple servers you can name them here.

Device Type - Functionally beneign. If you have multiple DF devices you can specify the type.

TCP Address - The IP address of the DF box you wish to control.

TCP Port - The Port of the DF box. This is normally 6002.

List:

Items per page - This is used to determine when a page scroll should happen when browsing the 2-way scrolling list. Normally a value of 7 works best.

Licensing:

Unlock Code - Once you have purchased a license for this driver, enter the unlock code here. Without an unlock code the driver will for for 60 minutes at a time. After 60 minutes the driver will cease to function until the XP8 is reset/power cycled.

Functions:

Server / Zone Selection:

Set Zone

This command allows you to set the "current" zone. Once set any feedback or commands will be directed to that zone when using the "current zone" setting.

Zone: 1 - 17.

Increment Zone

This command allows you to increment the "current" zone. Useful for providing a way to scroll through zones.

Decrement Zone

This command allows you to decrement the "current" zone. Useful for providing a way to scroll through zones.

Control:

IR Command

This command mimics the IR remote.

Command: One of the following:

Exit

Menu

Red

Green

Yellow

Blue

Record

Volume Up

Volume Down

Play

Pause

Stop

Skip Left

Skip Right

Scan Left

Scan Right

OK

Cursor Up

Cursor Down

Cursor Left

Cursor Right

Cycle Browse Mode

0

1

2

3

4

5

6

7

8

9

Channel Up

Channel Down

Mute

Movie Library

Albums

Guide

Enter

Zone: Zone Master, Current Zone, or 1 - 17.

Extended IR Command

This command mimics multi-key commands.

Command: Settings, Check for updates, Check for beta updates.

Get Volume Level

This command requests the volume level for the current zone. The result is stored in the Volume variable for the zone.

Set Volume Level

This command sets the volume level for the current zone. The Volume variable for the zone is automatically updated.

Volume: 0 - 100.

Reboot

This command reboots the DF machine.

Power Off

This command powers down the machine. Please note: unless wake on LAN is enabled in the bios (and supported) you may not be able to remotely power the box back on again.

Power On (WOL)

This command attempts to power on the box via a Wake On LAN packet. WOL must be enabled in the BIOS for this to work.

MAC Address: MAC address of the DF box is the format XX:XX:XX:XX:XX:XX. Where XX is a 2 digit uppercase hex value. For example: 01:02:03:AB:CD:EF.

Multicast IP Address: If your XP8 is on a different subnet to the DF box you need to provide a multicast address.

For example, If the DF box is 192.168.1.2 and your XP8 is 192.168.2.27 then you should enter 192.168.1.0 as the multicast address.

If both are on the same subnet leave this field blank.

Please note, the boot up time of the DF box is anything up to several minutes.

Audio:

Request Audio Status

This command requests the current status of the audio playback system and updates the following variables:

State

Song Percentage

Track Position (seconds)

Track Position (MM:SS)

Track Length (seconds)

Track Length (MM:SS)

Queue Length

Queue Current Index

Track Title

Artist

Album

Audio Cover Art

Note that this isn't normally required as any changes are broadcast by the server. Use this function if you wish to ensure the latest info when changing pages on a panel.

Find Audio

This command searches the server for a specific type of audio and populates the 2-way list. This command isn't normally required as the list will take care of the information automatically.

Audio Type: Album, Artist, Genre, Playlist, Title, Net Radio.

Request Audio Queue

This command requests the current entries in the queue and populates the associated 2-way list.

Play Audio Queue

This command plays the queue starting from the specified index.

Index: 0 - queue length.

Clear Audio Queue

This command clears the queue on the server and updates the associated 2-way list.

Video:

Set DVD Parental Level

This command sets the parental level for watching DVDs. Set to "All" to disable parental control.

Level: All, Universal, PG, Twelve, Fifteen (MA15), Eighteen (R18+), Restricted.

Browser List:

The Browser List and it's related functions are used to display the available artists/albums/tracks/stations etc to the user.

Select Item

This function determines the action when the user selects an item in the Browser List. Associate this function with a 2-way list. Set the "Index" parameter to be dynamic. The default action is what happens once the item is selected.

Index: This is the item selected. Set to dynamic when used in a list.

Default action: Add to Queue, Show detail, do nothing.

Select Item (tracking)

This is similar to Select Item above, however its used for navigating using the hard keys on for example, a t3v. The 'tracking' refers to highlighting the correct entry on the 2-way scrolling list as you're not directly touching the screen. You would normally assign this to a hard-key ENTER or SELECT button.

Default action: Add to Queue, Show detail, do nothing.

Back

This moves up one level in the browser hierachy. Associate this function with a 2-way list.

Scroll List

This moves the selection (highlight) bar up/down and tracks the position.

Scroll List Page

This moves the selection (highlight) bar up/down by a full page (the number of items specified in the driver settings, normally 7) and tracks the position.

Set Scroll List Position

This sets (highlights) the requested item in the 2-way list.

Queue List:

The Queue List and it's related functions are used to display the current enqueued tracks to the user.

Select Item

This function determines the action when the user selects an item in the Queue List. Associate this function with a 2-way list. Set the "Index" parameter to be dynamic.

Index: This is the item selected. Set to dynamic when used in a list.

Select Item Tracking

This is similar to Select Item above, however its used for navigating using the hard keys on for example, a t3v. The 'tracking' refers to highlighting the correct entry on the 2-way scrolling list as you're not directly touching the screen. You would normally assign this to a hard-key ENTER or SELECT button.

Scroll List

This moves the selection (highlight) bar up/down and tracks the position.

Scroll List Page

This moves the selection (highlight) bar up/down by a full page (the number of items specified in the driver settings, normally 7) and tracks the position.

System:

Ping

This function "pings" the server to ensure it is still online. Really only useful for debugging. Not needed during normal use.

Request System Info

This function gets an update of the current system information. Updates the following variables:

Zones - total zones available in the system.

Zone Name - the string name for each zone.

Free Space - the amount of HDD space free on the server.

Client/Server - indicates if the DF box is a client or server (ie. Base or Link).

Variables:

System:

Connected

Boolean variable which is true when a connection has been established with the DF server, false otherwise. Great for debugging.

Zones

Integer variable indicating the total number of zones available.

Free Space

Integer variable indicating the number of Mb of free disk space on the server.

Client/Server

Boolean variable which is true when the connected box is a Base, false otherwise.

Address

IP address of the server as configured in the driver settings.

Port

Port of the server as configured in the driver settings.

Current Zone, Zone 1 - 17:

Zone (Current Zone only)

Integer variable containing the zone number.

Zone Name

String variable containing the name of the zone.

Volume

Integer variable indicating the current volume level for a zone (0 - 100).

Mute

Boolean variable which is true when the zone is muted, false otherwise.

State

Integer list variable indicating the current state of the media player: Stopped (0), Paused (1), or Playing (2).

Song Percentage

Integer variable indicating the current progress of the song being played as a percentage (0 - 100). Use this for tracking a song on a progress bar.

Track Position (Seconds)

Integer variable indicating the current playback position of a song in seconds. For example, if a 5 minute song is half way through it would read "150".

Track Length (Seconds)

Integer variable indicating the length of the current song in seconds. For example, a 5 minute song would be displayed as "300".

Track Position (MM:SS)

String variable indicating the current playback position of a song in the format MM:SS. For example, if a 5 minute song is half way through it would read "2:30".

Track Length (MM:SS)

Integer variable indicating the length of the current song in the format MM:SS. For example, a 5 minute song would be displayed as "5:00".

Queue Length

Integer variable indicating the number of songs in the queue.

Queue Current Index

Integer variable indicating the index of the currently playing song in the queue.

Track Title

String variable indicating the name of the current song.

Artist

String variable indicating the name of the current artist.

Album

String variable indicating the name of the current album.

Play Mode

Integer list variable indicating the current playback mode: Once (0), Random (1), Repeat (2), or Shuffle (3).

Audio Cover Art

Dynamic image variable that holds the cover art for the current album.

Browse List

2-way list object that is used for browsing the music library.

Browse List Heading

String variable that dynamically indicates the type of data being viewed.

Queue List

2-way list object that is used for browsing the playback queue.

Queue List Heading

String variable that dynamically indicates the type of data being viewed.

Video Title

String variable indicating the name of the current movie.

Video Year

Integer variable indicating the production year of the current movie.

Actors

String variable indicating the main actors in the current movie.

Director

String variable indicating the director(s) of the current movie.

Video Genre

String variable indicating the genre of the current movie.

Parental Level

Integer list variable indicating the required parental level to watch the current movie: Universal (0), PG (1), 12 (2), 15MA (3), R-18 (4), Restricted (5), All (7).

Video Cover Art

Dynamic image variable that holds the cover art for the current movie.