common_data_RDL.hpp File Reference

file to hold common data and functions used by many Displays Project Name: Display_Lib_RPI More...

#include <cstdint>
#include <chrono>
#include <thread>
#include <array>
#include <lgpio.h>
#include "utility_data_RDL.hpp"

Go to the source code of this file.

Namespaces
namespace	rdlib
	Name space for common utilities.

Macros
#define	delaySecRDL   lguSleep
#define	delayMilliSecRDL(x)   std::this_thread::sleep_for(std::chrono::milliseconds(x))
#define	delayMicroSecRDL(x)   std::this_thread::sleep_for(std::chrono::microseconds(x))

Enumerations
enum	rdlib::Return_Codes_e : uint8_t {   rdlib::Success = 0 , rdlib::Reserved = 1 , rdlib::WrongFont = 2 , rdlib::CharScreenBounds = 3 ,   rdlib::CharFontASCIIRange = 4 , rdlib::CharArrayNullptr = 5 , rdlib::FontDataEmpty = 6 , rdlib::BitmapDataEmpty = 7 ,   rdlib::BitmapScreenBounds = 8 , rdlib::BitmapLargerThanScreen = 9 , rdlib::BitmapVerticalSize = 10 , rdlib::BitmapHorizontalSize = 11 ,   rdlib::BitmapSize = 12 , rdlib::CustomCharLen = 13 , rdlib::BufferSize = 14 , rdlib::BufferEmpty = 15 ,   rdlib::SPIOpenFailure = 16 , rdlib::SPICloseFailure = 17 , rdlib::I2CbeginFail = 18 , rdlib::I2CcloseFail = 19 ,   rdlib::ShapeScreenBounds = 20 , rdlib::MemoryAError = 21 , rdlib::WrongInputPCBType = 22 , rdlib::GpioChipDevice = 23 ,   rdlib::GpioPinClaim = 24 , rdlib::GpioPinFree = 25 , rdlib::WrongModeChosen = 26 , rdlib::GenericError = 27 ,   rdlib::UnknownError = 28 , rdlib::InvalidRAMLocation = 29 }

Functions
std::string	rdlib::ReturnCodetoText (rdlib::Return_Codes_e code)
	Prints out Enum label and help message for given enum code from Return_Codes_e.
uint16_t	rdlib::LibraryVersion (void)
	get the library version number

Variables
constexpr std::array< const char *, 30 >	rdlib::ReturnCodesStrings

Detailed Description

file to hold common data and functions used by many Displays Project Name: Display_Lib_RPI

Author

Gavin Lyons

Macro Definition Documentation

delayMicroSecRDL

#define delayMicroSecRDL

(

x

)

std::this_thread::sleep_for(std::chrono::microseconds(x))

micro second delay abstraction

delayMilliSecRDL

#define delayMilliSecRDL

(

x

)

std::this_thread::sleep_for(std::chrono::milliseconds(x))

milli second delay abstraction

delaySecRDL

#define delaySecRDL   lguSleep

second delay abstraction