Seeed Grove ++  v0.0.1-2386
Linux C++ Library For Seeed Grove Devices
SG::Buzzer Class Reference

Audible buzzer. More...

#include <sg_107020000_Buzzer.hpp>

Inheritance diagram for SG::Buzzer:
Collaboration diagram for SG::Buzzer:

Public Member Functions

virtual ~Buzzer (void)
 Destructor. More...
 
 Buzzer (const std::string &n="")
 Constructor. More...
 
 Buzzer (const Buzzer &rhs)
 Copy constructor. More...
 
Buzzeroperator= (const Buzzer &rhs)
 Assignment. More...
 
Buzzerturn_on (void)
 Turn the buzzer on. More...
 
Buzzerturn_off (void)
 Turn the buzzer off. More...
 
Buzzerturn_on (const std::chrono::high_resolution_clock::duration &duration)
 Turn the buzzer on for a limited amount of time, then turn it off again. More...
 
Buzzerturn_off (const std::chrono::high_resolution_clock::duration &duration)
 Turn the buzzer off for a limited amount of time, then turn it on again. More...
 
virtual GroveGPIOsend_2_bytes (uint16_t bits)
 Send 16 bits (2 bytes). More...
 
virtual GroveGPIOsend_byte (uint8_t byte)
 Send a single byte. More...
 
virtual bool is_grove_uart (void) const
 Determine if this is a Grove UART device. More...
 
virtual bool is_grove_i2c (void) const
 Determine if this is a Grove I2C device. More...
 
virtual bool is_grove_gpio (void) const
 Determine if this is a Grove GPIO device. More...
 
virtual uint32_t get_sku (void) const
 Return a guess as to the Seeed SKU number based on the grove type. More...
 
virtual std::string get_type_name (void) const
 Return a short text string representing the grove type. More...
 
virtual EGroveType get_type (void) const
 Return the grove type. More...
 
virtual std::string get_name (void) const
 Return the user-supplied name. More...
 
virtual std::string get_description (void) const
 Return a multi-word 1-line description of this object. More...
 
bool operator== (const Buzzer &rhs) const
 Test object equality. More...
 
bool operator!= (const Buzzer &rhs) const
 Test object equality. More...
 
bool operator== (const GroveBase &rhs) const
 Test object equality. More...
 
bool operator!= (const GroveBase &rhs) const
 Test object equality. More...
 

Public Attributes

EGroveType grove_type
 Grove type. More...
 
std::string grove_name
 User-supplied name. More...
 

Detailed Description

Audible buzzer.

Description Image
Buzzer connected to the Grove UART interface.
Buzzer_1.jpg
See also
http://www.seeedstudio.com/wiki/Grove_-_Buzzer
http://www.seeedstudio.com/depot/Grove-Buzzer-p-768.html

Constructor & Destructor Documentation

◆ ~Buzzer()

SG::Buzzer::~Buzzer ( void  )
virtual

Destructor.

References SG::SGpp::get(), SG::SGpp::gpio, and SG::GpioManagement::gpio_unexport().

Here is the call graph for this function:

◆ Buzzer() [1/2]

SG::Buzzer::Buzzer ( const std::string &  n = "")

Constructor.

References SG::SGpp::get(), SG::SGpp::gpio, SG::GpioManagement::gpio_export(), and SG::GpioManagement::kOutput.

Here is the call graph for this function:

◆ Buzzer() [2/2]

SG::Buzzer::Buzzer ( const Buzzer rhs)

Copy constructor.

Member Function Documentation

◆ get_description()

◆ get_name()

virtual std::string SG::GroveBase::get_name ( void  ) const
inlinevirtualinherited

Return the user-supplied name.

References SG::GroveBase::get_description(), SG::GroveBase::grove_name, SG::GroveBase::is_grove_gpio(), SG::GroveBase::is_grove_i2c(), and SG::GroveBase::is_grove_uart().

Referenced by SG::GroveBase::get_description(), SG::GroveBase::operator=(), and SG::GroveBase::operator==().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_sku()

virtual uint32_t SG::GroveBase::get_sku ( void  ) const
inlinevirtualinherited

Return a guess as to the Seeed SKU number based on the grove type.

References SG::get_sku_from_grove_type(), and SG::GroveBase::grove_type.

Referenced by SG::GroveBase::get_description().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_type()

virtual EGroveType SG::GroveBase::get_type ( void  ) const
inlinevirtualinherited

Return the grove type.

References SG::GroveBase::grove_type.

Referenced by SG::GroveI2CDigital::get_address_from_type(), SG::GroveBase::operator=(), and SG::GroveBase::operator==().

Here is the caller graph for this function:

◆ get_type_name()

