private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Performed some doxygen updates

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@423 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
mmi
2018-01-12 12:59:03 +00:00
parent ed3b53ce32
commit 7f42b00161
4 changed files with 168 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h
View File

@@ -1,6 +1,6 @@
// -----------------------------------------------------------------------------
/// @file Buzzer.h
/// @brief File description
/// \file Buzzer.h
/// \brief File description
// -----------------------------------------------------------------------------
// Micro-Key bv
// Industrieweg 28, 9804 TG Noordhorn
@@ -17,16 +17,15 @@
// (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------
/**
* Buzzer implementation
* \defgroup Buzzer Package Buzzer
* \ingroup HAL
* @{
*/
#ifndef INC_BUZZER_H_
#define INC_BUZZER_H_
/**
* Buzzer implementation
* \defgroup Buzzer Buzzer
* \ingroup HAL
* @{
*/
// -----------------------------------------------------------------------------
// Include files
@@ -62,102 +61,110 @@
// Type definitions.
// -----------------------------------------------------------------------------
/**
* \ingroup Buzzer
* \class Buzzer
* The Buzzer struct that can be used as an object
*/
struct Buzzer
{
// General
bool initialized;
struct Gpio* gpio;
bool initialized; //!< Flag indicating initialisation status
struct Gpio* gpio; //!< The GPIO to use for the buzzer
// Functionary properties
unsigned int pulseWidth;
unsigned int pulseWidth; //!< Pulsewidth of the buzzer tone
// Task properties
bool runTask;
bool runPeriodically;
SemaphoreHandle_t semaphore;
xTaskHandle taskHandle;
int taskPriority;
uint16_t stackSize;
bool runTask; //!< keep-alive flag for buzzer task
bool runPeriodically; //!< Indicates single or periodical run
SemaphoreHandle_t semaphore; //!< Task semaphore for synchronisation
xTaskHandle taskHandle; //!< FreeRTOS task handle
int taskPriority; //!< FreeRTOS task priority
uint16_t stackSize; //!< FreeRTOS task stacksize
};
// -----------------------------------------------------------------------------
// Function declarations
// -----------------------------------------------------------------------------
/** ----------------------------------------------------------------------------
* Buzzer_construct
* Constructor for a new buzzer instance
/** Buzzer_construct
* \brief Constructor for a new buzzer instance
*
* @param self The buzzer object that gets created
* @param gpio The GPIO to use
* @param taskPriority FreeRTOS task priority
* @param stackSize FreeRTOS stack size
* This function creates a new buzzer object
*
* @return ErrorStatus SUCCESS if constructor was successful,
* Created by: mmi
* \memberof Buzzer
*
* \param self The buzzer object that gets created
* \param[in] gpio The GPIO to use
* \param[in] taskPriority FreeRTOS task priority
* \param[in] stackSize FreeRTOS stack size
* \return ErrorStatus SUCCESS if constructor was successful,
* including generation/start of task
* ERROR otherwise
*
* @todo
* -----------------------------------------------------------------------------
* \todo
*/
extern ErrorStatus Buzzer_construct(struct Buzzer* self, struct Gpio* gpio, int taskPriority, uint16_t stackSize);
/** ----------------------------------------------------------------------------
* Buzzer_destruct
/** Buzzer_destruct
* Destructor for buzzer instance. Also removes the buzzer task
*
* @param self The buzzer instance to destruct
* Created by: mmi
* \memberof Buzzer
*
* @return void
* \param self The buzzer instance to destruct
* \return void
*
* @todo
* -----------------------------------------------------------------------------
* \todo
*/
extern void Buzzer_destruct(struct Buzzer* self);
/** ----------------------------------------------------------------------------
* Buzzer_start
* Starts the buzzer with a repeating tone.
/** Buzzer_start
* \brief Starts the buzzer with a repeating tone.
* Tone length is given with argument pulseWidth
*
* @param self The buzzer instance to use
* @param pulseWidth The length of the tone in ms. Also defines
* Created by: mmi
* \memberof Buzzer
*
* \param self The buzzer instance to use
* \param[in] pulseWidth The length of the tone in ms. Also defines
* the length of the pause between two
* tones
*
* @return void
* \return void
*
* @todo
* -----------------------------------------------------------------------------
* \todo
*/
extern void Buzzer_start(struct Buzzer* self, unsigned int pulseWidth);
/** ----------------------------------------------------------------------------
* Buzzer_stop
* Stops the repeating buzzer tone
/** Buzzer_stop
* \brief Stops the repeating buzzer tone
*
* @param self THe buzzer instance to stop
* Created by: mmi
* \memberof Buzzer
*
* @return void
* \param self The buzzer instance to stop *
* \return void
*
* @todo
* -----------------------------------------------------------------------------
* \todo
*/
extern void Buzzer_stop(struct Buzzer* self);
/** ----------------------------------------------------------------------------
* Buzzer_singleTone
/** Buzzer_singleTone
* Creates a single tone with the length given in pulseWidth
*
* @param self The buzzer instance to use
* @param pulseWidth The length of the tone in ms
* Created by: mmi
* \memberof Buzzer
*
* @return void
* \param self The buzzer instance to use
* \param[in] pulseWidth The length of the tone in ms
* \return void
*
* @todo
* -----------------------------------------------------------------------------
* \todo
*/
extern void Buzzer_singleTone(struct Buzzer* self, unsigned int pulseWidth);