Latest version 0.2.21 introduces build errors for the StackChan library

[jjs357]

If I revert to 0.2.20, the errors go away.

In file included from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.cpp:6:
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:26:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::setDirection(uint8_t, bool)'
   26 |     void setDirection(uint8_t pin, bool direction) override;
      |          ^~~~~~~~~~~~
In file included from /Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/M5Unified.hpp:68,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:9:
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:33:18: note: overridden function is 'virtual bool m5::IOExpander_Base::setDirection(uint8_t, bool)'
   33 |     virtual bool setDirection(uint8_t pin, bool direction) = 0;
      |                  ^~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:28:10: error: 'void m5::PY32IOExpander_Class::enablePull(uint8_t, bool)' marked 'override', but does not override
   28 |     void enablePull(uint8_t pin, bool enablePull) override;
      |          ^~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:31:10: error: 'void m5::PY32IOExpander_Class::setPullMode(uint8_t, bool)' marked 'override', but does not override
   31 |     void setPullMode(uint8_t pin, bool mode) override;
      |          ^~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:36:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::setHighImpedance(uint8_t, bool)'
   36 |     void setHighImpedance(uint8_t pin, bool enable) override;
      |          ^~~~~~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:42:18: note: overridden function is 'virtual bool m5::IOExpander_Base::setHighImpedance(uint8_t, bool)'
   42 |     virtual bool setHighImpedance(uint8_t pin, bool enable) = 0;
      |                  ^~~~~~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:40:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::digitalWrite(uint8_t, bool)'
   40 |     void digitalWrite(uint8_t pin, bool level) override;
      |          ^~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:48:18: note: overridden function is 'virtual bool m5::IOExpander_Base::digitalWrite(uint8_t, bool)'
   48 |     virtual bool digitalWrite(uint8_t pin, bool level) = 0;
      |                  ^~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:44:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::resetIrq()'
   44 |     void resetIrq() override;
      |          ^~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:63:18: note: overridden function is 'virtual bool m5::IOExpander_Base::resetIrq()'
   63 |     virtual bool resetIrq() = 0;
      |                  ^~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:46:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::disableIrq()'
   46 |     void disableIrq() override;
      |          ^~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:67:18: note: overridden function is 'virtual bool m5::IOExpander_Base::disableIrq()'
   67 |     virtual bool disableIrq() = 0;
      |                  ^~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:48:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::enableIrq()'
   48 |     void enableIrq() override;
      |          ^~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:71:18: note: overridden function is 'virtual bool m5::IOExpander_Base::enableIrq()'
   71 |     virtual bool enableIrq() = 0;
      |                  ^~~~~~~~~
In file included from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/M5StackChan.cpp:7:
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:26:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::setDirection(uint8_t, bool)'
   26 |     void setDirection(uint8_t pin, bool direction) override;
      |          ^~~~~~~~~~~~
In file included from /Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/M5Unified.hpp:68,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/M5Unified.h:5,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/utils/touch_sensor/../../drivers/Si12T/Si12T.h:5,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/utils/touch_sensor/touch_sensor.h:7,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/M5StackChan.h:7,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/M5StackChan.cpp:6:
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:33:18: note: overridden function is 'virtual bool m5::IOExpander_Base::setDirection(uint8_t, bool)'
   33 |     virtual bool setDirection(uint8_t pin, bool direction) = 0;
      |                  ^~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:28:10: error: 'void m5::PY32IOExpander_Class::enablePull(uint8_t, bool)' marked 'override', but does not override
   28 |     void enablePull(uint8_t pin, bool enablePull) override;
      |          ^~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:31:10: error: 'void m5::PY32IOExpander_Class::setPullMode(uint8_t, bool)' marked 'override', but does not override
   31 |     void setPullMode(uint8_t pin, bool mode) override;
      |          ^~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:36:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::setHighImpedance(uint8_t, bool)'
   36 |     void setHighImpedance(uint8_t pin, bool enable) override;
      |          ^~~~~~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:42:18: note: overridden function is 'virtual bool m5::IOExpander_Base::setHighImpedance(uint8_t, bool)'
   42 |     virtual bool setHighImpedance(uint8_t pin, bool enable) = 0;
      |                  ^~~~~~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:40:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::digitalWrite(uint8_t, bool)'
   40 |     void digitalWrite(uint8_t pin, bool level) override;
      |          ^~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:48:18: note: overridden function is 'virtual bool m5::IOExpander_Base::digitalWrite(uint8_t, bool)'
   48 |     virtual bool digitalWrite(uint8_t pin, bool level) = 0;
      |                  ^~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:44:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::resetIrq()'
   44 |     void resetIrq() override;
      |          ^~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:63:18: note: overridden function is 'virtual bool m5::IOExpander_Base::resetIrq()'
   63 |     virtual bool resetIrq() = 0;
      |                  ^~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:46:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::disableIrq()'
   46 |     void disableIrq() override;
      |          ^~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:67:18: note: overridden function is 'virtual bool m5::IOExpander_Base::disableIrq()'
   67 |     virtual bool disableIrq() = 0;
      |                  ^~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:48:10: error: conflicting return type specified for 'virtual void m5::PY32IOExpander_Class::enableIrq()'
   48 |     void enableIrq() override;
      |          ^~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:71:18: note: overridden function is 'virtual bool m5::IOExpander_Base::enableIrq()'
   71 |     virtual bool enableIrq() = 0;
      |                  ^~~~~~~~~
