Buzzer.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Buzzer settings
 *
 *  Use the function GetBuzzer() to get a handle to pass on to the other functions.
 *  Use the method Buzzer_release(BUZZERHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include buzzer_example.cpp
 *
 ************************************************/
#ifndef CC_BUZZER_H
#define CC_BUZZER_H
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *BUZZERHANDLE;
 
EXTERN_C
CCAUXDLL_API
BUZZERHANDLE
CCAUXDLL_CALLING_CONV
GetBuzzer(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Buzzer_release(BUZZERHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_getFrequency(BUZZERHANDLE, uint16_t *frequency);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_getVolume(BUZZERHANDLE, uint16_t *volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t *volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_getTrigger(BUZZERHANDLE, bool *trigger);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_setVolume(BUZZERHANDLE, uint16_t volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_setTrigger(BUZZERHANDLE, bool trigger);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_setActive(BUZZERHANDLE, ComponentLocation location);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Buzzer_getActive(BUZZERHANDLE, ComponentLocation *location);
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_BUZZER_H */