Merge pull request #21 from m5stack/develop

0.0.12

Author: lovyan03

docs/ATOMDisplay.md

@@ -24,10 +24,14 @@ Sample Code:
 M5AtomDisplay display;
 
 
-// Set the resolution in the argument (width, height).  default : 1280, 720.
-// 引数で解像度(幅,高さ)を設定できます。 省略時は 1280, 720
+// Set the resolution in the argument (width, height, refresh rate).  default : 1280, 720, 60 .
+// The value of width x height x refresh rate must be within 55,296,000.
+// If the display does not match the supported resolution or frequency of the display, it will not be displayed correctly.
+
+// 引数で解像度(幅,高さ,リフレッシュレート)を設定できます。 省略時は 1280, 720, 60
+// 幅 × 高さ × リフレッシュレート の値が 55,296,000 以下である必要があります。
+// また、ディスプレイが指定の解像度や周波数に対応していない場合は正しく表示されません。
 
-// M5AtomDisplay display( 480, 1920);
 // M5AtomDisplay display(1920, 480);
 // M5AtomDisplay display(1280, 720);
 // M5AtomDisplay display(1024, 768);
@@ -47,22 +51,26 @@ M5AtomDisplay display;
 // M5AtomDisplay display( 160,  80);
 // M5AtomDisplay display(  80, 160);
 // M5AtomDisplay display(  80,  80);
+// M5AtomDisplay display( 480, 1920);
+
+// M5AtomDisplay display(1920, 1080, 24);
+// M5AtomDisplay display(1920, 960, 30);
 
 
 // Depending on the supported resolution of the display, it may not be displayed correctly.
-// You may be able to display it by setting the resolution (width and height) to be output to the display with the  arguments 3 and 4.
-// You can also set the scaling factor for width and height with arguments 5 and 6.
+// You may be able to display it by setting the resolution (width and height) to be output to the display with the  arguments 4 and 5.
+// You can also set the scaling factor for width and height with arguments 6 and 7.
 // If the enlarged resolution is less than the output resolution, there will be a gap around the perimeter of the screen.
 // ディスプレイの対応解像度によっては正しく表示できない場合があります。
-// 引数3と4でディスプレイに出力する解像度(幅,高さ)を設定することで表示できる場合があります。
-// また、引数5と6で幅と高さの拡大倍率を設定できます。
+// 引数4と5でディスプレイに出力する解像度(幅,高さ)を設定することで表示できる場合があります。
+// また、引数6と7で幅と高さの拡大倍率を設定できます。
 // なお拡大後の解像度が出力解像度に満たない場合、画面外周に隙間が生じます。
 
-// M5AtomDisplay display ( 512, 384, 1280, 800, 2, 2 );
+// M5AtomDisplay display ( 512, 384, 60, 1280, 800, 2, 2 );
 
 // ※ The width scaling factor must be a number that is divisible by the width of the output resolution.
 // ※ 幅の拡大倍率は、出力解像度の幅を割り切れる数である必要があります。
-// ex: M5AtomDisplay display ( 400, 250, 1280, 800, 3, 3 );
+// ex: M5AtomDisplay display ( 400, 250, 60, 1280, 800, 3, 3 );
 //  In this example, 1280 is not divisible by 3, so the horizontal scaling factor will be changed to 2.
 //  この例は 1280 を 3で割り切れないため、横方向の拡大倍率は2に変更されます。
 

library.json

@@ -10,7 +10,8 @@
     "type": "git",
     "url": "https://github.com/m5stack/M5GFX.git"
   },
-  "version": "0.0.11",
+  "version": "0.0.12",
   "framework": "arduino",
-  "platforms": "espressif32"
+  "platforms": "espressif32",
+  "headers": "M5GFX.h"
 }

library.properties

@@ -1,5 +1,5 @@
 name=M5GFX
-version=0.0.11
+version=0.0.12
 author=M5Stack
 maintainer=M5Stack
 sentence=Library for M5Stack All Display

src/M5AtomDisplay.h

@@ -7,12 +7,35 @@
 // #include <SPIFFS.h>
 // #include <HTTPClient.h>
 
+#include <sdkconfig.h>
 #include <esp_efuse.h>
 #include <soc/efuse_reg.h>
 
 #include "M5GFX.h"
 #include "lgfx/v1/panel/Panel_M5HDMI.hpp"
 
