Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(lua): add screenshot() function #5181

Merged
merged 2 commits into from
Aug 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions radio/src/lua/api_general.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1631,6 +1631,30 @@ static int luaPlayTone(lua_State * L)
return 0;
}

/*luadoc
@name screenshot

@description Takes a screenshot, which is saved to the SCREENSHOTS folder on the radio SD card.

@syntax screenshot()

@return none

@notes This command is currently not rate limited, so repeated frequent calls will slow down the UI and can even freeze the entire radio, so should be used with care.

@target [BW]
@target [GS]
@target [COLOR]

@status current Introduced in 2.11
*/
static int luaScreenshot(lua_State * L)
{
UNUSED(L);
writeScreenshot();
return 0;
}

/*luadoc
@function playHaptic(duration, pause [, flags])

Expand Down Expand Up @@ -2930,6 +2954,7 @@ LROT_BEGIN(etxlib, NULL, 0)
LROT_FUNCENTRY( playTone, luaPlayTone )
LROT_FUNCENTRY( playHaptic, luaPlayHaptic )
LROT_FUNCENTRY( flushAudio, luaFlushAudio )
LROT_FUNCENTRY( screenshot, luaScreenshot )
#if defined(ENABLE_LUA_POPUP_INPUT)
LROT_FUNCENTRY( popupInput, luaPopupInput )
#endif
Expand Down