Skip to content

Commit

Permalink
[modules] dox for nav_survey_poly_osam
Browse files Browse the repository at this point in the history
  • Loading branch information
flixr committed Dec 7, 2014
1 parent dd4f415 commit 6d70947
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion sw/airborne/modules/nav/nav_survey_poly_osam.h
Expand Up @@ -29,10 +29,28 @@

#include "std.h"

/**
* Setup polygon survey.
* @param FirstWP first waypoint/corner of the polygon
* @param Size number of waypoints/corners used to define the polygon
* @param Sweep distance between scan lines
* @param Orientation angle of scan lines in degrees (CCW, east)
*/
extern bool_t nav_survey_poly_osam_setup(uint8_t FirstWP, uint8_t Size, float Sweep, float Orientation);
/** start a polygonsurvey and compute the orientation angle from the line FirstWP-SecondWP */

/**
* Setup polygon survey with sweep orientation towards a waypoint.
* Computes the sweep orientation angle from the line FirstWP-SecondWP.
* @param FirstWp first waypoint/corner of the polygon
* @param Size number of waypoints/corners used to define the polygon
* @param Sweep distance between scan lines
* @param SecondWp second waypoint towards which the sweep orientation is computed
*/
extern bool_t nav_survey_poly_osam_setup_towards(uint8_t FirstWP, uint8_t Size, float Sweep, int SecondWP);

/** Run polygon survey */
extern bool_t nav_survey_poly_osam_run(void);

extern uint16_t PolySurveySweepNum;
extern uint16_t PolySurveySweepBackNum;

Expand Down

0 comments on commit 6d70947

Please sign in to comment.