IToiFrontPanelService Interface Reference


Description

The IToiFrontPanelService 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.

import "IToiFrontPanelService.idl";

List of all members.

Public Member Functions

void GetLedCount (out long numberOfLeds)
void GetLedInfo (in long index, out TToiLedInfo info) raises (TToiInvalidArgumentException)
void SetLedState (in long index, in TToiLedState state) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
void GetLedState (in long index, out TToiLedState state) raises (TToiInvalidArgumentException)
void GetSegmentDisplayInfo (out TToiSegmentDisplayInfo info) raises (TToiOperationNotSupportedException)
void SetSegmentDisplayState (in TToiSegmentDisplayState state) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
void GetSegmentDisplayState (out TToiSegmentDisplayState state) raises (TToiOperationNotSupportedException)
void IsSegmentDisplaySupported (out boolean isSupported)

Classes

struct  TToiLedInfo
struct  TToiLedState
struct  TToiSegmentDisplayInfo
struct  TToiSegmentDisplayState

Public Types

enum  TToiColor {
  COLOR_OFF, COLOR_GREEN, COLOR_RED, COLOR_ORANGE,
  COLOR_BLUE, COLOR_YELLOW
}
enum  TToiSegmentDisplayModes { SEGMENT_DISPLAY_MODE_TEXT, SEGMENT_DISPLAY_MODE_CLOCK }
typedef sequence< TToiColorTToiColorSequence

Member Typedef Documentation

A sequence of colors.


Member Enumeration Documentation

List of possible colors for a LED.

Enumerator:
COLOR_OFF 

The LED is turned off.

COLOR_GREEN 

The LED is lit with a green light.

COLOR_RED 

The LED is lit with a red light.

COLOR_ORANGE 

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

COLOR_BLUE 

The LED is lit with a blue light.

COLOR_YELLOW 

The LED is lit with a yellow light.

Enumerates the segment display's different modes.

Enumerator:
SEGMENT_DISPLAY_MODE_TEXT 

Regular text is shown on the segment display.

SEGMENT_DISPLAY_MODE_CLOCK 

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


Member Function Documentation

void IToiFrontPanelService::GetLedCount ( out long  numberOfLeds  ) 

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.
void IToiFrontPanelService::GetLedInfo ( in long  index,
out TToiLedInfo  info 
) 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.
void IToiFrontPanelService::GetLedState ( in long  index,
out TToiLedState  state 
) 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.
void IToiFrontPanelService::GetSegmentDisplayInfo ( out TToiSegmentDisplayInfo  info  )  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.
void IToiFrontPanelService::GetSegmentDisplayState ( out TToiSegmentDisplayState  state  )  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.
void IToiFrontPanelService::IsSegmentDisplaySupported ( out boolean  isSupported  ) 

Indicates if the STB is equipped with a segment display.

Return values:
isSupported Set to true if a segment display is present.
void IToiFrontPanelService::SetLedState ( in long  index,
in TToiLedState  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 IToiFrontPanelService::SetSegmentDisplayState ( in TToiSegmentDisplayState  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.