/**
 * \file
 * \brief Buzzer driver interface.
 * \author Erich Styger, erich.styger@hslu.ch
 * \license SPDX-License-Identifier: BSD-3-Clause
 * This is the interface to the buzzer.
 */

#ifndef BUZZER_H_
#define BUZZER_H_

#include "platform.h"
#include <stdint.h>

#if PL_CONFIG_USE_BUZZER
#if PL_CONFIG_USE_SHELL
  #include "McuShell.h"

/*!
 * \brief Shell parser routine.
 * \param cmd Pointer to command line string.
 * \param handled Pointer to status if command has been handled. Set to TRUE if command was understood.
 * \param io Pointer to stdio handle
 * \return Error code, ERR_OK if everything was ok.
 */
  uint8_t BUZ_ParseCommand(const unsigned char *cmd, bool *handled, const McuShell_StdIOType *io);
#endif

/*!
 * \brief Let the buzzer sound for a specified time.
 * \param freqHz Frequency of the sound. Ignored if the buzzer is not supporting it.
 * \param durationMs Duration in milliseconds.
 * \return Error code, ERR_OK if everything is fine.
 */
uint8_t BUZ_Beep(uint16_t freqHz, uint16_t durationMs);

typedef enum {
  BUZ_TUNE_WELCOME,
  BUZ_TUNE_BUTTON,
  BUZ_TUNE_BUTTON_LONG,
  BUZ_TUNE_MAZE_DESTINATION,
  BUZ_TUNE_JINGLE_BELLS,
  BUZ_TUNE_NOF_TUNES
} BUZ_Tunes;

/*!
 * \brief Plays a tune
 * \param tune Tune to play
 * \return ERR_OK or error code
 */
uint8_t BUZ_PlayTune(BUZ_Tunes tune);

/*!
 * \brief Initialization of the driver
 */
void BUZ_Init(void);

void BUZ_StopTune(void);

void BUZ_StopBeep(void);

/*!
 * \brief De-initialization of the driver
 */
void BUZ_Deinit(void);
#endif /* PL_CONFIG_USE_BUZZER */

#endif /* BUZZER_H_ */