Phidget LED
[Specific Phidgets]

Typedefs
typedef struct _CPhidgetLED *	CPhidgetLEDHandle
Enumerations
enum	CPhidgetLED_CurrentLimit { PHIDGET_LED_CURRENT_LIMIT_20mA = 1, PHIDGET_LED_CURRENT_LIMIT_40mA, PHIDGET_LED_CURRENT_LIMIT_60mA, PHIDGET_LED_CURRENT_LIMIT_80mA }
enum	CPhidgetLED_Voltage { PHIDGET_LED_VOLTAGE_1_7V = 1, PHIDGET_LED_VOLTAGE_2_75V, PHIDGET_LED_VOLTAGE_3_9V, PHIDGET_LED_VOLTAGE_5_0V }
Functions
int	CPhidgetLED_create (CPhidgetLEDHandle *phid)
int	CPhidgetLED_getLEDCount (CPhidgetLEDHandle phid, int *count)
int	CPhidgetLED_getCurrentLimit (CPhidgetLEDHandle phid, CPhidgetLED_CurrentLimit *currentLimit)
int	CPhidgetLED_setCurrentLimit (CPhidgetLEDHandle phid, CPhidgetLED_CurrentLimit currentLimit)
int	CPhidgetLED_getVoltage (CPhidgetLEDHandle phid, CPhidgetLED_Voltage *voltage)
int	CPhidgetLED_setVoltage (CPhidgetLEDHandle phid, CPhidgetLED_Voltage voltage)
int	CPhidgetLED_getBrightness (CPhidgetLEDHandle phid, int index, double *brightness)
int	CPhidgetLED_setBrightness (CPhidgetLEDHandle phid, int index, double brightness)
int	CPhidgetLED_getCurrentLimitIndexed (CPhidgetLEDHandle phid, int index, double *limit)
int	CPhidgetLED_setCurrentLimitIndexed (CPhidgetLEDHandle phid, int index, double limit)

---

Detailed Description

These calls are specific to the Phidget LED object. See your device's User Guide for more specific API details, technical information, and revision details. The User Guide, along with other resources, can be found on the product page for your device.

---

Typedef Documentation

typedef struct _CPhidgetLED* CPhidgetLEDHandle

A Phidget LED handle

---

Enumeration Type Documentation

enum CPhidgetLED_CurrentLimit

The Phidget LED supports these current limits

Enumerator:

PHIDGET_LED_CURRENT_LIMIT_20mA	20mA
PHIDGET_LED_CURRENT_LIMIT_40mA	40mA
PHIDGET_LED_CURRENT_LIMIT_60mA	60mA
PHIDGET_LED_CURRENT_LIMIT_80mA	80mA

enum CPhidgetLED_Voltage

The Phidget LED supports these voltages

Enumerator:

PHIDGET_LED_VOLTAGE_1_7V	1.7V
PHIDGET_LED_VOLTAGE_2_75V	2.75V
PHIDGET_LED_VOLTAGE_3_9V	3.9V
PHIDGET_LED_VOLTAGE_5_0V	5.0V

---

Function Documentation

int CPhidgetLED_create

(

CPhidgetLEDHandle *

phid

)

Creates a Phidget LED handle.

Parameters:

phid

A pointer to an unallocated Phidget LED handle.

int CPhidgetLED_getLEDCount	(	CPhidgetLEDHandle	phid,
		int *	count
	)

Gets the number of LEDs supported by this board.

Parameters:

	phid	An attached phidget LED handle.
	count	The led count.

int CPhidgetLED_getCurrentLimit	(	CPhidgetLEDHandle	phid,
		CPhidgetLED_CurrentLimit *	currentLimit
	)

Gets the current limit. This is for all ouputs.

Parameters:

	phid	An attached phidget LED handle.
	currentLimit	The Current Limit.

int CPhidgetLED_setCurrentLimit	(	CPhidgetLEDHandle	phid,
		CPhidgetLED_CurrentLimit	currentLimit
	)

Sets the current limit. This is for all ouputs.

Parameters:

	phid	An attached phidget LED handle.
	currentLimit	The Current Limit.

int CPhidgetLED_getVoltage	(	CPhidgetLEDHandle	phid,
		CPhidgetLED_Voltage *	voltage
	)

Gets the output voltate. This is for all ouputs.

Parameters:

	phid	An attached phidget LED handle.
	voltage	The Output Voltage.

int CPhidgetLED_setVoltage	(	CPhidgetLEDHandle	phid,
		CPhidgetLED_Voltage	voltage
	)

Sets the output voltage. This is for all ouputs.

Parameters:

	phid	An attached phidget LED handle.
	voltage	The Output Voltage.

int CPhidgetLED_getBrightness	(	CPhidgetLEDHandle	phid,
		int	index,
		double *	brightness
	)

Gets the brightness of an LED.

Parameters:

	phid	An attached phidget LED handle.
	index	The LED index.
	brightness	The LED brightness (0-100).

int CPhidgetLED_setBrightness	(	CPhidgetLEDHandle	phid,
		int	index,
		double	brightness
	)

Sets the brightness of an LED.

Parameters:

	phid	An attached phidget LED handle.
	index	The LED index.
	brightness	The LED brightness (0-100).

int CPhidgetLED_getCurrentLimitIndexed	(	CPhidgetLEDHandle	phid,
		int	index,
		double *	limit
	)

Gets the current limit of an LED.

Parameters:

	phid	An attached phidget LED handle.
	index	The LED index.
	limit	The LED current limit (0-80 mA).

int CPhidgetLED_setCurrentLimitIndexed	(	CPhidgetLEDHandle	phid,
		int	index,
		double	limit
	)

Sets the current limit of an LED.

Parameters:

	phid	An attached phidget LED handle.
	index	The LED index.
	limit	The LED current limit (0-80 mA).