From ff699d68b9db665db2fe16f112d17b6d4c822a8e Mon Sep 17 00:00:00 2001
From: 3djc <lesitewebdejc@hotmail.com>
Date: Sat, 6 Dec 2025 22:40:22 +0100
Subject: [PATCH] feat(lua): add getSwitchInfo for detecting customisable
 switches and switch type (#6859)

---
 radio/src/lua/api_general.cpp | 38 +++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/radio/src/lua/api_general.cpp b/radio/src/lua/api_general.cpp
index 0e56a5d12..66259cb97 100644
--- a/radio/src/lua/api_general.cpp
+++ b/radio/src/lua/api_general.cpp
@@ -2575,6 +2575,43 @@ static int luaGetLogicalSwitchValue(lua_State * L)
   return 1;
 }
 
+
+/*luadoc
+@function getSwitchInfo(sourceIndex)
+
+@param sourceIndex: integer identifying a value source as returned by `getSourceIndex(sourceName)` or the `id` field in the table returned by `getFieldInfo`.
+
+@retval table information about requested field, table elements:
+* `type`   (number) field identifier
+0 = SWITCH_NONE
+1 = SWITCH_TOGGLE
+2 = SWITCH_2POS
+3 = SWITCH_3POS
+
+* `isCustomisableSwitch`   (boolean) field identifier
+return true if switch is a customisable switch
+
+* `name` (string) switch name
+
+@status current Introduced in 2.12
+*/
+
+static int luaGetSwitchInfo(lua_State * L)
+{
+  swsrc_t idx = luaL_checkinteger(L, 1) - MIXSRC_FIRST_SWITCH;
+  if (idx < SWSRC_COUNT && isSwitchAvailable(idx, ModelCustomFunctionsContext)) {
+    lua_newtable(L);
+    char* name = getSwitchPositionName(idx);
+    lua_pushtableinteger(L, "type", g_model.getSwitchType(idx));
+    lua_pushtableboolean(L, "isCustomisableSwitch", switchIsCustomSwitch(idx));
+    lua_pushtablestring(L, "name", name);
+  }
+  else
+    lua_pushnil(L);
+
+  return 1;
+}
+
 /*luadoc
 @function getSwitchIndex(positionName)
 
@@ -3132,6 +3169,7 @@ LROT_BEGIN(etxlib, NULL, 0)
 #endif
   LROT_FUNCENTRY( setStickySwitch, luaSetStickySwitch )
   LROT_FUNCENTRY( getLogicalSwitchValue, luaGetLogicalSwitchValue )
+  LROT_FUNCENTRY( getSwitchInfo, luaGetSwitchInfo )
   LROT_FUNCENTRY( getSwitchIndex, luaGetSwitchIndex )
   LROT_FUNCENTRY( getSwitchName, luaGetSwitchName )
   LROT_FUNCENTRY( getSwitchValue, luaGetSwitchValue )