ToiFrontPanelService Interface Reference

---

Description

The ToiFrontPanelService interface provides access to all LEDs and the segment display on the front panel. Buttons on the front panel are NOT handled by this interface. Note that availability of LEDs, segment displays and buttons varies between different STB models.

Service:

This is a service and can be accessed through toi.frontPanelService

import "ToiFrontPanelService.idl";

List of all members.

Public Member Functions
long	getLedCount ()
ToiFrontPanelServiceLedInfo	getLedInfo (in long index) raises (TToiInvalidArgumentException)
void	setLedState (in long index, in ToiFrontPanelServiceLedState state) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
ToiFrontPanelServiceLedState	getLedState (in long index) raises (TToiInvalidArgumentException)
ToiFrontPanelServiceSegmentDisplayInfo	getSegmentDisplayInfo () raises (TToiOperationNotSupportedException)
void	setSegmentDisplayState (in ToiFrontPanelServiceSegmentDisplayState state) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
ToiFrontPanelServiceSegmentDisplayState	getSegmentDisplayState () raises (TToiOperationNotSupportedException)
boolean	isSegmentDisplaySupported ()
Public Attributes
const long	CONFIGURED_INTENSITY = -1
TToiColor
const TToiColor	COLOR_OFF = 0
const TToiColor	COLOR_GREEN = 1
const TToiColor	COLOR_RED = 2
const TToiColor	COLOR_ORANGE = 3
const TToiColor	COLOR_BLUE = 4
const TToiColor	COLOR_YELLOW = 5
const TToiColor	COLOR_WHITE = 6
TToiSegmentDisplayModes
const TToiSegmentDisplayModes	SEGMENT_DISPLAY_MODE_TEXT = 0
const TToiSegmentDisplayModes	SEGMENT_DISPLAY_MODE_CLOCK = 1
Public Types
typedef long	TToiColor
typedef sequence< TToiColor >	TToiColorSequence
typedef long	TToiSegmentDisplayModes

---

Member Typedef Documentation

typedef long ToiFrontPanelService::TToiColor

List of possible colors for a LED.

typedef sequence< TToiColor > ToiFrontPanelService::TToiColorSequence

A sequence of colors.

typedef long ToiFrontPanelService::TToiSegmentDisplayModes

Enumerates the segment display's different modes.

---

Member Function Documentation

long ToiFrontPanelService::getLedCount

(

)

Returns the number of LEDs.

Return values:

numberOfLeds

The number of LEDs deployed on the STB. LED indexing starts at zero and increments to the number of LEDs - 1.

ToiFrontPanelServiceLedInfo ToiFrontPanelService::getLedInfo

(

in long

index

)

raises (TToiInvalidArgumentException)

Get information about a LED.

Parameters:

index

The index for the LED.

Return values:

info	Information about the LED.

Exceptions:

TToiInvalidArgumentException

Raised if any of the parameters to the call are invalid. Also raised if there are no LEDs present.

ToiFrontPanelServiceLedState ToiFrontPanelService::getLedState

(

in long

index

)

raises (TToiInvalidArgumentException)

Get the current state of a given LED.

Parameters:

index

The index for the LED.

Return values:

state

The current state of the LED.

Exceptions:

TToiInvalidArgumentException

Raised if any of the parameters to the call are invalid. Also raised if there are no LEDs present.

ToiFrontPanelServiceSegmentDisplayInfo ToiFrontPanelService::getSegmentDisplayInfo

(

)

raises (TToiOperationNotSupportedException)

Returns information about the segment display.

Return values:

info	Returns information about the segment display.

Exceptions:

TToiOperationNotSupportedException

Raised if the STB doesn't have a segment display.

ToiFrontPanelServiceSegmentDisplayState ToiFrontPanelService::getSegmentDisplayState

(

)

raises (TToiOperationNotSupportedException)

Returns the current state of the segment display.

Return values:

state

The current state of the display.

Exceptions:

TToiOperationNotSupportedException

Raised if the STB doesn't have a segment display.

boolean ToiFrontPanelService::isSegmentDisplaySupported

(

)

Indicates if the STB is equipped with a segment display.

Return values:

isSupported

Set to true if a segment display is present.

void ToiFrontPanelService::setLedState	(	in long	index,
		in ToiFrontPanelServiceLedState	state
	)		raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)

Turn the LED to the desired color and blinking state.

Parameters:

index	The index for the LED.
state	The state to use for the LED.

Exceptions:

TToiInvalidArgumentException	Raised if any of the parameters to the call are invalid. Also raised if there are no LEDs present.
TToiOperationNotSupportedException	Raised if any of the parameters to the call are not supported.

void ToiFrontPanelService::setSegmentDisplayState

(

in ToiFrontPanelServiceSegmentDisplayState

state

)

raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)

Starts a clock or sets text on the segment display.

Parameters:

state

The state to use for the display.

Exceptions:

TToiInvalidArgumentException	Raised if any of the parameters to the call are invalid. An example would be if you try to display text and a clock at the same time.
TToiOperationNotSupportedException	Raised if the STB doesn't have a segment display.

---

Member Data Documentation

const TToiColor ToiFrontPanelService::COLOR_BLUE = 4

The LED is lit with a blue light.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_BLUE.

const TToiColor ToiFrontPanelService::COLOR_GREEN = 1

The LED is lit with a green light.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_GREEN.

const TToiColor ToiFrontPanelService::COLOR_OFF = 0

The LED is turned off.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_OFF.

const TToiColor ToiFrontPanelService::COLOR_ORANGE = 3

The LED is lit with both green and red lights producing an orange color.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_ORANGE.

const TToiColor ToiFrontPanelService::COLOR_RED = 2

The LED is lit with a red light.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_RED.

const TToiColor ToiFrontPanelService::COLOR_WHITE = 6

The LED is lit with a white light.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_WHITE.

const TToiColor ToiFrontPanelService::COLOR_YELLOW = 5

The LED is lit with a yellow light.

This constant can also be accessed from toi.consts.ToiFrontPanelService.COLOR_YELLOW.

const long ToiFrontPanelService::CONFIGURED_INTENSITY = -1

Set intensity to value of cfg.frontpanel.intensity in ToiFrontPanelServiceSegmentDisplayState

This constant can also be accessed from toi.consts.ToiFrontPanelService.CONFIGURED_INTENSITY.

const TToiSegmentDisplayModes ToiFrontPanelService::SEGMENT_DISPLAY_MODE_CLOCK = 1

A clock is shown on the segment display. The clock is updated by the service.

This constant can also be accessed from toi.consts.ToiFrontPanelService.SEGMENT_DISPLAY_MODE_CLOCK.

const TToiSegmentDisplayModes ToiFrontPanelService::SEGMENT_DISPLAY_MODE_TEXT = 0

Regular text is shown on the segment display.

This constant can also be accessed from toi.consts.ToiFrontPanelService.SEGMENT_DISPLAY_MODE_TEXT.