Skip to content
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

AP_AdvancedFailsafe: wiki on AFS_OPTIONS #5424

Merged
merged 1 commit into from
Sep 21, 2023

Conversation

eppravitra
Copy link
Contributor

No description provided.

Copy link
Contributor

@Hwurzburg Hwurzburg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs some more explanation....probably partly due to historical documentation not being explict enough also

------------------
In addition, the behavior of AFS can be modified by the setting of the :ref:`AFS_OPTIONS<AFS_OPTIONS>` bitmask parameter (no bits are set by default):

- bit 0 (+1), if set, the aircraft will continue the mission even after data link is recovered. If not set, the aircraft will return to the mission item right before GCS failsafe occurs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"continue the mission" ?doesnt this mean "continue the mission sequence jumped to by the AFS"?
what is data link? RC?GCS? either?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite, continuing the mission means it will keep flying with the current mission item. If set, there would be no jumping. I reword it slightly. I hope it's a bit better.

The phrase data link has been changed.

In addition, the behavior of AFS can be modified by the setting of the :ref:`AFS_OPTIONS<AFS_OPTIONS>` bitmask parameter (no bits are set by default):

- bit 0 (+1), if set, the aircraft will continue the mission even after data link is recovered. If not set, the aircraft will return to the mission item right before GCS failsafe occurs
- bit 1 (+2), if set, will force entering AUTO when GCS failsafe occurs. This is to make sure AFS is entered if the Plane is flying in other autonomous modes (such as GUIDED).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so currently if in GUIDED nothing happens on an AFS event? what other "autonomous" modes are there?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's correct. By default, AFS will not trigger on GUIDED.

I'm not sure if I want to list out all the modes. I kind of want to keep the description as it is. This is because autonomous modes might refer to different modes for Plane, Copter, and Rover. In the code, it is whatever mode is interpreted as AP_AdvancedFailsafe::AFS_AUTO.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfotunately, there is no place in the wiki that designates a vehicles modes as autonomous or non-autonomous, so we will have to list them here since this is the only place in the wiki that this designation is mentioned associated with a mode...even I am uncertain which modes would fall under this category....for example in Plane is LOITER??? you cant say that autonomous is a mode where pilot input is denied, because you can stick mix control even in AUTO....so how do you designate "autonomous"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

discussed with Tridge....its not autonomous....its auto-throttle modes in Plane..using AFS in other vehicles is something that is possible but only for an advanced user compiling their own code...so the wiki article will remain Plane focussed for now....I will update this PR accordingly...thanks

Copy link
Contributor

@Hwurzburg Hwurzburg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also under the "Ground station communications loss" section there is this incorrect sentence:
If GPS lock is lost at the same time as GCS communications is lost then that is considered a “dual loss”, and the aircraft will immediately terminate.
lower it states this only happens if the AFS_DUAL_LOSS is enabled...correct? or is the order of GCS/GPS loss important?

@@ -262,6 +262,13 @@ the aircraft is a danger to people or other aircraft. To force an
immediate termination you should use the :ref:`AFS_TERMINATE<AFS_TERMINATE>` parameter. By
setting that parameter to 1 the aircraft will immediately terminate.

AFS_OPTIONS
------------------
In addition, the behavior of AFS can be modified by the setting of the :ref:`AFS_OPTIONS<AFS_OPTIONS>` bitmask parameter (no bits are set by default):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In addition, the behavior of AFS can be modified by the setting of the :ref:`AFS_OPTIONS<AFS_OPTIONS>` bitmask parameter (no bits are set by default):
In addition, the behavior of AFS during GCS communication loass can be modified by the setting of the :ref:`AFS_OPTIONS<AFS_OPTIONS>` bitmask parameter (no bits are set by default):

based on your change this param only affects GCS loss....not GPS(which also changes mission sequence)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we should change this sentence though. In the future, someone could use other bit mask to change behavior of RC failsafe or GCS failsafe.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if and when the behavior is changed, we can modify the sentence...as it is it could be assumed to be used for GPS mission changes also, which It is not

@Hwurzburg
Copy link
Contributor

I have updated and squashed....I think I am going to go ahead and merge this since it improves the existing info as well as add the new option, rather than putting it as an upcoming 4.5 feature...and the same with the other AFS 4.5 addition....users of this are advanced and it wont confuse normal users...thanks for documenting your code addition!

@Hwurzburg Hwurzburg merged commit d009914 into ArduPilot:master Sep 21, 2023
4 checks passed
@eppravitra
Copy link
Contributor Author

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants