blinkenlight
[Interface specifications]


Detailed Description

A blinking lightThe blinkenlight interface is used to switch on and off a flashing indicator light, and to set it's flash period.

This interface accepts no configuration requests.

#define PLAYER_BLINKENLIGHT_DATA_STATE   1
#define PLAYER_BLINKENLIGHT_CMD_STATE   1
 Command subtype: state.
#define PLAYER_BLINKENLIGHT_CMD_POWER   2
 Command subtype: light.
#define PLAYER_BLINKENLIGHT_CMD_COLOR   3
 Command subtype: color.
#define PLAYER_BLINKENLIGHT_CMD_PERIOD   4
 Command subtype: period.
#define PLAYER_BLINKENLIGHT_CMD_DUTYCYCLE   5
 Command subtype: dutycycle.
typedef struct
player_blinkenlight_data 
player_blinkenlight_data_t
typedef struct
player_blinkenlight_cmd 
player_blinkenlight_cmd_t
typedef struct
player_blinkenlight_cmd_power 
player_blinkenlight_cmd_power_t
typedef struct
player_blinkenlight_cmd_color 
player_blinkenlight_cmd_color_t
typedef struct
player_blinkenlight_cmd_period 
player_blinkenlight_cmd_period_t
typedef struct
player_blinkenlight_cmd_dutycycle 
player_blinkenlight_cmd_dutycycle_t

Define Documentation

#define PLAYER_BLINKENLIGHT_DATA_STATE   1

Data subtype: state


Typedef Documentation

Command: color (PLAYER_BLINKENLIGHT_CMD_COLOR) This blinkenlight command sets the color of the light.

Command: dutycycle (PLAYER_BLINKENLIGHT_CMD_DUTYCYCLE) This blinkenlight command sets the ratio of light-on to light-off time in one on/off blink cycle.

Command: period (PLAYER_BLINKENLIGHT_CMD_PERIOD) This blinkenlight command sets the duration of one on/off blink cycle in seconds.

Command: power (PLAYER_BLINKENLIGHT_CMD_POWER) This blinkenlight command turns the light on or off.

Command: state (PLAYER_BLINKENLIGHT_CMD_STATE) This blinkenlight command sets the complete current state of the indicator light.

Data: state (PLAYER_BLINKENLIGHT_DATA_STATE) The blinkenlight data provides the current state of the indicator light.


Last updated 12 September 2005 21:38:45