479 lines (407 loc) · 11.8 KB

PicOS Lua SDK Manifest

Auto-generated by scripts/list_lua_api/main.go

picocalc.audio

Functions

Function	Status
playTone	✅ documented
pushSamples	❌ undocumented
ringFree	❌ undocumented
setVolume	✅ documented
startStream	❌ undocumented
stopStream	❌ undocumented
stopTone	✅ documented

picocalc.config

Functions

Function	Status
clear	❌ undocumented
get	✅ documented
load	✅ documented
reset	❌ undocumented
save	✅ documented
set	✅ documented

picocalc.crypto

Functions

Function	Status
aes_ctr_new	❌ undocumented
computeShared	❌ undocumented
deriveKey	❌ undocumented
ecdh_p256_new	❌ undocumented
ecdh_x25519_new	❌ undocumented
ecdsaP256Verify	❌ undocumented
free	❌ undocumented
getPublicKey	❌ undocumented
hmacSHA1	❌ undocumented
hmacSHA256	❌ undocumented
randomBytes	❌ undocumented
rsaVerify	❌ undocumented
sha1	❌ undocumented
sha256	❌ undocumented
update	❌ undocumented

picocalc.display

Functions

Function	Status
applyEffect	✅ documented
clear	✅ documented
drawCircle	❌ undocumented
drawLine	✅ documented
drawRect	✅ documented
drawText	✅ documented
drawTexturedColumn	❌ undocumented
fillCircle	❌ undocumented
fillRect	✅ documented
fillVLine	❌ undocumented
fillVLineGradient	❌ undocumented
flush	✅ documented
getFont	❌ undocumented
getFontHeight	❌ undocumented
getFontWidth	❌ undocumented
getHeight	✅ documented
getWidth	✅ documented
rgb	✅ documented
setBrightness	✅ documented
setFont	❌ undocumented
setPixel	✅ documented
setScrollArea	❌ undocumented
setScrollOffset	❌ undocumented
textWidth	✅ documented

Constants

Constant	Status
BLACK	✅ documented
BLUE	✅ documented
CYAN	✅ documented
FONT_6X8	❌ undocumented
FONT_8X12	❌ undocumented
FONT_SCIENTIFICA	❌ undocumented
FONT_SCIENTIFICA_BOLD	❌ undocumented
GRAY	✅ documented
GREEN	✅ documented
RED	✅ documented
WHITE	✅ documented
YELLOW	✅ documented

picocalc.fs

Functions

Function	Status
appPath	✅ documented
browse	✅ documented
close	✅ documented
copy	❌ undocumented
delete	❌ undocumented
deleteRecursive	❌ undocumented
diskInfo	❌ undocumented
ensureReady	❌ undocumented
exists	✅ documented
glob	❌ undocumented
listDir	✅ documented
mkdir	✅ documented
open	✅ documented
read	✅ documented
readFile	✅ documented
rename	❌ undocumented
seek	✅ documented
setSlowMode	❌ undocumented
size	✅ documented
stat	❌ undocumented
tell	✅ documented
write	✅ documented

picocalc.input

Functions

Function	Status
clearState	❌ undocumented
getButtons	✅ documented
getButtonsPressed	✅ documented
getButtonsReleased	✅ documented
getChar	✅ documented
getRawKey	✅ documented
update	✅ documented

picocalc.modplayer

Functions

Function	Status
__gc	❌ undocumented
create	❌ undocumented
getVolume	❌ undocumented
isPlaying	❌ undocumented
load	❌ undocumented
pause	❌ undocumented
play	❌ undocumented
resume	❌ undocumented
setLoop	❌ undocumented
setVolume	❌ undocumented
stop	❌ undocumented

picocalc.perf

Functions

Function	Status
beginFrame	✅ documented
drawFPS	✅ documented
endFrame	✅ documented
getFPS	✅ documented
getFrameTime	✅ documented
setTargetFPS	❌ undocumented

picocalc.repl

Functions

Function	Status
clear	❌ undocumented
echo	❌ undocumented
print	❌ undocumented
readline	❌ undocumented

picocalc.sound

Functions

Function	Status
__gc	❌ undocumented
decompress	❌ undocumented
didUnderrun	❌ undocumented
fileplayer	✅ documented
getCurrentTime	✅ documented
getFormat	❌ undocumented
getLength	❌ undocumented
getOffset	❌ undocumented
getPosition	❌ undocumented
getRate	❌ undocumented
getSample	❌ undocumented
getSampleRate	❌ undocumented
getSubsample	❌ undocumented
getVolume	❌ undocumented
isPlaying	❌ undocumented
load	❌ undocumented
mp3player	✅ documented
pause	❌ undocumented
play	❌ undocumented
playingSources	❌ undocumented
resetTime	✅ documented
resume	❌ undocumented
sample	✅ documented
sampleplayer	✅ documented
setFinishCallback	❌ undocumented
setLoop	❌ undocumented
setLoopRange	❌ undocumented
setOffset	❌ undocumented
setPaused	❌ undocumented
setPlayRange	❌ undocumented
setRate	❌ undocumented
setSample	❌ undocumented
setStopOnUnderrun	❌ undocumented
setVolume	❌ undocumented
stop	❌ undocumented

picocalc.sys

Functions

Function	Status
addMenuItem	✅ documented
applyUpdate	❌ undocumented
clearMenuItems	✅ documented
exit	✅ documented
getBattery	✅ documented
getClock	✅ documented
getMemInfo	✅ documented
getPowerStatus	❌ undocumented
getTimeMs	✅ documented
getVersion	❌ undocumented
isUSBPowered	✅ documented
loadlib	❌ undocumented
log	✅ documented
pauseBackground	❌ undocumented
pioPsramRead	❌ undocumented
pioPsramSize	❌ undocumented
pioPsramWrite	❌ undocumented
qmiPsramAlloc	❌ undocumented
qmiPsramFree	❌ undocumented
qmiPsramRead	❌ undocumented
qmiPsramWrite	❌ undocumented
reboot	✅ documented
resumeBackground	❌ undocumented
sleep	✅ documented
triggerFault	✅ documented

