From 9ab32b69e9f5d31895ec26fc6afa150e25345648 Mon Sep 17 00:00:00 2001 From: robthomson <4599545+robthomson@users.noreply.github.com> Date: Mon, 12 Oct 2026 13:13:38 +0000 Subject: [PATCH] Update lua-doc, official examples and real-world usage --- data/api.json | 4 +- data/usage.json | 287 +++++++++------------- docs/api/crsf/getSensor.md | 4 +- docs/api/form/addBooleanField.md | 2 +- docs/api/form/addChoiceField.md | 6 +- docs/api/form/addExpansionPanel.md | 10 +- docs/api/form/addFileField.md | 2 +- docs/api/form/addLine.md | 4 +- docs/api/form/addNumberField.md | 21 +- docs/api/form/addSliderField.md | 2 +- docs/api/form/addSourceField.md | 38 --- docs/api/form/addStaticText.md | 6 +- docs/api/form/addSwitchField.md | 2 +- docs/api/form/addTextButton.md | 2 +- docs/api/form/addTextField.md | 44 ++-- docs/api/form/clear.md | 4 +- docs/api/form/getFieldSlots.md | 6 +- docs/api/form/height.md | 2 +- docs/api/form/invalidate.md | 4 +- docs/api/form/openDialog.md | 4 +- docs/api/glasses/createLayout.md | 2 +- docs/api/glasses/getWindowSize.md | 2 +- docs/api/index.md | 26 +- docs/api/lcd/GREY.md | 14 +- docs/api/lcd/RGB.md | 4 +- docs/api/lcd/color.md | 6 +- docs/api/lcd/darkMode.md | 4 +- docs/api/lcd/drawAnnulusSector.md | 2 +- docs/api/lcd/drawBitmap.md | 4 +- docs/api/lcd/drawCircle.md | 2 +- docs/api/lcd/drawFilledCircle.md | 2 +- docs/api/lcd/drawFilledRectangle.md | 4 +- docs/api/lcd/drawFilledTriangle.md | 2 +- docs/api/lcd/drawLine.md | 2 +- docs/api/lcd/drawMask.md | 2 +- docs/api/lcd/drawRectangle.md | 2 +- docs/api/lcd/drawText.md | 2 +- docs/api/lcd/font.md | 8 +- docs/api/lcd/getTextSize.md | 6 +- docs/api/lcd/getWindowSize.md | 4 +- docs/api/lcd/hasFocus.md | 6 +- docs/api/lcd/invalidate.md | 2 +- docs/api/lcd/loadBitmap.md | 4 +- docs/api/lcd/loadMask.md | 4 +- docs/api/lcd/pen.md | 2 +- docs/api/lcd/setClipping.md | 4 +- docs/api/lcd/themeColor.md | 4 +- docs/api/model/bitmap.md | 4 +- docs/api/model/name.md | 2 +- docs/api/serial/open.md | 2 +- docs/api/sport/getSensor.md | 4 +- docs/api/storage/read.md | 12 +- docs/api/storage/write.md | 12 +- docs/api/system/exit.md | 2 +- docs/api/system/getLocale.md | 2 +- docs/api/system/getMemoryUsage.md | 4 +- docs/api/system/getVersion.md | 2 +- docs/api/system/isSensorDiscoverActive.md | 2 +- docs/api/system/killEvents.md | 15 +- docs/api/system/openPage.md | 2 +- docs/api/system/playFile.md | 2 +- docs/api/system/playHaptic.md | 4 +- docs/api/system/playNumber.md | 2 +- docs/api/system/registerLayout.md | 19 -- docs/api/system/registerSystemTool.md | 4 +- docs/api/system/registerTask.md | 4 +- docs/api/system/registerWidget.md | 32 ++- docs/api/system/voltageRange.md | 2 +- docs/examples/official/tool-form/form.png | Bin docs/examples/official/widget-jet.md | 8 +- docs/examples/official/wizard/arm.png | Bin 71 files changed, 300 insertions(+), 422 deletions(-) mode change 100644 => 100755 docs/examples/official/tool-form/form.png mode change 100644 => 100755 docs/examples/official/wizard/arm.png diff --git a/data/api.json b/data/api.json index 45d1102..540f6b1 100644 --- a/data/api.json +++ b/data/api.json @@ -9145,7 +9145,7 @@ "source": { "url": "https://github.com/FrSkyRC/ETHOS-Feedback-Community/releases/download/nightly26/lua-doc.zip", "release": "nightly26", - "sha256": "42165986832dca0a0f8807e1e750769e3f7ef4612055a6322e6596cb515be5d8", - "fetched": "2026-10-09" + "sha256": "4d305931decac1c1529b992e0d36c29fa236c2e693acee0145d52c16c5d28bea", + "fetched": "2026-10-12" } } diff --git a/data/usage.json b/data/usage.json index 5ce7908..444fbdb 100644 --- a/data/usage.json +++ b/data/usage.json @@ -2,11 +2,11 @@ "repos": { "rotorflight/rotorflight-lua-ethos-suite": { "label": "Rotorflight suite", - "sha": "53c7e819afe6293cb7623b5972e4a4d276a90ad1" + "sha": "cdf0b8f37d0ea56d7373ce501d489eeebeda234b" }, "WingFlight/wingflight-lua-ethos-suite": { "label": "Wingflight suite", - "sha": "0a7b1c61ad582033adebbe65183702650d4e377a" + "sha": "8222d3c763027018989da480c098e38ac4c32d4f" }, "robthomson/dashx-ethos": { "label": "DashX", @@ -50,7 +50,7 @@ }, "FrSkyRC/ETHOS-Feedback-Community": { "label": "FrSky official scripts", - "sha": "7cab00b5ee95e761965c58ddec2d2b113fedde64" + "sha": "b92b58ea6585a7b0060a5ac63e827316aa890b45" } }, "calls": { @@ -192,7 +192,7 @@ ] }, "form.addExpansionPanel": { - "count": 86, + "count": 84, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -210,10 +210,10 @@ }, { "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 342, - "start": 342, - "snippet": "panel = form.addExpansionPanel(\"EGT configure\")" + "path": "lua/frsky/RB25_S/group/group.lua", + "line": 126, + "start": 126, + "snippet": "local panel = form.addExpansionPanel(\"Copy bank\")" }, { "repo": "rotorflight/rotorflight-lua-ethos-suite", @@ -225,7 +225,7 @@ ] }, "form.addLine": { - "count": 667, + "count": 657, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -264,7 +264,7 @@ ] }, "form.addStaticText": { - "count": 219, + "count": 217, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -335,7 +335,7 @@ ] }, "form.addNumberField": { - "count": 229, + "count": 225, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -345,13 +345,6 @@ "rotorflight/rotorflight-lua-ethos-suite" ], "snippets": [ - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 307, - "start": 306, - "snippet": "line = panel:addLine(\"Max RPM\")\nrpmMaxEdit = form.addNumberField(line, nil, 0, 10000, function() return widget.maxRpm end, function(newValue) widget.maxRpm = newValue end)" - }, { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/widgets/dashboard/themes/kevd/configure.lua", @@ -365,11 +358,18 @@ "line": 99, "start": 98, "snippet": "local esc_max_line = esc_panel:addLine(\"Max\")\nformFields[#formFields + 1] = form.addNumberField(esc_max_line, nil, 1, 200, function() return config.esctemp_max end, function(val) config.esctemp_max = clamp(tonumber(val) or THEME_DEFAULTS.esctemp_max, config.esctemp_warn + 1, 200) end, 1)" + }, + { + "repo": "FrSkyRC/ETHOS-Feedback-Community", + "path": "lua/frsky/RB25_S/group/group.lua", + "line": 128, + "start": 126, + "snippet": "local panel = form.addExpansionPanel(\"Copy bank\")\nlocal line = panel:addLine(\"From\")\nlocal numberField = form.addNumberField(line, nil, 0, 15, function() return fromGroup end, function(newValue) fromGroup = newValue end)" } ] }, "form.addChoiceField": { - "count": 188, + "count": 186, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -385,8 +385,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/app/pages/tune_advisor.lua", - "line": 637, - "start": 637, + "line": 908, + "start": 908, "snippet": "form.addChoiceField(axisLine, nil, AXES, function() return AXES[selected][2] end, onAxis)" }, { @@ -438,35 +438,6 @@ } ] }, - "form.addSourceField": { - "count": 6, - "projects": [ - "FrSkyRC/ETHOS-Feedback-Community" - ], - "snippets": [ - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 358, - "start": 357, - "snippet": "line = form.addLine(\"Pump source\")\nform.addSourceField(line, nil, function() return widget.pumpSource end, function(newValue) widget.pumpSource = newValue end)" - }, - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 295, - "start": 294, - "snippet": "local line = form.addLine(\"Altitude source\")\nform.addSourceField(line, nil, function() return widget.altSource end, function(newValue) widget.altSource = newValue end)" - }, - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 345, - "start": 342, - "snippet": "panel = form.addExpansionPanel(\"EGT configure\")\nlocal egtMaxEdit\nline = panel:addLine(\"EGT source\")\nform.addSourceField(line, nil, function() return widget.egtSource end, function(newValue)\n widget.egtSource = newValue\n if egtMaxEdit ~= nil then\n egtMaxEdit:suffix(widget.egtSource ~= nil and widget.egtSource:stringUnit() or \"\")\n end\nend)" - } - ] - }, "form.addSwitchField": { "count": 11, "projects": [ @@ -515,24 +486,24 @@ "start": 663, "snippet": "control = form.addTextField(form.addLine(\"@i18n(app.modules.configuration.craft_name)@\"), textFieldPos(app),\n function()\n return state.currentName\n end,\n function(newValue)\n local value = tostring(newValue or \"\")\n if value ~= state.currentName then\n state.currentName = value\n state.dirty = true\n app:setPageDirty(true)\n end\n end)" }, - { - "repo": "rotorflight/rotorflight-lua-ethos-suite", - "path": "src/rfsuite/app/pages/configuration.lua", - "line": 231, - "start": 228, - "snippet": "-- header comment for why: the first page needing one, and why it\n-- can't be corrected in place like every other field type).\nlocal nameLine = form.addLine(\"@i18n(app.modules.configuration.craft_name)@\")\nlocal nameField = form.addTextField(nameLine, nil,\n function()\n local craftName = dataRef.data.craftName\n return craftName and craftName.name or \"\"\n end,\n function(value)\n markDirty()\n local craftName = dataRef.data.craftName\n if craftName then craftName.name = value or \"\" end\n end)" - }, { "repo": "robthomson/dashx-ethos", "path": "src/dashx/app/lib/ui.lua", "line": 534, "start": 534, "snippet": "formFields[i] = form.addTextField(formLines[dashx.session.formLineCnt], posField, function()\n if not fields or not fields[i] then\n ui.disableAllFields()\n ui.disableAllNavigationFields()\n ui.enableNavigationField('menu')\n return nil\n end\n return dashx.app.utils.getFieldValue(fields[i])\nend, function(value)\n if f.postEdit then f.postEdit(page) end\n if f.onChange then f.onChange(page) end\n\n f.value = dashx.app.utils.saveFieldValue(fields[i], value)\nend)" + }, + { + "repo": "rotorflight/rotorflight-lua-ethos-suite", + "path": "src/rfsuite/app/pages/configuration.lua", + "line": 240, + "start": 237, + "snippet": "-- header comment for why: the first page needing one, and why it\n-- can't be corrected in place like every other field type).\nlocal nameLine = form.addLine(\"@i18n(app.modules.configuration.craft_name)@\")\nlocal nameField = form.addTextField(nameLine, nil,\n function()\n local craftName = dataRef.data.craftName\n return craftName and craftName.name or \"\"\n end,\n function(value)\n markDirty()\n local craftName = dataRef.data.craftName\n if craftName then\n local name = value or \"\"\n if type(name) ~= \"string\" then name = tostring(name) end\n craftName.name = name:sub(1, mspName.MAX_NAME_LENGTH)\n end\n end)" } ] }, "form.addTextButton": { - "count": 80, + "count": 78, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "robthomson/ethos-arcade", @@ -627,8 +598,8 @@ { "repo": "FrSkyRC/ETHOS-Feedback-Community", "path": "lua/frsky/RB25_S/stab/stab.lua", - "line": 362, - "start": 362, + "line": 381, + "start": 381, "snippet": "local slots = form.getFieldSlots(line, fieldLabels)" }, { @@ -648,7 +619,7 @@ ] }, "form.openDialog": { - "count": 120, + "count": 122, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -745,7 +716,7 @@ ] }, "lcd.RGB": { - "count": 637, + "count": 641, "projects": [ "WingFlight/wingflight-lua-ethos-suite", "iNavFlight/ETHOS-Telemetry-Dashboard", @@ -784,7 +755,7 @@ ] }, "lcd.GREY": { - "count": 32, + "count": 27, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -792,13 +763,6 @@ "rotorflight/rotorflight-lua-ethos-suite" ], "snippets": [ - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 115, - "start": 115, - "snippet": "lcd.color(lcd.GREY(0xFF))" - }, { "repo": "robthomson/ethos-app-framework", "path": "src/rfsuite/app/modules/governor/tools/curves.lua", @@ -812,11 +776,18 @@ "line": 82, "start": 82, "snippet": "if lcd.color and lcd.GREY then lcd.color(lcd.GREY(90)) end" + }, + { + "repo": "FrSkyRC/ETHOS-Feedback-Community", + "path": "lua/frsky/RB25_S/stab/cali/cali.lua", + "line": 163, + "start": 163, + "snippet": "lcd.color(lcd.darkMode() and lcd.GREY(0xFF) or lcd.GREY(0))" } ] }, "lcd.color": { - "count": 601, + "count": 607, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -879,15 +850,16 @@ { "repo": "WingFlight/wingflight-lua-ethos-suite", "path": "src/wfsuite/widgets/dashboard.lua", - "line": 466, - "start": 464, + "line": 468, + "start": 466, "snippet": "local function resolveToolbarThemeColor(themeColorKey, fallback)\n if type(themeColorKey) == \"number\" and type(lcd.themeColor) == \"function\" and ensureEthosVersion().atLeast({26, 1, 0}) then\n return lcd.themeColor(themeColorKey)\n end\n return fallback\nend" } ] }, "lcd.darkMode": { - "count": 38, + "count": 41, "projects": [ + "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", "iNavFlight/ETHOS-Telemetry-Dashboard", "robthomson/dashx-ethos", @@ -922,9 +894,8 @@ ] }, "lcd.font": { - "count": 323, + "count": 334, "projects": [ - "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", "flyingeek/ethos-gps-qrcode", "iNavFlight/ETHOS-Telemetry-Dashboard", @@ -945,17 +916,17 @@ "snippet": "lcd.font(font)" }, { - "repo": "robthomson/ethos-arcade", - "path": "src/ethos-arcade/games/gulaxian/game.lua", - "line": 914, - "start": 914, + "repo": "WingFlight/wingflight-lua-ethos-suite", + "path": "src/wfsuite/widgets/dashboard/battery_picker.lua", + "line": 152, + "start": 152, "snippet": "lcd.font(FONT_S)" }, { - "repo": "WingFlight/wingflight-lua-ethos-suite", - "path": "src/wfsuite/app/alignment_visual.lua", - "line": 223, - "start": 223, + "repo": "robthomson/dashx-ethos", + "path": "src/dashx/widgets/dashboard/lib/toolbar.lua", + "line": 56, + "start": 56, "snippet": "lcd.font(FONT_XS)" } ] @@ -1016,9 +987,8 @@ ] }, "lcd.drawLine": { - "count": 133, + "count": 121, "projects": [ - "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", "iNavFlight/ETHOS-Telemetry-Dashboard", "robthomson/dashx-ethos", @@ -1127,9 +1097,8 @@ ] }, "lcd.drawFilledRectangle": { - "count": 354, + "count": 363, "projects": [ - "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", "flyingeek/ethos-gps-qrcode", "iNavFlight/ETHOS-Telemetry-Dashboard", @@ -1268,7 +1237,7 @@ ] }, "lcd.drawText": { - "count": 409, + "count": 402, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -1309,7 +1278,7 @@ ] }, "lcd.hasFocus": { - "count": 15, + "count": 17, "projects": [ "WingFlight/wingflight-lua-ethos-suite", "iNavFlight/ETHOS-Telemetry-Dashboard", @@ -1326,23 +1295,23 @@ "snippet": "if not lcd.hasFocus() then return false end" }, { - "repo": "robthomson/dashx-ethos", - "path": "src/dashx/widgets/dashboard/dashboard.lua", - "line": 726, - "start": 726, + "repo": "rotorflight/rotorflight-lua-ethos-suite", + "path": "src/rfsuite/widgets/dashboard.lua", + "line": 1372, + "start": 1372, "snippet": "if category == EVT_KEY and lcd.hasFocus() then" }, { - "repo": "rotorflight/rotorflight-lua-ethos-suite", - "path": "src/rfsuite/widgets/dashboard.lua", - "line": 1893, - "start": 1893, + "repo": "WingFlight/wingflight-lua-ethos-suite", + "path": "src/wfsuite/widgets/dashboard.lua", + "line": 2093, + "start": 2093, "snippet": "if widget.infoPanelVisible and category == EVT_KEY and lcd.hasFocus()" } ] }, "lcd.loadBitmap": { - "count": 35, + "count": 27, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -1410,7 +1379,7 @@ ] }, "lcd.drawBitmap": { - "count": 39, + "count": 31, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -1454,14 +1423,14 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/widgets/dashboard.lua", - "line": 605, - "start": 602, + "line": 617, + "start": 614, "snippet": "local minIconY = labelY + (labelH or 0) + iconGap\nlocal iconY = by + bh - iconSize - iconBottomPad\nif iconY < minIconY then iconY = minIconY end\nlcd.drawMask(math.floor(bx + (bw - iconSize) / 2 + 0.5), math.floor(iconY + 0.5), mask)" } ] }, "lcd.getTextSize": { - "count": 259, + "count": 265, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -1492,14 +1461,14 @@ { "repo": "WingFlight/wingflight-lua-ethos-suite", "path": "src/wfsuite/widgets/dashboard.lua", - "line": 517, - "start": 517, + "line": 519, + "start": 519, "snippet": "local tw, th = lcd.getTextSize(label)" } ] }, "lcd.getWindowSize": { - "count": 231, + "count": 242, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -1832,8 +1801,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/tasks/msp/transport_sport.lua", - "line": 33, - "start": 31, + "line": 39, + "start": 37, "snippet": "local function getSensor()\n if not sensor then\n sensor = sport.getSensor({module = moduleNumber or 0, primId = REPLY_FRAME_ID})\n end\n return sensor\nend" }, { @@ -1846,20 +1815,12 @@ ] }, "storage.read": { - "count": 16, + "count": 6, "projects": [ - "FrSkyRC/ETHOS-Feedback-Community", "iNavFlight/ETHOS-Telemetry-Dashboard", "robthomson/ethos-bmfa-caller" ], "snippets": [ - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 376, - "start": 376, - "snippet": "widget.pumpSource = storage.read(\"pumpSource\")" - }, { "repo": "robthomson/ethos-bmfa-caller", "path": "src/bmfa-caller/widget_impl.lua", @@ -1877,20 +1838,12 @@ ] }, "storage.write": { - "count": 16, + "count": 6, "projects": [ - "FrSkyRC/ETHOS-Feedback-Community", "iNavFlight/ETHOS-Telemetry-Dashboard", "robthomson/ethos-bmfa-caller" ], "snippets": [ - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 394, - "start": 394, - "snippet": "storage.write(\"pumpSource\", widget.pumpSource)" - }, { "repo": "iNavFlight/ETHOS-Telemetry-Dashboard", "path": "src/inav-dashboard/widget.lua", @@ -1972,7 +1925,7 @@ ] }, "system.getVersion": { - "count": 67, + "count": 69, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -2019,8 +1972,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/tasks/background.lua", - "line": 78, - "start": 78, + "line": 85, + "start": 85, "snippet": "local mem = system.getMemoryUsage and system.getMemoryUsage() or {}" }, { @@ -2097,8 +2050,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/tasks/audio_events.lua", - "line": 186, - "start": 185, + "line": 194, + "start": 193, "snippet": "local function playCommon(file)\n system.playFile(\"audio/\" .. file)\nend" }, { @@ -2129,8 +2082,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/tasks/audio_events.lua", - "line": 206, - "start": 205, + "line": 214, + "start": 213, "snippet": "local function playNumber(value, unit, decimals)\n if system.playNumber then system.playNumber(value, unit, decimals) end\nend" }, { @@ -2152,8 +2105,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/tasks/audio_events.lua", - "line": 233, - "start": 232, + "line": 241, + "start": 240, "snippet": "local function haptic()\n if system.playHaptic then system.playHaptic(\". . . .\") end\nend" }, { @@ -2166,7 +2119,7 @@ ] }, "system.killEvents": { - "count": 41, + "count": 43, "projects": [ "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", @@ -2182,19 +2135,19 @@ "start": 440, "snippet": "system.killEvents(KEY_ENTER_BREAK)" }, + { + "repo": "rotorflight/rotorflight-lua-ethos-suite", + "path": "src/rfsuite/widgets/dashboard.lua", + "line": 1383, + "start": 1383, + "snippet": "if system and system.killEvents then system.killEvents(value) end" + }, { "repo": "robthomson/omp-ofs3-dashboard", "path": "src/ofs3/widgets/dashboard/lib/logviewer.lua", "line": 912, "start": 911, "snippet": "if system.killEvents then\n system.killEvents(value)" - }, - { - "repo": "rotorflight/rotorflight-lua-ethos-suite", - "path": "src/rfsuite/app/pages/ports.lua", - "line": 577, - "start": 574, - "snippet": "if opts.setEventHandler then\n opts.setEventHandler(function(category, value)\n if value == KEY_ENTER_LONG then\n system.killEvents(KEY_ENTER_BREAK)" } ] }, @@ -2232,25 +2185,9 @@ } ] }, - "system.registerLayout": { - "count": 1, - "projects": [ - "FrSkyRC/ETHOS-Feedback-Community" - ], - "snippets": [ - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/Layout1P3/main.lua", - "line": 4, - "start": 3, - "snippet": "local function init()\n system.registerLayout({key=\"XL+3\", widgets={\n {x=8, y=95, w=784, h=248},\n {x=8, y=351, w=256, h=56},\n {x=272, y=351, w=256, h=56},\n {x=536, y=351, w=256, h=56}\n }})\nend" - } - ] - }, "system.registerWidget": { - "count": 7, + "count": 6, "projects": [ - "FrSkyRC/ETHOS-Feedback-Community", "WingFlight/wingflight-lua-ethos-suite", "iNavFlight/ETHOS-Telemetry-Dashboard", "robthomson/ethos-app-framework", @@ -2266,19 +2203,19 @@ "start": 13, "snippet": "local function init()\n system.registerWidget(widget)\nend" }, - { - "repo": "FrSkyRC/ETHOS-Feedback-Community", - "path": "lua/frsky/JetWidget/main.lua", - "line": 398, - "start": 397, - "snippet": "local function init()\n system.registerWidget({ key = \"FrkJet\", name = \"Jet dashboard\", create = create, build = build, paint = paint, wakeup = wakeup, configure = configure, read = read, write = write, title = false })\nend" - }, { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/widgets/dashboard.lua", - "line": 2208, - "start": 2205, + "line": 2331, + "start": 2328, "snippet": "local function init(opts)\n opts = opts or {}\n systemToolHandle = opts.systemToolHandle\n system.registerWidget(widget)\nend" + }, + { + "repo": "robthomson/ethos-app-framework", + "path": "src/rfsuite/main.lua", + "line": 70, + "start": 70, + "snippet": "system.registerWidget({\n name = meta.name,\n key = meta.key,\n create = widget.create,\n wakeup = widget.wakeup,\n paint = widget.paint,\n event = widget.event,\n close = widget.close,\n persistent = widget.persistent or false,\n configure = widget.configure,\n read = widget.read,\n write = widget.write,\n menu = widget.menu,\n title = widget.title\n})" } ] }, @@ -2353,15 +2290,15 @@ { "repo": "WingFlight/wingflight-lua-ethos-suite", "path": "src/wfsuite/tasks/background.lua", - "line": 416, - "start": 415, + "line": 474, + "start": 473, "snippet": "local function init()\n system.registerTask({\n key = \"wf2bg\",\n name = \"Wingflight [Background]\",\n init = taskInit,\n wakeup = taskWakeup,\n event = taskEvent,\n })\nend" }, { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/tasks/background.lua", - "line": 209, - "start": 208, + "line": 267, + "start": 266, "snippet": "local function init()\n system.registerTask({\n key = \"rf2bg\",\n name = \"Rotorflight [Background]\",\n init = taskInit,\n wakeup = taskWakeup,\n event = taskEvent,\n })\nend" }, { @@ -2462,8 +2399,8 @@ { "repo": "rotorflight/rotorflight-lua-ethos-suite", "path": "src/rfsuite/widgets/dashboard.lua", - "line": 1289, - "start": 1284, + "line": 1395, + "start": 1390, "snippet": "local function launchSystemTool(widget)\n if not canOpenSystemTool() then return end\n setToolbarVisible(widget, false)\n requestPaint(widget)\n invalidateWidget(widget)\n system.openPage({system = systemToolHandle})\nend" } ] diff --git a/docs/api/crsf/getSensor.md b/docs/api/crsf/getSensor.md index 8d5242e..5aa3300 100644 --- a/docs/api/crsf/getSensor.md +++ b/docs/api/crsf/getSensor.md @@ -43,7 +43,7 @@ local sensor = crsf.getSensor() end ``` - [src/rfsuite/tasks/msp/transport_crsf.lua:22](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/msp/transport_crsf.lua#L22-L25) + [src/rfsuite/tasks/msp/transport_crsf.lua:22](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/msp/transport_crsf.lua#L22-L25) === "Example 2" @@ -81,4 +81,4 @@ local sensor = crsf.getSensor() end ``` - [src/wfsuite/lib/elrslink_task.lua:243](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/lib/elrslink_task.lua#L243-L254) + [src/wfsuite/lib/elrslink_task.lua:243](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/lib/elrslink_task.lua#L243-L254) diff --git a/docs/api/form/addBooleanField.md b/docs/api/form/addBooleanField.md index fcae07d..713b6e6 100644 --- a/docs/api/form/addBooleanField.md +++ b/docs/api/form/addBooleanField.md @@ -88,4 +88,4 @@ form.addBooleanField(line, nil, function() return value end, function(newValue) end) ``` - [src/rfsuite/app/pages/blackbox_edit_page.lua:364](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/blackbox_edit_page.lua#L364-L370) + [src/rfsuite/app/pages/blackbox_edit_page.lua:364](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/blackbox_edit_page.lua#L364-L370) diff --git a/docs/api/form/addChoiceField.md b/docs/api/form/addChoiceField.md index 0f3ab7b..18a2e5e 100644 --- a/docs/api/form/addChoiceField.md +++ b/docs/api/form/addChoiceField.md @@ -43,7 +43,7 @@ form.addChoiceField(line, nil, values, function() return value end, function(new ## Real-world usage -
Called 188 times across 9 open-source Ethos Lua projects. A few short excerpts:
+
Called 186 times across 9 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -51,7 +51,7 @@ form.addChoiceField(line, nil, values, function() return value end, function(new form.addChoiceField(axisLine, nil, AXES, function() return AXES[selected][2] end, onAxis) ``` - [src/rfsuite/app/pages/tune_advisor.lua:637](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/tune_advisor.lua#L637-L637) + [src/rfsuite/app/pages/tune_advisor.lua:908](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/tune_advisor.lua#L908-L908) === "Example 2" @@ -62,7 +62,7 @@ form.addChoiceField(line, nil, values, function() return value end, function(new field = form.addChoiceField(line, slot, spec.choices, access.get, access.setWithDirty) ``` - [src/wfsuite/app/field_layout.lua:408](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/field_layout.lua#L408-L411) + [src/wfsuite/app/field_layout.lua:408](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/field_layout.lua#L408-L411) === "Example 3" diff --git a/docs/api/form/addExpansionPanel.md b/docs/api/form/addExpansionPanel.md index 8c91364..0d7f9c8 100644 --- a/docs/api/form/addExpansionPanel.md +++ b/docs/api/form/addExpansionPanel.md @@ -41,7 +41,7 @@ panel:open(false) -- by default the panel is open, let's keep it closed! ## Real-world usage -
Called 86 times across 5 open-source Ethos Lua projects. A few short excerpts:
+
Called 84 times across 5 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -49,15 +49,15 @@ panel:open(false) -- by default the panel is open, let's keep it closed! local rpm_panel = form.addExpansionPanel("RPM") ``` - [src/wfsuite/widgets/dashboard/themes/kevd/configure.lua:47](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/widgets/dashboard/themes/kevd/configure.lua#L47-L47) + [src/wfsuite/widgets/dashboard/themes/kevd/configure.lua:47](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard/themes/kevd/configure.lua#L47-L47) === "Example 2" ```lua - panel = form.addExpansionPanel("EGT configure") + local panel = form.addExpansionPanel("Copy bank") ``` - [lua/frsky/JetWidget/main.lua:342](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L342-L342) + [lua/frsky/RB25_S/group/group.lua:126](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/group/group.lua#L126-L126) === "Example 3" @@ -65,4 +65,4 @@ panel:open(false) -- by default the panel is open, let's keep it closed! local radio = form.addExpansionPanel("Radio link") ``` - [src/rfsuite/widgets/dashboard/themes/bastion/configure.lua:154](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/themes/bastion/configure.lua#L154-L154) + [src/rfsuite/widgets/dashboard/themes/bastion/configure.lua:154](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/themes/bastion/configure.lua#L154-L154) diff --git a/docs/api/form/addFileField.md b/docs/api/form/addFileField.md index eb0f52e..d44c31f 100644 --- a/docs/api/form/addFileField.md +++ b/docs/api/form/addFileField.md @@ -55,4 +55,4 @@ form.addFileField(line, nil, "/audio/en/system", "audio", function() return file end) ``` - [lua/frsky/RB25_S/stab/basic/basic.lua:101](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/RB25_S/stab/basic/basic.lua#L101-L105) + [lua/frsky/RB25_S/stab/basic/basic.lua:101](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/stab/basic/basic.lua#L101-L105) diff --git a/docs/api/form/addLine.md b/docs/api/form/addLine.md index f20fcfe..eefc21f 100644 --- a/docs/api/form/addLine.md +++ b/docs/api/form/addLine.md @@ -66,7 +66,7 @@ form.addLine("Label", nil, false) -- no separator ## Real-world usage -
Called 667 times across 11 open-source Ethos Lua projects. A few short excerpts:
+
Called 657 times across 11 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -90,4 +90,4 @@ form.addLine("Label", nil, false) -- no separator local line = form.addLine("") ``` - [src/rfsuite/app/header.lua:231](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/header.lua#L231-L231) + [src/rfsuite/app/header.lua:231](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/header.lua#L231-L231) diff --git a/docs/api/form/addNumberField.md b/docs/api/form/addNumberField.md index d235cba..e84d9a1 100644 --- a/docs/api/form/addNumberField.md +++ b/docs/api/form/addNumberField.md @@ -56,31 +56,32 @@ myField:step(2) ## Real-world usage -
Called 229 times across 6 open-source Ethos Lua projects. A few short excerpts:
+
Called 225 times across 6 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" ```lua - line = panel:addLine("Max RPM") - rpmMaxEdit = form.addNumberField(line, nil, 0, 10000, function() return widget.maxRpm end, function(newValue) widget.maxRpm = newValue end) + local rpm_max_line = rpm_panel:addLine("Max") + formFields[#formFields + 1] = form.addNumberField(rpm_max_line, nil, 1, 20000, function() return config.rpm_max end, function(val) config.rpm_max = clamp(tonumber(val) or THEME_DEFAULTS.rpm_max, config.rpm_min + 1, 20000) end, 1) ``` - [lua/frsky/JetWidget/main.lua:306](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L306-L307) + [src/rfsuite/widgets/dashboard/themes/kevd/configure.lua:53](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/themes/kevd/configure.lua#L53-L54) === "Example 2" ```lua - local rpm_max_line = rpm_panel:addLine("Max") - formFields[#formFields + 1] = form.addNumberField(rpm_max_line, nil, 1, 20000, function() return config.rpm_max end, function(val) config.rpm_max = clamp(tonumber(val) or THEME_DEFAULTS.rpm_max, config.rpm_min + 1, 20000) end, 1) + local esc_max_line = esc_panel:addLine("Max") + formFields[#formFields + 1] = form.addNumberField(esc_max_line, nil, 1, 200, function() return config.esctemp_max end, function(val) config.esctemp_max = clamp(tonumber(val) or THEME_DEFAULTS.esctemp_max, config.esctemp_warn + 1, 200) end, 1) ``` - [src/rfsuite/widgets/dashboard/themes/kevd/configure.lua:53](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/themes/kevd/configure.lua#L53-L54) + [src/wfsuite/widgets/dashboard/themes/kevd/configure.lua:98](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard/themes/kevd/configure.lua#L98-L99) === "Example 3" ```lua - local esc_max_line = esc_panel:addLine("Max") - formFields[#formFields + 1] = form.addNumberField(esc_max_line, nil, 1, 200, function() return config.esctemp_max end, function(val) config.esctemp_max = clamp(tonumber(val) or THEME_DEFAULTS.esctemp_max, config.esctemp_warn + 1, 200) end, 1) + local panel = form.addExpansionPanel("Copy bank") + local line = panel:addLine("From") + local numberField = form.addNumberField(line, nil, 0, 15, function() return fromGroup end, function(newValue) fromGroup = newValue end) ``` - [src/wfsuite/widgets/dashboard/themes/kevd/configure.lua:98](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/widgets/dashboard/themes/kevd/configure.lua#L98-L99) + [lua/frsky/RB25_S/group/group.lua:126](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/group/group.lua#L126-L128) diff --git a/docs/api/form/addSliderField.md b/docs/api/form/addSliderField.md index 2eb9d1e..a74e435 100644 --- a/docs/api/form/addSliderField.md +++ b/docs/api/form/addSliderField.md @@ -60,7 +60,7 @@ form.addSliderField(line, nil, 0, 100, function() return value end, function(new end) ``` - [src/rfsuite/app/pages/logs.lua:540](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/logs.lua#L540-L544) + [src/rfsuite/app/pages/logs.lua:540](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/logs.lua#L540-L544) === "Example 3" diff --git a/docs/api/form/addSourceField.md b/docs/api/form/addSourceField.md index 39cb58a..2731dc1 100644 --- a/docs/api/form/addSourceField.md +++ b/docs/api/form/addSourceField.md @@ -58,41 +58,3 @@ form.addSourceField(line, nil, function() return source end, function(newValue) - [widget-form](../../examples/official/widget-form.md) - [widget-gauge](../../examples/official/widget-gauge.md) - [widget-jet](../../examples/official/widget-jet.md) - -## Real-world usage - -
Called 6 times across 1 open-source Ethos Lua project. A few short excerpts:
- -=== "Example 1" - - ```lua - line = form.addLine("Pump source") - form.addSourceField(line, nil, function() return widget.pumpSource end, function(newValue) widget.pumpSource = newValue end) - ``` - - [lua/frsky/JetWidget/main.lua:357](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L357-L358) - -=== "Example 2" - - ```lua - local line = form.addLine("Altitude source") - form.addSourceField(line, nil, function() return widget.altSource end, function(newValue) widget.altSource = newValue end) - ``` - - [lua/frsky/JetWidget/main.lua:294](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L294-L295) - -=== "Example 3" - - ```lua - panel = form.addExpansionPanel("EGT configure") - local egtMaxEdit - line = panel:addLine("EGT source") - form.addSourceField(line, nil, function() return widget.egtSource end, function(newValue) - widget.egtSource = newValue - if egtMaxEdit ~= nil then - egtMaxEdit:suffix(widget.egtSource ~= nil and widget.egtSource:stringUnit() or "") - end - end) - ``` - - [lua/frsky/JetWidget/main.lua:342](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L342-L350) diff --git a/docs/api/form/addStaticText.md b/docs/api/form/addStaticText.md index 94d7bd7..b9cdbe3 100644 --- a/docs/api/form/addStaticText.md +++ b/docs/api/form/addStaticText.md @@ -48,7 +48,7 @@ form.addStaticText(line, nil, "Static Text") ## Real-world usage -
Called 219 times across 10 open-source Ethos Lua projects. A few short excerpts:
+
Called 217 times across 10 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -64,7 +64,7 @@ form.addStaticText(line, nil, "Static Text") previewTop = form.addStaticText(layoutLine, slots[2], "") ``` - [src/rfsuite/app/pages/settings_activelook_mode.lua:41](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/settings_activelook_mode.lua#L41-L41) + [src/rfsuite/app/pages/settings_activelook_mode.lua:41](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/settings_activelook_mode.lua#L41-L41) === "Example 3" @@ -72,4 +72,4 @@ form.addStaticText(line, nil, "Static Text") local enaLive = form.addStaticText(enaLine, {x = xLive, y = y, w = wLive, h = h}, "--") ``` - [src/wfsuite/app/pages/adjustments.lua:727](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/pages/adjustments.lua#L727-L727) + [src/wfsuite/app/pages/adjustments.lua:727](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/pages/adjustments.lua#L727-L727) diff --git a/docs/api/form/addSwitchField.md b/docs/api/form/addSwitchField.md index 0836a85..d959fed 100644 --- a/docs/api/form/addSwitchField.md +++ b/docs/api/form/addSwitchField.md @@ -80,4 +80,4 @@ form.addSwitchField(line, nil, function() return switch end, function(newValue) end) ``` - [src/rfsuite/app/pages/settings_activelook_settings.lua:36](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/settings_activelook_settings.lua#L36-L42) + [src/rfsuite/app/pages/settings_activelook_settings.lua:36](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/settings_activelook_settings.lua#L36-L42) diff --git a/docs/api/form/addTextButton.md b/docs/api/form/addTextButton.md index 573f7d5..50082eb 100644 --- a/docs/api/form/addTextButton.md +++ b/docs/api/form/addTextButton.md @@ -44,7 +44,7 @@ form.addTextButton(line, nil, "Text Button", function() end) ## Real-world usage -
Called 80 times across 4 open-source Ethos Lua projects. A few short excerpts:
+
Called 78 times across 4 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" diff --git a/docs/api/form/addTextField.md b/docs/api/form/addTextField.md index 493ede3..cdc20cb 100644 --- a/docs/api/form/addTextField.md +++ b/docs/api/form/addTextField.md @@ -68,26 +68,6 @@ form.addTextField(line, form.getFieldSlots(line, {100, 0, "slot3"})[0], function === "Example 2" - ```lua - -- header comment for why: the first page needing one, and why it - -- can't be corrected in place like every other field type). - local nameLine = form.addLine("@i18n(app.modules.configuration.craft_name)@") - local nameField = form.addTextField(nameLine, nil, - function() - local craftName = dataRef.data.craftName - return craftName and craftName.name or "" - end, - function(value) - markDirty() - local craftName = dataRef.data.craftName - if craftName then craftName.name = value or "" end - end) - ``` - - [src/rfsuite/app/pages/configuration.lua:228](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/configuration.lua#L228-L240) - -=== "Example 3" - ```lua formFields[i] = form.addTextField(formLines[dashx.session.formLineCnt], posField, function() if not fields or not fields[i] then @@ -106,3 +86,27 @@ form.addTextField(line, form.getFieldSlots(line, {100, 0, "slot3"})[0], function ``` [src/dashx/app/lib/ui.lua:534](https://github.com/robthomson/dashx-ethos/blob/6dcae492715da80d210cb4c6b16c3881c9791e2a/src/dashx/app/lib/ui.lua#L534-L547) + +=== "Example 3" + + ```lua + -- header comment for why: the first page needing one, and why it + -- can't be corrected in place like every other field type). + local nameLine = form.addLine("@i18n(app.modules.configuration.craft_name)@") + local nameField = form.addTextField(nameLine, nil, + function() + local craftName = dataRef.data.craftName + return craftName and craftName.name or "" + end, + function(value) + markDirty() + local craftName = dataRef.data.craftName + if craftName then + local name = value or "" + if type(name) ~= "string" then name = tostring(name) end + craftName.name = name:sub(1, mspName.MAX_NAME_LENGTH) + end + end) + ``` + + [src/rfsuite/app/pages/configuration.lua:237](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/configuration.lua#L237-L253) diff --git a/docs/api/form/clear.md b/docs/api/form/clear.md index ef4a311..99000e1 100644 --- a/docs/api/form/clear.md +++ b/docs/api/form/clear.md @@ -46,7 +46,7 @@ form.clear() form.clear() ``` - [src/rfsuite/app/pages/adjustments.lua:811](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/adjustments.lua#L811-L812) + [src/rfsuite/app/pages/adjustments.lua:811](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/adjustments.lua#L811-L812) === "Example 2" @@ -55,7 +55,7 @@ form.clear() form.clear() ``` - [src/wfsuite/app/pages/adjustments.lua:545](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/pages/adjustments.lua#L545-L546) + [src/wfsuite/app/pages/adjustments.lua:545](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/pages/adjustments.lua#L545-L546) === "Example 3" diff --git a/docs/api/form/getFieldSlots.md b/docs/api/form/getFieldSlots.md index 66bd561..9bd085e 100644 --- a/docs/api/form/getFieldSlots.md +++ b/docs/api/form/getFieldSlots.md @@ -50,7 +50,7 @@ form.getFieldSlots(line, {100, 0, "slot3"}) local slots = form.getFieldSlots(line, fieldLabels) ``` - [lua/frsky/RB25_S/stab/stab.lua:362](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/RB25_S/stab/stab.lua#L362-L362) + [lua/frsky/RB25_S/stab/stab.lua:381](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/stab/stab.lua#L381-L381) === "Example 2" @@ -58,7 +58,7 @@ form.getFieldSlots(line, {100, 0, "slot3"}) local slots = form.getFieldSlots(line, {0, SLOT_HINT, SLOT_HINT, SLOT_HINT, SLOT_HINT}) ``` - [src/rfsuite/app/header.lua:255](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/header.lua#L255-L255) + [src/rfsuite/app/header.lua:255](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/header.lua#L255-L255) === "Example 3" @@ -67,4 +67,4 @@ form.getFieldSlots(line, {100, 0, "slot3"}) local slot = form.getFieldSlots(line, {0})[1] ``` - [src/wfsuite/app/pages/alignment.lua:60](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/pages/alignment.lua#L60-L61) + [src/wfsuite/app/pages/alignment.lua:60](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/pages/alignment.lua#L60-L61) diff --git a/docs/api/form/height.md b/docs/api/form/height.md index c019676..064cde0 100644 --- a/docs/api/form/height.md +++ b/docs/api/form/height.md @@ -53,7 +53,7 @@ print(form.height()) local preCountHeight = form.height() ``` - [src/wfsuite/app/pages/curves.lua:376](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/pages/curves.lua#L376-L376) + [src/wfsuite/app/pages/curves.lua:376](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/pages/curves.lua#L376-L376) === "Example 3" diff --git a/docs/api/form/invalidate.md b/docs/api/form/invalidate.md index 05d0eb3..72ee577 100644 --- a/docs/api/form/invalidate.md +++ b/docs/api/form/invalidate.md @@ -38,7 +38,7 @@ Nothing. if form.invalidate then form.invalidate() end ``` - [src/rfsuite/app/pages/power_smartfuel.lua:129](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/power_smartfuel.lua#L129-L129) + [src/rfsuite/app/pages/power_smartfuel.lua:129](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/power_smartfuel.lua#L129-L129) === "Example 2" @@ -48,7 +48,7 @@ Nothing. if form.invalidate then form.invalidate() end ``` - [src/wfsuite/app/pages/telemetry.lua:294](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/pages/telemetry.lua#L294-L296) + [src/wfsuite/app/pages/telemetry.lua:294](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/pages/telemetry.lua#L294-L296) === "Example 3" diff --git a/docs/api/form/openDialog.md b/docs/api/form/openDialog.md index a0c6ca9..549e90d 100644 --- a/docs/api/form/openDialog.md +++ b/docs/api/form/openDialog.md @@ -70,7 +70,7 @@ local dialog = form.openDialog({ ## Real-world usage -
Called 120 times across 6 open-source Ethos Lua projects. A few short excerpts:
+
Called 122 times across 6 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -98,4 +98,4 @@ local dialog = form.openDialog({ end ``` - [lua/frsky/RB25_S/stab/common.lua:46](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/RB25_S/stab/common.lua#L46-L48) + [lua/frsky/RB25_S/stab/common.lua:46](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/stab/common.lua#L46-L48) diff --git a/docs/api/glasses/createLayout.md b/docs/api/glasses/createLayout.md index b9f47d0..c1be55f 100644 --- a/docs/api/glasses/createLayout.md +++ b/docs/api/glasses/createLayout.md @@ -76,4 +76,4 @@ end }) ``` - [src/rfsuite/widgets/activelook.lua:269](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/activelook.lua#L269-L279) + [src/rfsuite/widgets/activelook.lua:269](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/activelook.lua#L269-L279) diff --git a/docs/api/glasses/getWindowSize.md b/docs/api/glasses/getWindowSize.md index b5b3f02..7f7a443 100644 --- a/docs/api/glasses/getWindowSize.md +++ b/docs/api/glasses/getWindowSize.md @@ -39,4 +39,4 @@ width (integer): window with local w, h = glasses.getWindowSize() ``` - [src/rfsuite/widgets/activelook.lua:244](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/activelook.lua#L244-L245) + [src/rfsuite/widgets/activelook.lua:244](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/activelook.lua#L244-L245) diff --git a/docs/api/index.md b/docs/api/index.md index 559b402..115478b 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -8,7 +8,7 @@ title: API reference # API reference -
Generated from lua-doc.zip (nightly26, fetched 2026-10-09, sha256 42165986832d).
+
Generated from lua-doc.zip (nightly26, fetched 2026-10-12, sha256 4d305931deca).
## Namespaces @@ -68,21 +68,21 @@ The calls that real scripts use most, counted across the open-source projects li | Function | Calls | Projects | | --- | --- | --- | -| [`form.addLine()`](form/addLine.md) | 667 | 11 | -| [`lcd.RGB()`](lcd/RGB.md) | 637 | 11 | -| [`lcd.color()`](lcd/color.md) | 601 | 11 | -| [`lcd.drawText()`](lcd/drawText.md) | 409 | 13 | -| [`lcd.drawFilledRectangle()`](lcd/drawFilledRectangle.md) | 354 | 12 | -| [`lcd.font()`](lcd/font.md) | 323 | 11 | -| [`lcd.getTextSize()`](lcd/getTextSize.md) | 259 | 10 | +| [`form.addLine()`](form/addLine.md) | 657 | 11 | +| [`lcd.RGB()`](lcd/RGB.md) | 641 | 11 | +| [`lcd.color()`](lcd/color.md) | 607 | 11 | +| [`lcd.drawText()`](lcd/drawText.md) | 402 | 13 | +| [`lcd.drawFilledRectangle()`](lcd/drawFilledRectangle.md) | 363 | 11 | +| [`lcd.font()`](lcd/font.md) | 334 | 10 | +| [`lcd.getTextSize()`](lcd/getTextSize.md) | 265 | 10 | | [`lcd.loadMask()`](lcd/loadMask.md) | 252 | 6 | -| [`lcd.getWindowSize()`](lcd/getWindowSize.md) | 231 | 13 | -| [`form.addNumberField()`](form/addNumberField.md) | 229 | 6 | +| [`lcd.getWindowSize()`](lcd/getWindowSize.md) | 242 | 13 | | [`form.clear()`](form/clear.md) | 227 | 9 | -| [`form.addStaticText()`](form/addStaticText.md) | 219 | 10 | -| [`form.addChoiceField()`](form/addChoiceField.md) | 188 | 9 | +| [`form.addNumberField()`](form/addNumberField.md) | 225 | 6 | +| [`form.addStaticText()`](form/addStaticText.md) | 217 | 10 | +| [`form.addChoiceField()`](form/addChoiceField.md) | 186 | 9 | | [`lcd.invalidate()`](lcd/invalidate.md) | 153 | 13 | -| [`lcd.drawLine()`](lcd/drawLine.md) | 133 | 9 | +| [`form.openDialog()`](form/openDialog.md) | 122 | 6 | ## What's new diff --git a/docs/api/lcd/GREY.md b/docs/api/lcd/GREY.md index d1f602f..3b1a712 100644 --- a/docs/api/lcd/GREY.md +++ b/docs/api/lcd/GREY.md @@ -42,28 +42,28 @@ local SUBTLE = lcd.GREY(160, 0.5) -- light grey, 50 % transparent ## Real-world usage -
Called 32 times across 4 open-source Ethos Lua projects. A few short excerpts:
+
Called 27 times across 4 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" ```lua - lcd.color(lcd.GREY(0xFF)) + lcd.color(isDark and lcd.GREY(80) or lcd.GREY(180)) ``` - [lua/frsky/JetWidget/main.lua:115](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L115-L115) + [src/rfsuite/app/modules/governor/tools/curves.lua:443](https://github.com/robthomson/ethos-app-framework/blob/fdfd6e70f8f2865a2742102e009b791ae18e3ca9/src/rfsuite/app/modules/governor/tools/curves.lua#L443-L443) === "Example 2" ```lua - lcd.color(isDark and lcd.GREY(80) or lcd.GREY(180)) + if lcd.color and lcd.GREY then lcd.color(lcd.GREY(90)) end ``` - [src/rfsuite/app/modules/governor/tools/curves.lua:443](https://github.com/robthomson/ethos-app-framework/blob/fdfd6e70f8f2865a2742102e009b791ae18e3ca9/src/rfsuite/app/modules/governor/tools/curves.lua#L443-L443) + [src/rfsuite/app/pages/setup_governor_curves.lua:82](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/setup_governor_curves.lua#L82-L82) === "Example 3" ```lua - if lcd.color and lcd.GREY then lcd.color(lcd.GREY(90)) end + lcd.color(lcd.darkMode() and lcd.GREY(0xFF) or lcd.GREY(0)) ``` - [src/rfsuite/app/pages/setup_governor_curves.lua:82](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/setup_governor_curves.lua#L82-L82) + [lua/frsky/RB25_S/stab/cali/cali.lua:163](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/stab/cali/cali.lua#L163-L163) diff --git a/docs/api/lcd/RGB.md b/docs/api/lcd/RGB.md index 6d97d64..ff02317 100644 --- a/docs/api/lcd/RGB.md +++ b/docs/api/lcd/RGB.md @@ -61,7 +61,7 @@ end ## Real-world usage -
Called 637 times across 11 open-source Ethos Lua projects. A few short excerpts:
+
Called 641 times across 11 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -85,4 +85,4 @@ end local skyColor = lcd.RGB(70, 130, 180) ``` - [src/rfsuite/widgets/dashboard/objects/navigation/ah.lua:140](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/objects/navigation/ah.lua#L140-L140) + [src/rfsuite/widgets/dashboard/objects/navigation/ah.lua:140](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/objects/navigation/ah.lua#L140-L140) diff --git a/docs/api/lcd/color.md b/docs/api/lcd/color.md index 1d11d80..0d22871 100644 --- a/docs/api/lcd/color.md +++ b/docs/api/lcd/color.md @@ -56,7 +56,7 @@ The current color applies to every following `lcd.draw*` call **and** to masks d ## Real-world usage -
Called 601 times across 11 open-source Ethos Lua projects. A few short excerpts:
+
Called 607 times across 11 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -64,7 +64,7 @@ The current color applies to every following `lcd.draw*` call **and** to masks d lcd.color(bg) ``` - [src/rfsuite/app/alignment_visual.lua:183](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/alignment_visual.lua#L183-L183) + [src/rfsuite/app/alignment_visual.lua:183](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/alignment_visual.lua#L183-L183) === "Example 2" @@ -72,7 +72,7 @@ The current color applies to every following `lcd.draw*` call **and** to masks d lcd.color(grid) ``` - [src/wfsuite/app/alignment_visual.lua:219](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/alignment_visual.lua#L219-L219) + [src/wfsuite/app/alignment_visual.lua:219](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/alignment_visual.lua#L219-L219) === "Example 3" diff --git a/docs/api/lcd/darkMode.md b/docs/api/lcd/darkMode.md index 3f81f3a..486e260 100644 --- a/docs/api/lcd/darkMode.md +++ b/docs/api/lcd/darkMode.md @@ -26,7 +26,7 @@ darkMode (boolean) ## Real-world usage -
Called 38 times across 8 open-source Ethos Lua projects. A few short excerpts:
+
Called 41 times across 9 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -42,7 +42,7 @@ darkMode (boolean) local isDark = lcd.darkMode() ``` - [src/rfsuite/app/alignment_visual.lua:168](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/alignment_visual.lua#L168-L168) + [src/rfsuite/app/alignment_visual.lua:168](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/alignment_visual.lua#L168-L168) === "Example 3" diff --git a/docs/api/lcd/drawAnnulusSector.md b/docs/api/lcd/drawAnnulusSector.md index 8b74dea..62ca26a 100644 --- a/docs/api/lcd/drawAnnulusSector.md +++ b/docs/api/lcd/drawAnnulusSector.md @@ -64,7 +64,7 @@ Full example in [Drawing on screen](../../guides/drawing.md#shapes). lcd.drawAnnulusSector(cx, cy, inner, outer, segStart, segEnd) ``` - [src/rfsuite/widgets/dashboard/objects/dial/rainbow.lua:97](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/objects/dial/rainbow.lua#L97-L98) + [src/rfsuite/widgets/dashboard/objects/dial/rainbow.lua:97](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/objects/dial/rainbow.lua#L97-L98) === "Example 2" diff --git a/docs/api/lcd/drawBitmap.md b/docs/api/lcd/drawBitmap.md index d6894e4..ac65084 100644 --- a/docs/api/lcd/drawBitmap.md +++ b/docs/api/lcd/drawBitmap.md @@ -52,7 +52,7 @@ Scaling at draw time is convenient, but an image that is always shown small shou ## Real-world usage -
Called 39 times across 7 open-source Ethos Lua projects. A few short excerpts:
+
Called 31 times across 7 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -76,4 +76,4 @@ Scaling at draw time is convenient, but an image that is always shown small shou lcd.drawBitmap(math.floor(imgX + 0.5), math.floor(imgY + 0.5), bitmap, math.floor(imgW + 0.5), math.floor(imgH + 0.5)) ``` - [src/rfsuite/widgets/dashboard/context.lua:1866](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/context.lua#L1866-L1866) + [src/rfsuite/widgets/dashboard/context.lua:1866](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/context.lua#L1866-L1866) diff --git a/docs/api/lcd/drawCircle.md b/docs/api/lcd/drawCircle.md index 57c22e0..19f207a 100644 --- a/docs/api/lcd/drawCircle.md +++ b/docs/api/lcd/drawCircle.md @@ -38,7 +38,7 @@ Nothing. lcd.drawCircle(cx, cy, outer) ``` - [src/rfsuite/widgets/dashboard/context.lua:2208](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/context.lua#L2208-L2208) + [src/rfsuite/widgets/dashboard/context.lua:2208](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/context.lua#L2208-L2208) === "Example 2" diff --git a/docs/api/lcd/drawFilledCircle.md b/docs/api/lcd/drawFilledCircle.md index be55389..921ba6b 100644 --- a/docs/api/lcd/drawFilledCircle.md +++ b/docs/api/lcd/drawFilledCircle.md @@ -59,7 +59,7 @@ end lcd.drawFilledCircle(p.x, p.y, r) ``` - [src/wfsuite/app/curves_visual.lua:102](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/curves_visual.lua#L102-L103) + [src/wfsuite/app/curves_visual.lua:102](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/curves_visual.lua#L102-L103) === "Example 3" diff --git a/docs/api/lcd/drawFilledRectangle.md b/docs/api/lcd/drawFilledRectangle.md index 6162c32..a4eca44 100644 --- a/docs/api/lcd/drawFilledRectangle.md +++ b/docs/api/lcd/drawFilledRectangle.md @@ -54,7 +54,7 @@ See the [battery gauge recipe](../../cookbook/battery-gauge.md) for a complete w ## Real-world usage -
Called 354 times across 12 open-source Ethos Lua projects. A few short excerpts:
+
Called 363 times across 11 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -62,7 +62,7 @@ See the [battery gauge recipe](../../cookbook/battery-gauge.md) for a complete w lcd.drawFilledRectangle(x, y, w, h) ``` - [src/rfsuite/widgets/dashboard/objects/gauge/bar.lua:129](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/objects/gauge/bar.lua#L129-L129) + [src/rfsuite/widgets/dashboard/objects/gauge/bar.lua:129](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/objects/gauge/bar.lua#L129-L129) === "Example 2" diff --git a/docs/api/lcd/drawFilledTriangle.md b/docs/api/lcd/drawFilledTriangle.md index 3b642fb..36e7323 100644 --- a/docs/api/lcd/drawFilledTriangle.md +++ b/docs/api/lcd/drawFilledTriangle.md @@ -53,7 +53,7 @@ Nothing. lcd.drawFilledTriangle(p1x, p1y, p2x, p2y, p3x, p3y) ``` - [src/rfsuite/widgets/dashboard/objects/navigation/ah.lua:172](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/objects/navigation/ah.lua#L172-L172) + [src/rfsuite/widgets/dashboard/objects/navigation/ah.lua:172](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/objects/navigation/ah.lua#L172-L172) === "Example 3" diff --git a/docs/api/lcd/drawLine.md b/docs/api/lcd/drawLine.md index f03b62e..ef460ca 100644 --- a/docs/api/lcd/drawLine.md +++ b/docs/api/lcd/drawLine.md @@ -57,7 +57,7 @@ Use [`lcd.pen(PEN_DOTTED)`](pen.md) before drawing for dotted lines (grid lines, ## Real-world usage -
Called 133 times across 9 open-source Ethos Lua projects. A few short excerpts:
+
Called 121 times across 8 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" diff --git a/docs/api/lcd/drawMask.md b/docs/api/lcd/drawMask.md index d191a7c..9ce540f 100644 --- a/docs/api/lcd/drawMask.md +++ b/docs/api/lcd/drawMask.md @@ -59,4 +59,4 @@ Masks are single-channel images, cheaper than full-color bitmaps and recolorable lcd.drawMask(math.floor(bx + (bw - iconSize) / 2 + 0.5), math.floor(iconY + 0.5), mask) ``` - [src/rfsuite/widgets/dashboard.lua:602](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard.lua#L602-L605) + [src/rfsuite/widgets/dashboard.lua:614](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard.lua#L614-L617) diff --git a/docs/api/lcd/drawRectangle.md b/docs/api/lcd/drawRectangle.md index c90874e..fee8b45 100644 --- a/docs/api/lcd/drawRectangle.md +++ b/docs/api/lcd/drawRectangle.md @@ -75,4 +75,4 @@ end lcd.drawRectangle(infoX, infoY, infoW, infoH) ``` - [src/rfsuite/app/alignment_visual.lua:213](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/alignment_visual.lua#L213-L214) + [src/rfsuite/app/alignment_visual.lua:213](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/alignment_visual.lua#L213-L214) diff --git a/docs/api/lcd/drawText.md b/docs/api/lcd/drawText.md index 93685b2..2279800 100644 --- a/docs/api/lcd/drawText.md +++ b/docs/api/lcd/drawText.md @@ -66,7 +66,7 @@ end ## Real-world usage -
Called 409 times across 13 open-source Ethos Lua projects. A few short excerpts:
+
Called 402 times across 13 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" diff --git a/docs/api/lcd/font.md b/docs/api/lcd/font.md index f9e0c19..7eef26d 100644 --- a/docs/api/lcd/font.md +++ b/docs/api/lcd/font.md @@ -67,7 +67,7 @@ All font constants are under [Fonts](../constants.md#fonts). ## Real-world usage -
Called 323 times across 11 open-source Ethos Lua projects. A few short excerpts:
+
Called 334 times across 10 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -75,7 +75,7 @@ All font constants are under [Fonts](../constants.md#fonts). lcd.font(font) ``` - [src/rfsuite/widgets/dashboard/themes/danielrc/common.lua:520](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/themes/danielrc/common.lua#L520-L520) + [src/rfsuite/widgets/dashboard/themes/danielrc/common.lua:520](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/themes/danielrc/common.lua#L520-L520) === "Example 2" @@ -83,7 +83,7 @@ All font constants are under [Fonts](../constants.md#fonts). lcd.font(FONT_S) ``` - [src/ethos-arcade/games/gulaxian/game.lua:914](https://github.com/robthomson/ethos-arcade/blob/0fb9f36a97dc902391c425e97ef79211fc7ae0d9/src/ethos-arcade/games/gulaxian/game.lua#L914-L914) + [src/wfsuite/widgets/dashboard/battery_picker.lua:152](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard/battery_picker.lua#L152-L152) === "Example 3" @@ -91,4 +91,4 @@ All font constants are under [Fonts](../constants.md#fonts). lcd.font(FONT_XS) ``` - [src/wfsuite/app/alignment_visual.lua:223](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/alignment_visual.lua#L223-L223) + [src/dashx/widgets/dashboard/lib/toolbar.lua:56](https://github.com/robthomson/dashx-ethos/blob/6dcae492715da80d210cb4c6b16c3881c9791e2a/src/dashx/widgets/dashboard/lib/toolbar.lua#L56-L56) diff --git a/docs/api/lcd/getTextSize.md b/docs/api/lcd/getTextSize.md index db888d9..f571366 100644 --- a/docs/api/lcd/getTextSize.md +++ b/docs/api/lcd/getTextSize.md @@ -64,7 +64,7 @@ end ## Real-world usage -
Called 259 times across 10 open-source Ethos Lua projects. A few short excerpts:
+
Called 265 times across 10 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -72,7 +72,7 @@ end local tw = lcd.getTextSize(text) ``` - [src/rfsuite/app/tile_grid.lua:95](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/tile_grid.lua#L95-L95) + [src/rfsuite/app/tile_grid.lua:95](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/tile_grid.lua#L95-L95) === "Example 2" @@ -88,4 +88,4 @@ end local tw, th = lcd.getTextSize(label) ``` - [src/wfsuite/widgets/dashboard.lua:517](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/widgets/dashboard.lua#L517-L517) + [src/wfsuite/widgets/dashboard.lua:519](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard.lua#L519-L519) diff --git a/docs/api/lcd/getWindowSize.md b/docs/api/lcd/getWindowSize.md index d7bcd97..5172239 100644 --- a/docs/api/lcd/getWindowSize.md +++ b/docs/api/lcd/getWindowSize.md @@ -53,7 +53,7 @@ The same widget can be placed in slots of very different sizes (and radios range ## Real-world usage -
Called 231 times across 13 open-source Ethos Lua projects. A few short excerpts:
+
Called 242 times across 13 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -61,7 +61,7 @@ The same widget can be placed in slots of very different sizes (and radios range local w, h = lcd.getWindowSize() ``` - [src/rfsuite/app/alignment_visual.lua:162](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/alignment_visual.lua#L162-L162) + [src/rfsuite/app/alignment_visual.lua:162](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/alignment_visual.lua#L162-L162) === "Example 2" diff --git a/docs/api/lcd/hasFocus.md b/docs/api/lcd/hasFocus.md index ac1f497..fb6ceed 100644 --- a/docs/api/lcd/hasFocus.md +++ b/docs/api/lcd/hasFocus.md @@ -40,7 +40,7 @@ On the home screen a widget only receives key events while it has focus. See [Ev ## Real-world usage -
Called 15 times across 5 open-source Ethos Lua projects. A few short excerpts:
+
Called 17 times across 5 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -56,7 +56,7 @@ On the home screen a widget only receives key events while it has focus. See [Ev if category == EVT_KEY and lcd.hasFocus() then ``` - [src/dashx/widgets/dashboard/dashboard.lua:726](https://github.com/robthomson/dashx-ethos/blob/6dcae492715da80d210cb4c6b16c3881c9791e2a/src/dashx/widgets/dashboard/dashboard.lua#L726-L726) + [src/rfsuite/widgets/dashboard.lua:1372](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard.lua#L1372-L1372) === "Example 3" @@ -64,4 +64,4 @@ On the home screen a widget only receives key events while it has focus. See [Ev if widget.infoPanelVisible and category == EVT_KEY and lcd.hasFocus() ``` - [src/rfsuite/widgets/dashboard.lua:1893](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard.lua#L1893-L1893) + [src/wfsuite/widgets/dashboard.lua:2093](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard.lua#L2093-L2093) diff --git a/docs/api/lcd/invalidate.md b/docs/api/lcd/invalidate.md index 8b30146..b27eea3 100644 --- a/docs/api/lcd/invalidate.md +++ b/docs/api/lcd/invalidate.md @@ -67,7 +67,7 @@ lcd.invalidate(0, 0, 100, 100) lcd.invalidate() ``` - [lua/frsky/RB25_S/stab/cali/cali.lua:224](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/RB25_S/stab/cali/cali.lua#L224-L225) + [lua/frsky/RB25_S/stab/cali/cali.lua:224](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/stab/cali/cali.lua#L224-L225) === "Example 3" diff --git a/docs/api/lcd/loadBitmap.md b/docs/api/lcd/loadBitmap.md index b083dcc..5652848 100644 --- a/docs/api/lcd/loadBitmap.md +++ b/docs/api/lcd/loadBitmap.md @@ -49,7 +49,7 @@ end ## Real-world usage -
Called 35 times across 6 open-source Ethos Lua projects. A few short excerpts:
+
Called 27 times across 6 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -65,7 +65,7 @@ end local icon = lcd.loadBitmap("pgc.png") ``` - [lua/frsky/PGC/main.lua:13](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/PGC/main.lua#L13-L13) + [lua/frsky/PGC/main.lua:13](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/PGC/main.lua#L13-L13) === "Example 3" diff --git a/docs/api/lcd/loadMask.md b/docs/api/lcd/loadMask.md index b91af8e..e7ef937 100644 --- a/docs/api/lcd/loadMask.md +++ b/docs/api/lcd/loadMask.md @@ -65,7 +65,7 @@ Loading is lazy by default (`lazy = true`): the image is decoded on first draw. local icon = lcd.loadMask("srx.png") ``` - [lua/frsky/SR6MiniE_Cali/main.lua:113](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/SR6MiniE_Cali/main.lua#L113-L113) + [lua/frsky/SR6MiniE_Cali/main.lua:113](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/SR6MiniE_Cali/main.lua#L113-L113) === "Example 2" @@ -73,7 +73,7 @@ Loading is lazy by default (`lazy = true`): the image is decoded on first draw. local folderIcon = lcd.loadMask("app/gfx/logs_folder.png") ``` - [src/rfsuite/app/pages/logs.lua:15](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/logs.lua#L15-L15) + [src/rfsuite/app/pages/logs.lua:15](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/logs.lua#L15-L15) === "Example 3" diff --git a/docs/api/lcd/pen.md b/docs/api/lcd/pen.md index bd3dbb4..ec1d668 100644 --- a/docs/api/lcd/pen.md +++ b/docs/api/lcd/pen.md @@ -61,4 +61,4 @@ lcd.pen(PEN_SOLID) -- back to solid for the rest lcd.pen(pen or SOLID) ``` - [src/rfsuite/app/pages/logs.lua:222](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/logs.lua#L222-L223) + [src/rfsuite/app/pages/logs.lua:222](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/pages/logs.lua#L222-L223) diff --git a/docs/api/lcd/setClipping.md b/docs/api/lcd/setClipping.md index a81572e..c09bf1d 100644 --- a/docs/api/lcd/setClipping.md +++ b/docs/api/lcd/setClipping.md @@ -53,7 +53,7 @@ lcd.setClipping() -- reset lcd.setClipping(x, y, w, h) ``` - [src/rfsuite/widgets/dashboard/objects/navigation/ah.lua:143](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/objects/navigation/ah.lua#L143-L143) + [src/rfsuite/widgets/dashboard/objects/navigation/ah.lua:143](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/objects/navigation/ah.lua#L143-L143) === "Example 2" @@ -69,4 +69,4 @@ lcd.setClipping() -- reset lcd.setClipping(0, 0, lcd.getWindowSize()) ``` - [src/wfsuite/widgets/dashboard/objects/navigation/ah.lua:270](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/widgets/dashboard/objects/navigation/ah.lua#L270-L270) + [src/wfsuite/widgets/dashboard/objects/navigation/ah.lua:270](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard/objects/navigation/ah.lua#L270-L270) diff --git a/docs/api/lcd/themeColor.md b/docs/api/lcd/themeColor.md index 2ebe149..a60ff26 100644 --- a/docs/api/lcd/themeColor.md +++ b/docs/api/lcd/themeColor.md @@ -73,7 +73,7 @@ Using theme colors keeps a script readable on light and dark themes. All indexes end ``` - [src/rfsuite/widgets/dashboard/context.lua:412](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/context.lua#L412-L417) + [src/rfsuite/widgets/dashboard/context.lua:412](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/context.lua#L412-L417) === "Example 3" @@ -86,4 +86,4 @@ Using theme colors keeps a script readable on light and dark themes. All indexes end ``` - [src/wfsuite/widgets/dashboard.lua:464](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/widgets/dashboard.lua#L464-L469) + [src/wfsuite/widgets/dashboard.lua:466](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard.lua#L466-L471) diff --git a/docs/api/model/bitmap.md b/docs/api/model/bitmap.md index 85d7806..f2670a1 100644 --- a/docs/api/model/bitmap.md +++ b/docs/api/model/bitmap.md @@ -37,7 +37,7 @@ bitmap (string) local bm = model.bitmap() ``` - [src/rfsuite/widgets/dashboard/objects/image/model.lua:137](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/objects/image/model.lua#L137-L138) + [src/rfsuite/widgets/dashboard/objects/image/model.lua:137](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/objects/image/model.lua#L137-L138) === "Example 2" @@ -52,4 +52,4 @@ bitmap (string) end ``` - [src/wfsuite/widgets/dashboard/objects/image/model.lua:163](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/widgets/dashboard/objects/image/model.lua#L163-L170) + [src/wfsuite/widgets/dashboard/objects/image/model.lua:163](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/widgets/dashboard/objects/image/model.lua#L163-L170) diff --git a/docs/api/model/name.md b/docs/api/model/name.md index f4887ef..b179133 100644 --- a/docs/api/model/name.md +++ b/docs/api/model/name.md @@ -60,4 +60,4 @@ local logFile = "LOGS:/mytool/" .. safe .. ".csv" displayValue = session.craftName or (model and model.name and model.name()) or nil ``` - [src/rfsuite/widgets/dashboard/themes/danielrc/common.lua:425](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/themes/danielrc/common.lua#L425-L425) + [src/rfsuite/widgets/dashboard/themes/danielrc/common.lua:425](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/themes/danielrc/common.lua#L425-L425) diff --git a/docs/api/serial/open.md b/docs/api/serial/open.md index 9864899..f140034 100644 --- a/docs/api/serial/open.md +++ b/docs/api/serial/open.md @@ -49,4 +49,4 @@ conn:flush() SportConnection = serial.open("sport", SportInterfaceBandrate, "8N1", true) ``` - [lua/frsky/XAct/config/ui.lua:25](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/XAct/config/ui.lua#L25-L25) + [lua/frsky/XAct/config/ui.lua:25](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/XAct/config/ui.lua#L25-L25) diff --git a/docs/api/sport/getSensor.md b/docs/api/sport/getSensor.md index 81627ff..039fa4b 100644 --- a/docs/api/sport/getSensor.md +++ b/docs/api/sport/getSensor.md @@ -51,7 +51,7 @@ local sensor = sport.getSensor({module=0, band=0, rx=0, physId=0x1B, appId=0x680 local sensor = sport.getSensor(0x0c30); ``` - [lua/frsky/SR6MiniE_Cali/main.lua:35](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/SR6MiniE_Cali/main.lua#L35-L35) + [lua/frsky/SR6MiniE_Cali/main.lua:35](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/SR6MiniE_Cali/main.lua#L35-L35) === "Example 2" @@ -64,7 +64,7 @@ local sensor = sport.getSensor({module=0, band=0, rx=0, physId=0x1B, appId=0x680 end ``` - [src/rfsuite/tasks/msp/transport_sport.lua:31](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/msp/transport_sport.lua#L31-L36) + [src/rfsuite/tasks/msp/transport_sport.lua:37](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/msp/transport_sport.lua#L37-L42) === "Example 3" diff --git a/docs/api/storage/read.md b/docs/api/storage/read.md index fd948c0..13d46c0 100644 --- a/docs/api/storage/read.md +++ b/docs/api/storage/read.md @@ -52,18 +52,10 @@ Use it inside `read` callbacks of widgets, tasks and sources. Values live in the ## Real-world usage -
Called 16 times across 3 open-source Ethos Lua projects. A few short excerpts:
+
Called 6 times across 2 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" - ```lua - widget.pumpSource = storage.read("pumpSource") - ``` - - [lua/frsky/JetWidget/main.lua:376](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L376-L376) - -=== "Example 2" - ```lua local function read(widget) widget.discIdx = storage.read("discIdx") or widget.discIdx @@ -76,7 +68,7 @@ Use it inside `read` callbacks of widgets, tasks and sources. Values live in the [src/bmfa-caller/widget_impl.lua:153](https://github.com/robthomson/ethos-bmfa-caller/blob/f4bb5511dbe666567fc5406ca60124be65b9c830/src/bmfa-caller/widget_impl.lua#L153-L159) -=== "Example 3" +=== "Example 2" ```lua function widget.read() diff --git a/docs/api/storage/write.md b/docs/api/storage/write.md index 44a072e..5f7478c 100644 --- a/docs/api/storage/write.md +++ b/docs/api/storage/write.md @@ -54,25 +54,17 @@ Keep the keys and order in step with your `read` callback. ## Real-world usage -
Called 16 times across 3 open-source Ethos Lua projects. A few short excerpts:
+
Called 6 times across 2 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" - ```lua - storage.write("pumpSource", widget.pumpSource) - ``` - - [lua/frsky/JetWidget/main.lua:394](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L394-L394) - -=== "Example 2" - ```lua function widget.write() storage.write("currentPage", tostring(currentPage or 1)) end ``` [src/inav-dashboard/widget.lua:421](https://github.com/iNavFlight/ETHOS-Telemetry-Dashboard/blob/656975b84cbbbc3bd7861bdf2a92b4686937280e/src/inav-dashboard/widget.lua#L421-L421) -=== "Example 3" +=== "Example 2" ```lua local function write(widget) diff --git a/docs/api/system/exit.md b/docs/api/system/exit.md index 8591578..9c42963 100644 --- a/docs/api/system/exit.md +++ b/docs/api/system/exit.md @@ -67,7 +67,7 @@ In a widget's `configure` form, `system.exit()` leaves the configuration page, a end ``` - [src/rfsuite/app/menu_container.lua:165](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/menu_container.lua#L165-L173) + [src/rfsuite/app/menu_container.lua:165](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/menu_container.lua#L165-L173) === "Example 3" diff --git a/docs/api/system/getLocale.md b/docs/api/system/getLocale.md index fefe1d9..5ab11dc 100644 --- a/docs/api/system/getLocale.md +++ b/docs/api/system/getLocale.md @@ -63,7 +63,7 @@ See [Translations](../../guides/i18n.md) for a translation-file pattern. local locale = system.getLocale() ``` - [lua/frsky/RB25_S/stab/i18n/i18n.lua:1](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/RB25_S/stab/i18n/i18n.lua#L1-L1) + [lua/frsky/RB25_S/stab/i18n/i18n.lua:1](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/RB25_S/stab/i18n/i18n.lua#L1-L1) === "Example 3" diff --git a/docs/api/system/getMemoryUsage.md b/docs/api/system/getMemoryUsage.md index 0322c2d..f281611 100644 --- a/docs/api/system/getMemoryUsage.md +++ b/docs/api/system/getMemoryUsage.md @@ -57,7 +57,7 @@ On current radios the Lua heap and bitmap memory come from one shared region, so local mem = system.getMemoryUsage and system.getMemoryUsage() or {} ``` - [src/rfsuite/tasks/background.lua:78](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/background.lua#L78-L78) + [src/rfsuite/tasks/background.lua:85](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/background.lua#L85-L85) === "Example 2" @@ -77,4 +77,4 @@ On current radios the Lua heap and bitmap memory come from one shared region, so end ``` - [src/wfsuite/app/pages/diagnostics_rfstatus.lua:22](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/pages/diagnostics_rfstatus.lua#L22-L26) + [src/wfsuite/app/pages/diagnostics_rfstatus.lua:22](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/pages/diagnostics_rfstatus.lua#L22-L26) diff --git a/docs/api/system/getVersion.md b/docs/api/system/getVersion.md index b24c191..99f7fa2 100644 --- a/docs/api/system/getVersion.md +++ b/docs/api/system/getVersion.md @@ -60,7 +60,7 @@ Prefer feature checks (`if system.getSources then`) over version checks where po ## Real-world usage -
Called 67 times across 9 open-source Ethos Lua projects. A few short excerpts:
+
Called 69 times across 9 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" diff --git a/docs/api/system/isSensorDiscoverActive.md b/docs/api/system/isSensorDiscoverActive.md index 57e6f6a..f6e1c73 100644 --- a/docs/api/system/isSensorDiscoverActive.md +++ b/docs/api/system/isSensorDiscoverActive.md @@ -42,7 +42,7 @@ end if system.isSensorDiscoverActive and system.isSensorDiscoverActive() then ``` - [src/rfsuite/lib/frsky_sensors.lua:171](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/lib/frsky_sensors.lua#L171-L172) + [src/rfsuite/lib/frsky_sensors.lua:171](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/lib/frsky_sensors.lua#L171-L172) === "Example 2" diff --git a/docs/api/system/killEvents.md b/docs/api/system/killEvents.md index bc1d935..c1d0b5b 100644 --- a/docs/api/system/killEvents.md +++ b/docs/api/system/killEvents.md @@ -43,7 +43,7 @@ Real projects also kill touch sequences after acting on a touch (`system.killEve ## Real-world usage -
Called 41 times across 5 open-source Ethos Lua projects. A few short excerpts:
+
Called 43 times across 5 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -56,19 +56,16 @@ Real projects also kill touch sequences after acting on a touch (`system.killEve === "Example 2" ```lua - if system.killEvents then - system.killEvents(value) + if system and system.killEvents then system.killEvents(value) end ``` - [src/ofs3/widgets/dashboard/lib/logviewer.lua:911](https://github.com/robthomson/omp-ofs3-dashboard/blob/2970572ba2b0a4b47d3789f6cd29c6acdc9b231d/src/ofs3/widgets/dashboard/lib/logviewer.lua#L911-L912) + [src/rfsuite/widgets/dashboard.lua:1383](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard.lua#L1383-L1383) === "Example 3" ```lua - if opts.setEventHandler then - opts.setEventHandler(function(category, value) - if value == KEY_ENTER_LONG then - system.killEvents(KEY_ENTER_BREAK) + if system.killEvents then + system.killEvents(value) ``` - [src/rfsuite/app/pages/ports.lua:574](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/pages/ports.lua#L574-L577) + [src/ofs3/widgets/dashboard/lib/logviewer.lua:911](https://github.com/robthomson/omp-ofs3-dashboard/blob/2970572ba2b0a4b47d3789f6cd29c6acdc9b231d/src/ofs3/widgets/dashboard/lib/logviewer.lua#L911-L912) diff --git a/docs/api/system/openPage.md b/docs/api/system/openPage.md index f9c8e01..8963527 100644 --- a/docs/api/system/openPage.md +++ b/docs/api/system/openPage.md @@ -65,4 +65,4 @@ system.openPage({sensor=0}) -- Sensor 1 configuration end ``` - [src/rfsuite/widgets/dashboard.lua:1284](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard.lua#L1284-L1290) + [src/rfsuite/widgets/dashboard.lua:1390](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard.lua#L1390-L1396) diff --git a/docs/api/system/playFile.md b/docs/api/system/playFile.md index f28036e..156f05e 100644 --- a/docs/api/system/playFile.md +++ b/docs/api/system/playFile.md @@ -55,7 +55,7 @@ From callbacks, use absolute paths: relative paths only resolve to your script f end ``` - [src/rfsuite/tasks/audio_events.lua:185](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/audio_events.lua#L185-L187) + [src/rfsuite/tasks/audio_events.lua:193](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/audio_events.lua#L193-L195) === "Example 3" diff --git a/docs/api/system/playHaptic.md b/docs/api/system/playHaptic.md index 2347a4f..2edc332 100644 --- a/docs/api/system/playHaptic.md +++ b/docs/api/system/playHaptic.md @@ -50,7 +50,7 @@ system.playHaptic("- . -") -- Bzzz Bz Bzzz end ``` - [src/rfsuite/tasks/audio_events.lua:232](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/audio_events.lua#L232-L234) + [src/rfsuite/tasks/audio_events.lua:240](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/audio_events.lua#L240-L242) === "Example 2" @@ -63,4 +63,4 @@ system.playHaptic("- . -") -- Bzzz Bz Bzzz end ``` - [src/wfsuite/app/header.lua:174](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/app/header.lua#L174-L179) + [src/wfsuite/app/header.lua:174](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/app/header.lua#L174-L179) diff --git a/docs/api/system/playNumber.md b/docs/api/system/playNumber.md index 6a7a2a6..181a02f 100644 --- a/docs/api/system/playNumber.md +++ b/docs/api/system/playNumber.md @@ -67,7 +67,7 @@ if src then system.playNumber(src:value(), src:unit(), src:decimals()) end end ``` - [src/rfsuite/tasks/audio_events.lua:205](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/audio_events.lua#L205-L207) + [src/rfsuite/tasks/audio_events.lua:213](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/audio_events.lua#L213-L215) === "Example 3" diff --git a/docs/api/system/registerLayout.md b/docs/api/system/registerLayout.md index 8358474..aecb55c 100644 --- a/docs/api/system/registerLayout.md +++ b/docs/api/system/registerLayout.md @@ -50,22 +50,3 @@ return {init=init} ## Used in - [layout](../../examples/official/layout.md) - -## Real-world usage - -
Called 1 times across 1 open-source Ethos Lua project. A few short excerpts:
- -=== "Example 1" - - ```lua - local function init() - system.registerLayout({key="XL+3", widgets={ - {x=8, y=95, w=784, h=248}, - {x=8, y=351, w=256, h=56}, - {x=272, y=351, w=256, h=56}, - {x=536, y=351, w=256, h=56} - }}) - end - ``` - - [lua/frsky/Layout1P3/main.lua:3](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/Layout1P3/main.lua#L3-L10) diff --git a/docs/api/system/registerSystemTool.md b/docs/api/system/registerSystemTool.md index d7d4848..cf1c853 100644 --- a/docs/api/system/registerSystemTool.md +++ b/docs/api/system/registerSystemTool.md @@ -66,7 +66,7 @@ end end ``` - [src/rfsuite/app/tool.lua:634](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/app/tool.lua#L634-L636) + [src/rfsuite/app/tool.lua:634](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/app/tool.lua#L634-L636) === "Example 2" @@ -90,4 +90,4 @@ end end ``` - [lua/frsky/SR6MiniE_Cali/main.lua:117](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/SR6MiniE_Cali/main.lua#L117-L123) + [lua/frsky/SR6MiniE_Cali/main.lua:117](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/b92b58ea6585a7b0060a5ac63e827316aa890b45/lua/frsky/SR6MiniE_Cali/main.lua#L117-L123) diff --git a/docs/api/system/registerTask.md b/docs/api/system/registerTask.md index 9ed85f7..01880fd 100644 --- a/docs/api/system/registerTask.md +++ b/docs/api/system/registerTask.md @@ -90,7 +90,7 @@ return {init=init} end ``` - [src/wfsuite/tasks/background.lua:415](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/0a7b1c61ad582033adebbe65183702650d4e377a/src/wfsuite/tasks/background.lua#L415-L423) + [src/wfsuite/tasks/background.lua:473](https://github.com/WingFlight/wingflight-lua-ethos-suite/blob/8222d3c763027018989da480c098e38ac4c32d4f/src/wfsuite/tasks/background.lua#L473-L481) === "Example 2" @@ -106,7 +106,7 @@ return {init=init} end ``` - [src/rfsuite/tasks/background.lua:208](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/tasks/background.lua#L208-L216) + [src/rfsuite/tasks/background.lua:266](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/tasks/background.lua#L266-L274) === "Example 3" diff --git a/docs/api/system/registerWidget.md b/docs/api/system/registerWidget.md index 8060674..69f5c7a 100644 --- a/docs/api/system/registerWidget.md +++ b/docs/api/system/registerWidget.md @@ -93,7 +93,7 @@ return {init=init} ## Real-world usage -
Called 7 times across 7 open-source Ethos Lua projects. A few short excerpts:
+
Called 6 times across 6 open-source Ethos Lua projects. A few short excerpts:
=== "Example 1" @@ -108,21 +108,33 @@ return {init=init} === "Example 2" ```lua - local function init() - system.registerWidget({ key = "FrkJet", name = "Jet dashboard", create = create, build = build, paint = paint, wakeup = wakeup, configure = configure, read = read, write = write, title = false }) + local function init(opts) + opts = opts or {} + systemToolHandle = opts.systemToolHandle + system.registerWidget(widget) end ``` - [lua/frsky/JetWidget/main.lua:397](https://github.com/FrSkyRC/ETHOS-Feedback-Community/blob/7cab00b5ee95e761965c58ddec2d2b113fedde64/lua/frsky/JetWidget/main.lua#L397-L399) + [src/rfsuite/widgets/dashboard.lua:2328](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard.lua#L2328-L2332) === "Example 3" ```lua - local function init(opts) - opts = opts or {} - systemToolHandle = opts.systemToolHandle - system.registerWidget(widget) - end + system.registerWidget({ + name = meta.name, + key = meta.key, + create = widget.create, + wakeup = widget.wakeup, + paint = widget.paint, + event = widget.event, + close = widget.close, + persistent = widget.persistent or false, + configure = widget.configure, + read = widget.read, + write = widget.write, + menu = widget.menu, + title = widget.title + }) ``` - [src/rfsuite/widgets/dashboard.lua:2205](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard.lua#L2205-L2209) + [src/rfsuite/main.lua:70](https://github.com/robthomson/ethos-app-framework/blob/fdfd6e70f8f2865a2742102e009b791ae18e3ca9/src/rfsuite/main.lua#L70-L84) diff --git a/docs/api/system/voltageRange.md b/docs/api/system/voltageRange.md index 1a42483..7b67057 100644 --- a/docs/api/system/voltageRange.md +++ b/docs/api/system/voltageRange.md @@ -40,4 +40,4 @@ min (number) and max (number) end ``` - [src/rfsuite/widgets/dashboard/context.lua:1315](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/53c7e819afe6293cb7623b5972e4a4d276a90ad1/src/rfsuite/widgets/dashboard/context.lua#L1315-L1321) + [src/rfsuite/widgets/dashboard/context.lua:1315](https://github.com/rotorflight/rotorflight-lua-ethos-suite/blob/cdf0b8f37d0ea56d7373ce501d489eeebeda234b/src/rfsuite/widgets/dashboard/context.lua#L1315-L1321) diff --git a/docs/examples/official/tool-form/form.png b/docs/examples/official/tool-form/form.png old mode 100644 new mode 100755 diff --git a/docs/examples/official/widget-jet.md b/docs/examples/official/widget-jet.md index e67263c..db6f93c 100644 --- a/docs/examples/official/widget-jet.md +++ b/docs/examples/official/widget-jet.md @@ -413,11 +413,11 @@ return { init = init } ## Assets -![egt_panel.png](widget-jet/egt_panel.png){ loading=lazy style="max-height:120px" } -![egt_pointer.png](widget-jet/egt_pointer.png){ loading=lazy style="max-height:120px" } -![pump_panel.png](widget-jet/pump_panel.png){ loading=lazy style="max-height:120px" } -![pump_pointer.png](widget-jet/pump_pointer.png){ loading=lazy style="max-height:120px" } ![rpm_panel.png](widget-jet/rpm_panel.png){ loading=lazy style="max-height:120px" } ![rpm_pointer.png](widget-jet/rpm_pointer.png){ loading=lazy style="max-height:120px" } +![pump_pointer.png](widget-jet/pump_pointer.png){ loading=lazy style="max-height:120px" } +![egt_pointer.png](widget-jet/egt_pointer.png){ loading=lazy style="max-height:120px" } ![speed_panel.png](widget-jet/speed_panel.png){ loading=lazy style="max-height:120px" } +![pump_panel.png](widget-jet/pump_panel.png){ loading=lazy style="max-height:120px" } ![speed_pointer.png](widget-jet/speed_pointer.png){ loading=lazy style="max-height:120px" } +![egt_panel.png](widget-jet/egt_panel.png){ loading=lazy style="max-height:120px" } diff --git a/docs/examples/official/wizard/arm.png b/docs/examples/official/wizard/arm.png old mode 100644 new mode 100755