Maxim Integrated / Mbed OS HSP_RPC_GUI

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   USBDevice

Fork of HSP_Release by Jerry Bradshaw

Embed: (wiki syntax)

« Back to documentation index

HspLed Class Reference
Public Types | Public Member Functions

HspLed Class Reference

Driver for the HSP Led, supports different blink rates and patterns. More...

#include <HspLed.h>

Public Types

enum  eMode
 

define all of the modes the LED can support

More...
typedef enum HspLed::eMode eMode_t
 define all of the modes the LED can support

Public Member Functions

void blink (uint32_t mSeconds)
 Blink the HSP LED at a set time interval.
void pattern (uint32_t pattern, uint32_t mSeconds)
 Start rotating the LED through a 32-bit pattern at a mS rate specified.
void on (void)
 Turn the LED on.
void off (void)
 Turn the LED off.
void service (void)
 Update the LED.

Detailed Description

Driver for the HSP Led, supports different blink rates and patterns.

Definition at line 43 of file HspLed.h.

Member Typedef Documentation

typedef enum HspLed::eMode eMode_t

define all of the modes the LED can support

Member Enumeration Documentation

enum eMode

define all of the modes the LED can support

Definition at line 49 of file HspLed.h.

Member Function Documentation

void blink ( uint32_t  mSeconds )

Blink the HSP LED at a set time interval.

Parameters:
mSecondsNumber of seconds to set the timer interval

Definition at line 60 of file HspLed.cpp.

void off ( void   )

Turn the LED off.

Definition at line 82 of file HspLed.cpp.

void on ( void   )

Turn the LED on.

Definition at line 75 of file HspLed.cpp.

void pattern ( uint32_t  pattern,
uint32_t  mSeconds 
)

Start rotating the LED through a 32-bit pattern at a mS rate specified.

Parameters:
pattern32-bit pattern to rotate through
mSecondsthe amount of time to take per bit in the pattern

Definition at line 67 of file HspLed.cpp.

void service ( void   )

Update the LED.

Definition at line 99 of file HspLed.cpp.

Generated on Tue Jul 12 2022 17:59:20 by  doxygen 1.7.2