Merge pull request #10819 from dhalbert/improved-settings-toml-fetching

add supervisor.get_setting(); change os.getenv() behavior

Author: tannewt

devices/ble_hci/common-hal/_bleio/Adapter.c

@@ -29,7 +29,7 @@
 #include "shared-bindings/_bleio/ScanEntry.h"
 #include "shared-bindings/time/__init__.h"
 
-#if CIRCUITPY_OS_GETENV
+#if CIRCUITPY_SETTINGS_TOML
 #include "shared-bindings/os/__init__.h"
 #endif
 
@@ -261,7 +261,7 @@ static void _adapter_set_name(bleio_adapter_obj_t *self, mp_obj_str_t *name_obj)
 static void bleio_adapter_hci_init(bleio_adapter_obj_t *self) {
     mp_int_t name_len = 0;
 
-    #if CIRCUITPY_OS_GETENV
+    #if CIRCUITPY_SETTINGS_TOML
     mp_obj_t name = common_hal_os_getenv("CIRCUITPY_BLE_NAME", mp_const_none);
     if (name != mp_const_none) {
         mp_arg_validate_type_string(name, MP_QSTR_CIRCUITPY_BLE_NAME);

docs/environment.rst

@@ -187,7 +187,7 @@ Allows the entry of a display scaling factor used during the terminalio console
 The entered scaling factor only affects the terminalio console and has no impact on
 the UART, Web Workflow, BLE Workflow, etc consoles.
 
-This feature is not enabled on boards that the CIRCUITPY_OS_GETENV (os CIRCUIPTY_FULL_BUILD)
+This feature is not enabled on boards that the CIRCUITPY_SETTINGS_TOML (or CIRCUITPY_FULL_BUILD)
 flag has been set to 0. Currently this is primarily boards with limited flash including some
 of the Atmel_samd boards based on the SAMD21/M0 microprocessor.
 
@@ -197,7 +197,7 @@ Specifies a custom font file path to use for the terminalio console instead of t
 ``/fonts/terminal.lvfontbin``. This allows users to create and use custom fonts for the
 CircuitPython console.
 
-This feature requires both CIRCUITPY_OS_GETENV and CIRCUITPY_LVFONTIO to be enabled.
+This feature requires both CIRCUITPY_SETTINGS_TOML and CIRCUITPY_LVFONTIO to be enabled.
 
 Example:
 

docs/shared_bindings_matrix.py

@@ -84,8 +84,9 @@
     "keypad.Keys": "CIRCUITPY_KEYPAD_KEYS",
     "keypad.ShiftRegisterKeys": "CIRCUITPY_KEYPAD_SHIFTREGISTERKEYS",
     "keypad_demux.DemuxKeyMatrix": "CIRCUITPY_KEYPAD_DEMUX",
-    "os.getenv": "CIRCUITPY_OS_GETENV",
+    "os.getenv": "CIRCUITPY_SETTINGS_TOML",
     "select": "MICROPY_PY_SELECT_SELECT",
+    "supervisor.get_setting": "CIRCUITPY_SETTINGS_TOML",
     "sys": "CIRCUITPY_SYS",
     "terminalio": "CIRCUITPY_DISPLAYIO",
     "usb": "CIRCUITPY_PYUSB",

locale/circuitpython.pot

@@ -583,7 +583,7 @@ msgstr ""
 msgid "Already scanning for wifi networks"
 msgstr ""
 
-#: shared-module/os/getenv.c
+#: supervisor/shared/settings.c
 #, c-format
 msgid "An error occurred while retrieving '%s':\n"
 msgstr ""
@@ -1092,7 +1092,6 @@ msgid "File exists"
 msgstr ""
 
 #: shared-bindings/supervisor/__init__.c shared-module/lvfontio/OnDiskFont.c
-#: shared-module/os/getenv.c
 msgid "File not found"
 msgstr ""
 
@@ -1243,7 +1242,7 @@ msgstr ""
 msgid "Internal define error"
 msgstr ""
 
-#: shared-bindings/pwmio/PWMOut.c shared-module/os/getenv.c
+#: shared-bindings/pwmio/PWMOut.c supervisor/shared/settings.c
 msgid "Internal error"
 msgstr ""
 
@@ -1340,17 +1339,12 @@ msgstr ""
 msgid "Invalid bits per value"
 msgstr ""
 
-#: shared-module/os/getenv.c
-#, c-format
-msgid "Invalid byte %.*s"
-msgstr ""
-
 #: ports/atmel-samd/common-hal/imagecapture/ParallelImageCapture.c
 #, c-format
 msgid "Invalid data_pins[%d]"
 msgstr ""
 
-#: shared-module/msgpack/__init__.c
+#: shared-module/msgpack/__init__.c supervisor/shared/settings.c
 msgid "Invalid format"
 msgstr ""
 
@@ -1381,18 +1375,14 @@ msgstr ""
 msgid "Invalid state"
 msgstr ""
 
-#: shared-module/os/getenv.c
+#: supervisor/shared/settings.c
 msgid "Invalid unicode escape"
 msgstr ""
 
 #: shared-bindings/aesio/aes.c
 msgid "Key must be 16, 24, or 32 bytes long"
 msgstr ""
 
-#: shared-module/os/getenv.c
-msgid "Key not found"
-msgstr ""
-
 #: shared-module/is31fl3741/FrameBuffer.c
 msgid "LED mappings must match display size"
 msgstr ""

main.c

@@ -113,8 +113,8 @@
 uint8_t value_out = 0;
 #endif
 
-#if MICROPY_ENABLE_PYSTACK && CIRCUITPY_OS_GETENV
-#include "shared-module/os/__init__.h"
+#if CIRCUITPY_SETTINGS_TOML
+#include "supervisor/shared/settings.h"
 #endif
 
 static void reset_devices(void) {
@@ -132,17 +132,17 @@ static const char line_clear[] = "\x1b[2K\x1b[0G";
 #if MICROPY_ENABLE_PYSTACK || MICROPY_ENABLE_GC
 static uint8_t *_allocate_memory(safe_mode_t safe_mode, const char *env_key, size_t default_size, size_t *final_size) {
     *final_size = default_size;
-    #if CIRCUITPY_OS_GETENV
+    #if CIRCUITPY_SETTINGS_TOML
     if (safe_mode == SAFE_MODE_NONE) {
         mp_int_t size;
-        if (common_hal_os_getenv_int(env_key, &size) == GETENV_OK && size > 0) {
+        if (settings_get_int(env_key, &size) == SETTINGS_OK && size > 0) {
             *final_size = size;
         }
     }
     #endif
     uint8_t *ptr = port_malloc(*final_size, false);
 
-    #if CIRCUITPY_OS_GETENV
+    #if CIRCUITPY_SETTINGS_TOML
     if (ptr == NULL) {
         // Fallback to the build size.
         ptr = port_malloc(default_size, false);

ports/atmel-samd/mpconfigport.mk

@@ -48,10 +48,10 @@ CIRCUITPY_I2CTARGET ?= 0
 CIRCUITPY_JSON ?= 0
 CIRCUITPY_KEYPAD ?= 0
 CIRCUITPY_MSGPACK ?= 0
-CIRCUITPY_OS_GETENV ?= 0
 CIRCUITPY_PIXELMAP ?= 0
 CIRCUITPY_RE ?= 0
 CIRCUITPY_SDCARDIO ?= 0
+CIRCUITPY_SETTINGS_TOML ?= 0
 CIRCUITPY_SPITARGET ?= 0
 CIRCUITPY_SYNTHIO ?= 0
 CIRCUITPY_TOUCHIO_USE_NATIVE ?= 1

ports/espressif/boards/makerfabs_tft7/board.c

@@ -6,13 +6,14 @@
 
 #include "supervisor/board.h"
 #include "mpconfigboard.h"
+
 #include "shared-bindings/board/__init__.h"
 #include "shared-bindings/dotclockframebuffer/DotClockFramebuffer.h"
 #include "shared-bindings/dotclockframebuffer/__init__.h"
 #include "shared-bindings/framebufferio/FramebufferDisplay.h"
 #include "shared-bindings/microcontroller/Pin.h"
 #include "shared-module/displayio/__init__.h"
-#include "shared-module/os/__init__.h"
+#include "supervisor/shared/settings.h"
 
 static const mcu_pin_obj_t *blue_pins[] = {
     &pin_GPIO8,
@@ -40,14 +41,14 @@ static const mcu_pin_obj_t *red_pins[] = {
 static void display_init(void) {
 
     mp_int_t height = 0, width = 0, frequency = 0;
-    os_getenv_err_t result;
+    settings_err_t result;
 
-    result = common_hal_os_getenv_int("CIRCUITPY_DISPLAY_WIDTH", &width);
-    if (result == GETENV_OK && width == 800) {
+    result = settings_get_int("CIRCUITPY_DISPLAY_WIDTH", &width);
+    if (result == SETTINGS_OK && width == 800) {
         width = 800;
         height = 480;
         frequency = 6500000;
-    } else if (result == GETENV_OK && width == 1024) {
+    } else if (result == SETTINGS_OK && width == 1024) {
         width = 1024;
         height = 600;
         frequency = 10000000;

ports/espressif/boards/sunton_esp32_2432S024C/board.c

@@ -6,13 +6,14 @@
 
 #include "supervisor/board.h"
 #include "mpconfigboard.h"
+
+#include "common-hal/microcontroller/Pin.h"
+#include "driver/gpio.h"
 #include "shared-bindings/board/__init__.h"
 #include "shared-bindings/microcontroller/Pin.h"
 #include "shared-module/displayio/__init__.h"
 #include "shared-module/displayio/mipi_constants.h"
-#include "driver/gpio.h"
-#include "common-hal/microcontroller/Pin.h"
-#include "shared-module/os/__init__.h"
+#include "supervisor/shared/settings.h"
 
 uint8_t display_init_sequence[] = {
     0x01, 0x80, 0x80, //   # Software reset then delay 0x80 (128ms)
@@ -59,8 +60,8 @@ static void display_init(void) {
 
     busdisplay_busdisplay_obj_t *display = &allocate_display()->display;
     display->base.type = &busdisplay_busdisplay_type;
-    os_getenv_err_t result = common_hal_os_getenv_int("CIRCUITPY_DISPLAY_ROTATION", &rotation);
-    if (result != GETENV_OK) {
+    settings_err_t result = settings_get_int("CIRCUITPY_DISPLAY_ROTATION", &rotation);
+    if (result != SETTINGS_OK) {
         rotation = 0;
     }
 

ports/espressif/boards/sunton_esp32_2432S028/board.c

@@ -6,13 +6,14 @@
 
 #include "supervisor/board.h"
 #include "mpconfigboard.h"
+
+#include "common-hal/microcontroller/Pin.h"
+#include "driver/gpio.h"
 #include "shared-bindings/board/__init__.h"
 #include "shared-bindings/microcontroller/Pin.h"
 #include "shared-module/displayio/__init__.h"
 #include "shared-module/displayio/mipi_constants.h"
-#include "driver/gpio.h"
-#include "common-hal/microcontroller/Pin.h"
-#include "shared-module/os/__init__.h"
+#include "supervisor/shared/settings.h"
 
 uint8_t display_init_sequence[] = {
     0x01, 0x80, 0x80, //   # Software reset then delay 0x80 (128ms)
@@ -59,8 +60,8 @@ static void display_init(void) {
 
     busdisplay_busdisplay_obj_t *display = &allocate_display()->display;
     display->base.type = &busdisplay_busdisplay_type;
-    os_getenv_err_t result = common_hal_os_getenv_int("CIRCUITPY_DISPLAY_ROTATION", &rotation);
-    if (result != GETENV_OK) {
+    settings_err_t result = settings_get_int("CIRCUITPY_DISPLAY_ROTATION", &rotation);
+    if (result != SETTINGS_OK) {
         rotation = 0;
     }
 

ports/espressif/boards/sunton_esp32_8048S050/board.c

@@ -6,13 +6,14 @@
 
 #include "supervisor/board.h"
 #include "mpconfigboard.h"
+
 #include "shared-bindings/board/__init__.h"
 #include "shared-bindings/dotclockframebuffer/DotClockFramebuffer.h"
 #include "shared-bindings/dotclockframebuffer/__init__.h"
 #include "shared-bindings/framebufferio/FramebufferDisplay.h"
 #include "shared-bindings/microcontroller/Pin.h"
 #include "shared-module/displayio/__init__.h"
-#include "shared-module/os/__init__.h"
+#include "supervisor/shared/settings.h"
 
 static const mcu_pin_obj_t *blue_pins[] = {
     &pin_GPIO8,
@@ -47,8 +48,8 @@ static void display_init(void) {
 
     dotclockframebuffer_framebuffer_obj_t *framebuffer = &allocate_display_bus_or_raise()->dotclock;
     framebuffer->base.type = &dotclockframebuffer_framebuffer_type;
-    os_getenv_err_t result = common_hal_os_getenv_int("CIRCUITPY_DISPLAY_FREQUENCY", &frequency);
-    if (result != GETENV_OK) {
+    settings_err_t result = settings_get_int("CIRCUITPY_DISPLAY_FREQUENCY", &frequency);
+    if (result != SETTINGS_OK) {
         frequency = 12500000;
     }