![]() |
DVBCore
22.3.0
Open Source DVB Engine
|
Header file - Function prototypes for front panel control. More...
#include "techtype.h"
Go to the source code of this file.
Enumerations | |
enum | E_FRONTPANEL_WAKEUP_TYPE { WAKEUP_UNKNOWN = 0, WAKEUP_TIMER, WAKEUP_USER } |
enum | E_LED_STATE { LED_OFF = 0, LED_ON, LED_BLINKING } |
Functions | |
void | STB_FPInitialise (void) |
Initialise the Front Panel and Remote Control components. | |
void | STB_FPKeyEnable (BOOLEAN enable) |
Globally enables the front panel keys. More... | |
void | STB_FPRemoteEnable (BOOLEAN enable) |
Globally enables the remote control keys. More... | |
void | STB_FPSetHandsetCode (U16BIT hset_code) |
Sets the handset code/id of the remote control. More... | |
void | STB_FPDisplayString (const char *string, U8BIT scrollstep, U16BIT scrollrate) |
Show a static or scrolling text string on the front panel. More... | |
void | STB_FPSetClock (U16BIT mjd, U16BIT year, U8BIT month, U8BIT day, U8BIT hours, U8BIT minutes, U8BIT seconds) |
Set the current date on the front panel. More... | |
void | STB_FPShowClock (BOOLEAN show) |
Instructs the front panel to show/hide the time. More... | |
void | STB_FPSetWakeUpTime (U16BIT mjd, U16BIT year, U8BIT month, U8BIT day, U8BIT hours, U8BIT minutes, U32BIT time_in_mins) |
Sets the local time when the front panel should come out of standby. The date is passed as mjd and as year, month and day and the number of minutes until the wake up is also passed for an easier implementation. It is implementation specific which parameters to use. More... | |
void | STB_FPSetStandby (BOOLEAN standby) |
Controls the box low power standby status. More... | |
E_FRONTPANEL_WAKEUP_TYPE | STB_FPGetWakeUpType (void) |
Returns the wake up type. More... | |
void | STB_FPSetLedState (U8BIT led_id, E_LED_STATE led_state, U16BIT period, U8BIT duty_cycle) |
Turns front panel LEDs on or off. More... | |
void | STB_FPWaitForUserInput (void) |
U8BIT | STB_FPGetDisplaySize (void) |
void | STB_FPAnimation (U8BIT anim_type, U8BIT frame_rate) |
void | STB_FPRefreshWatchdog (void) |
void | STB_FPSetWdogPeriod (U16BIT watchdog_period) |
void | STB_FPSetAutoStandby (BOOLEAN auto_standby) |
void | STB_FPSetAutoStandbyTime (U8BIT minute) |
Header file - Function prototypes for front panel control.
void STB_FPDisplayString | ( | const char * | string, |
U8BIT | scrollstep, | ||
U16BIT | scrollrate | ||
) |
Show a static or scrolling text string on the front panel.
string | text string to be displayed |
scrollstep | characters to move each step (0=static) |
scrollrate | delay between steps (in units of 10mS) |
E_FRONTPANEL_WAKEUP_TYPE STB_FPGetWakeUpType | ( | void | ) |
Returns the wake up type.
void STB_FPKeyEnable | ( | BOOLEAN | enable | ) |
Globally enables the front panel keys.
enable | set to TRUE to enable keys, FALSE otherwise |
void STB_FPRemoteEnable | ( | BOOLEAN | enable | ) |
Globally enables the remote control keys.
enable | set to TRUE to enable keys, FALSE otherwise |
void STB_FPSetClock | ( | U16BIT | mjd, |
U16BIT | year, | ||
U8BIT | month, | ||
U8BIT | day, | ||
U8BIT | hours, | ||
U8BIT | minutes, | ||
U8BIT | seconds | ||
) |
Set the current date on the front panel.
mjd | modified Julian day |
year | year |
month | month |
day | day |
hours | hours |
minutes | minutes |
seconds | seconds |
void STB_FPSetHandsetCode | ( | U16BIT | hset_code | ) |
Sets the handset code/id of the remote control.
hset_code | The 16 bit handset code |
void STB_FPSetLedState | ( | U8BIT | led_id, |
E_LED_STATE | led_state, | ||
U16BIT | period, | ||
U8BIT | duty_cycle | ||
) |
Turns front panel LEDs on or off.
led_id | The LED number to control |
led_state | TRUE to turn on, FALSE to turn off |
void STB_FPSetStandby | ( | BOOLEAN | standby | ) |
Controls the box low power standby status.
standby | if TRUE instructs the front panel to put the box in low power standby, if FALSE instructs the front panel to wake the box up from low power stand-by |
void STB_FPSetWakeUpTime | ( | U16BIT | mjd, |
U16BIT | year, | ||
U8BIT | month, | ||
U8BIT | day, | ||
U8BIT | hours, | ||
U8BIT | minutes, | ||
U32BIT | time_in_mins | ||
) |
Sets the local time when the front panel should come out of standby. The date is passed as mjd and as year, month and day and the number of minutes until the wake up is also passed for an easier implementation. It is implementation specific which parameters to use.
mjd | modified Julian day of the wake up time |
year | wake up year |
month | wake up month |
day | wake up day |
hours | wake up hour |
minutes | wake up minute |
time_in_mins | Number of minutes until wakeup |
void STB_FPShowClock | ( | BOOLEAN | show | ) |
Instructs the front panel to show/hide the time.
BOOLEAN | show if TRUE, show the time, else hide it. |