Program Listing for File buzzer.hpp

Return to documentation for file (src/tap/communication/sensors/buzzer/buzzer.hpp)

/*
 * Copyright (c) 2020-2021 Advanced Robotics at the University of Washington <robomstr@uw.edu>
 *
 * This file is part of Taproot.
 *
 * Taproot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Taproot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Taproot.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef TAPROOT_BUZZER_HPP_
#define TAPROOT_BUZZER_HPP_

#include <cstdint>

namespace tap
{
namespace gpio
{
class Pwm;
}

namespace buzzer
{
void playNote(gpio::Pwm *pwmController, uint32_t frequency);

void silenceBuzzer(gpio::Pwm *pwmController);
}  // namespace buzzer
}  // namespace tap

#endif  // TAPROOT_BUZZER_HPP_