aepko/Ardupilot2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

AP_Scripting: Fix parameter name in find_serial, add description

Browse Source 
The argument to find_serial is not the protocol name, but the number of instance that can run the Scripting protocol (28).
The matching doc update is in https://github.com/ArduPilot/ardupilot_wiki/pull/4346.
This commit is contained in:
Maxim Buzdalov 2022-05-19 00:14:24 +03:00 committed by Peter Hall
parent 6f3b760d0b
commit e71ced7984
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
libraries/AP_Scripting/docs/docs.lua
View File

@ -1116,10 +1116,12 @@ function baro:get_pressure() end
---@class serial
serial = {}
-- desc
---@param protocol integer
---@return AP_HAL__UARTDriver_ud
function serial:find_serial(protocol) end
-- Returns the UART instance that allows connections from scripts (those with SERIALx_PROTOCOL = 28`).
-- For instance = 0, returns first such UART, second for instance = 1, and so on.
-- If such an instance is not found, returns nil.
---@param instance integer -- the 0-based index of the UART instance to return.
---@return AP_HAL__UARTDriver_ud -- the requested UART instance available for scripting, or nil if none.
function serial:find_serial(instance) end
-- desc