Skip to content

Commit 02ddb3c

Browse files
committed
supervisor: Put more info in settings.toml
This list sadly has to be kept manually up to date, but it may be helpful to people!
1 parent 056ca32 commit 02ddb3c

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

supervisor/shared/filesystem.c

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,30 @@ bool filesystem_init(bool create_allowed, bool force_create) {
147147
#endif
148148

149149
#if CIRCUITPY_OS_GETENV
150-
make_empty_file(&vfs_fat->fatfs, "/settings.toml");
150+
MAKE_FILE_WITH_OPTIONAL_CONTENTS(&vfs_fat->fatfs, "/settings.toml",
151+
"# Settings in this file can be retrieved via os.getenv()\n"
152+
"# Certain settings starting with CIRCUITPY_ are also used by CircuitPython.\n"
153+
"\n"
154+
"### Core settings\n"
155+
"# CIRCUITPY_HEAP_START_SIZE = 8192\n"
156+
"# CIRCUITPY_PYSTACK_SIZE = 1536\n"
157+
#if CIRCUITPY_WEB_WORKFLOW
158+
"\n"
159+
"### Wifi settings\n"
160+
"# CIRCUITPY_WIFI_SSID = \"wifi network name\"\n"
161+
"# CIRCUITPY_WIFI_PASSWORD = \"wifi password\"\n"
162+
"\n"
163+
"### Web workflow settings\n"
164+
"# CIRCUITPY_WEB_API_PASSWORD = \"api password\"\n"
165+
"# CIRCUITPY_WEB_API_PORT = 80\n"
166+
"# CIRCUITPY_WEB_INSTANCE_NAME = \"web instance name\"\n"
167+
#endif
168+
#if CIRCUITPY_BLEIO
169+
"\n"
170+
"### BLE settings\n"
171+
"# CIRCUITPY_BLE_NAME = \"ble device name\"\n"
172+
#endif
173+
);
151174
#endif
152175
// make a sample code.py file
153176
MAKE_FILE_WITH_OPTIONAL_CONTENTS(&vfs_fat->fatfs, "/code.py", "print(\"Hello World!\")\n");

0 commit comments

Comments
 (0)