LED API - Revision history

Mahong at 09:34, 11 March 2019

2019-03-11T09:34:48Z

← Older revision		Revision as of 09:34, 11 March 2019
Line 3:		Line 3:
	=== <big>open</big> ===		=== <big>open</big> ===
	<syntaxhighlight lang="c">int led_open()</syntaxhighlight >		<syntaxhighlight lang="c">int led_open()</syntaxhighlight >
	Open the LED device, which contains all the ~~LEDs’~~ service.		Open the LED device, which contains all the LED service.
	This operation should be used before other operations.		This operation should be used before other operations.

Line 17:		Line 17:
	<syntaxhighlight lang="c">int led_close()</syntaxhighlight >		<syntaxhighlight lang="c">int led_close()</syntaxhighlight >
	Close the LED device, which contains all the LEDs’ service.		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.		The open and close API are pair operations. If you don’t want to use this device, you should call the close API to release this device.

	{\|class="wizarpostable"		{\|class="wizarpostable"

Mahong: /* get_status */

2018-05-03T02:34:00Z

get_status

← Older revision		Revision as of 02:34, 3 May 2018
Line 92:		Line 92:
	! scope="row" colspan="2" \| Returns		! scope="row" colspan="2" \| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, ~~success~~; <0 [[Error_code\|error code]].		\| int \|\| The result code, > 0, LED on; =0, LED off; <0 [[Error_code\|error code]].
	\|}		\|}

Mahong at 07:32, 2 May 2018

2018-05-02T07:32:40Z

← Older revision		Revision as of 07:32, 2 May 2018
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"

Mahong at 06:17, 2 May 2018

2018-05-02T06:17:19Z

