ITCLEDSetControl

Sets the active period and blink rate for the specified LED.

Syntax

HRESULT ITCLEDSetControl (
    int LedNo, 
    BYTE *ActivePeriod, 
    BYTE *BlinkRate
)

Parameters

LedNo
[in] LED number:
12 for LED_VM3_USER_GREEN
13 for LED_VM3_USER_RED

ActivePeriod
[out] Buffer to store active period. For valid values, see Remarks.

BlinkRate
[out] Buffer to store blink rate. For valid values, see Remarks.

Return Values

ITC_SUCCESS
Success.

ITC_ERROR
Failure.

ITC_ERROR_FUNCTION_NOT_SUPPORTED
Platform does not support the function.

Remarks

The next table lists valid values for ActivePeriod and BlinkRate:

Value ActivePeriod (in seconds) BlinkRate (in Hz)
0 Off Off
1 1/4 1/4
2 1/2 1/2
3 1 1
4 2 2
5 4 4
6 8 8
7 Always on Always on

For example, if ActivePeriod = 3 and BlinkRate = 5, the LED blinks for 1 second at a rate of 4 blinks/second.

Header and Library Files

Header File: ITC50.H

Library: ITC50.LIB

More Information

LED Control Functions