// -----------------------------------------------------------------------------
/// @file  led.h
/// @brief File description
// -----------------------------------------------------------------------------
//  Micro-Key bv
//  Industrieweg 28, 9804 TG Noordhorn
//  Postbus 92, 9800 AB Zuidhorn
//  The Netherlands
//  Tel: +31 594 503020
//  Fax: +31 594 505825
//  Email: support@microkey.nl
//  Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
//  (c) 2017 Micro-Key bv
// -----------------------------------------------------------------------------

/// @defgroup {group_name} {group_description}
/// Description

/// @file led.h
/// @ingroup {group_name}


#ifndef LED_INC_LED_H_
#define LED_INC_LED_H_


// -----------------------------------------------------------------------------
// Include files 
// -----------------------------------------------------------------------------
#include <stdbool.h>

#include "platform.h"
#include "IODevice.h"

// -----------------------------------------------------------------------------
// Constant and macro definitions 
// -----------------------------------------------------------------------------



// -----------------------------------------------------------------------------
// Type definitions.
// -----------------------------------------------------------------------------

struct Led
{
   struct IODevice device;
   T_PL_GPIO ledGpio;
   bool status;
};

// -----------------------------------------------------------------------------
// Function declarations 
// -----------------------------------------------------------------------------


ErrorStatus LED_construct (struct Led* self);

/** ----------------------------------------------------------------------------
 * LED_turnOn
 * Turns on the LED identified with the ID
 *
 * @param   ledID                      Unique identifier of the LED
 *
 * @return  ErrorStatus                SUCCESS if init was successful
 *                                     ERROR otherwise
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern ErrorStatus LED_turnOn(struct Led* led);

/** ----------------------------------------------------------------------------
 * LED_turnOff
 * Turns off the LED identified with the ID
 *
 * @param   ledID                      Unique identifier of the LED
 *
 * @return  ErrorStatus                SUCCESS if init was successful
 *                                     ERROR otherwise
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern ErrorStatus LED_turnOff(struct Led* led);

#endif /* LED_INC_LED_H_ */