I2C 10-segment LED gauge bar. More...

#include <sg_104020006_LEDBar.hpp>

Inheritance diagram for SG::LEDBar:

Collaboration diagram for SG::LEDBar:

[legend]

Classes
struct	Data
	The command is 16 bits wide, and the colour data is 12 x 16 bits. More...

Public Member Functions
virtual	~LEDBar (void)
	Destructor. More...

	LEDBar (const std::string &n="")
	Constructor. More...

virtual LEDBar &	all_on (void)

virtual LEDBar &	all_off (void)

virtual LEDBar &	toggle (const size_t led_idx, const uint8_t intensity=127)

virtual LEDBar &	send_data (const Data &data)

virtual GroveGPIO &	send_2_bytes (uint16_t bits)
	Send 16 bits (2 bytes). More...

virtual GroveGPIO &	send_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 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

I2C 10-segment LED gauge bar.

The LED segments are as follows:

one red
one yellow
eight green

This twig uses a MY-Semi MY9221 LED control chip. Each LED segment can be individually controlled, and set to different intensity levels.

Connect the OLED display to the right-hand-side GPIO interface.

See also: http://www.seeedstudio.com/wiki/Grove_-_LED_Bar; http://www.seeedstudio.com/depot/Grove-LED-Bar-v20-p-2474.html; http://www.seeedstudio.com/wiki/images/9/98/MY9221_DS_1.0.pdf; http://www.my-semi.com.tw/file/MY9221_BF_3.0.pdf

Constructor & Destructor Documentation

◆ ~LEDBar()

SG::LEDBar::~LEDBar ( void )

virtual

Destructor.

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

Referenced by SG::LEDBar::Data::Data().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LEDBar()

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

Constructor.

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

Referenced by SG::LEDBar::Data::Data().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ all_off()

SG::LEDBar & SG::LEDBar::all_off ( void )

virtual

References SG::LEDBar::Data::colour, and send_data().

Referenced by SG::LEDBar::Data::Data(), and ledbar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ all_on()

SG::LEDBar & SG::LEDBar::all_on ( void )

virtual

References SG::LEDBar::Data::colour, and send_data().

Referenced by SG::LEDBar::Data::Data(), and ledbar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_description()

std::string SG::GroveBase::get_description ( void ) const

virtualinherited

Return a multi-word 1-line description of this object.

References SG::demangle(), SG::GroveBase::get_name(), SG::GroveBase::get_sku(), SG::GroveBase::get_type_name(), SG::GroveBase::is_grove_gpio(), SG::GroveBase::is_grove_i2c(), SG::GroveBase::is_grove_uart(), and SG::BeagleBone::Detect::to_string().

Referenced by buzzer(), chainable_rgb_led(), common_oled(), SG::GroveBase::get_name(), SG::GroveI2CDigital::GroveI2CDigital(), SG::CommonOLED::set_display_bitmap(), SG::CommonOLED::set_orientation(), temperature(), variable_led(), and SG::GroveI2CDigital::write_block().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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!=()

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==()

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!=(), SG::Buzzer::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:

◆ 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:

◆ send_data()

SG::LEDBar & SG::LEDBar::send_data ( const Data & data )

virtual

References SG::LEDBar::Data::colour, SG::LEDBar::Data::command, SG::SGpp::get(), SG::GpioManagement::get_bool(), SG::SGpp::gpio, SG::GpioManagement::set_high(), SG::GpioManagement::set_low(), and SG::GpioManagement::set_value().

Referenced by all_off(), all_on(), and SG::LEDBar::Data::Data().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggle()

SG::LEDBar & SG::LEDBar::toggle	(	const size_t	led_idx,
		const uint8_t	intensity = `127`
	)

virtual

Referenced by SG::LEDBar::Data::Data().

Here is the caller 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

EGroveType SG::GroveBase::grove_type

inherited

Grove type.

Referenced by SG::GroveBase::get_sku(), SG::GroveBase::get_type(), SG::GroveBase::get_type_name(), and SG::GroveBase::operator=().

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

src-groves/sg_104020006_LEDBar.hpp
src-groves/sg_104020006_LEDBar.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~LEDBar()

◆ LEDBar()

Member Function Documentation

◆ all_off()

◆ all_on()

◆ get_description()

◆ get_name()

◆ get_sku()

◆ get_type()

◆ get_type_name()

◆ is_grove_gpio()

◆ is_grove_i2c()

◆ is_grove_uart()

◆ operator!=()

◆ operator==()

◆ send_2_bytes()

◆ send_byte()

◆ send_data()

◆ toggle()

Member Data Documentation

◆ grove_name

◆ grove_type