LED API: Difference between revisions
No edit summary |
No edit summary |
||
| Line 37: | Line 37: | ||
| nLedIndex || '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT | | nLedIndex || '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT | ||
|} | |} | ||
{| | |||
|- | |||
| | |||
|} | |||
{|class="wizarpostable" | {|class="wizarpostable" | ||
| Line 57: | Line 60: | ||
| nLedIndex || '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT | | nLedIndex || '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT | ||
|} | |} | ||
{| | |||
|- | |||
| | |||
|} | |||
{|class="wizarpostable" | {|class="wizarpostable" | ||
| Line 77: | Line 83: | ||
| nLedIndex || '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT | | nLedIndex || '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT | ||
|} | |} | ||
{| | |||
|- | |||
| | |||
|} | |||
{|class="wizarpostable" | {|class="wizarpostable" | ||
Revision as of 07:32, 2 May 2018
API Overview
The calling sequence is open>turn_on/turn_off/get_status>close
open
int led_open()
Open the LED device, which contains all the LEDs’ service. This operation should be used before other operations.
| Returns | |
|---|---|
| int | The result code, >= 0, success; <0 error code. |
close
int led_close()
Close the LED device, which contains all the LEDs’ service. The open and close apis are pair operations. If you don’t want to use this device, you should call the close api to release this device.
| Returns | |
|---|---|
| int | The result code, >= 0, success; <0 error code. |
turn_on
int led_on(unsigned int nLedIndex)
Turn on the specified LED.
| Parameters | |
|---|---|
| nLedIndex | unsigned int: Index of led, >= 0 && < MAX_LED_COUNT |
| Returns | |
|---|---|
| int | The result code, >= 0, success; <0 error code. |
turn_off
int led_off(unsigned int nLedIndex)
Turn off the specified LED.
| Parameters | |
|---|---|
| nLedIndex | unsigned int: Index of led, >= 0 && < MAX_LED_COUNT |
| Returns | |
|---|---|
| int | The result code, >= 0, success; <0 error code. |
get_status
int led_get_status(unsigned int nLedIndex)
Get the status of the specified LED.
| Parameters | |
|---|---|
| nLedIndex | unsigned int: Index of led, >= 0 && < MAX_LED_COUNT |
| Returns | |
|---|---|
| int | The result code, >= 0, success; <0 error code. |