blinkenlight
[Interface specifications]

Collaboration diagram for blinkenlight:


Detailed Description

An indicator light.

The blinkenlight interface is used to switch on and off an indicator light, set its color (if supported) and to set its flash period and duty cycle (if supported).

This interface accepts no configuration requests.

#define PLAYER_BLINKENLIGHT_DATA_STATE   1
#define PLAYER_BLINKENLIGHT_CMD_STATE   1
#define PLAYER_BLINKENLIGHT_CMD_POWER   2
#define PLAYER_BLINKENLIGHT_CMD_COLOR   3
#define PLAYER_BLINKENLIGHT_CMD_FLASH   4
typedef player_blinkenlight_data player_blinkenlight_data_t
 Data: state (PLAYER_BLINKENLIGHT_DATA_STATE) The blinkenlight data provides the current state of the indicator light.
typedef player_blinkenlight_cmd player_blinkenlight_cmd_t
 Command: state (PLAYER_BLINKENLIGHT_CMD_STATE) This blinkenlight command sets the complete current state of the indicator light.
typedef player_blinkenlight_cmd_power player_blinkenlight_cmd_power_t
 Command: power (PLAYER_BLINKENLIGHT_CMD_POWER) This blinkenlight command turns the light on or off.
typedef player_blinkenlight_cmd_color player_blinkenlight_cmd_color_t
 Command: color (PLAYER_BLINKENLIGHT_CMD_COLOR) This blinkenlight command sets the color of the light.
typedef player_blinkenlight_cmd_flash player_blinkenlight_cmd_flash_t
 Command: flash (PLAYER_BLINKENLIGHT_CMD_FLASH) This blinkenlight command sets the duration of one on/off blink cycle in seconds and the ratio of light on/off time (0.0 to 1.0 ).

Last updated 12 September 2005 21:38:45