+#ifndef M5ATOMDISPLAY_LOGICAL_WIDTH
+#define M5ATOMDISPLAY_LOGICAL_WIDTH 1280
+#endif
+#ifndef M5ATOMDISPLAY_LOGICAL_HEIGHT
+#define M5ATOMDISPLAY_LOGICAL_HEIGHT 720
+#endif
+#ifndef M5ATOMDISPLAY_REFRESH_RATE
+#define M5ATOMDISPLAY_REFRESH_RATE 60.0f
+#endif
+#ifndef M5ATOMDISPLAY_OUTPUT_WIDTH
+#define M5ATOMDISPLAY_OUTPUT_WIDTH 0
+#endif
+#ifndef M5ATOMDISPLAY_OUTPUT_HEIGHT
+#define M5ATOMDISPLAY_OUTPUT_HEIGHT 0
+#endif
+#ifndef M5ATOMDISPLAY_SCALE_W
+#define M5ATOMDISPLAY_SCALE_W 0
+#endif
+#ifndef M5ATOMDISPLAY_SCALE_H
+#define M5ATOMDISPLAY_SCALE_H 0
+#endif
+
 class M5AtomDisplay : public lgfx::LGFX_Device
 {
   lgfx::Panel_M5HDMI _panel_instance;
@@ -22,8 +45,17 @@ class M5AtomDisplay : public lgfx::LGFX_Device
 
   m5gfx::board_t getBoard(void) const { return m5gfx::board_t::board_M5AtomDisplay; }
 
-  M5AtomDisplay(uint16_t logical_width = 0, uint16_t logical_height = 0, uint16_t output_width = 0, uint16_t output_height = 0, uint_fast8_t x_scale = 0, uint_fast8_t y_scale = 0)
+  M5AtomDisplay( uint16_t logical_width  = M5ATOMDISPLAY_LOGICAL_WIDTH
+               , uint16_t logical_height = M5ATOMDISPLAY_LOGICAL_HEIGHT
+               , float refresh_rate      = M5ATOMDISPLAY_REFRESH_RATE
+               , uint16_t output_width   = M5ATOMDISPLAY_OUTPUT_WIDTH
+               , uint16_t output_height  = M5ATOMDISPLAY_OUTPUT_HEIGHT
+               , uint_fast8_t scale_w    = M5ATOMDISPLAY_SCALE_W
+               , uint_fast8_t scale_h    = M5ATOMDISPLAY_SCALE_H
+               )
   {
+#if defined (CONFIG_IDF_TARGET_ESP32)
+
     static constexpr int i2c_port =  1;
     static constexpr int i2c_sda  = 25;
     static constexpr int i2c_scl  = 21;
@@ -68,15 +100,19 @@ class M5AtomDisplay : public lgfx::LGFX_Device
 
     {
       static constexpr int SCALE_MAX = 16;
+      static constexpr int RANGE_MAX = 2048;
+
+      if (refresh_rate < 8.0f) { refresh_rate = 8.0f; }
+      if (refresh_rate > 256.0f) { refresh_rate = 256.0f; }
 
       if (output_width)
       {
-        if (output_width  > 1920) { output_width  = 1920; }
+        if (output_width  > RANGE_MAX) { output_width  = RANGE_MAX; }
         if (logical_width > output_width) { logical_width = output_width; }
       }
       if (output_height)
       {
-        if (output_height > 1920) { output_height = 1920; }
+        if (output_height > RANGE_MAX) { output_height = RANGE_MAX; }
         if (logical_height > output_height) { logical_height = output_height; }
       }
 
@@ -97,40 +133,46 @@ class M5AtomDisplay : public lgfx::LGFX_Device
       {
         logical_height = (logical_width * 9) >> 4;
       }
+      if (logical_width  > RANGE_MAX) { logical_width  = RANGE_MAX; }
+      if (logical_height > RANGE_MAX) { logical_height = RANGE_MAX; }
+
+      int limit = 55296000 / refresh_rate;
 
-      if (output_width == 0 && output_height == 0 && x_scale == 0 && y_scale == 0)
+      if (output_width == 0 && output_height == 0 && scale_w == 0 && scale_h == 0)
       {
-        x_scale = 1;
-        y_scale = 1;
+        scale_w = 1;
+        scale_h = 1;
         for (int scale = 2; scale <= SCALE_MAX; ++scale)
         {
           uint32_t scale_height = scale * logical_height;
           uint32_t scale_width = scale * logical_width;
           uint32_t total = scale_width * scale_height;
-          if (scale_width > 1920 || scale_height > 1920 || total >= 1024000) { break; }
-          x_scale = scale;
-          y_scale = scale;
+          if (scale_width > 1920 || scale_height > 1920 || total > limit) { break; }
+          scale_w = scale;
+          scale_h = scale;
         }
-        output_width  = x_scale * logical_width;
-        output_height = y_scale * logical_height;
+        output_width  = scale_w * logical_width;
+        output_height = scale_h * logical_height;
+        if (output_height & 1) { output_height++; }
+        if ((output_width & 1) && (scale_w & 1)) { output_width += scale_w; }
       }
       else
       {
-        if (y_scale == 0)
+        if (scale_h == 0)
         {
-          y_scale = output_height / logical_height;
+          scale_h = output_height / logical_height;
         }
-        if (y_scale > SCALE_MAX) { y_scale = SCALE_MAX; }
-        while (logical_height * y_scale > output_height) { --y_scale; }
+        if (scale_h > SCALE_MAX) { scale_h = SCALE_MAX; }
+        while (logical_height * scale_h > output_height) { --scale_h; }
 
-        if (x_scale == 0)
+        if (scale_w == 0)
         {
-          x_scale = output_width  / logical_width;
+          scale_w = output_width  / logical_width;
         }
-        uint32_t w = output_width / x_scale;
-        while (x_scale > SCALE_MAX || w * x_scale != output_width || logical_width * x_scale > output_width)
+        uint32_t w = output_width / scale_w;
+        while (scale_w > SCALE_MAX || w * scale_w != output_width || logical_width * scale_w > output_width)
         {
-          w = output_width / --x_scale;
+          w = output_width / --scale_w;
         }
       }
 
@@ -139,16 +181,17 @@ class M5AtomDisplay : public lgfx::LGFX_Device
       cfg.memory_height    = output_height ;
       cfg.panel_width      = logical_width ;
       cfg.panel_height     = logical_height;
-      cfg.offset_x         = (output_width  / x_scale - logical_width ) >> 1;
-      cfg.offset_y         = (output_height / y_scale - logical_height) >> 1;
+      cfg.offset_x         = (output_width  / scale_w - logical_width ) >> 1;
+      cfg.offset_y         = (output_height / scale_h - logical_height) >> 1;
       cfg.offset_rotation  = 0;
       cfg.pin_cs       = spi_cs;
       cfg.readable   = false;
       cfg.bus_shared = false;
 
-      _panel_instance.config(cfg);
+      _panel_instance.config(cfg, scale_w, scale_h, refresh_rate);
     }
     setPanel(&_panel_instance);
+#endif
   }
 };
 

