Env:simulator fails to compile

[AarynSmith]

Device

Both

Affected Version

b7f6708

EPUB Optimization

No / Not Applicable

Cache State

No / Not Applicable

Describe the Bug

The env:simulator fails to compile due to several incompatible shims used in the simulator environment.

Commit 994fb4b (Release v1.3.4 (#310)) added two calls into non-simulator-gated code paths that don't exist in the simulator's Arduino/HAL shims. pio run -e simulator fails on current main as a result.

I've created a fork/branch with guards added so the simulator compiles and runs in my fork on simulator-fix. I'd be happy to open a pull request if you'd like.

Steps to Reproduce

pio run -e simulator

Expected Behavior

Simulator compiles and runs.

Relevant Log Output/Screenshots

Processing simulator (platform: native)
----------------------------------------------------------------------------------------------------------------
Verbose mode can be enabled via `-v, --verbose` option
Language            Code  Own  Fallback  Unused  Data (B)
------------------  ----  ---  --------  ------  --------
English             EN    646  0         56      11545
Беларуская          BE    461  185       20      15240
Català              CA    517  129       19      11687
Valencià            CAV   495  151       17      10893
Čeština             CS    454  192       22      9268
Dansk               DA    460  186       20      8065
Deutsch             DE    621  25        51      13186
Español             ES    515  131       17      11101
Suomi               FI    450  196       21      8734
Français            FR    460  186       20      8700
עברית               HE    446  200       20      11718
Magyar              HU    460  186       20      9587
Italiano            IT    526  120       28      10576
Қазақша             KK    459  187       20      15155
Lietuvių            LT    460  186       20      8209
Nederlands          NL    460  186       20      8205
Polski              PL    480  166       28      9462
Português (Brasil)  PT    449  197       19      8787
Română              RO    459  187       19      9195
Русский             RU    509  137       17      18073
Slovenščina         SI    460  186       20      8769
Slovenčina          SK    550  96        31      12328
Svenska             SV    515  131       18      10132
Türkçe              TR    460  186       20      8790
Українська          UK    515  131       26      18411
Tiếng Việt          VI    517  129       31      12000

  Total: 646  |  Used in code: 590  |  Never used: 56
  Flash: 287,816 B strings (deduped)  +  33,592 B offset tables  =  321,408 B

  Stripping 56 unused string(s) from output.

Code generation complete!
  Languages: 26
  String keys: 590
HomePageHtml          2817B ->   1105B gz
FilesPageHtml       209598B ->  48270B gz
SettingsPageHtml     25294B ->   5600B gz
FontsPageHtml        10677B ->   3253B gz
StyleCss              3056B ->   1150B gz
LogoPng               4043B raw
jszip_minJs          97630B ->  28379B gz
LDF: Library Dependency Finder -> https://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ off
Found 31 compatible libraries
Scanning dependencies...
Dependency Graph
|-- Crosspoint Simulator @ 1.0.0+sha.3c2fad0
|-- ArduinoJson @ 7.4.2
|-- QRCode @ 0.0.1
|-- PNGdec @ 1.1.6
|-- JPEGDEC @ 1.2.7+sha.8628297
|-- Logging
|-- Serialization
|-- uzlib @ 2.9.8
|-- I18n
|-- Epub
|-- FsHelpers
|-- Xtc
|-- GfxRenderer
|-- AppVersion
|-- Txt
|-- Memory
|-- OpdsParser
|-- InflateReader
|-- Utf8
|-- KOReaderSync
|-- MemoryBudget
|-- MiniBidi
|-- EpdFont
|-- FileIndex
Building in release mode
Compiling .pio/build/simulator/src/BookmarkStore.o
Compiling .pio/build/simulator/src/ClippingStore.o
Compiling .pio/build/simulator/src/CrossPointSettings.o
Compiling .pio/build/simulator/src/CrossPointState.o
Compiling .pio/build/simulator/src/FontInstaller.o
Compiling .pio/build/simulator/src/JsonSettingsIO.o
Compiling .pio/build/simulator/src/MappedInputManager.o
Compiling .pio/build/simulator/src/OpdsServerStore.o
Compiling .pio/build/simulator/src/RecentBooksStore.o
Compiling .pio/build/simulator/src/SdCardFontSystem.o
Compiling .pio/build/simulator/src/WifiCredentialStore.o
Compiling .pio/build/simulator/src/activities/Activity.o
Compiling .pio/build/simulator/src/activities/ActivityManager.o
Compiling .pio/build/simulator/src/activities/boot_sleep/BootActivity.o
Compiling .pio/build/simulator/src/activities/boot_sleep/SleepActivity.o
Compiling .pio/build/simulator/src/activities/boot_sleep/SleepCoverAssets.o
Compiling .pio/build/simulator/src/activities/browser/OpdsBookBrowserActivity.o
Compiling .pio/build/simulator/src/activities/home/AlertActivity.o
Compiling .pio/build/simulator/src/activities/home/BookActions.o
Compiling .pio/build/simulator/src/activities/home/BookmarksHomeActivity.o
Compiling .pio/build/simulator/src/activities/home/CrashActivity.o
Compiling .pio/build/simulator/src/activities/home/FileBrowserActionActivity.o
Compiling .pio/build/simulator/src/activities/home/FileBrowserActivity.o
Compiling .pio/build/simulator/src/activities/home/HomeActivity.o
Compiling .pio/build/simulator/src/activities/home/RecentBookProgress.o
Compiling .pio/build/simulator/src/activities/home/RecentBooksActivity.o
Compiling .pio/build/simulator/src/activities/home/RecentBooksGridActivity.o
Compiling .pio/build/simulator/src/activities/home/SavedItemsHomeActivity.o
Compiling .pio/build/simulator/src/activities/network/CalibreConnectActivity.o
Compiling .pio/build/simulator/src/activities/network/CrossPointWebServerActivity.o
Compiling .pio/build/simulator/src/activities/network/NearbyStatsSyncActivity.o
Compiling .pio/build/simulator/src/activities/network/NetworkModeSelectionActivity.o
Compiling .pio/build/simulator/src/activities/network/WifiSelectionActivity.o
Compiling .pio/build/simulator/src/activities/reader/BookReadingStats.o
Compiling .pio/build/simulator/src/activities/reader/BookStatsActivity.o
Compiling .pio/build/simulator/src/activities/reader/BookStatsView.o
Compiling .pio/build/simulator/src/activities/reader/ClipSelectionActivity.o
Compiling .pio/build/simulator/src/activities/reader/ControlsOptionsActivity.o
Compiling .pio/build/simulator/src/activities/reader/EndOfBookOptions.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderActivity.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderBookmarkListActivity.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderChapterSelectionActivity.o
src/activities/network/WifiSelectionActivity.cpp:412:38: error: too many arguments to function call, expected at most 2, have 3
  412 |   if (!WiFi.disconnect(false, false, 1000)) {
      |        ~~~~~~~~~~~~~~~               ^~~~
.pio/libdeps/simulator/simulator/src/WiFi.h:193:8: note: 'disconnect' declared here
  193 |   void disconnect(bool wifioff = false, bool eraseap = false) {
      |        ^          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/activities/network/WifiSelectionActivity.cpp:412:7: error: invalid argument type 'void' to unary expression
  412 |   if (!WiFi.disconnect(false, false, 1000)) {
      |       ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Compiling .pio/build/simulator/src/activities/reader/EpubReaderClippingListActivity.o
2 errors generated.
*** [.pio/build/simulator/src/activities/network/WifiSelectionActivity.o] Error 1
========================================== [FAILED] Took 5.48 seconds ==========================================

Environment    Status    Duration
-------------  --------  ------------
simulator      FAILED    00:00:05.480

[uxjulia]

I'm able to run the simulator fine on 1.4.0 with latest simulator updates.

[AarynSmith]

I've tried cleaning my build environment and updating the crosspoint-simulator dependency, but still am unable to compile without the guards in place.

I've also double checked the history for the crosspoint-simulator repo and only see two versions of the disconnect shim called in WifiSelectionActivity.cpp:412, neither of which supported 3 arguments, so this should not be a stale dependency issue.

I'm happy to try anything else you can suggest.

For the record, here is my build post-clean of both my .pio and ~/.platformio folders:

Processing simulator (platform: native)
----------------------------------------------------------------------------------------------------------------
Platform Manager: Installing native
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Platform Manager: native@1.2.1 has been installed!
Tool Manager: Installing platformio/tool-scons @ ~4.40801.0
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Tool Manager: tool-scons@4.40801.0 has been installed!
Library Manager: Installing git+https://github.com/uxjulia/crosspoint-simulator
git version 2.50.1 (Apple Git-155)
Cloning into '/Users/aaryn/.platformio/.cache/tmp/pkg-installing-9b8jyy2r'...
remote: Enumerating objects: 95, done.
remote: Counting objects: 100% (95/95), done.
remote: Compressing objects: 100% (90/90), done.
remote: Total 95 (delta 1), reused 48 (delta 0), pack-reused 0 (from 0)
Receiving objects: 100% (95/95), 154.79 KiB | 1.65 MiB/s, done.
Resolving deltas: 100% (1/1), done.
Library Manager: simulator@1.0.0+sha.3c2fad0 has been installed!
Library Manager: Installing bblanchon/ArduinoJson @ 7.4.2
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Library Manager: ArduinoJson@7.4.2 has been installed!
Library Manager: Installing ricmoo/QRCode @ ^0.0.1
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Library Manager: QRCode@0.0.1 has been installed!
Library Manager: Installing bitbank2/PNGdec @ 1.1.6
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Library Manager: PNGdec@1.1.6 has been installed!
Library Manager: Installing git+https://github.com/bitbank2/JPEGDEC.git#86282979224c8a32fd51e091ed5a35b0c699a52b
git version 2.50.1 (Apple Git-155)
Cloning into '/Users/aaryn/.platformio/.cache/tmp/pkg-installing-b0hz3moy'...
remote: Enumerating objects: 1247, done.
remote: Counting objects: 100% (201/201), done.
remote: Compressing objects: 100% (74/74), done.
remote: Total 1247 (delta 150), reused 160 (delta 127), pack-reused 1046 (from 1)
Receiving objects: 100% (1247/1247), 4.35 MiB | 6.41 MiB/s, done.
Resolving deltas: 100% (648/648), done.
HEAD is now at 8628297 Fixed 2 issues which occur when decoding progressive images
Library Manager: JPEGDEC@1.2.7+sha.8628297 has been installed!
Library Manager: Installing links2004/WebSockets @ 2.7.3
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Library Manager: WebSockets@2.7.3 has been installed!
Verbose mode can be enabled via `-v, --verbose` option
Language            Code  Own  Fallback  Unused  Data (B)
------------------  ----  ---  --------  ------  --------
English             EN    646  0         56      11545
Беларуская          BE    461  185       20      15240
Català              CA    517  129       19      11687
Valencià            CAV   495  151       17      10893
Čeština             CS    454  192       22      9268
Dansk               DA    460  186       20      8065
Deutsch             DE    621  25        51      13186
Español             ES    515  131       17      11101
Suomi               FI    450  196       21      8734
Français            FR    460  186       20      8700
עברית               HE    446  200       20      11718
Magyar              HU    460  186       20      9587
Italiano            IT    526  120       28      10576
Қазақша             KK    459  187       20      15155
Lietuvių            LT    460  186       20      8209
Nederlands          NL    460  186       20      8205
Polski              PL    480  166       28      9462
Português (Brasil)  PT    449  197       19      8787
Română              RO    459  187       19      9195
Русский             RU    509  137       17      18073
Slovenščina         SI    460  186       20      8769
Slovenčina          SK    550  96        31      12328
Svenska             SV    515  131       18      10132
Türkçe              TR    460  186       20      8790
Українська          UK    515  131       26      18411
Tiếng Việt          VI    517  129       31      12000

  Total: 646  |  Used in code: 590  |  Never used: 56
  Flash: 287,816 B strings (deduped)  +  33,592 B offset tables  =  321,408 B

  Stripping 56 unused string(s) from output.

Code generation complete!
  Languages: 26
  String keys: 590
HomePageHtml          2817B ->   1105B gz
FilesPageHtml       209598B ->  48270B gz
SettingsPageHtml     25294B ->   5600B gz
FontsPageHtml        10677B ->   3253B gz
StyleCss              3056B ->   1150B gz
LogoPng               4043B raw
jszip_minJs          97630B ->  28379B gz
LDF: Library Dependency Finder -> https://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ off
Found 31 compatible libraries
Scanning dependencies...
Dependency Graph
|-- Crosspoint Simulator @ 1.0.0+sha.3c2fad0
|-- ArduinoJson @ 7.4.2
|-- QRCode @ 0.0.1
|-- PNGdec @ 1.1.6
|-- JPEGDEC @ 1.2.7+sha.8628297
|-- Logging
|-- Serialization
|-- uzlib @ 2.9.8
|-- I18n
|-- Epub
|-- FsHelpers
|-- Xtc
|-- GfxRenderer
|-- AppVersion
|-- Txt
|-- Memory
|-- OpdsParser
|-- InflateReader
|-- Utf8
|-- KOReaderSync
|-- MemoryBudget
|-- MiniBidi
|-- EpdFont
|-- FileIndex
Building in release mode
Compiling .pio/build/simulator/src/BookmarkStore.o
Compiling .pio/build/simulator/src/ClippingStore.o
Compiling .pio/build/simulator/src/CrossPointSettings.o
Compiling .pio/build/simulator/src/CrossPointState.o
Compiling .pio/build/simulator/src/FontInstaller.o
Compiling .pio/build/simulator/src/JsonSettingsIO.o
Compiling .pio/build/simulator/src/MappedInputManager.o
Compiling .pio/build/simulator/src/OpdsServerStore.o
Compiling .pio/build/simulator/src/RecentBooksStore.o
Compiling .pio/build/simulator/src/SdCardFontSystem.o
Compiling .pio/build/simulator/src/WifiCredentialStore.o
Compiling .pio/build/simulator/src/activities/Activity.o
Compiling .pio/build/simulator/src/activities/ActivityManager.o
Compiling .pio/build/simulator/src/activities/boot_sleep/BootActivity.o
Compiling .pio/build/simulator/src/activities/boot_sleep/SleepActivity.o
Compiling .pio/build/simulator/src/activities/boot_sleep/SleepCoverAssets.o
Compiling .pio/build/simulator/src/activities/browser/OpdsBookBrowserActivity.o
Compiling .pio/build/simulator/src/activities/home/AlertActivity.o
Compiling .pio/build/simulator/src/activities/home/BookActions.o
Compiling .pio/build/simulator/src/activities/home/BookmarksHomeActivity.o
Compiling .pio/build/simulator/src/activities/home/CrashActivity.o
Compiling .pio/build/simulator/src/activities/home/FileBrowserActionActivity.o
Compiling .pio/build/simulator/src/activities/home/FileBrowserActivity.o
Compiling .pio/build/simulator/src/activities/home/HomeActivity.o
Compiling .pio/build/simulator/src/activities/home/RecentBookProgress.o
Compiling .pio/build/simulator/src/activities/home/RecentBooksActivity.o
Compiling .pio/build/simulator/src/activities/home/RecentBooksGridActivity.o
Compiling .pio/build/simulator/src/activities/home/SavedItemsHomeActivity.o
Compiling .pio/build/simulator/src/activities/network/CalibreConnectActivity.o
Compiling .pio/build/simulator/src/activities/network/CrossPointWebServerActivity.o
Compiling .pio/build/simulator/src/activities/network/NearbyStatsSyncActivity.o
Compiling .pio/build/simulator/src/activities/network/NetworkModeSelectionActivity.o
Compiling .pio/build/simulator/src/activities/network/WifiSelectionActivity.o
Compiling .pio/build/simulator/src/activities/reader/BookReadingStats.o
Compiling .pio/build/simulator/src/activities/reader/BookStatsActivity.o
Compiling .pio/build/simulator/src/activities/reader/BookStatsView.o
Compiling .pio/build/simulator/src/activities/reader/ClipSelectionActivity.o
Compiling .pio/build/simulator/src/activities/reader/ControlsOptionsActivity.o
Compiling .pio/build/simulator/src/activities/reader/EndOfBookOptions.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderActivity.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderBookmarkListActivity.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderChapterSelectionActivity.o
Compiling .pio/build/simulator/src/activities/reader/EpubReaderClippingListActivity.o
src/activities/network/WifiSelectionActivity.cpp:412:38: error: too many arguments to function call, expected at most 2, have 3
  412 |   if (!WiFi.disconnect(false, false, 1000)) {
      |        ~~~~~~~~~~~~~~~               ^~~~
.pio/libdeps/simulator/simulator/src/WiFi.h:193:8: note: 'disconnect' declared here
  193 |   void disconnect(bool wifioff = false, bool eraseap = false) {
      |        ^          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/activities/network/WifiSelectionActivity.cpp:412:7: error: invalid argument type 'void' to unary expression
  412 |   if (!WiFi.disconnect(false, false, 1000)) {
      |       ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Compiling .pio/build/simulator/src/activities/reader/EpubReaderFootnotesActivity.o
2 errors generated.
*** [.pio/build/simulator/src/activities/network/WifiSelectionActivity.o] Error 1
========================================= [FAILED] Took 22.66 seconds =========================================

Environment    Status    Duration
-------------  --------  ------------
simulator      FAILED    00:00:22.662
==================================== 1 failed, 0 succeeded in 00:00:22.662 ====================================

and my pio pkg list -e simulator

Resolving simulator dependencies...
Platform native @ 1.2.1 (required: native)
└── tool-scons @ 4.40801.0 (required: platformio/tool-scons)

Libraries
├── ArduinoJson @ 7.4.2 (required: bblanchon/ArduinoJson @ 7.4.2)
├── JPEGDEC @ 1.2.7+sha.8628297 (required: git+https://github.com/bitbank2/JPEGDEC.git#86282979224c8a32fd51e091ed5a35b0c699a52b)
├── PNGdec @ 1.1.6 (required: bitbank2/PNGdec @ 1.1.6)
├── QRCode @ 0.0.1 (required: ricmoo/QRCode @ ^0.0.1)
├── WebSockets @ 2.7.3 (required: links2004/WebSockets @ 2.7.3)
└── simulator @ 1.0.0+sha.3c2fad0 (required: git+https://github.com/uxjulia/crosspoint-simulator)

[uxjulia]

Ah, forgot I swapped out the simulator repo to my crossink specific one since it's slowly been diverging from my original crosspoint-simulator one (which is being used by upstream Crosspoint now so I didn't want to make crossink-only stubs there). You can switch the repo to https://github.com/uxjulia/crossink-simulator and it should work.

[AarynSmith]

Yes. Can confirm, updating the lib_deps for the env:simulator to simulator=https://github.com/uxjulia/crossink-simulator#33f66c4 does resolve the issue.

Would you like a pull request for this, or would you like to just update yourself?

[uxjulia]

Yes. Can confirm, updating the lib_deps for the env:simulator to simulator=https://github.com/uxjulia/crossink-simulator#33f66c4 does resolve the issue.

Would you like a pull request for this, or would you like to just update yourself?

Nah, I'll update it locally and it'll get merged in on the next release