2015-12-30 18:57:56 -04:00
/// -*- tab-width: 4; Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*-
2016-01-14 15:30:56 -04:00
# include "Sub.h"
2015-12-30 18:57:56 -04:00
// start_command - this function will be called when the ap_mission lib wishes to start a new command
2016-01-14 15:30:56 -04:00
bool Sub : : start_command ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// To-Do: logging when new commands start/end
if ( should_log ( MASK_LOG_CMD ) ) {
DataFlash . Log_Write_Mission_Cmd ( mission , cmd ) ;
}
switch ( cmd . id ) {
///
/// navigation commands
///
case MAV_CMD_NAV_TAKEOFF : // 22
do_takeoff ( cmd ) ;
break ;
case MAV_CMD_NAV_WAYPOINT : // 16 Navigate to Waypoint
do_nav_wp ( cmd ) ;
break ;
case MAV_CMD_NAV_LAND : // 21 LAND to Waypoint
do_land ( cmd ) ;
break ;
case MAV_CMD_NAV_LOITER_UNLIM : // 17 Loiter indefinitely
do_loiter_unlimited ( cmd ) ;
break ;
case MAV_CMD_NAV_LOITER_TURNS : //18 Loiter N Times
do_circle ( cmd ) ;
break ;
case MAV_CMD_NAV_LOITER_TIME : // 19
do_loiter_time ( cmd ) ;
break ;
case MAV_CMD_NAV_RETURN_TO_LAUNCH : //20
do_RTL ( ) ;
break ;
case MAV_CMD_NAV_SPLINE_WAYPOINT : // 82 Navigate to Waypoint using spline
do_spline_wp ( cmd ) ;
break ;
# if NAV_GUIDED == ENABLED
case MAV_CMD_NAV_GUIDED_ENABLE : // 92 accept navigation commands from external nav computer
do_nav_guided_enable ( cmd ) ;
break ;
# endif
//
// conditional commands
//
case MAV_CMD_CONDITION_DELAY : // 112
do_wait_delay ( cmd ) ;
break ;
case MAV_CMD_CONDITION_DISTANCE : // 114
do_within_distance ( cmd ) ;
break ;
case MAV_CMD_CONDITION_CHANGE_ALT : // 113
do_change_alt ( cmd ) ;
break ;
case MAV_CMD_CONDITION_YAW : // 115
do_yaw ( cmd ) ;
break ;
///
/// do commands
///
case MAV_CMD_DO_CHANGE_SPEED : // 178
do_change_speed ( cmd ) ;
break ;
case MAV_CMD_DO_SET_HOME : // 179
do_set_home ( cmd ) ;
break ;
case MAV_CMD_DO_SET_SERVO :
ServoRelayEvents . do_set_servo ( cmd . content . servo . channel , cmd . content . servo . pwm ) ;
break ;
case MAV_CMD_DO_SET_RELAY :
ServoRelayEvents . do_set_relay ( cmd . content . relay . num , cmd . content . relay . state ) ;
break ;
case MAV_CMD_DO_REPEAT_SERVO :
ServoRelayEvents . do_repeat_servo ( cmd . content . repeat_servo . channel , cmd . content . repeat_servo . pwm ,
cmd . content . repeat_servo . repeat_count , cmd . content . repeat_servo . cycle_time * 1000.0f ) ;
break ;
case MAV_CMD_DO_REPEAT_RELAY :
ServoRelayEvents . do_repeat_relay ( cmd . content . repeat_relay . num , cmd . content . repeat_relay . repeat_count ,
cmd . content . repeat_relay . cycle_time * 1000.0f ) ;
break ;
case MAV_CMD_DO_SET_ROI : // 201
// point the copter and camera at a region of interest (ROI)
do_roi ( cmd ) ;
break ;
case MAV_CMD_DO_MOUNT_CONTROL : // 205
// point the camera to a specified angle
do_mount_control ( cmd ) ;
break ;
# if CAMERA == ENABLED
case MAV_CMD_DO_CONTROL_VIDEO : // Control on-board camera capturing. |Camera ID (-1 for all)| Transmission: 0: disabled, 1: enabled compressed, 2: enabled raw| Transmission mode: 0: video stream, >0: single images every n seconds (decimal)| Recording: 0: disabled, 1: enabled compressed, 2: enabled raw| Empty| Empty| Empty|
break ;
case MAV_CMD_DO_DIGICAM_CONFIGURE : // Mission command to configure an on-board camera controller system. |Modes: P, TV, AV, M, Etc| Shutter speed: Divisor number for one second| Aperture: F stop number| ISO number e.g. 80, 100, 200, Etc| Exposure type enumerator| Command Identity| Main engine cut-off time before camera trigger in seconds/10 (0 means no cut-off)|
do_digicam_configure ( cmd ) ;
break ;
case MAV_CMD_DO_DIGICAM_CONTROL : // Mission command to control an on-board camera controller system. |Session control e.g. show/hide lens| Zoom's absolute position| Zooming step value to offset zoom from the current position| Focus Locking, Unlocking or Re-locking| Shooting Command| Command Identity| Empty|
do_digicam_control ( cmd ) ;
break ;
case MAV_CMD_DO_SET_CAM_TRIGG_DIST :
camera . set_trigger_distance ( cmd . content . cam_trigg_dist . meters ) ;
break ;
# endif
# if PARACHUTE == ENABLED
case MAV_CMD_DO_PARACHUTE : // Mission command to configure or release parachute
do_parachute ( cmd ) ;
break ;
# endif
# if EPM_ENABLED == ENABLED
case MAV_CMD_DO_GRIPPER : // Mission command to control EPM gripper
do_gripper ( cmd ) ;
break ;
# endif
# if NAV_GUIDED == ENABLED
case MAV_CMD_DO_GUIDED_LIMITS : // 220 accept guided mode limits
do_guided_limits ( cmd ) ;
break ;
# endif
default :
// do nothing with unrecognized MAVLink messages
break ;
}
// always return success
return true ;
}
/********************************************************************************/
// Verify command Handlers
/********************************************************************************/
// verify_command_callback - callback function called from ap-mission at 10hz or higher when a command is being run
// we double check that the flight mode is AUTO to avoid the possibility of ap-mission triggering actions while we're not in AUTO mode
2016-01-14 15:30:56 -04:00
bool Sub : : verify_command_callback ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
if ( control_mode = = AUTO ) {
bool cmd_complete = verify_command ( cmd ) ;
// send message to GCS
if ( cmd_complete ) {
gcs_send_mission_item_reached_message ( cmd . index ) ;
}
return cmd_complete ;
}
return false ;
}
// verify_command - this will be called repeatedly by ap_mission lib to ensure the active commands are progressing
// should return true once the active navigation command completes successfully
// called at 10hz or higher
2016-01-14 15:30:56 -04:00
bool Sub : : verify_command ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
switch ( cmd . id ) {
//
// navigation commands
//
case MAV_CMD_NAV_TAKEOFF :
return verify_takeoff ( ) ;
case MAV_CMD_NAV_WAYPOINT :
return verify_nav_wp ( cmd ) ;
case MAV_CMD_NAV_LAND :
return verify_land ( ) ;
case MAV_CMD_NAV_LOITER_UNLIM :
return verify_loiter_unlimited ( ) ;
case MAV_CMD_NAV_LOITER_TURNS :
return verify_circle ( cmd ) ;
case MAV_CMD_NAV_LOITER_TIME :
return verify_loiter_time ( ) ;
case MAV_CMD_NAV_RETURN_TO_LAUNCH :
return verify_RTL ( ) ;
case MAV_CMD_NAV_SPLINE_WAYPOINT :
return verify_spline_wp ( cmd ) ;
# if NAV_GUIDED == ENABLED
case MAV_CMD_NAV_GUIDED_ENABLE :
return verify_nav_guided_enable ( cmd ) ;
# endif
///
/// conditional commands
///
case MAV_CMD_CONDITION_DELAY :
return verify_wait_delay ( ) ;
case MAV_CMD_CONDITION_DISTANCE :
return verify_within_distance ( ) ;
case MAV_CMD_CONDITION_CHANGE_ALT :
return verify_change_alt ( ) ;
case MAV_CMD_CONDITION_YAW :
return verify_yaw ( ) ;
case MAV_CMD_DO_PARACHUTE :
// assume parachute was released successfully
return true ;
default :
// return true if we do not recognize the command so that we move on to the next command
return true ;
}
}
// exit_mission - function that is called once the mission completes
2016-01-14 15:30:56 -04:00
void Sub : : exit_mission ( )
2015-12-30 18:57:56 -04:00
{
// play a tone
AP_Notify : : events . mission_complete = 1 ;
// if we are not on the ground switch to loiter or land
if ( ! ap . land_complete ) {
// try to enter loiter but if that fails land
if ( ! auto_loiter_start ( ) ) {
set_mode ( LAND ) ;
}
} else {
# if LAND_REQUIRE_MIN_THROTTLE_TO_DISARM == ENABLED
// disarm when the landing detector says we've landed and throttle is at minimum
if ( ap . throttle_zero | | failsafe . radio ) {
init_disarm_motors ( ) ;
}
# else
// if we've landed it's safe to disarm
init_disarm_motors ( ) ;
# endif
}
}
/********************************************************************************/
//
/********************************************************************************/
// do_RTL - start Return-to-Launch
2016-01-14 15:30:56 -04:00
void Sub : : do_RTL ( void )
2015-12-30 18:57:56 -04:00
{
// start rtl in auto flight mode
auto_rtl_start ( ) ;
}
/********************************************************************************/
// Nav (Must) commands
/********************************************************************************/
// do_takeoff - initiate takeoff navigation command
2016-01-14 15:30:56 -04:00
void Sub : : do_takeoff ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// Set wp navigation target to safe altitude above current position
float takeoff_alt = cmd . content . location . alt ;
takeoff_alt = MAX ( takeoff_alt , current_loc . alt ) ;
takeoff_alt = MAX ( takeoff_alt , 100.0f ) ;
auto_takeoff_start ( takeoff_alt ) ;
}
// do_nav_wp - initiate move to next waypoint
2016-01-14 15:30:56 -04:00
void Sub : : do_nav_wp ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
const Vector3f & curr_pos = inertial_nav . get_position ( ) ;
const Vector3f local_pos = pv_location_to_vector_with_default ( cmd . content . location , curr_pos ) ;
// this will be used to remember the time in millis after we reach or pass the WP.
loiter_time = 0 ;
// this is the delay, stored in seconds
loiter_time_max = abs ( cmd . p1 ) ;
// Set wp navigation target
auto_wp_start ( local_pos ) ;
// if no delay set the waypoint as "fast"
if ( loiter_time_max = = 0 ) {
wp_nav . set_fast_waypoint ( true ) ;
}
}
// do_land - initiate landing procedure
2016-01-14 15:30:56 -04:00
void Sub : : do_land ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// To-Do: check if we have already landed
// if location provided we fly to that location at current altitude
if ( cmd . content . location . lat ! = 0 | | cmd . content . location . lng ! = 0 ) {
// set state to fly to location
land_state = LAND_STATE_FLY_TO_LOCATION ;
// calculate and set desired location above landing target
Vector3f pos = pv_location_to_vector ( cmd . content . location ) ;
pos . z = inertial_nav . get_altitude ( ) ;
auto_wp_start ( pos ) ;
} else {
// set landing state
land_state = LAND_STATE_DESCENDING ;
// initialise landing controller
auto_land_start ( ) ;
}
}
// do_loiter_unlimited - start loitering with no end conditions
// note: caller should set yaw_mode
2016-01-14 15:30:56 -04:00
void Sub : : do_loiter_unlimited ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
Vector3f target_pos ;
// get current position
Vector3f curr_pos = inertial_nav . get_position ( ) ;
// default to use position provided
target_pos = pv_location_to_vector ( cmd . content . location ) ;
// use current location if not provided
if ( cmd . content . location . lat = = 0 & & cmd . content . location . lng = = 0 ) {
wp_nav . get_wp_stopping_point_xy ( target_pos ) ;
}
// use current altitude if not provided
// To-Do: use z-axis stopping point instead of current alt
if ( cmd . content . location . alt = = 0 ) {
target_pos . z = curr_pos . z ;
}
// start way point navigator and provide it the desired location
auto_wp_start ( target_pos ) ;
}
// do_circle - initiate moving in a circle
2016-01-14 15:30:56 -04:00
void Sub : : do_circle ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
Vector3f curr_pos = inertial_nav . get_position ( ) ;
Vector3f circle_center = pv_location_to_vector ( cmd . content . location ) ;
uint8_t circle_radius_m = HIGHBYTE ( cmd . p1 ) ; // circle radius held in high byte of p1
bool move_to_edge_required = false ;
// set target altitude if not provided
if ( cmd . content . location . alt = = 0 ) {
circle_center . z = curr_pos . z ;
} else {
move_to_edge_required = true ;
}
// set lat/lon position if not provided
// To-Do: use previous command's destination if it was a straight line or spline waypoint command
if ( cmd . content . location . lat = = 0 & & cmd . content . location . lng = = 0 ) {
circle_center . x = curr_pos . x ;
circle_center . y = curr_pos . y ;
} else {
move_to_edge_required = true ;
}
// set circle controller's center
circle_nav . set_center ( circle_center ) ;
// set circle radius
if ( circle_radius_m ! = 0 ) {
circle_nav . set_radius ( ( float ) circle_radius_m * 100.0f ) ;
}
// check if we need to move to edge of circle
if ( move_to_edge_required ) {
// move to edge of circle (verify_circle) will ensure we begin circling once we reach the edge
auto_circle_movetoedge_start ( ) ;
} else {
// start circling
auto_circle_start ( ) ;
}
}
// do_loiter_time - initiate loitering at a point for a given time period
// note: caller should set yaw_mode
2016-01-14 15:30:56 -04:00
void Sub : : do_loiter_time ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
Vector3f target_pos ;
// get current position
Vector3f curr_pos = inertial_nav . get_position ( ) ;
// default to use position provided
target_pos = pv_location_to_vector ( cmd . content . location ) ;
// use current location if not provided
if ( cmd . content . location . lat = = 0 & & cmd . content . location . lng = = 0 ) {
wp_nav . get_wp_stopping_point_xy ( target_pos ) ;
}
// use current altitude if not provided
if ( cmd . content . location . alt = = 0 ) {
target_pos . z = curr_pos . z ;
}
// start way point navigator and provide it the desired location
auto_wp_start ( target_pos ) ;
// setup loiter timer
loiter_time = 0 ;
loiter_time_max = cmd . p1 ; // units are (seconds)
}
// do_spline_wp - initiate move to next waypoint
2016-01-14 15:30:56 -04:00
void Sub : : do_spline_wp ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
const Vector3f & curr_pos = inertial_nav . get_position ( ) ;
Vector3f local_pos = pv_location_to_vector_with_default ( cmd . content . location , curr_pos ) ;
// this will be used to remember the time in millis after we reach or pass the WP.
loiter_time = 0 ;
// this is the delay, stored in seconds
loiter_time_max = abs ( cmd . p1 ) ;
// determine segment start and end type
bool stopped_at_start = true ;
AC_WPNav : : spline_segment_end_type seg_end_type = AC_WPNav : : SEGMENT_END_STOP ;
AP_Mission : : Mission_Command temp_cmd ;
Vector3f next_destination ; // end of next segment
// if previous command was a wp_nav command with no delay set stopped_at_start to false
// To-Do: move processing of delay into wp-nav controller to allow it to determine the stopped_at_start value itself?
uint16_t prev_cmd_idx = mission . get_prev_nav_cmd_index ( ) ;
if ( prev_cmd_idx ! = AP_MISSION_CMD_INDEX_NONE ) {
if ( mission . read_cmd_from_storage ( prev_cmd_idx , temp_cmd ) ) {
if ( ( temp_cmd . id = = MAV_CMD_NAV_WAYPOINT | | temp_cmd . id = = MAV_CMD_NAV_SPLINE_WAYPOINT ) & & temp_cmd . p1 = = 0 ) {
stopped_at_start = false ;
}
}
}
// if there is no delay at the end of this segment get next nav command
if ( cmd . p1 = = 0 & & mission . get_next_nav_cmd ( cmd . index + 1 , temp_cmd ) ) {
// if the next nav command is a waypoint set end type to spline or straight
if ( temp_cmd . id = = MAV_CMD_NAV_WAYPOINT ) {
seg_end_type = AC_WPNav : : SEGMENT_END_STRAIGHT ;
next_destination = pv_location_to_vector_with_default ( temp_cmd . content . location , local_pos ) ;
} else if ( temp_cmd . id = = MAV_CMD_NAV_SPLINE_WAYPOINT ) {
seg_end_type = AC_WPNav : : SEGMENT_END_SPLINE ;
next_destination = pv_location_to_vector_with_default ( temp_cmd . content . location , local_pos ) ;
}
}
// set spline navigation target
auto_spline_start ( local_pos , stopped_at_start , seg_end_type , next_destination ) ;
}
# if NAV_GUIDED == ENABLED
// do_nav_guided_enable - initiate accepting commands from external nav computer
2016-01-14 15:30:56 -04:00
void Sub : : do_nav_guided_enable ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
if ( cmd . p1 > 0 ) {
// initialise guided limits
guided_limit_init_time_and_pos ( ) ;
// set spline navigation target
auto_nav_guided_start ( ) ;
}
}
# endif // NAV_GUIDED
# if PARACHUTE == ENABLED
// do_parachute - configure or release parachute
2016-01-14 15:30:56 -04:00
void Sub : : do_parachute ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
switch ( cmd . p1 ) {
case PARACHUTE_DISABLE :
parachute . enabled ( false ) ;
Log_Write_Event ( DATA_PARACHUTE_DISABLED ) ;
break ;
case PARACHUTE_ENABLE :
parachute . enabled ( true ) ;
Log_Write_Event ( DATA_PARACHUTE_ENABLED ) ;
break ;
case PARACHUTE_RELEASE :
parachute_release ( ) ;
break ;
default :
// do nothing
break ;
}
}
# endif
# if EPM_ENABLED == ENABLED
// do_gripper - control EPM gripper
2016-01-14 15:30:56 -04:00
void Sub : : do_gripper ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// Note: we ignore the gripper num parameter because we only support one gripper
switch ( cmd . content . gripper . action ) {
case GRIPPER_ACTION_RELEASE :
epm . release ( ) ;
Log_Write_Event ( DATA_EPM_RELEASE ) ;
break ;
case GRIPPER_ACTION_GRAB :
epm . grab ( ) ;
Log_Write_Event ( DATA_EPM_GRAB ) ;
break ;
default :
// do nothing
break ;
}
}
# endif
# if NAV_GUIDED == ENABLED
// do_guided_limits - pass guided limits to guided controller
2016-01-14 15:30:56 -04:00
void Sub : : do_guided_limits ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
guided_limit_set ( cmd . p1 * 1000 , // convert seconds to ms
cmd . content . guided_limits . alt_min * 100.0f , // convert meters to cm
cmd . content . guided_limits . alt_max * 100.0f , // convert meters to cm
cmd . content . guided_limits . horiz_max * 100.0f ) ; // convert meters to cm
}
# endif
/********************************************************************************/
// Verify Nav (Must) commands
/********************************************************************************/
// verify_takeoff - check if we have completed the takeoff
2016-01-14 15:30:56 -04:00
bool Sub : : verify_takeoff ( )
2015-12-30 18:57:56 -04:00
{
// have we reached our target altitude?
return wp_nav . reached_wp_destination ( ) ;
}
// verify_land - returns true if landing has been completed
2016-01-14 15:30:56 -04:00
bool Sub : : verify_land ( )
2015-12-30 18:57:56 -04:00
{
bool retval = false ;
switch ( land_state ) {
case LAND_STATE_FLY_TO_LOCATION :
// check if we've reached the location
if ( wp_nav . reached_wp_destination ( ) ) {
// get destination so we can use it for loiter target
Vector3f dest = wp_nav . get_wp_destination ( ) ;
// initialise landing controller
auto_land_start ( dest ) ;
// advance to next state
land_state = LAND_STATE_DESCENDING ;
}
break ;
case LAND_STATE_DESCENDING :
// rely on THROTTLE_LAND mode to correctly update landing status
retval = ap . land_complete ;
break ;
default :
// this should never happen
// TO-DO: log an error
retval = true ;
break ;
}
// true is returned if we've successfully landed
return retval ;
}
// verify_nav_wp - check if we have reached the next way point
2016-01-14 15:30:56 -04:00
bool Sub : : verify_nav_wp ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// check if we have reached the waypoint
if ( ! wp_nav . reached_wp_destination ( ) ) {
return false ;
}
// play a tone
AP_Notify : : events . waypoint_complete = 1 ;
// start timer if necessary
if ( loiter_time = = 0 ) {
loiter_time = millis ( ) ;
}
// check if timer has run out
if ( ( ( millis ( ) - loiter_time ) / 1000 ) > = loiter_time_max ) {
gcs_send_text_fmt ( MAV_SEVERITY_INFO , " Reached command #%i " , cmd . index ) ;
return true ;
} else {
return false ;
}
}
2016-01-14 15:30:56 -04:00
bool Sub : : verify_loiter_unlimited ( )
2015-12-30 18:57:56 -04:00
{
return false ;
}
// verify_loiter_time - check if we have loitered long enough
2016-01-14 15:30:56 -04:00
bool Sub : : verify_loiter_time ( )
2015-12-30 18:57:56 -04:00
{
// return immediately if we haven't reached our destination
if ( ! wp_nav . reached_wp_destination ( ) ) {
return false ;
}
// start our loiter timer
if ( loiter_time = = 0 ) {
loiter_time = millis ( ) ;
}
// check if loiter timer has run out
return ( ( ( millis ( ) - loiter_time ) / 1000 ) > = loiter_time_max ) ;
}
// verify_circle - check if we have circled the point enough
2016-01-14 15:30:56 -04:00
bool Sub : : verify_circle ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// check if we've reached the edge
if ( auto_mode = = Auto_CircleMoveToEdge ) {
if ( wp_nav . reached_wp_destination ( ) ) {
Vector3f curr_pos = inertial_nav . get_position ( ) ;
Vector3f circle_center = pv_location_to_vector ( cmd . content . location ) ;
// set target altitude if not provided
if ( is_zero ( circle_center . z ) ) {
circle_center . z = curr_pos . z ;
}
// set lat/lon position if not provided
if ( cmd . content . location . lat = = 0 & & cmd . content . location . lng = = 0 ) {
circle_center . x = curr_pos . x ;
circle_center . y = curr_pos . y ;
}
// start circling
auto_circle_start ( ) ;
}
return false ;
}
// check if we have completed circling
return fabsf ( circle_nav . get_angle_total ( ) / M_2PI_F ) > = LOWBYTE ( cmd . p1 ) ;
}
// verify_RTL - handles any state changes required to implement RTL
// do_RTL should have been called once first to initialise all variables
// returns true with RTL has completed successfully
2016-01-14 15:30:56 -04:00
bool Sub : : verify_RTL ( )
2015-12-30 18:57:56 -04:00
{
return ( rtl_state_complete & & ( rtl_state = = RTL_FinalDescent | | rtl_state = = RTL_Land ) ) ;
}
// verify_spline_wp - check if we have reached the next way point using spline
2016-01-14 15:30:56 -04:00
bool Sub : : verify_spline_wp ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// check if we have reached the waypoint
if ( ! wp_nav . reached_wp_destination ( ) ) {
return false ;
}
// start timer if necessary
if ( loiter_time = = 0 ) {
loiter_time = millis ( ) ;
}
// check if timer has run out
if ( ( ( millis ( ) - loiter_time ) / 1000 ) > = loiter_time_max ) {
gcs_send_text_fmt ( MAV_SEVERITY_INFO , " Reached command #%i " , cmd . index ) ;
return true ;
} else {
return false ;
}
}
# if NAV_GUIDED == ENABLED
// verify_nav_guided - check if we have breached any limits
2016-01-14 15:30:56 -04:00
bool Sub : : verify_nav_guided_enable ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// if disabling guided mode then immediately return true so we move to next command
if ( cmd . p1 = = 0 ) {
return true ;
}
// check time and position limits
return guided_limit_check ( ) ;
}
# endif // NAV_GUIDED
/********************************************************************************/
// Condition (May) commands
/********************************************************************************/
2016-01-14 15:30:56 -04:00
void Sub : : do_wait_delay ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
condition_start = millis ( ) ;
condition_value = cmd . content . delay . seconds * 1000 ; // convert seconds to milliseconds
}
2016-01-14 15:30:56 -04:00
void Sub : : do_change_alt ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
// To-Do: store desired altitude in a variable so that it can be verified later
}
2016-01-14 15:30:56 -04:00
void Sub : : do_within_distance ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
condition_value = cmd . content . distance . meters * 100 ;
}
2016-01-14 15:30:56 -04:00
void Sub : : do_yaw ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
set_auto_yaw_look_at_heading (
cmd . content . yaw . angle_deg ,
cmd . content . yaw . turn_rate_dps ,
cmd . content . yaw . direction ,
cmd . content . yaw . relative_angle ) ;
}
/********************************************************************************/
// Verify Condition (May) commands
/********************************************************************************/
2016-01-14 15:30:56 -04:00
bool Sub : : verify_wait_delay ( )
2015-12-30 18:57:56 -04:00
{
if ( millis ( ) - condition_start > ( uint32_t ) MAX ( condition_value , 0 ) ) {
condition_value = 0 ;
return true ;
}
return false ;
}
2016-01-14 15:30:56 -04:00
bool Sub : : verify_change_alt ( )
2015-12-30 18:57:56 -04:00
{
// To-Do: use recorded target altitude to verify we have reached the target
return true ;
}
2016-01-14 15:30:56 -04:00
bool Sub : : verify_within_distance ( )
2015-12-30 18:57:56 -04:00
{
// update distance calculation
calc_wp_distance ( ) ;
if ( wp_distance < ( uint32_t ) MAX ( condition_value , 0 ) ) {
condition_value = 0 ;
return true ;
}
return false ;
}
// verify_yaw - return true if we have reached the desired heading
2016-01-14 15:30:56 -04:00
bool Sub : : verify_yaw ( )
2015-12-30 18:57:56 -04:00
{
// set yaw mode if it has been changed (the waypoint controller often retakes control of yaw as it executes a new waypoint command)
if ( auto_yaw_mode ! = AUTO_YAW_LOOK_AT_HEADING ) {
set_auto_yaw_mode ( AUTO_YAW_LOOK_AT_HEADING ) ;
}
// check if we are within 2 degrees of the target heading
if ( labs ( wrap_180_cd ( ahrs . yaw_sensor - yaw_look_at_heading ) ) < = 200 ) {
return true ;
} else {
return false ;
}
}
/********************************************************************************/
// Do (Now) commands
/********************************************************************************/
// do_guided - start guided mode
2016-01-14 15:30:56 -04:00
bool Sub : : do_guided ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
Vector3f pos_or_vel ; // target location or velocity
// only process guided waypoint if we are in guided mode
if ( control_mode ! = GUIDED & & ! ( control_mode = = AUTO & & auto_mode = = Auto_NavGuided ) ) {
return false ;
}
// switch to handle different commands
switch ( cmd . id ) {
case MAV_CMD_NAV_WAYPOINT :
// set wp_nav's destination
pos_or_vel = pv_location_to_vector ( cmd . content . location ) ;
guided_set_destination ( pos_or_vel ) ;
return true ;
break ;
case MAV_CMD_CONDITION_YAW :
do_yaw ( cmd ) ;
return true ;
break ;
default :
// reject unrecognised command
return false ;
break ;
}
return true ;
}
2016-01-14 15:30:56 -04:00
void Sub : : do_change_speed ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
if ( cmd . content . speed . target_ms > 0 ) {
wp_nav . set_speed_xy ( cmd . content . speed . target_ms * 100.0f ) ;
}
}
2016-01-14 15:30:56 -04:00
void Sub : : do_set_home ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
if ( cmd . p1 = = 1 | | ( cmd . content . location . lat = = 0 & & cmd . content . location . lng = = 0 & & cmd . content . location . alt = = 0 ) ) {
set_home_to_current_location ( ) ;
} else {
if ( ! far_from_EKF_origin ( cmd . content . location ) ) {
set_home ( cmd . content . location ) ;
}
}
}
// do_roi - starts actions required by MAV_CMD_NAV_ROI
// this involves either moving the camera to point at the ROI (region of interest)
// and possibly rotating the copter to point at the ROI if our mount type does not support a yaw feature
// TO-DO: add support for other features of MAV_CMD_DO_SET_ROI including pointing at a given waypoint
2016-01-14 15:30:56 -04:00
void Sub : : do_roi ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
set_auto_yaw_roi ( cmd . content . location ) ;
}
// do_digicam_configure Send Digicam Configure message with the camera library
2016-01-14 15:30:56 -04:00
void Sub : : do_digicam_configure ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
# if CAMERA == ENABLED
camera . configure ( cmd . content . digicam_configure . shooting_mode ,
cmd . content . digicam_configure . shutter_speed ,
cmd . content . digicam_configure . aperture ,
cmd . content . digicam_configure . ISO ,
cmd . content . digicam_configure . exposure_type ,
cmd . content . digicam_configure . cmd_id ,
cmd . content . digicam_configure . engine_cutoff_time ) ;
# endif
}
// do_digicam_control Send Digicam Control message with the camera library
2016-01-14 15:30:56 -04:00
void Sub : : do_digicam_control ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
# if CAMERA == ENABLED
2016-02-03 18:56:39 -04:00
if ( camera . control ( cmd . content . digicam_control . session ,
2015-12-30 18:57:56 -04:00
cmd . content . digicam_control . zoom_pos ,
cmd . content . digicam_control . zoom_step ,
cmd . content . digicam_control . focus_lock ,
cmd . content . digicam_control . shooting_cmd ,
2016-02-03 18:56:39 -04:00
cmd . content . digicam_control . cmd_id ) ) {
log_picture ( ) ;
}
2015-12-30 18:57:56 -04:00
# endif
}
// do_take_picture - take a picture with the camera library
2016-01-14 15:30:56 -04:00
void Sub : : do_take_picture ( )
2015-12-30 18:57:56 -04:00
{
# if CAMERA == ENABLED
camera . trigger_pic ( true ) ;
log_picture ( ) ;
# endif
}
// log_picture - log picture taken and send feedback to GCS
2016-01-14 15:30:56 -04:00
void Sub : : log_picture ( )
2015-12-30 18:57:56 -04:00
{
2016-02-03 18:56:39 -04:00
if ( ! camera . using_feedback_pin ( ) ) {
gcs_send_message ( MSG_CAMERA_FEEDBACK ) ;
if ( should_log ( MASK_LOG_CAMERA ) ) {
DataFlash . Log_Write_Camera ( ahrs , gps , current_loc ) ;
}
} else {
if ( should_log ( MASK_LOG_CAMERA ) ) {
DataFlash . Log_Write_Trigger ( ahrs , gps , current_loc ) ;
}
}
2015-12-30 18:57:56 -04:00
}
// point the camera to a specified angle
2016-01-14 15:30:56 -04:00
void Sub : : do_mount_control ( const AP_Mission : : Mission_Command & cmd )
2015-12-30 18:57:56 -04:00
{
# if MOUNT == ENABLED
camera_mount . set_angle_targets ( cmd . content . mount_control . roll , cmd . content . mount_control . pitch , cmd . content . mount_control . yaw ) ;
# endif
}