XDK API  3.6.0
Documentation
Files | Typedefs | Enumerations | Enumerator | Functions

This module handles the LED features. The LED control are not thread safe, yet. It is expected that the interface user manages this. More...

+ Collaboration diagram for LED:

Files

file  XDK_LED.h
 

Typedefs

typedef enum LED_Pattern_E LED_Pattern_T
 Typedef to represent the pattern of LED's supported. More...
 
typedef enum LED_E LED_T
 Typedef to represent the inbuilt and external LED. More...
 

Enumerations

enum  LED_E
 Enum to represent the inbuilt and external LED's. More...
 
enum  LED_Pattern_E
 Enum to represent the patterns of LED's supported. More...
 

Functions

Retcode_T LED_Blink (bool enable, LED_T ledToBlink, uint32_t onTimeInMs, uint32_t offTimeInMs)
 This will blink the LED based on the user requested configuration. More...
 
Retcode_T LED_Enable (void)
 This will enable the LED's available on-board. More...
 
Retcode_T LED_Off (LED_T led)
 This will power OFF a particular LED. More...
 
Retcode_T LED_On (LED_T led)
 This will power ON a particular LED. More...
 
Retcode_T LED_Pattern (bool enable, LED_Pattern_T pattern, uint32_t statusTimeInMs)
 This will provide a LED pattern based on the user requested configuration. More...
 
Retcode_T LED_Setup (void)
 This will setup the LED's available on-board. More...
 
Retcode_T LED_Status (LED_T led, uint8_t *status)
 This will provide the status of a particular LED. More...
 
Retcode_T LED_Toggle (LED_T led)
 This will toggle a particular LED. More...
 

Detailed Description

Typedef Documentation

typedef enum LED_E LED_T

Enumeration Type Documentation

enum LED_E
Enumerator
LED_INBUILT_INVALID 
LED_INBUILT_RED 
LED_INBUILT_YELLOW 
LED_INBUILT_ORANGE 
Enumerator
LED_PATTERN_ROLLING 

This is roll through all the in-built LED's periodically forward and reverse

Function Documentation

Retcode_T LED_Blink ( bool  enable,
LED_T  ledToBlink,
uint32_t  onTimeInMs,
uint32_t  offTimeInMs 
)
Parameters
[in]enableBoolean to enable/disable LED blink
[in]ledToBlinkLED to blink (More the one LED can be provided for blinking with a bit-wise OR) Unused if 'enable' is 'false'
[in]onTimeInMsLED ON time while blinking in ms Unused if 'enable' is 'false'
[in]offTimeInMsLED OFF time while blinking in ms Unused if 'enable' is 'false'
Returns
RETCODE_OK on success, or an error code otherwise.
Note
- LED_Blink when enabled, it is expected for the interface user to disable prior to other LED related API calls to avoid misbehavior. It uses software timer internally which is shared with LED_Pattern API. So user is expected to avoid using them in parallel.
Retcode_T LED_Enable ( void  )
Note
By default these are Powered OFF
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LED_Off ( LED_T  led)
Parameters
[in]ledThe LED to be powered OFF (More the one LED can be provided with a bit-wise OR)
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LED_On ( LED_T  led)
Parameters
[in]ledThe LED to be powered ON (More the one LED can be provided with a bit-wise OR)
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LED_Pattern ( bool  enable,
LED_Pattern_T  pattern,
uint32_t  statusTimeInMs 
)
Parameters
[in]enableBoolean to enable/disable LED pattern
[in]patternLED pattern to be enabled Unused if 'enable' is 'false'
[in]statusTimeInMsLED status time until which an ongoing LED pattern change must be held in ms Unused if 'enable' is 'false'
Returns
RETCODE_OK on success, or an error code otherwise.
Note
- LED_Pattern when enabled, it is expected for the interface user to disable prior to other LED related API calls to avoid misbehavior. It uses software timer internally which is shared with LED_Blink API. So user is expected to avoid using them in parallel.

+ Here is the caller graph for this function:

Retcode_T LED_Setup ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LED_Status ( LED_T  led,
uint8_t *  status 
)
Parameters
[in]ledThe LED to be read for status
in/out]status Status on the IO port. User needs to provide memory for the same.
Note
This will read the value on the IO port and provide the same to the user
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LED_Toggle ( LED_T  led)
Parameters
[in]ledThe LED to be toggled (More the one LED can be provided with a bit-wise OR)
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8