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.

Sign up for GitHub

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

4.7:add littlefs scripting info #6564

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

4.7:add littlefs scripting info #6564

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d75eb0
4.7:add littlefs scripting info
Hwurzburg Jan 23, 2025
70b5182
Expand language
Hwurzburg Jan 24, 2025
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
7 changes: 4 additions & 3 deletions common/source/docs/common-lua-scripts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ While scripting normally requires at least some LUA programming and editing, the
Getting Started
===============

- Ensure your autopilot has at least 2 MB of flash and 80 kB of memory. High powered autopilots like the CubePilot Cube Orange and HolyBro Durandal will certainly work well but check the specifications of your :ref:`autopilot <common-autopilots>`. Scripting is not available in F4 based autopilots. Autopilots must have an SD card to store the script unless the user builds his own firmware and embeds it directly in the firmware (see :ref:`common-oem-customizations`).
- Set :ref:`SCR_ENABLE <SCR_ENABLE>` to 1 to enable scripting (refresh or reboot to see all ``SCR_`` parameters).
- Upload scripts (files with extension .lua) to the autopilot's SD card's ``APM/scripts`` folder.
- Ensure your autopilot has at least 2 MB of flash and 80 kB of memory. Higher powered autopilots like the CubePilot Cube Orange and HolyBro Durandal will certainly work well but check the specifications of your :ref:`autopilot <common-autopilots>`. Scripting is not available on 1 MB autopilots.
- Autopilots must have an SD card or compatible dataflash to store the script, unless the user builds his own firmware and embeds it directly in the firmware (see :ref:`common-oem-customizations`). Compatible autopilots include ``AP_SCRIPTING_ENABLED`` in their firmware limitation list (see :ref:`common-limited_firmware` for directions on how to check this).
- Set :ref:`SCR_ENABLE <SCR_ENABLE>` to 1 to enable scripting (refresh or reboot after to see other ``SCR_`` parameters).
- Upload scripts (files with extension .lua) to the autopilot's ``/APM/scripts`` folder. This can be done using MAVFTP to access the storage while in the autopilot, or by removing the SD card and using a PC.

- If this folder does not exist, you can create it by setting :ref:`SCR_ENABLE<SCR_ENABLE>` to 1 and rebooting. This folder can also be created manually on the SD card.
- If using Mission Planner, this can be done using MAVFTP.
Expand Down