-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Recommend a hello world workflow for first Lua script #6591
base: master
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
Signed-off-by: Ryan Friedman <[email protected]>
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,21 +5,36 @@ | |
Script Setup and Use Examples | ||
============================= | ||
|
||
Testing a Script in SITL | ||
Running a Script in SITL | ||
======================== | ||
In Linux: | ||
|
||
#. Assuming you have setup the build and simulation environment, run the simulation. See :ref:`using-sitl-for-ardupilot-testing`. For example: | ||
#. Assuming you have setup the build and SITL environment, run SITL. See :ref:`using-sitl-for-ardupilot-testing`. For example: | ||
|
||
.. code:: | ||
.. code-block:: bash | ||
|
||
sim_vehicle.py -v plane -f quadplane | ||
cd /path/to/ardupilot | ||
./Tools/autotest/sim_vehicle.py -v plane --console | ||
|
||
Mavproxy ground control station will automatically be started. You can also start QGC (using the QGroundControl.AppImage) and/or Mission Planner (using WISE to run under Linux). Any or all three can be used simultaneously. | ||
|
||
#. From your GCS, enable scripting by setting the :ref:`SCR_ENABLE<SCR_ENABLE>` parameter to "1". Restart the simulation. | ||
#. A "scripts" sub-directory will be created in the directory you started the simulation, if it did not already exist. Place the script you downloaded into this directory. Again, restart the simulation. | ||
#. If you get a "Scripting: out of memory" GCS message then you will need to increase :ref:`SCR_HEAP_SIZE<SCR_HEAP_SIZE>` parameter and try to restart the simulation. | ||
#. From your GCS, enable scripting by setting the :ref:`SCR_ENABLE<SCR_ENABLE>` parameter to "1". Restart the simulation, or in MAVProxy, type ``reboot``. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we say "restart the simulation" but never explain how, ie CRTL-C, re-enter run SITL command (up arrow on some systems) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That should be covered in the SITL docs, but it doesn't look like it is yet. |
||
#. A "scripts" sub-directory will be created in the directory you started the simulation, if it did not already exist. You should expect to see a line similar to the following: ``Lua: State memory usage: 4824 + 9263``. This shows that scripting is now enabled. | ||
#. Now, create your first script in the ``scripts`` folder. If it's your first time, try the hello world script | ||
|
||
.. code-block:: bash | ||
|
||
cp libraries/AP_Scripting/examples/hello_world.lua scripts/ | ||
|
||
#. Again, restart the simulation. | ||
#. You should now observe the following in console. | ||
|
||
.. image:: ../../../images/LuaHelloWorld.png | ||
:target: ../_images/LuaHelloWorld.png | ||
|
||
#. Now, you can try changing the script to say something else and saving the Lua script. | ||
#. In MAVProxy, once you you save changes to your Lua script, you can just restart the scripting engine with ``scripting restart``. This allows to you keep SITL running and quickly change your script. | ||
#. If you get a "Scripting: out of memory" GCS message then you will need to increase :ref:`SCR_HEAP_SIZE<SCR_HEAP_SIZE>` parameter and try to restart the simulation. The hello world script has enough memory. | ||
|
||
In Mission Planner (Windows): | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
probably need to talk about pwd...the above and following assumes you are starting SITL from the ardupilot clone directory
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You got it. I added some details in the initial SITL tutorial too where that was introduced. The wiki was making an assuming that
Tools/autotest
was on PATH.