virtual std::string SG::GroveBase::get_type_name ( void  ) const
inlinevirtualinherited

Return a short text string representing the grove type.

References SG::GroveBase::grove_type, and SG::to_string().

Referenced by SG::GroveBase::get_description().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is_grove_gpio()

virtual bool SG::GroveGPIO::is_grove_gpio ( void  ) const
inlinevirtualinherited

Determine if this is a Grove GPIO device.

See also
SG::GroveGPIO

Implements SG::GroveBase.

◆ is_grove_i2c()

virtual bool SG::GroveGPIO::is_grove_i2c ( void  ) const
inlinevirtualinherited

Determine if this is a Grove I2C device.

See also
SG::GroveI2C

Implements SG::GroveBase.

◆ is_grove_uart()

virtual bool SG::GroveGPIO::is_grove_uart ( void  ) const
inlinevirtualinherited

Determine if this is a Grove UART device.

See also
SG::GroveUART

Implements SG::GroveBase.

◆ operator!=() [1/2]

bool SG::GroveBase::operator!= ( const GroveBase rhs) const
inlineinherited

Test object equality.

References SG::GroveBase::operator==().

Here is the call graph for this function:

◆ operator!=() [2/2]

bool SG::Buzzer::operator!= ( const Buzzer rhs) const
inline

Test object equality.

References operator==(), turn_off(), and turn_on().

Here is the call graph for this function:

◆ operator=()

SG::Buzzer & SG::Buzzer::operator= ( const Buzzer rhs)

Assignment.

References SG::GroveBase::operator=().

Here is the call graph for this function:

◆ operator==() [1/2]

bool SG::GroveBase::operator== ( const GroveBase rhs) const
inherited

Test object equality.

References SG::GroveBase::get_name(), and SG::GroveBase::get_type().

Referenced by SG::GroveBase::operator!=(), operator==(), SG::TemperatureAndHumiditySensor::operator==(), SG::TemperatureSensor::operator==(), and SG::I2CADC::operator==().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator==() [2/2]

bool SG::Buzzer::operator== ( const Buzzer rhs) const

Test object equality.

References SG::GroveBase::operator==().

Referenced by operator!=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ send_2_bytes()

SG::GroveGPIO & SG::GroveGPIO::send_2_bytes ( uint16_t  bits)
virtualinherited

Send 16 bits (2 bytes).

References SG::GroveGPIO::send_byte().

Here is the call graph for this function:

◆ send_byte()

SG::GroveGPIO & SG::GroveGPIO::send_byte ( uint8_t  byte)
virtualinherited

Send a single byte.

References SG::SGpp::get(), SG::SGpp::gpio, SG::GpioManagement::set_high(), and SG::GpioManagement::set_low().

Referenced by SG::GroveGPIO::send_2_bytes(), and SG::ChainableRGBLED::turn_on().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ turn_off() [1/2]

SG::Buzzer & SG::Buzzer::turn_off ( void  )

Turn the buzzer off.

References SG::SGpp::get(), SG::SGpp::gpio, and SG::GpioManagement::set_low().

Referenced by buzzer(), and operator!=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ turn_off() [2/2]

SG::Buzzer & SG::Buzzer::turn_off ( const std::chrono::high_resolution_clock::duration &  duration)

Turn the buzzer off for a limited amount of time, then turn it on again.

This call is synchronous, and will not return until the buzzer has cycled off then on again. The duration should be more than 5 milliseconds, otherwise the buzzer may not behave as expected.

References SG::SGpp::get(), SG::SGpp::gpio, SG::GpioManagement::set_high(), and SG::GpioManagement::set_low().

Here is the call graph for this function:

◆ turn_on() [1/2]

SG::Buzzer & SG::Buzzer::turn_on ( void  )

Turn the buzzer on.

References SG::SGpp::get(), SG::SGpp::gpio, and SG::GpioManagement::set_high().

Referenced by buzzer(), and operator!=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ turn_on() [2/2]

SG::Buzzer & SG::Buzzer::turn_on ( const std::chrono::high_resolution_clock::duration &  duration)

Turn the buzzer on for a limited amount of time, then turn it off again.

This call is synchronous, and will not return until the buzzer has cycled on then off again. The duration should be more than 5 milliseconds, otherwise the buzzer may not behave as expected.

References SG::SGpp::get(), SG::SGpp::gpio, SG::GpioManagement::set_high(), and SG::GpioManagement::set_low().

Here is the call graph for this function:

Member Data Documentation

◆ grove_name

std::string SG::GroveBase::grove_name
inherited

User-supplied name.

Referenced by SG::GroveBase::get_name(), and SG::GroveBase::operator=().

◆ grove_type


The documentation for this class was generated from the following files: