Topfield TF5800 Driver

RSS

Interfaces with a Topfield TF5800 with ExtCmdEnable TAP installed.

Manufacturer: Topfield

Primary Communications Port: Serial

Table of Contents [Hide/Show]

Configuration Settings

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

Events

Source Changed

Occurs when a source changes.

Whenever Filter:

none

EventArgs:

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.

Channel Changed

Occurs when the channel is changed on the TF5800.

Whenever Filter:

Channel : (optional) The Channel Number.
ChannelName : (optional) The Channel Name.

EventArgs:

String ChannelName : The Channel Name.
Number Channel : The Channel Number.

Instance Properties

FirmwareVersion

Gets the firmware version.

Accessibility : Read Only

Type: String

Source

Gets the source.

Accessibility : Read Only

Type: Number

Channel

Gets the channel number.

Accessibility : Read / Write

Type: Number

ChannelName

Gets the current channel name.

Accessibility : Read Only

Type: String

TVChannelNames

Gets all TV Channel Names

Accessibility : Read Only

Type: Array

RadioChannelNames

Gets all Radio Channel 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 .

SendKeyCommand ( Number )

Sends a defined key press.

Syntax

void SendKeyCommand( Number command )

Parameters

command : keys

0 = up

1 = down

2 = left

3 = right

4 = chUp

5 = chDown

6 = 0

7 = 1

8 = 2

9 = 3

10 = 4

11 = 5

12 = 6

13 = 7

14 = 8

15 = 9

16 = ok

17 = epg

18 = exit

19 = menu

20 = mute

21 = info

22 = tvradio

23 = pause

24 = F1

25 = F2

26 = F3

27 = F4

28 = RW

29 = play

30 = FF

31 = AB

32 = stop

33 = rec

ChangeChannel ( Number )

Sends a defined key sequnce.

Syntax

void ChangeChannel( Number channel )

Parameters

channel : Channel Number (0-99).

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 )

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.