MAV'RIC
state_machine.h
1 /*******************************************************************************
2  * Copyright (c) 2009-2014, MAV'RIC Development Team
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  ******************************************************************************/
31 
32 /*******************************************************************************
33  * \file state_machine.h
34  *
35  * \author MAV'RIC Team
36  * \author Nicolas Dousse
37  * \author Julien Lecoeur
38  *
39  * \brief Handles transitions between states and modes
40  *
41  ******************************************************************************/
42 
43 
44 #ifndef STATE_MACHINE_H_
45 #define STATE_MACHINE_H_
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 #include "scheduler.h"
52 #include "state.h"
53 #include "mavlink_waypoint_handler.h"
54 #include "simulation.h"
55 
56 
60 typedef struct
61 {
62  uint8_t channel_switches;
63  signal_quality_t rc_check;
64  int8_t motor_state;
65 
71 
72 
83 bool state_machine_init( state_machine_t *state_machine,
84  state_t* state,
85  mavlink_waypoint_handler_t* waypoint_handler,
86  simulation_model_t *sim_model,
87  remote_t* remote);
88 
89 
97 task_return_t state_machine_set_mav_mode_n_state(state_machine_t* state_machine);
98 
104 void state_machine_update(state_machine_t* state_machine);
105 
106 
107 #ifdef __cplusplus
108 }
109 #endif
110 
111 #endif // STATE_MACHINE_H_
The configuration structure of the remote.
Definition: remote.h:150
state_t * state
Pointer to the state structure.
Definition: state_machine.h:67
simulation_model_t * sim_model
Pointer to the simulation structure.
Definition: state_machine.h:68
The simulation model structure definition.
Definition: simulation.h:99
int8_t motor_state
State of the motors to switch on and off.
Definition: state_machine.h:64
uint8_t channel_switches
State of the switches of the remote.
Definition: state_machine.h:62
remote_t * remote
Pointer to the remote structure.
Definition: state_machine.h:69
mavlink_waypoint_handler_t * waypoint_handler
Pointer to the mavlink waypoint handler structure.
Definition: state_machine.h:66
The state structure.
Definition: state.h:79
signal_quality_t rc_check
State of the remote (receiving signal or not)
Definition: state_machine.h:63
Defines the state machine structure.
Definition: state_machine.h:60