In file included from /Users/jjs/Library/Arduino15/packages/esp32/tools/esp-x32/2601/xtensa-esp-elf/include/c++/14.2.0/memory:78,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/lgfx/v1/platforms/esp32/../esp32/../../../utility/../internal/memory.h:13,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/lgfx/v1/platforms/esp32/../esp32/../../../utility/result.hpp:35,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/lgfx/v1/platforms/esp32/../esp32/common.hpp:22,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/lgfx/v1/platforms/esp32/../common.hpp:22,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/lgfx/v1/platforms/esp32/Bus_SPI.hpp:57,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/lgfx/v1/platforms/device.hpp:66,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5GFX/src/M5GFX.h:47,
                 from /Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/M5Unified.hpp:19:
/Users/jjs/Library/Arduino15/packages/esp32/tools/esp-x32/2601/xtensa-esp-elf/include/c++/14.2.0/bits/unique_ptr.h: In instantiation of 'std::__detail::__unique_ptr_t<_Tp> std::make_unique(_Args&& ...) [with _Tp = m5::PY32IOExpander_Class; _Args = {}; __detail::__unique_ptr_t<_Tp> = __detail::__unique_ptr_t<m5::PY32IOExpander_Class>]':
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/M5StackChan.cpp:42:62:   required from here
   42 |     _io_expander = std::make_unique<m5::PY32IOExpander_Class>();
      |                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~
/Users/jjs/Library/Arduino15/packages/esp32/tools/esp-x32/2601/xtensa-esp-elf/include/c++/14.2.0/bits/unique_ptr.h:1076:30: error: invalid new-expression of abstract class type 'm5::PY32IOExpander_Class'
 1076 |     { return unique_ptr<_Tp>(new _Tp(std::forward<_Args>(__args)...)); }
      |                              ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5StackChan/src/drivers/PY32IOExpander/PY32IOExpander.hpp:12:7: note:   because the following virtual functions are pure within 'm5::PY32IOExpander_Class':
   12 | class PY32IOExpander_Class : public IOExpander_Base {
      |       ^~~~~~~~~~~~~~~~~~~~
/Users/jjs/Desktop/Sketchbook/libraries/M5Unified/src/utility/IOExpander_Base.hpp:38:18: note:     'virtual bool m5::IOExpander_Base::setPullMode(uint8_t, gpio_pull_t)'
   38 |     virtual bool setPullMode(uint8_t pin, gpio_pull_t mode) = 0;
      |                  ^~~~~~~~~~~
Multiple libraries were found for "WiFi.h"
  Used: /Users/jjs/Library/Arduino15/packages/esp32/hardware/esp32/3.3.11/libraries/WiFi
  Not used: /Users/jjs/Desktop/Sketchbook/libraries/WiFiNINA
exit status 1

Compilation error: exit status 1

Suggestions?

[jjs357]

Using Arduino 2.3.10 for compiling

[ainyan03]

Thanks for the report, and sorry for the breakage. The cause is on the M5Unified side: 0.2.21 changed the IOExpander_Base interface that PY32IOExpander_Class in StackChan-BSP derives from (the setters now return the write status as bool, setPullMode() takes a gpio_pull_t, and enablePull() was removed), and StackChan-BSP 1.1.0 still declares the old signatures with override, so it cannot compile against 0.2.21.

The fix belongs in StackChan-BSP; I have opened #8 which follows the new interface and still builds against 0.2.20. Until that is merged and released, staying on M5Unified 0.2.20 (as you did) is the right workaround.

[ainyan03]

Update: the fix on the StackChan-BSP side (#8) has been merged, so the current main of StackChan-BSP builds against M5Unified 0.2.21 (StackChan-BSP's CI now compiles every example against both the released M5Unified and its develop branch, so this kind of break should be caught before a release next time).

Until a new StackChan-BSP release is tagged you will need the library from main rather than from the Library Manager. Could you give it a try and close this issue if it works for you?

[jjs357]

Remind me about how to install a library from "main".

[jjs357]

I figured out the manual StackChan library update process and replacing from main allows the compile against the latest Unified library to succeed.

[jjs357]

By the way, Arduino Library Manager reports the most recent version of the StackChan Library is 1.0.1 NOT 1.1.0.

[lovyan03]

@jjs357
Thank you for letting me know.

@Forairaaaaa
it seems that the change to the StackChan-BSP library name has not been reflected in the Arduino Library Manager.
( M5StackChan -> StackChan-BSP )

[ainyan03]

Some supplementary details on the Library Manager side, since the cause is easy to miss:

The Library Manager registry identifies libraries by the name field of library.properties, and this library was registered as M5StackChan (versions 1.0.0 / 1.0.1 are indexed under that name). Since 47c1649 (tag 1.0.2) the file says name=StackChan-BSP, so the indexer has been rejecting every release since then:

Release StackChan-BSP:1.0.2 has wrong library name, should be M5StackChan
Release StackChan-BSP:1.1.0 has wrong library name, should be M5StackChan

(from the indexer log: https://downloads.arduino.cc/libraries/logs/github.com/m5stack/StackChan-BSP/)

That is why the Library Manager still offers 1.0.1 as the latest version.

Two ways to fix it:

1. Keep the new name — file a rename request with Arduino (per the registry FAQ, name changes are only done on request via an issue in arduino/library-registry). Once the registry entry is renamed to StackChan-BSP, the existing 1.0.2 / 1.1.0 tags should be picked up on a subsequent scan without retagging. Note that Arduino discourages renames because copies already installed under the old name will no longer be recognized as the same library on users' machines.
2. Revert to the registered name — change library.properties back to name=M5StackChan and tag a new release (e.g. 1.1.1). The already-rejected tags stay unindexed, but the new tag will be picked up. If this route is taken, the Arduino Lint workflow should also switch library-manager: submit back to update (submit expects a name that is not yet in the index).

Either way the decision belongs to the maintainers — happy to prepare a PR for option 2 if that is the preferred route.