AP_Scripting: update docs file to be more comprehensive #30504

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

Jump to bottom

Open

andyp1per wants to merge 1 commit into ArduPilot:master from andyp1per:pr-docs-lua

+1,728 −1,794

Contributor

andyp1per commented Jun 28, 2025

No description provided.


          AP_Scripting: update docs file to be more comprehensive

b72e609

andyp1per requested a review from IamPete1

June 28, 2025 09:40

IamPete1 requested changes

View reviewed changes

Member

IamPete1 left a comment

Chat-GPT strikes again?

It certainty would be nice to get everything fully documented. But we have to make sure its documented correctly. I have only reviewed a small part of this, quite a bit of it is just wrong. I'm happy to work with you to get this across the line but I'm not interested in spending several hours reviewing PRs that were generated in 5 mins using AI.

libraries/AP_Scripting/docs/docs.lua

    
              ---@return integer

              function uint32_t_ud:toint() end

              --- Custom 64-bit unsigned integer userdata type.

              -- Essential for high-resolution timestamps (like from `micros()`) or large IDs where standard Lua numbers would lose precision.

Member

IamPete1 Jun 28, 2025

micros returns uint32. This is used in utc epoch from the gps, and a few places in DroneCAN.

libraries/AP_Scripting/docs/docs.lua

    
              ---@return uint32_t_ud -- microseconds

              -- Returns the system time in microseconds since the autopilot booted.

              -- This should be stored in a uint64_t_ud to avoid precision loss.

              ---@return uint64_t_ud -- Microseconds since boot.

Member

IamPete1 Jun 28, 2025

Suggested change

      
            ---@return uint64_t_ud -- Microseconds since boot.
          
            ---@return uint32_t_ud -- Microseconds since boot.

libraries/AP_Scripting/docs/docs.lua

    
              -- Prints text to the GCS and connected peripherals.

              -- If a MAVLink GCS is connected, this is equivalent to `gcs:send_text(MAV_SEVERITY.DEBUG, text)`.

              -- If the script is running on a peripheral, the text will be sent over the CAN bus.

              ---@param text string|number|integer -- The content to be printed. Non-string types will be converted to strings.

Member

IamPete1 Jun 28, 2025

I don't think we convert none strings? I might be worth testing, our print is not a nice as the built in print.

libraries/AP_Scripting/docs/docs.lua

    
              ---@param ... integer|number|uint32_t_ud|string|boolean -- data to be logged, type to match format string

              -- Writes a custom log entry to the dataflash log with full formatting options. A timestamp is automatically added.

              -- Example from `revert_param.lua`: `logger:write('QUIK','SRate,Gain,Param', 'ffn', srate, P:get(), axis .. stage)`

              ---@param name string -- A unique name for the log entry, must be 4 characters or less to avoid conflicts.

Member

IamPete1 Jun 28, 2025

Suggested change

      
            ---@param name string -- A unique name for the log entry, must be 4 characters or less to avoid conflicts.
          
            ---@param name string -- A unique name for the log entry, must be 4 characters or less.

libraries/AP_Scripting/docs/docs.lua

    
              -- Example from `revert_param.lua`: `logger:write('QUIK','SRate,Gain,Param', 'ffn', srate, P:get(), axis .. stage)`

              ---@param name string -- A unique name for the log entry, must be 4 characters or less to avoid conflicts.

              ---@param labels string -- Comma-separated labels for the data fields, up to 58 characters. E.g., "Lat,Lon,Alt".

              ---@param format string -- A format string defining the data types of the values. See https://ardupilot.org/dev/docs/code-overview-logger.html for format specifiers.

Member

IamPete1 Jun 28, 2025

This URL does not exist.

libraries/AP_Scripting/docs/docs.lua

    
              ---@class (exact) EFI_State_ud

              local EFI_State_ud = {}

              ---@return EFI_State_ud

              function EFI_State() end

              -- get field

              -- get field: Pressure/Temperature compensation for the engine.

              ---@return number

              function EFI_State_ud:pt_compensation() end

              -- set field

Member

IamPete1 Jun 28, 2025

set description should match that for get.

libraries/AP_Scripting/docs/docs.lua

    
              ---@return number

              function EFI_State_ud:fuel_consumption_rate_cm3pm() end

              -- set field

              ---@param value number

              function EFI_State_ud:fuel_consumption_rate_cm3pm(value) end

              -- get field

              -- get field: The current fuel pressure, typically in kPa.

Member

IamPete1 Jun 28, 2025

not typicaly, always in kPa.

libraries/AP_Scripting/docs/docs.lua

    
            @@ -233,87 +244,87 @@ function EFI_State_ud:fuel_pressure_status() end
          
              ---| '3' # Above nominal

              function EFI_State_ud:fuel_pressure_status(status) end

              -- get field

              -- get field: The engine oil temperature, typically in degrees Celsius.

Member

IamPete1 Jun 28, 2025

Suggested change

      
            -- get field: The engine oil temperature, typically in degrees Celsius.
          
            -- get field: The engine oil temperature, kelvin.

libraries/AP_Scripting/docs/docs.lua

    
              ---@return number

              function EFI_State_ud:oil_temperature() end

              -- set field

              ---@param value number

              function EFI_State_ud:oil_temperature(value) end

              -- get field

              -- get field: The engine oil pressure, typically in kPa.

Member

IamPete1 Jun 28, 2025

Suggested change

      
            -- get field: The engine oil pressure, typically in kPa.
          
            -- get field: The engine oil pressure, in kPa.

libraries/AP_Scripting/docs/docs.lua

    
              ---@return number

              function EFI_State_ud:oil_pressure() end

              -- set field

              ---@param value number

              function EFI_State_ud:oil_pressure(value) end

              -- get field

              -- get field: The engine coolant temperature, typically in degrees Celsius.

Member

IamPete1 Jun 28, 2025

Suggested change

      
            -- get field: The engine coolant temperature, typically in degrees Celsius.
          
            -- get field: The engine coolant temperature, kelvin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet