MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nodemcu-firmware/components/lua/Kconfig

167 lines
5.0 KiB
Plaintext
Raw Normal View History

idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
menu "Lua configuration"
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
choice LUA_VERSION
prompt "Lua version"
Initial migration to IDFv5.0 Plenty of dependency adjustments, printf format specificier updates, FreeRTOS type and macro name modernisation, not to mention API changes. Still plenty of legacy/deprecated drivers in use which will need updating. The following features have been removed due to no longer being available from the IDF: - ADC hall effect sensor reading - Configuration of SD SPI host via sdmmc module (now must be done first via the spimaster module) - FAT partition selection on external SD cards; only the first FAT partition is supported by the IDF now On the other hand, the eth module now supports the following new chipsets: - KSZ8001 - KSZ8021 - KSZ8031 - KSZ8051 - KSZ8061 - KSZ8091 - Possibly additional models in the LAN87xx series (the IDF docs aren't clear on precisely which models are handled) Further, the sdmmc module is now available on the ESP32-S3 as well.
2023-01-31 07:07:54 +01:00
default LUA_VERSION_53
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
help
The version of Lua interpreter to use.
config LUA_VERSION_51
bool "Lua 5.1"
config LUA_VERSION_53
bool "Lua 5.3"
endchoice
idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
config LUA_NUMBER_INTEGRAL
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
depends on LUA_VERSION_51
idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
bool "Integer-only build"
default "n"
help
Build Lua without support for floating point numbers.
Not generally recommended, but can save on code size.
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
config LUA_NUMBER_INT64
depends on LUA_VERSION_53
bool "Use 64bit integers"
default "n"
help
Build Lua with 64bit integers. This provides a greater value
range, but at the expense of extra memory usage and somewhat
reduced performance over the default 32bit integers.
config LUA_NUMBER_DOUBLE
depends on LUA_VERSION_53
bool "Use double precision floating point"
default "n"
help
Build Lua with double floating point precision. This provides
a greater value range, but at the expense of extra memory
usage and somewhat reduced performance over the default
single precision floating point.
idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
menu "Core Lua modules"
config LUA_BUILTIN_STRING
bool "String module"
default "y"
help
Includes the string module (recommended).
config LUA_BUILTIN_TABLE
bool "Table module"
default "y"
help
Includes the table module (recommended).
config LUA_BUILTIN_COROUTINE
bool "Coroutine module"
default "y"
help
Includes the coroutine module (recommended).
Switch to IDF-provided VFS and standard `io` module. The IDF-provided VFS resolves several issues: - The IDF components having a different view of the (virtual) file system compared to the Lua environment. - RTOS task/thread safety. Our legacy VFS was only ever safe to use from the LVM thread, which limited its usability. Upgrading it would have effectively required a reimplementation of the IDF VFS, which would have been a bigger task with larger on-going maintenance issues. - We're no longer needing to maintain our own SPIFFS component. - We're no longer needing to maintain our own FATFS component. - The legacy of the 8266's lack of standard C interface to the file system is no longer holding us back, meaning that we can use the standard Lua `io` module rather than the cobbled-together swiss army knife also known as the file module. Of course, the downside is that we'll either have to declare a backwards breakage in regard to the file module, or provide a Lua shim for the old functions, where applicable. Also included is some necessary integer type fixups in unrelated code, which apparently had depended on some non-standard types in either the SPIFFS or FATFS headers. A memory leak issue in the sdmmc module was also found and fixed while said module got switched over to the Espressif VFS. Module documentation has been updated to match the new reality (and I discovered in some places it wasn't even matching the old reality).
2021-10-20 12:24:09 +02:00
config LUA_BUILTIN_IO
bool "I/O module"
default "y"
help
Includes the file I/O module (recommended).
idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
config LUA_BUILTIN_MATH
bool "Math module"
default "y"
help
Includes the math module (recommended).
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
config LUA_BUILTIN_UTF8
depends on !LUA_VERSION_51
bool "UTF8 module"
default "y"
help
Fixed panic handling on REPL input. The Lua debug module is mandatory now.
2021-08-23 15:32:13 +02:00
Includes the debug module (required by our Lua VM).
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
config LUA_BUILTIN_DEBUG
bool "Debug module"
default "n"
help
Includes the debug module.
config LUA_BUILTIN_DEBUG_EXTENDED
depends on LUA_BUILTIN_DEBUG
bool "Extended debug support"
default "n"
help
Includes the full debug module, rather than just getregistry
and traceback.
config LUA_BUILTIN_DEBUG_MINIMAL
depends on LUA_BUILTIN_DEBUG
bool
default !LUA_BUILTIN_DEBUG_EXTENDED
endmenu
menu "Lua compilation"
choice LUA_OPTIMIZE_DEBUG_LEVEL
prompt "Discard debug info in compiled Lua"
default LUA_OPTIMIZE_DEBUG_NONE
help
Discard debug information in compiled Lua code to save memory.
config LUA_OPTIMIZE_DEBUG_NONE
bool "No (keep full debug info)"
config LUA_OPTIMIZE_DEBUG_LOCAL_UPVAL
bool "Some (discard local & upvalue debug info)"
config LUA_OPTIMIZE_DEBUG_LOCAL_UPVAL_LINENO
bool "All (discard local, upvalue & line number info)"
endchoice
config LUA_OPTIMIZE_DEBUG
int
default 1 if LUA_OPTIMIZE_DEBUG_NONE
default 2 if LUA_OPTIMIZE_DEBUG_LOCAL_UPVAL
default 3 if LUA_OPTIMIZE_DEBUG_LOCAL_UPVAL_LINENO
endmenu
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
config LUA_REQUIRED_MODULES
bool
default y
select NODEMCU_CMODULE_PIPE
Refactor to clean up and fix console handling (#3666) * Refactor into new 'console' module. A breaking change, but should finally see us move away from the chronic edge cases and inconsistent behaviour we have while trying to shoe-horn the usb-serial-jtag and cdc-acm consoles into uart behaviour and assumptions. * Fix and document console.write() Added example on using framed data transmission over the console. * fixup uart examples * Add workaround for silently dropped console output. * Add file upload helper script for console module. Plus, it can serve as a reference for any IDEs which may need/want updating. * Fixup really silly copy/paste error. * Make upload-file.py work better on CDC-ACM console. * Updated console module doc with CDC-ACM info. * Load file in binary mode in upload-file.py.
2024-12-10 01:08:10 +01:00
select NODEMCU_CMODULE_CONSOLE
Fixed panic handling on REPL input. The Lua debug module is mandatory now.
2021-08-23 15:32:13 +02:00
select LUA_BUILTIN_DEBUG
Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. Changes have been kept to a minimum, but a serious chunk of work was needed to move from 8266isms to IDFisms. Some things got refactored into components/lua/common, in particular the LFS location awareness. As part of this work I also evicted our partition table manipulation code, as with the current IDF it kept breaking checksums and rendering things unbootable, which is the opposite of helpful (which was the original intent behind it). The uart module got relocated from base_nodemcu to the modules component properly, after I worked out how to force its inclusion using Kconfig alone.
2021-08-21 17:39:54 +02:00
Allow LUA_INIT_STRING to be set in menuconfig
2022-10-17 23:39:56 +02:00
choice LUA_INIT_STRING
prompt "Boot command"
default LUA_INIT_STRING_INIT_LUA
help
Command to run on boot. This can be a .lua file, an LFS module, or
any valid Lua expression. By default init.lua is loaded and run
from the SPIFFS filesystem.
config LUA_INIT_STRING_INIT_LUA
bool "init.lua from SPIFFS"
config LUA_INIT_STRING_INIT_LFS
bool "init module from LFS"
config LUA_INIT_STRING_CUSTOM
bool "Custom"
endchoice
config LUA_INIT_STRING_CUSTOM_STRING
string "Custom boot command" if LUA_INIT_STRING_CUSTOM
default ""
help
Run a custom command on boot.
Specify @filename.lua to load "filename.lua" from SPIFFS.
Specify node.LFS.get('foo')() to load the module "foo" from LFS.
Or specify any other valid Lua expression to execute that on boot.
config LUA_INIT_STRING
string
default "@init.lua" if LUA_INIT_STRING_INIT_LUA
default "node.LFS.get('init')()" if LUA_INIT_STRING_INIT_LFS
default LUA_INIT_STRING_CUSTOM_STRING if LUA_INIT_STRING_CUSTOM
idf4: overhaul to new build system, part 1 of 3 Yet to come: - part 2: dealing with deprecated and removed APIs - part 3: making it actually work again
2021-07-15 08:25:25 +02:00
endmenu