src/M5GFX.cpp

@@ -1,8 +1,7 @@
 // Copyright (c) M5Stack. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-#if defined (ESP32) || defined (CONFIG_IDF_TARGET_ESP32) || defined (CONFIG_IDF_TARGET_ESP32S2) || defined (ESP_PLATFORM)
-
+#include <sdkconfig.h>
 #include "M5GFX.h"
 
 #include "lgfx/v1/panel/Panel_ILI9342.hpp"
@@ -16,20 +15,22 @@
 #include <nvs.h>
 #include <esp_log.h>
 #include <driver/i2c.h>
+#include <esp_efuse.h>
 #include <soc/efuse_reg.h>
 
 namespace m5gfx
 {
   static constexpr char LIBRARY_NAME[] = "M5GFX";
 
+  M5GFX* M5GFX::_instance = nullptr;
+
+#if !defined (CONFIG_IDF_TARGET) || defined (CONFIG_IDF_TARGET_ESP32)
   static constexpr std::int32_t axp_i2c_freq = 400000;
   static constexpr std::uint_fast8_t axp_i2c_addr = 0x34;
   static constexpr std::int_fast16_t axp_i2c_port = I2C_NUM_1;
   static constexpr std::int_fast16_t axp_i2c_sda = 21;
   static constexpr std::int_fast16_t axp_i2c_scl = 22;
 
-  M5GFX* M5GFX::_instance = nullptr;
-
   struct Panel_M5Stack : public lgfx::Panel_ILI9342
   {
     Panel_M5Stack(void)
@@ -260,11 +261,6 @@ namespace m5gfx
     }
   };
 
-  M5GFX::M5GFX(void) : LGFX_Device()
-  {
-    if (_instance == nullptr) _instance = this;
-  }
-
   static void _pin_level(std::int_fast16_t pin, bool level)
   {
     lgfx::pinMode(pin, lgfx::pin_mode_t::output);
@@ -309,13 +305,11 @@ namespace m5gfx
     return res;
   }
 
