M5Unified
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
m5::M5Unified Class Reference

#include <M5Unified.hpp>

Collaboration diagram for m5::M5Unified:
Collaboration graph
[legend]

Classes

struct  config_t
 

Public Member Functions

M5GFX & getDisplay (size_t index)
 
M5GFX & Displays (size_t index)
 
std::size_t getDisplayCount (void) const
 
std::size_t addDisplay (M5GFX &dsp)
 
int32_t getDisplayIndex (m5gfx::board_t board)
 
int32_t getDisplayIndex (std::initializer_list< m5gfx::board_t > board_list)
 
bool setPrimaryDisplay (std::size_t index)
 
bool setPrimaryDisplayType (std::initializer_list< m5gfx::board_t > board_list)
 
bool setPrimaryDisplayType (m5gfx::board_t board)
 
void setLogDisplayIndex (size_t index)
 Set the display to show logs. More...
 
void setLogDisplayType (std::initializer_list< m5gfx::board_t > board_list)
 
void setLogDisplayType (m5gfx::board_t board)
 
std::uint32_t getUpdateMsec (void) const
 milli seconds at the time the update was called More...
 
board_t getBoard (void) const
 
void update (void)
 To call this function in a loop function. More...
 
void begin (void)
 Perform initialization process at startup. More...
 
void begin (config_t cfg)
 Perform initialization process at startup. More...
 

Static Public Member Functions

static int8_t getPin (pin_name_t name)
 
static config_t config (void)
 
static void delay (uint32_t msec)
 
static uint32_t millis (void)
 
static uint32_t micros (void)
 

Public Attributes

M5GFX Display
 
M5GFX & Lcd = Display
 
IMU_Class Imu
 
Log_Class Log
 
Power_Class Power
 
RTC8563_Class Rtc
 
Touch_Class Touch
 
Button_Class BtnA
 
Button_Class BtnB
 
Button_Class BtnC
 
Button_Class BtnEXT
 
Button_Class BtnPWR
 
I2C_Class & In_I2C = m5::In_I2C
 for internal I2C device More...
 
I2C_Class & Ex_I2C = m5::Ex_I2C
 for external I2C device (Port.A) More...
 
Speaker_Class Speaker
 
Mic_Class Mic
 

Detailed Description

Definition at line 68 of file M5Unified.hpp.

Member Function Documentation

◆ addDisplay()

std::size_t m5::M5Unified::addDisplay ( M5GFX &  dsp)

Definition at line 1227 of file M5Unified.cpp.

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

◆ begin() [1/2]

void m5::M5Unified::begin ( config_t  cfg)
inline

Perform initialization process at startup.

Definition at line 311 of file M5Unified.hpp.

Here is the call graph for this function:

◆ begin() [2/2]

void m5::M5Unified::begin ( void  )
inline

Perform initialization process at startup.

Definition at line 303 of file M5Unified.hpp.

Here is the caller graph for this function:

◆ config()

static config_t m5::M5Unified::config ( void  )
inlinestatic

Definition at line 271 of file M5Unified.hpp.

◆ delay()

static void m5::M5Unified::delay ( uint32_t  msec)
inlinestatic

Definition at line 276 of file M5Unified.hpp.

Here is the caller graph for this function:

◆ Displays()

M5GFX& m5::M5Unified::Displays ( size_t  index)
inline

Definition at line 239 of file M5Unified.hpp.

Here is the call graph for this function:

◆ getBoard()

board_t m5::M5Unified::getBoard ( void  ) const
inline

get the board type of the runtime environment.

Returns
board type

Definition at line 297 of file M5Unified.hpp.

Here is the caller graph for this function:

◆ getDisplay()

M5GFX & m5::M5Unified::getDisplay ( size_t  index)

Definition at line 1222 of file M5Unified.cpp.

Here is the caller graph for this function:

◆ getDisplayCount()

std::size_t m5::M5Unified::getDisplayCount ( void  ) const
inline

Definition at line 241 of file M5Unified.hpp.

Here is the caller graph for this function:

◆ getDisplayIndex() [1/2]

int32_t m5::M5Unified::getDisplayIndex ( m5gfx::board_t  board)

Definition at line 1239 of file M5Unified.cpp.

Here is the caller graph for this function:

◆ getDisplayIndex() [2/2]

int32_t m5::M5Unified::getDisplayIndex ( std::initializer_list< m5gfx::board_t >  board_list)

