You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Brown.Z 844ce114bc Normalize all the line endings 2 years ago
..
applets Normalize all the line endings 2 years ago
docs AP_Scripting: add set_desired_speed binding 3 years ago
examples Normalize all the line endings 2 years ago
generator AP_Scripting: add set_desired_speed binding 3 years ago
lua AP_Scripting: make LUA memory panic more helpful 4 years ago
tests AP_Scripting: move scripting_test.lua from examples to tests 5 years ago
.gitignore AP_Scripting: auto-build the bindings 5 years ago
AP_Scripting.cpp AP_Scripting: increase default heap size in SITL and on F7/H7 3 years ago
AP_Scripting.h AP_Scripting: expand to 6 SCR_USER parameters 3 years ago
AP_Scripting_CANSensor.cpp AP_Scripting: add CANSensor and manaul bindings to load. 4 years ago
AP_Scripting_CANSensor.h AP_Scripting: add CANSensor and manaul bindings to load. 4 years ago
AP_Scripting_helpers.cpp AP_Scripting: add binding and helper to get old params 3 years ago
AP_Scripting_helpers.h AP_Scripting: add binding and helper to get old params 3 years ago
README.md AP_Scripting: rename AP_AHRS::get_position to get_location 3 years ago
lua_bindings.cpp AP_Scripting: Remove meaningless semicolons 3 years ago
lua_bindings.h AP_Scripting: Enforce a time limit for a script 6 years ago
lua_boxed_numerics.cpp AP_Scripting: remove compile errors and warnings 4 years ago
lua_boxed_numerics.h AP_Scripting: Add support for UART drivers 5 years ago
lua_repl.cpp AP_Scripting: Add missing const in member functions 4 years ago
lua_scripts.cpp AP_Scripting: add define option to disable interupts for the duration of script run 3 years ago
lua_scripts.h AP_Scripting: log files and runtime stats 3 years ago
wscript AP_Scripting: wscript: support docs option 3 years ago

README.md

AP_Scripting

Enabling Scripting Support in Builds

Scripting is automatically enabled on all boards with at least 1MB of flash space. The following example enables scripting, builds the ArduPlane firmware for the Cube, and uploads it.

$ waf configure --board=CubeBlack

$ waf plane

$ waf plane --upload

To run SITL you can simply use the sim_vehicle.py script which will wrap the configuration, compilation, and launching of the simulation into one command for you.

$ Tools/autotest/sim_vehicle.py -v ArduPlane

Once you have a vehicle flashed with scripting you need to set the SCR_ENABLE parameter to 1 to enable scripting and reboot.

Adding Scripts

The vehicle will automatically look for and launch any scripts that are contained in the scripts folder when it starts. On real hardware this should be inside of the APM folder of the SD card. In SITL this should be in the working directory (typically the main ardupilot directory).

An example script is given below:

function update () -- periodic function that will be called
  current_pos = ahrs:get_location()
  home = ahrs:get_home()
  if current_pos and home then
    distance = current_pos:get_distance(ahrs:get_home()) -- calculate the distance from home
    if distance > 1000 then -- if more then 1000 meters away
      distance = 1000;      -- clamp the distance to 1000 meters
    end
    SRV_Channels:set_output_pwm(96, 1000 + distance) -- set the servo assigned function 96 (scripting3) to a proportional value
  end

  return update, 1000 -- request to be rerun again 1000 milliseconds (1 second) from now
end

return update, 1000 -- request to be rerun again 1000 milliseconds (1 second) from now

Working with bindings

Edit bindings.desc and rebuild. The waf build will automatically re-run the code generator.