Skip to content

Commit 80cd349

Browse files
committed
AP_Scripting: add access to more fence methods
1 parent d1a5f5a commit 80cd349

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

libraries/AP_Scripting/docs/docs.lua

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4019,6 +4019,30 @@ function fence:get_margin_breach_time() end
40194019
---| 8 # Minimum altitude
40204020
function fence:get_breaches() end
40214021

4022+
-- Returns minimum safe altitude in meters (i.e. alt_min + margin)
4023+
---@return number
4024+
function fence:get_safe_alt_min_m() end
4025+
4026+
-- Returns maximum safe altitude in meters (i.e. alt_max - margin)
4027+
---@return number
4028+
function fence:get_safe_alt_max_m() end
4029+
4030+
-- Returns configured fences
4031+
---@return integer fence_type bitmask
4032+
---| 1 # Maximim altitude
4033+
---| 2 # Circle
4034+
---| 4 # Polygon
4035+
---| 8 # Minimum altitude
4036+
function fence:present() end
4037+
4038+
-- Returns enabled fences
4039+
---@return integer fence_type bitmask
4040+
---| 1 # Maximim altitude
4041+
---| 2 # Circle
4042+
---| 4 # Polygon
4043+
---| 8 # Minimum altitude
4044+
function fence:get_enabled_fences() end
4045+
40224046
-- Returns the type bitmask of any fence whose margins have been crossed
40234047
---@return integer fence_type bitmask
40244048
---| 1 # Maximim altitude

libraries/AP_Scripting/generator/description/bindings.desc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1052,6 +1052,10 @@ singleton AC_Fence method get_margin_breaches uint8_t
10521052
singleton AC_Fence method get_margin_breach_time uint32_t
10531053
singleton AC_Fence method get_breach_distance float uint8_t'skip_check
10541054
singleton AC_Fence method get_breach_direction_NED boolean uint8_t'skip_check Vector3f'Null Location'Null
1055+
singleton AC_Fence method get_safe_alt_min_m float
1056+
singleton AC_Fence method get_safe_alt_max_m float
1057+
singleton AC_Fence method present uint8_t
1058+
singleton AC_Fence method get_enabled_fences uint8_t
10551059

10561060
include AP_Rally/AP_Rally.h depends HAL_RALLY_ENABLED
10571061

0 commit comments

Comments
 (0)