Constants

Constant	Status
hour	❌ undocumented
min	❌ undocumented
sec	❌ undocumented

picocalc.sysconfig

Functions

Function	Status
get	❌ undocumented
load	❌ undocumented
save	❌ undocumented
set	❌ undocumented

picocalc.terminal

Functions

Function	Status
__gc	❌ undocumented
clear	❌ undocumented
getCell	❌ undocumented
getColors	❌ undocumented
getCols	❌ undocumented
getContentCols	❌ undocumented
getCursor	❌ undocumented
getDirtyRange	❌ undocumented
getFont	❌ undocumented
getRows	❌ undocumented
getScrollbackCount	❌ undocumented
getScrollbackLine	❌ undocumented
getScrollbackOffset	❌ undocumented
getVisualRowCount	❌ undocumented
getWordWrap	❌ undocumented
isFullDirty	❌ undocumented
markAllDirty	❌ undocumented
new	❌ undocumented
readChar	❌ undocumented
readKey	❌ undocumented
render	❌ undocumented
renderDirty	❌ undocumented
scroll	❌ undocumented
setCell	❌ undocumented
setCellColors	❌ undocumented
setColors	❌ undocumented
setCursor	❌ undocumented
setCursorBlink	❌ undocumented
setCursorVisible	❌ undocumented
setFont	❌ undocumented
setLineNumberColors	❌ undocumented
setLineNumberCols	❌ undocumented
setLineNumberStart	❌ undocumented
setLineNumbers	❌ undocumented
setRenderBounds	❌ undocumented
setRowColors	❌ undocumented
setScrollInfo	❌ undocumented
setScrollbackOffset	❌ undocumented
setScrollbar	❌ undocumented
setScrollbarColors	❌ undocumented
setScrollbarWidth	❌ undocumented
setWordWrap	❌ undocumented
setWordWrapColumn	❌ undocumented
setWrapIndicator	❌ undocumented
waitForAnyKey	❌ undocumented
waitForChar	❌ undocumented
waitForKey	❌ undocumented
write	❌ undocumented

picocalc.ui

Functions

Function	Status
confirm	❌ undocumented
drawButton	❌ undocumented
drawCheckbox	❌ undocumented
drawDivider	❌ undocumented
drawFooter	✅ documented
drawHeader	✅ documented
drawListItem	❌ undocumented
drawPanel	❌ undocumented
drawProgress	❌ undocumented
drawRadio	❌ undocumented
drawSpinner	❌ undocumented
drawTabs	✅ documented
drawTextArea	❌ undocumented
drawTextField	❌ undocumented
drawToast	❌ undocumented
splash	❌ undocumented
textInput	❌ undocumented
toast	❌ undocumented
wrapText	❌ undocumented

picocalc.video

Functions

Function	Status
__gc	❌ undocumented
getDroppedFrames	❌ undocumented
getFPS	❌ undocumented
getInfo	❌ undocumented
getSize	❌ undocumented
getVolume	❌ undocumented
hasAudio	❌ undocumented
isMuted	❌ undocumented
isPaused	❌ undocumented
isPlaying	❌ undocumented
load	❌ undocumented
pause	❌ undocumented
play	❌ undocumented
player	❌ undocumented
resetStats	❌ undocumented
resume	❌ undocumented
seek	❌ undocumented
setAutoFlush	❌ undocumented
setLoop	❌ undocumented
setMuted	❌ undocumented
setVolume	❌ undocumented
stop	❌ undocumented
update	❌ undocumented

picocalc.wifi

Functions

Function	Status
close	❌ undocumented
connect	✅ documented
disconnect	✅ documented
get	❌ undocumented
getBytesAvailable	❌ undocumented
getError	❌ undocumented
getIP	✅ documented
getProgress	❌ undocumented
getResponseHeaders	❌ undocumented
getResponseStatus	❌ undocumented
getSSID	✅ documented
getStatus	✅ documented
hasInternet	❌ undocumented
isAvailable	✅ documented
isHwDisconnected	❌ undocumented
new	❌ undocumented
post	❌ undocumented
read	❌ undocumented
setByteRange	❌ undocumented
setConnectTimeout	❌ undocumented
setConnectionClosedCallback	❌ undocumented
setEnabled	❌ undocumented
setHeadersReadCallback	❌ undocumented
setKeepAlive	❌ undocumented
setReadBufferSize	❌ undocumented
setReadTimeout	❌ undocumented
setRequestCallback	❌ undocumented
setRequestCompleteCallback	❌ undocumented

Summary

Module	Functions	Documented	Constants	Documented
audio	7	3 (42%)	-	100%
config	6	4 (66%)	-	100%
crypto	15	0 (0%)	-	100%
display	24	13 (54%)	12	66%
fs	22	13 (59%)	-	100%
input	7	6 (85%)	-	100%
modplayer	11	0 (0%)	-	100%
perf	6	5 (83%)	-	100%
repl	4	0 (0%)	-	100%
sound	35	6 (17%)	-	100%
sys	25	12 (48%)	3	0%
sysconfig	4	0 (0%)	-	100%
terminal	48	0 (0%)	-	100%
ui	19	3 (15%)	-	100%
video	23	0 (0%)	-	100%
wifi	28	6 (21%)	-	100%
Total	284	71 (25%)	15	53%