-  static std::uint32_t _get_chip_ver_pkg(void)
-  {
-    std::uint32_t res = REG_GET_FIELD(EFUSE_BLK0_RDATA3_REG, EFUSE_RD_CHIP_VER_PKG);
-#if defined ( EFUSE_RD_CHIP_VER_PKG_4BIT )
-    res |= REG_GET_FIELD(EFUSE_BLK0_RDATA3_REG, EFUSE_RD_CHIP_VER_PKG_4BIT) << 3;
 #endif
-    return res;
+
+  M5GFX::M5GFX(void) : LGFX_Device()
+  {
+    if (_instance == nullptr) _instance = this;
   }
 
   void M5GFX::_set_backlight(lgfx::ILight* bl)
@@ -423,6 +417,7 @@ namespace m5gfx
 
   board_t M5GFX::autodetect(bool use_reset, board_t board)
   {
+#if !defined (CONFIG_IDF_TARGET) || defined (CONFIG_IDF_TARGET_ESP32)
     auto bus_cfg = _bus_spi.config();
 
     panel(nullptr);
@@ -452,7 +447,7 @@ namespace m5gfx
 
     std::uint32_t id;
 
-    std::uint32_t pkg_ver = _get_chip_ver_pkg();
+    std::uint32_t pkg_ver = esp_efuse_get_pkg_ver();
 
     if (pkg_ver == EFUSE_RD_CHIP_VER_PKG_ESP32PICOD4)  /// check PICO-D4 (M5StickC,CPlus,T,T2 / CoreInk / ATOM )
     {
@@ -843,9 +838,10 @@ namespace m5gfx
       }
 
     }
+#endif
 
     board = board_t::board_unknown;
-
+    goto init_clear;
 init_clear:
 
 ESP_LOGI("nvs_board","_board:%d", board);
@@ -885,5 +881,3 @@ ESP_LOGI("nvs_board","_board:%d", board);
   }
 
 }
-
-#endif

src/M5GFX.h

@@ -144,11 +144,19 @@ namespace m5gfx
     , board_M5StackCoreInk
     , board_M5Paper
     , board_M5Tough
-    , board_M5ATOM
+    , board_M5Station
+
+/// non display boards 
+    , board_M5Atom
+    , board_M5ATOM = board_M5Atom
     , board_M5Camera
     , board_M5TimerCam
-    , board_M5Station
+    , board_M5StampPico
+    , board_M5StampC3
+
+/// external displays
     , board_M5AtomDisplay
+    , board_M5ATOMDisplay = board_M5AtomDisplay
     , board_M5UnitLCD
     , board_M5UnitOLED
     };
@@ -229,3 +237,4 @@ using namespace m5gfx::ili9341_colors;
 using namespace m5gfx::tft_command;
 using M5GFX = m5gfx::M5GFX;
 using M5Canvas = m5gfx::M5Canvas;
+using RGBColor = m5gfx::bgr888_t;

src/M5UnitLCD.h

@@ -13,6 +13,15 @@
  #include <Arduino.h>
  static constexpr std::uint8_t M5_UNIT_LCD_SDA = SDA;
  static constexpr std::uint8_t M5_UNIT_LCD_SCL = SCL;
+#elif defined (ESP_PLATFORM)
+ #include <sdkconfig.h>
+ #if defined (CONFIG_IDF_TARGET_ESP32C3)
+  static constexpr std::uint8_t M5_UNIT_LCD_SDA = 1;
+  static constexpr std::uint8_t M5_UNIT_LCD_SCL = 0;
+ #else
+  static constexpr std::uint8_t M5_UNIT_LCD_SDA = 21;
+  static constexpr std::uint8_t M5_UNIT_LCD_SCL = 22;
+ #endif
 #else
  static constexpr std::uint8_t M5_UNIT_LCD_SDA = 21;
  static constexpr std::uint8_t M5_UNIT_LCD_SCL = 22;

src/M5UnitOLED.h

@@ -13,6 +13,15 @@
  #include <Arduino.h>
  static constexpr std::uint8_t M5_UNIT_OLED_SDA = SDA;
  static constexpr std::uint8_t M5_UNIT_OLED_SCL = SCL;
+#elif defined (ESP_PLATFORM)
+ #include <sdkconfig.h>
+ #if defined (CONFIG_IDF_TARGET_ESP32C3)
+  static constexpr std::uint8_t M5_UNIT_OLED_SDA = 1;
+  static constexpr std::uint8_t M5_UNIT_OLED_SCL = 0;
+ #else
+  static constexpr std::uint8_t M5_UNIT_OLED_SDA = 21;
+  static constexpr std::uint8_t M5_UNIT_OLED_SCL = 22;
+ #endif
 #else
  static constexpr std::uint8_t M5_UNIT_OLED_SDA = 21;
  static constexpr std::uint8_t M5_UNIT_OLED_SCL = 22;

src/lgfx/Fonts/Ascii24x48.h

@@ -21,7 +21,7 @@
 //
 /************************************************************************************/
 
-const unsigned char FontLib24x48[] = {  
+PROGMEM const unsigned char FontLib24x48[] = {
 
    /* 0x00 [   ] [ 0 ] */ 
       0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,