Docs Panel
Use the side docs as the API contract.
The documentation panel shows supported modules, function signatures, keyword arguments, examples, and return shapes generated from Studio stubs.
How to read a module page
Start with the module summaryIt explains what hardware or behavior the module controls.
Review examplesExamples show normal call order, such as begin, configure, read, draw, flush, or stop.
Check each method signatureUse the exact method name and argument order shown by the docs.
Read keyword argumentsSome APIs accept named options; the docs show supported names and meanings.
Look at return shapesFor modules such as cv, color_detector, and motion_detector, returned dictionaries have documented keys.
Module groups
systemScheduling, heap info, restart/update helpers, and runtime utilities.
GPIO and busesPin IO, PWM, ADC, UART, I2C, SPI, and related low-level device interfaces.
Displays and sensorsDisplay drivers, DHT, OneWire, LCD, OLED, and sensor-facing modules.
Camera and CVCamera setup, frame capture, model load, prediction, detection, and camera-to-model helpers.
DetectorsDedicated modules such as color_detector and motion_detector for model-free vision tasks.
Network and storageWi-Fi, HTTP, MQTT, webserver, key-value state, and other communication or persistence APIs.
Autocomplete and lint use the same source
Studio stubs are the shared contract between docs, autocomplete, linter, and transpiler. If a future release adds a module feature, the docs should show it and the linter should allow it at the same time.
SurfaceWhat it gives usersWhy it matters
DocsModule summaries, examples, methods, args, kwargs, return values.Users know what can be written.
AutocompleteSuggestions while typing imports and method calls.Less guessing in the editor.
LintErrors for unknown modules, unsupported methods, and invalid forms.Problems are caught before flashing.
TranspileConverts supported Python into the device runtime language.The board receives code it can run.
When the docs are missing something
Module is missingDo not import it yet. The firmware and Studio stubs need a release before it is supported.
Method is missingThe module may exist, but that function is not exposed to Studio scripts.
Return value is unclearUse the documented dictionary keys or run a tiny script that prints the returned value.
Example does not match hardwareAdjust pins, presets, addresses, and intervals for your board. Keep the call pattern.