← Older revision		Revision as of 06:17, 2 May 2018
Line 1:		Line 1:
	== ~~Functions~~ ==		== API Overview==
	The calling sequence is [[#open\|open]]>[[#turn_on\|turn_on]]/[[#turn_off\|turn_off]]/[[#get_status\|get_status]]>[[#close\|close ]]		The calling sequence is [[#open\|open]]>[[#turn_on\|turn_on]]/[[#turn_off\|turn_off]]/[[#get_status\|get_status]]>[[#close\|close ]]
	=== open ===		=== <big>open</big> ===
	int led_open()		<syntaxhighlight lang="c">int led_open()</syntaxhighlight >
	Open the LED device, which contains all the LEDs’ service.		Open the LED device, which contains all the LEDs’ service.
	This operation should be used before other operations.		This operation should be used before other operations.

	~~'''Parameters'''~~		{\|class="wizarpostable"
			\|-
	~~'''~~Returns~~'''~~		! scope="row" colspan="2" \| Returns
			\|-
			\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}


	~~The result code, >= 0, success; <0 [[Error_code\|error code]].~~		=== <big>close</big> ===
			<syntaxhighlight lang="c">int led_close()</syntaxhighlight >
	=== close ===
	int led_close()
	Close the LED device, which contains all the LEDs’ service.		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.		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.

	~~'''Parameters'''~~		{\|class="wizarpostable"
			\|-
	~~'''~~Returns~~'''~~		! scope="row" colspan="2" \| Returns
			\|-
			\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}


	~~The result code, >= 0, success; <0 [[Error_code\|error code]].~~		=== <big>turn_on</big>===
			<syntaxhighlight lang="c">int led_on(unsigned int nLedIndex)</syntaxhighlight >
	=== turn_on===
	int led_on(unsigned int nLedIndex)
	Turn on the specified LED.		Turn on the specified LED.

	~~'''Parameters'''~~		{\|class="wizarpostable"
	{\|
	\|-		\|-
	\| '~~'nLedIndex~~'' \|\| unsigned int \|\| Index of led, >= 0 && < MAX_LED_COUNT		! scope="row" colspan="2" \| Parameters
			\|-
			\| nLedIndex \|\| '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT
	\|}		\|}
	~~'''Returns'''~~

	The result code, >= 0, success; <0 [[Error_code\|error code]].
			{\|class="wizarpostable"
			\|-
			! scope="row" colspan="2" \| Returns
			\|-
			\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}

	=== turn_off===
	int led_off(unsigned int nLedIndex)		=== <big>turn_off</big>===
			<syntaxhighlight lang="c">int led_off(unsigned int nLedIndex)</syntaxhighlight >
	Turn off the specified LED.		Turn off the specified LED.

			{\|class="wizarpostable"
			\|-
			! scope="row" colspan="2" \| Parameters
			\|-
			\| nLedIndex \|\| '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT
			\|}


	~~'''Parameters'''~~		{\|class="wizarpostable"
	{\|		\|-
			! scope="row" colspan="2" \| Returns
	\|-		\|-
	\| ~~''nLedIndex'' \|\| unsigned~~ int \|\| ~~Index of led~~, >= 0 && < ~~MAX_LED_COUNT~~		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}
	~~'''Returns'''~~

	~~The result code, >= 0, success; <0 [[Error_code\|error code]].~~

	=== get_status===		=== <big>get_status</big>===
	int led_get_status(unsigned int nLedIndex)		<syntaxhighlight lang="c">int led_get_status(unsigned int nLedIndex)</syntaxhighlight >
	Get the status of the specified LED.		Get the status of the specified LED.

			{\|class="wizarpostable"
			\|-
			! scope="row" colspan="2" \| Parameters
			\|-
			\| nLedIndex \|\| '''unsigned int:''' Index of led, >= 0 && < MAX_LED_COUNT
			\|}

	~~'''Parameters'''~~
	{\|		{\|class="wizarpostable"
	\|-		\|-
	\| ~~''nLedIndex''~~ \|\| ~~unsigned~~ int \|\| ~~Index of led~~, >= 0 && < ~~MAX_LED_COUNT~~		! scope="row" colspan="2" \| Returns
			\|-
			\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}
	~~'''Returns'''~~

	~~The result code, > 0, LED on; = 0, LED off; <0 [[Error_code\|error code]].~~

Mahong: /* Functions */

2018-04-19T07:16:55Z

Functions

← Older revision		Revision as of 07:16, 19 April 2018
Line 30:		Line 30:
	{\|		{\|
	\|-		\|-
	\| ''nLedIndex'' \|\| Index of led, >= 0 && < MAX_LED_COUNT		\| ''nLedIndex'' \|\| unsigned int \|\| Index of led, >= 0 && < MAX_LED_COUNT
	\|}		\|}
	'''Returns'''		'''Returns'''
Line 44:		Line 44:
	{\|		{\|
	\|-		\|-
	\| ''nLedIndex'' \|\| Index of led, >= 0 && < MAX_LED_COUNT		\| ''nLedIndex'' \|\| unsigned int \|\| Index of led, >= 0 && < MAX_LED_COUNT
	\|}		\|}
	'''Returns'''		'''Returns'''
Line 58:		Line 58:
	{\|		{\|
	\|-		\|-
	\| ''nLedIndex'' \|\| Index of led, >= 0 && < MAX_LED_COUNT		\| ''nLedIndex'' \|\| unsigned int \|\| Index of led, >= 0 && < MAX_LED_COUNT
	\|}		\|}
	'''Returns'''		'''Returns'''

	The result code, > 0, LED on; = 0, LED off; <0 [[Error_code\|error code]].		The result code, > 0, LED on; = 0, LED off; <0 [[Error_code\|error code]].

Mahong: Created page with "== Functions == The calling sequence is open>turn_on/turn_off/get_status>close === open === int led_open() Op..."

2018-04-13T07:13:27Z

Created page with "== Functions == The calling sequence is open>turn_on/turn_off/get_status>close === open === int led_open() Op..."

New page

== Functions ==
The calling sequence is [[#open|open]]>[[#turn_on|turn_on]]/[[#turn_off|turn_off]]/[[#get_status|get_status]]>[[#close|close ]]
=== open ===
int led_open()
Open the LED device, which contains all the LEDs’ service.
This operation should be used before other operations.

'''Parameters'''

'''Returns'''

The result code, >= 0, success; <0 [[Error_code|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.

'''Parameters'''

'''Returns'''

The result code, >= 0, success; <0 [[Error_code|error code]].

=== turn_on===
int led_on(unsigned int nLedIndex)
Turn on the specified LED.

'''Parameters'''
{|
|-
| ''nLedIndex'' || Index of led, >= 0 && < MAX_LED_COUNT
|}
'''Returns'''

The result code, >= 0, success; <0 [[Error_code|error code]].

=== turn_off===
int led_off(unsigned int nLedIndex)
Turn off the specified LED.

'''Parameters'''
{|
|-
| ''nLedIndex'' || Index of led, >= 0 && < MAX_LED_COUNT
|}
'''Returns'''

The result code, >= 0, success; <0 [[Error_code|error code]].

=== get_status===
int led_get_status(unsigned int nLedIndex)
Get the status of the specified LED.

'''Parameters'''
{|
|-
| ''nLedIndex'' || Index of led, >= 0 && < MAX_LED_COUNT
|}
'''Returns'''

The result code, > 0, LED on; = 0, LED off; <0 [[Error_code|error code]].