Definition at line 1249 of file M5Unified.cpp.

Here is the call graph for this function:

◆ getPin()

static int8_t m5::M5Unified::getPin ( pin_name_t  name)
inlinestatic

Definition at line 235 of file M5Unified.hpp.

◆ getUpdateMsec()

std::uint32_t m5::M5Unified::getUpdateMsec ( void  ) const
inline

milli seconds at the time the update was called

Definition at line 269 of file M5Unified.hpp.

◆ micros()

static uint32_t m5::M5Unified::micros ( void  )
inlinestatic

Definition at line 290 of file M5Unified.hpp.

◆ millis()

static uint32_t m5::M5Unified::millis ( void  )
inlinestatic

Definition at line 285 of file M5Unified.hpp.

◆ setLogDisplayIndex()

void m5::M5Unified::setLogDisplayIndex ( size_t  index)

Set the display to show logs.

Definition at line 1281 of file M5Unified.cpp.

Here is the call graph for this function:

◆ setLogDisplayType() [1/2]

void m5::M5Unified::setLogDisplayType ( m5gfx::board_t  board)
inline

Definition at line 266 of file M5Unified.hpp.

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

◆ setLogDisplayType() [2/2]

void m5::M5Unified::setLogDisplayType ( std::initializer_list< m5gfx::board_t >  board_list)

Definition at line 1286 of file M5Unified.cpp.

Here is the call graph for this function:

◆ setPrimaryDisplay()

bool m5::M5Unified::setPrimaryDisplay ( std::size_t  index)

Definition at line 1259 of file M5Unified.cpp.

Here is the caller graph for this function:

◆ setPrimaryDisplayType() [1/2]

bool m5::M5Unified::setPrimaryDisplayType ( m5gfx::board_t  board)
inline

Definition at line 259 of file M5Unified.hpp.

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

◆ setPrimaryDisplayType() [2/2]

bool m5::M5Unified::setPrimaryDisplayType ( std::initializer_list< m5gfx::board_t >  board_list)

Definition at line 1273 of file M5Unified.cpp.

Here is the call graph for this function:

◆ update()

void m5::M5Unified::update ( void  )

To call this function in a loop function.

don't break;

don't break;

Definition at line 1056 of file M5Unified.cpp.

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

Member Data Documentation

◆ BtnA

Button_Class m5::M5Unified::BtnA

Definition at line 219 of file M5Unified.hpp.

◆ BtnB

Button_Class m5::M5Unified::BtnB

Definition at line 220 of file M5Unified.hpp.

◆ BtnC

Button_Class m5::M5Unified::BtnC

Definition at line 221 of file M5Unified.hpp.

◆ BtnEXT

Button_Class m5::M5Unified::BtnEXT

Definition at line 222 of file M5Unified.hpp.

◆ BtnPWR

Button_Class m5::M5Unified::BtnPWR

Definition at line 223 of file M5Unified.hpp.

◆ Display

M5GFX m5::M5Unified::Display

Definition at line 199 of file M5Unified.hpp.

◆ Ex_I2C

I2C_Class& m5::M5Unified::Ex_I2C = m5::Ex_I2C

for external I2C device (Port.A)

Definition at line 229 of file M5Unified.hpp.

◆ Imu

IMU_Class m5::M5Unified::Imu

Definition at line 202 of file M5Unified.hpp.

◆ In_I2C

I2C_Class& m5::M5Unified::In_I2C = m5::In_I2C

for internal I2C device

Definition at line 226 of file M5Unified.hpp.

◆ Lcd

M5GFX& m5::M5Unified::Lcd = Display

Definition at line 200 of file M5Unified.hpp.

◆ Log

Log_Class m5::M5Unified::Log

Definition at line 203 of file M5Unified.hpp.

◆ Mic

Mic_Class m5::M5Unified::Mic

Definition at line 233 of file M5Unified.hpp.

◆ Power

Power_Class m5::M5Unified::Power

Definition at line 204 of file M5Unified.hpp.

◆ Rtc

RTC8563_Class m5::M5Unified::Rtc

Definition at line 205 of file M5Unified.hpp.

◆ Speaker

Speaker_Class m5::M5Unified::Speaker

Definition at line 231 of file M5Unified.hpp.

◆ Touch

Touch_Class m5::M5Unified::Touch

Definition at line 206 of file M5Unified.hpp.

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