aliases.hpp

Go to the documentation of this file.

/**
 * @file aliases.hpp
 * @brief Optional convenience aliases for SBL namespaces
 *
 * Include this header to bring driver functions and common types
 * into the sbl:: namespace for shorter code. This is opt-in.
 *
 * Without aliases (explicit):
 *   sbl::driver::Gpio::set_mode(pin, sbl::driver::PinMode::Output);
 *   sbl::driver::Timer::delay_ms(500);
 *
 * With aliases (convenient):
 *   sbl::Gpio::set_mode(pin, sbl::PinMode::Output);
 *   sbl::Timer::delay_ms(500);
 */
 
#ifndef SBL_ALIASES_HPP_
#define SBL_ALIASES_HPP_
 
#include <sbl/driver/gpio.hpp>
#include <sbl/driver/timer.hpp>
#include <sbl/driver/init.hpp>
 
namespace sbl {
 
// Driver class aliases
using Gpio = driver::Gpio;
using Timer = driver::Timer;
using PinMode = driver::PinMode;
 
// Driver function aliases
using driver::init;
 
} // namespace sbl
 
#endif // SBL_ALIASES_HPP_