modm API documentation
modm::DogM081< SPI, CS, RS > Class Template Reference

EA DOGM081x-A. More...

#include <modm/driver/display/ea_dog.hpp>

Inheritance diagram for modm::DogM081< SPI, CS, RS >:
modm::St7036< SPI, CS, RS, 8, 1 > modm::CharacterDisplay modm::IOStream

Public Types

enum  Command {
  ClearDisplay = 0b00000001, ResetCursor = 0b00000010, IncrementCursor = 0b00000110, DecrementCursor = 0b00000100,
  DisableDisplay = 0b00001000, EnableDisplay = 0b00001100, DisableCursor = 0b00001000, EnableCursor = 0b00001010,
  DisableCursorBlink = 0b00001000, EnableCursorBlink = 0b00001001, ShiftCursorLeft = 0b00010000, ShiftCursorRight = 0b00010100
}
 

Public Member Functions

IOStreamascii ()
 set the output mode to ASCII style for integer types
 
IOStreambin ()
 set the output mode to binary style for integer types
 
void clear ()
 clear the entire display and reset the cursor
 
IOStreamendl ()
 
virtual void execute (Command command)
 
IOStreamflush ()
 
IOStreamget (char &c)
 Reads one character and returns it if available. Otherwise, returns IOStream::eof.
 
IOStreamget (char *s, size_t n)
 
template<size_t N>
IOStreamget (char (&s)[N])
 
IOStreamhex ()
 set the output mode to hexadecimal style for integer types
 
virtual void initialize ()
 Initialize the display. More...
 
IOStreamoperator<< (const bool &v)
 
IOStreamoperator<< (const char &v)
 
IOStreamoperator<< (const uint8_t &v)
 
IOStreamoperator<< (const int16_t &v)
 
IOStreamoperator<< (const uint16_t &v)
 
IOStreamoperator<< (const int32_t &v)
 
IOStreamoperator<< (const uint32_t &v)
 
IOStreamoperator<< (const int64_t &v)
 
IOStreamoperator<< (const uint64_t &v)
 
IOStreamoperator<< (const int &v)
 
IOStreamoperator<< (const unsigned int &v)
 
IOStreamoperator<< (const float &v)
 
IOStreamoperator<< (const double &v)
 
IOStreamoperator<< (const char *s)
 
IOStreamoperator<< (const void *p)
 write the hex value of a pointer
 
template<class Ret , class... Args>
IOStreamoperator<< (Ret (*pointer)(Args...))
 Write the hex value of any function pointer.
 
IOStreamoperator<< (IOStream &(*format)(IOStream &))
 
IOStreamprintf (const char *fmt,...)))
 
virtual void setCursor (uint8_t column, uint8_t line)
 
IOStreamvprintf (const char *fmt, va_list vlist)))
 
void write (char c)
 
virtual void writeRaw (char c)
 

Static Public Attributes

static constexpr char eof = -1
 

Protected Member Functions

void writeBin (uint8_t value)
 
void writeCommand (uint8_t command)
 
void writeDouble (const double &value)
 
void writeFloat (float value)
 
void writeHex (uint8_t value)
 
void writeInteger (int16_t value)
 
void writeInteger (uint16_t value)
 
void writeInteger (int32_t value)
 
void writeInteger (uint32_t value)
 
void writeInteger (int64_t value)
 
void writeInteger (uint64_t value)
 
template<typename T >
void writeIntegerMode (const T v)
 
void writePointer (const void *value)
 

Protected Attributes

uint8_t column
 
uint8_t line
 
uint8_t lineCount
 
uint8_t lineWidth
 
Writer writer
 

Detailed Description

template<typename SPI, typename CS, typename RS>
class modm::DogM081< SPI, CS, RS >

EA DOGM081x-A.

See also
Datasheet

Member Enumeration Documentation

Enum ValuesDocumentation
ClearDisplay 

Clear the display content.

ResetCursor 

Set cursor to position (0,0)

IncrementCursor 

Increments address upon write.

DecrementCursor 

Decrements address upon write.

DisableDisplay 

Disable display.

EnableDisplay 

Enable display.

DisableCursor 

Disable cursor.

EnableCursor 

Enable cursor.

DisableCursorBlink 

Disable blinking cursor.

EnableCursorBlink 

Enable blinking cursor.

ShiftCursorLeft 

Shift cursor left.

ShiftCursorRight 

Shift cursor right.

Member Function Documentation

IOStream & modm::IOStream::get ( char *  s,
size_t  n 
)
inherited

reads characters into NULL delimited c string in contrast to the standard implementation, this does not care about newline characters in the input

virtual void modm::St7036< SPI, CS, RS, Width, Heigth >::initialize ( )
inheritedvirtual

Initialize the display.

The display needs some time to initialize after startup. You have to wait at least 50 ms until calling this method.

virtual void modm::St7036< SPI, CS, RS, Width, Heigth >::setCursor ( uint8_t  column,
uint8_t  line 
)
inheritedvirtual

Set cursor to specified position

Parameters
columnhorizontal position
linevertical position

Implements modm::CharacterDisplay.

void modm::CharacterDisplay::write ( char  c)
inherited

Write a character

This method provides an automatic wrap-round if the output reaches the end of the current line or a newline character is detected.

Use writeRaw() if this behavior is not wanted.

virtual void modm::St7036< SPI, CS, RS, Width, Heigth >::writeRaw ( char  c)
inheritedvirtual

Write a raw character at cursor position

Unlike write() no further processing will occur.

See also
write()

Implements modm::CharacterDisplay.


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