forked from multiwii/multiwii-firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
/
GPS.cpp
1482 lines (1312 loc) · 55.5 KB
/
GPS.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "Arduino.h"
#include "config.h"
#include "def.h"
#include "types.h"
#include "GPS.h"
#include "Serial.h"
#include "Sensors.h"
#include "MultiWii.h"
#include "EEPROM.h"
#include <math.h>
#if GPS
//Function prototypes for GPS frame parsing
bool GPS_newFrame(uint8_t c);
//Function prototypes for other GPS functions
//These perhaps could go to the gps.h file, however these are local to the gps.cpp
void GPS_bearing(int32_t* lat1, int32_t* lon1, int32_t* lat2, int32_t* lon2, int32_t* bearing);
void GPS_distance_cm(int32_t* lat1, int32_t* lon1, int32_t* lat2, int32_t* lon2,uint32_t* dist);
static void GPS_calc_velocity(void);
static void GPS_calc_location_error( int32_t* target_lat, int32_t* target_lng, int32_t* gps_lat, int32_t* gps_lng );
static void GPS_calc_poshold(void);
static uint16_t GPS_calc_desired_speed(uint16_t max_speed, bool _slow);
static void GPS_calc_nav_rate(uint16_t max_speed);
int32_t wrap_18000(int32_t ang);
static bool check_missed_wp(void);
void GPS_calc_longitude_scaling(int32_t lat);
static void GPS_update_crosstrack(void);
int32_t wrap_36000(int32_t ang);
#if defined(INIT_MTK_GPS)
#define MTK_SET_BINARY PSTR("$PGCMD,16,0,0,0,0,0*6A\r\n")
#define MTK_SET_NMEA PSTR("$PGCMD,16,1,1,1,1,1*6B\r\n")
#define MTK_SET_NMEA_SENTENCES PSTR("$PMTK314,0,1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0*28\r\n")
#define MTK_OUTPUT_4HZ PSTR("$PMTK220,250*29\r\n")
#define MTK_OUTPUT_5HZ PSTR("$PMTK220,200*2C\r\n")
#define MTK_OUTPUT_10HZ PSTR("$PMTK220,100*2F\r\n")
#define MTK_NAVTHRES_OFF PSTR("$PMTK397,0*23\r\n") // Set Nav Threshold (the minimum speed the GPS must be moving to update the position) to 0 m/s
#define SBAS_ON PSTR("$PMTK313,1*2E\r\n")
#define WAAS_ON PSTR("$PMTK301,2*2E\r\n")
#define SBAS_TEST_MODE PSTR("$PMTK319,0*25\r\n") //Enable test use of sbas satelite in test mode (usually PRN124 is in test mode)
#endif
// Leadig filter - TODO: rewrite to normal C instead of C++
// Set up gps lag
#if defined(UBLOX) || defined (MTK_BINARY19)
#define GPS_LAG 0.5f //UBLOX GPS has a smaller lag than MTK and other
#else
#define GPS_LAG 1.0f //We assumes that MTK GPS has a 1 sec lag
#endif
static int32_t GPS_coord_lead[2]; // Lead filtered gps coordinates
class LeadFilter {
public:
LeadFilter() :
_last_velocity(0) {
}
// setup min and max radio values in CLI
int32_t get_position(int32_t pos, int16_t vel, float lag_in_seconds = 1.0);
void clear() { _last_velocity = 0; }
private:
int16_t _last_velocity;
};
int32_t LeadFilter::get_position(int32_t pos, int16_t vel, float lag_in_seconds)
{
int16_t accel_contribution = (vel - _last_velocity) * lag_in_seconds * lag_in_seconds;
int16_t vel_contribution = vel * lag_in_seconds;
// store velocity for next iteration
_last_velocity = vel;
return pos + vel_contribution + accel_contribution;
}
LeadFilter xLeadFilter; // Long GPS lag filter
LeadFilter yLeadFilter; // Lat GPS lag filter
typedef struct PID_PARAM_ {
float kP;
float kI;
float kD;
float Imax;
} PID_PARAM;
PID_PARAM posholdPID_PARAM;
PID_PARAM poshold_ratePID_PARAM;
PID_PARAM navPID_PARAM;
typedef struct PID_ {
float integrator; // integrator value
int32_t last_input; // last input for derivative
float lastderivative; // last derivative for low-pass filter
float output;
float derivative;
} PID;
PID posholdPID[2];
PID poshold_ratePID[2];
PID navPID[2];
int32_t get_P(int32_t error, struct PID_PARAM_* pid) {
return (float)error * pid->kP;
}
int32_t get_I(int32_t error, float* dt, struct PID_* pid, struct PID_PARAM_* pid_param) {
pid->integrator += ((float)error * pid_param->kI) * *dt;
pid->integrator = constrain(pid->integrator,-pid_param->Imax,pid_param->Imax);
return pid->integrator;
}
int32_t get_D(int32_t input, float* dt, struct PID_* pid, struct PID_PARAM_* pid_param) { // dt in milliseconds
pid->derivative = (input - pid->last_input) / *dt;
/// Low pass filter cut frequency for derivative calculation.
float filter = 7.9577e-3; // Set to "1 / ( 2 * PI * f_cut )";
// Examples for _filter:
// f_cut = 10 Hz -> _filter = 15.9155e-3
// f_cut = 15 Hz -> _filter = 10.6103e-3
// f_cut = 20 Hz -> _filter = 7.9577e-3
// f_cut = 25 Hz -> _filter = 6.3662e-3
// f_cut = 30 Hz -> _filter = 5.3052e-3
// discrete low pass filter, cuts out the
// high frequency noise that can drive the controller crazy
pid->derivative = pid->lastderivative + (*dt / ( filter + *dt)) * (pid->derivative - pid->lastderivative);
// update state
pid->last_input = input;
pid->lastderivative = pid->derivative;
// add in derivative component
return pid_param->kD * pid->derivative;
}
void reset_PID(struct PID_* pid) {
pid->integrator = 0;
pid->last_input = 0;
pid->lastderivative = 0;
}
#define _X 1
#define _Y 0
#define RADX100 0.000174532925
uint8_t land_detect; //Detect land (extern)
static uint32_t land_settle_timer;
static uint32_t GPS_last_frame_seen; //Last gps frame seen at this time, used to detect stalled gps communication
static uint8_t GPS_Frame; // a valid GPS_Frame was detected, and data is ready for nav computation
static float dTnav; // Delta Time in milliseconds for navigation computations, updated with every good GPS read
static int16_t actual_speed[2] = {0,0};
static float GPS_scaleLonDown; // this is used to offset the shrinking longitude as we go towards the poles
// The difference between the desired rate of travel and the actual rate of travel
// updated after GPS read - 5-10hz
static int16_t rate_error[2];
static int32_t error[2];
static int32_t GPS_WP[2]; //Currently used WP
static int32_t GPS_FROM[2]; //the pervious waypoint for precise track following
int32_t target_bearing; // This is the angle from the copter to the "next_WP" location in degrees * 100
static int32_t original_target_bearing; // deg * 100, The original angle to the next_WP when the next_WP was set, Also used to check when we pass a WP
static int16_t crosstrack_error; // The amount of angle correction applied to target_bearing to bring the copter back on its optimum path
uint32_t wp_distance; // distance between plane and next_WP in cm
static uint16_t waypoint_speed_gov; // used for slow speed wind up when start navigation;
////////////////////////////////////////////////////////////////////////////////////
// moving average filter variables
//
#define GPS_FILTER_VECTOR_LENGTH 5
static uint8_t GPS_filter_index = 0;
static int32_t GPS_filter[2][GPS_FILTER_VECTOR_LENGTH];
static int32_t GPS_filter_sum[2];
static int32_t GPS_read[2];
static int32_t GPS_filtered[2];
static int32_t GPS_degree[2]; //the lat lon degree without any decimals (lat/10 000 000)
static uint16_t fraction3[2];
static int16_t nav_takeoff_bearing; // saves the bearing at takeof (1deg = 1) used to rotate to takeoff direction when arrives at home
//Serial GPS initialization
#if defined(GPS_SERIAL)
#if defined(INIT_MTK_GPS) || defined(UBLOX)
uint32_t init_speed[5] = {9600,19200,38400,57600,115200};
void SerialGpsPrint(const char PROGMEM * str) {
char b;
while(str && (b = pgm_read_byte(str++))) {
SerialWrite(GPS_SERIAL, b);
#if defined(UBLOX)
delay(5);
#endif
}
}
#endif
#if defined(UBLOX)
const prog_char UBLOX_INIT[] PROGMEM = { // PROGMEM array must be outside any function !!!
0xB5,0x62,0x06,0x01,0x03,0x00,0xF0,0x05,0x00,0xFF,0x19, //disable all default NMEA messages
0xB5,0x62,0x06,0x01,0x03,0x00,0xF0,0x03,0x00,0xFD,0x15,
0xB5,0x62,0x06,0x01,0x03,0x00,0xF0,0x01,0x00,0xFB,0x11,
0xB5,0x62,0x06,0x01,0x03,0x00,0xF0,0x00,0x00,0xFA,0x0F,
0xB5,0x62,0x06,0x01,0x03,0x00,0xF0,0x02,0x00,0xFC,0x13,
0xB5,0x62,0x06,0x01,0x03,0x00,0xF0,0x04,0x00,0xFE,0x17,
0xB5,0x62,0x06,0x01,0x03,0x00,0x01,0x02,0x01,0x0E,0x47, //set POSLLH MSG rate
0xB5,0x62,0x06,0x01,0x03,0x00,0x01,0x03,0x01,0x0F,0x49, //set STATUS MSG rate
0xB5,0x62,0x06,0x01,0x03,0x00,0x01,0x06,0x01,0x12,0x4F, //set SOL MSG rate
0xB5,0x62,0x06,0x01,0x03,0x00,0x01,0x12,0x01,0x1E,0x67, //set VELNED MSG rate
0xB5,0x62,0x06,0x16,0x08,0x00,0x03,0x07,0x03,0x00,0x51,0x08,0x00,0x00,0x8A,0x41, //set WAAS to EGNOS
0xB5, 0x62, 0x06, 0x08, 0x06, 0x00, 0xC8, 0x00, 0x01, 0x00, 0x01, 0x00, 0xDE, 0x6A //set rate to 5Hz
};
#endif
void GPS_SerialInit(void) {
SerialOpen(GPS_SERIAL,GPS_BAUD);
delay(1000);
#if defined(UBLOX)
for(uint8_t i=0;i<5;i++){
SerialOpen(GPS_SERIAL,init_speed[i]); // switch UART speed for sending SET BAUDRATE command (NMEA mode)
#if (GPS_BAUD==19200)
SerialGpsPrint(PSTR("$PUBX,41,1,0003,0001,19200,0*23\r\n")); // 19200 baud - minimal speed for 5Hz update rate
#endif
#if (GPS_BAUD==38400)
SerialGpsPrint(PSTR("$PUBX,41,1,0003,0001,38400,0*26\r\n")); // 38400 baud
#endif
#if (GPS_BAUD==57600)
SerialGpsPrint(PSTR("$PUBX,41,1,0003,0001,57600,0*2D\r\n")); // 57600 baud
#endif
#if (GPS_BAUD==115200)
SerialGpsPrint(PSTR("$PUBX,41,1,0003,0001,115200,0*1E\r\n")); // 115200 baud
#endif
while(!SerialTXfree(GPS_SERIAL)) delay(10);
}
delay(200);
SerialOpen(GPS_SERIAL,GPS_BAUD);
for(uint8_t i=0; i<sizeof(UBLOX_INIT); i++) { // send configuration data in UBX protocol
SerialWrite(GPS_SERIAL, pgm_read_byte(UBLOX_INIT+i));
delay(5); //simulating a 38400baud pace (or less), otherwise commands are not accepted by the device.
}
#elif defined(INIT_MTK_GPS) // MTK GPS setup
for(uint8_t i=0;i<5;i++){
SerialOpen(GPS_SERIAL,init_speed[i]); // switch UART speed for sending SET BAUDRATE command
#if (GPS_BAUD==19200)
SerialGpsPrint(PSTR("$PMTK251,19200*22\r\n")); // 19200 baud - minimal speed for 5Hz update rate
#endif
#if (GPS_BAUD==38400)
SerialGpsPrint(PSTR("$PMTK251,38400*27\r\n")); // 38400 baud
#endif
#if (GPS_BAUD==57600)
SerialGpsPrint(PSTR("$PMTK251,57600*2C\r\n")); // 57600 baud
#endif
#if (GPS_BAUD==115200)
SerialGpsPrint(PSTR("$PMTK251,115200*1F\r\n")); // 115200 baud
#endif
while(!SerialTXfree(GPS_SERIAL)) delay(80);
}
// at this point we have GPS working at selected (via #define GPS_BAUD) baudrate
// So now we have to set the desired mode and update rate (which depends on the NMEA or MTK_BINARYxx settings)
SerialOpen(GPS_SERIAL,GPS_BAUD);
SerialGpsPrint(MTK_NAVTHRES_OFF);
while(!SerialTXfree(GPS_SERIAL)) delay(80);
SerialGpsPrint(SBAS_ON);
while(!SerialTXfree(GPS_SERIAL)) delay(80);
SerialGpsPrint(WAAS_ON);
while(!SerialTXfree(GPS_SERIAL)) delay(80);
SerialGpsPrint(SBAS_TEST_MODE);
while(!SerialTXfree(GPS_SERIAL)) delay(80);
SerialGpsPrint(MTK_OUTPUT_5HZ); // 5 Hz update rate
#if defined(NMEA)
SerialGpsPrint(MTK_SET_NMEA_SENTENCES); // only GGA and RMC sentence
#endif
#if defined(MTK_BINARY19) || defined(MTK_BINARY16)
SerialGpsPrint(MTK_SET_BINARY);
#endif
#endif //elif init_mtk_gps
}
#endif
//Main GPS nav loop. Called by the task scheduler
uint8_t GPS_NewData(void) {
uint8_t c = SerialAvailable(GPS_SERIAL);
if (c==0) return 0; //if we don't have char's to read, so return with a zero
while (c--) {
if (GPS_newFrame(SerialRead(GPS_SERIAL))) {
//We had a valid GPS data frame, so signal task scheduler to switch to compute
if (GPS_update == 1) GPS_update = 0; else GPS_update = 1; //Blink GPS update
GPS_last_frame_seen = millis();
GPS_Frame = 1;
GPS_Present = 1;
}
}
// Check for stalled GPS, if no frames seen for 1.2sec then consider it LOST
if ((millis() - GPS_last_frame_seen) > 1200) {
//No update since 1200ms clear fix...
f.GPS_FIX = 0;
GPS_numSat = 0;
}
return 1;
}
//Main navigation processor and state engine
// TODO: add proceesing states to ease processing burden
uint8_t GPS_Compute(void) {
unsigned char axis;
uint32_t dist; //temp variable to store dist to copter
int32_t dir; //temp variable to store dir to copter
static uint32_t nav_loopTimer;
//check that we have a valid frame, if not then return immediatly
if (GPS_Frame == 0) return 0; else GPS_Frame = 0;
//check home position and set it if it was not set
if (f.GPS_FIX && GPS_numSat >= 5) {
#if !defined(DONT_RESET_HOME_AT_ARM)
if (!f.ARMED) {f.GPS_FIX_HOME = 0;}
#endif
if (!f.GPS_FIX_HOME && f.ARMED) {
GPS_reset_home_position();
}
//Apply moving average filter to GPS data
if (GPS_conf.filtering) {
GPS_filter_index = (GPS_filter_index+1) % GPS_FILTER_VECTOR_LENGTH;
for (axis = 0; axis< 2; axis++) {
GPS_read[axis] = GPS_coord[axis]; //latest unfiltered data is in GPS_latitude and GPS_longitude
GPS_degree[axis] = GPS_read[axis] / 10000000; // get the degree to assure the sum fits to the int32_t
// How close we are to a degree line ? its the first three digits from the fractions of degree
// later we use it to Check if we are close to a degree line, if yes, disable averaging,
fraction3[axis] = (GPS_read[axis]- GPS_degree[axis]*10000000) / 10000;
GPS_filter_sum[axis] -= GPS_filter[axis][GPS_filter_index];
GPS_filter[axis][GPS_filter_index] = GPS_read[axis] - (GPS_degree[axis]*10000000);
GPS_filter_sum[axis] += GPS_filter[axis][GPS_filter_index];
GPS_filtered[axis] = GPS_filter_sum[axis] / GPS_FILTER_VECTOR_LENGTH + (GPS_degree[axis]*10000000);
if ( NAV_state == NAV_STATE_HOLD_INFINIT || NAV_state == NAV_STATE_HOLD_TIMED) { //we use gps averaging only in poshold mode...
if ( fraction3[axis]>1 && fraction3[axis]<999 ) GPS_coord[axis] = GPS_filtered[axis];
}
}
}
//dTnav calculation
//Time for calculating x,y speed and navigation pids
dTnav = (float)(millis() - nav_loopTimer)/ 1000.0;
nav_loopTimer = millis();
// prevent runup from bad GPS
dTnav = min(dTnav, 1.0);
//calculate distance and bearings for gui and other stuff continously - From home to copter
GPS_bearing(&GPS_coord[LAT],&GPS_coord[LON],&GPS_home[LAT],&GPS_home[LON],&dir);
GPS_distance_cm(&GPS_coord[LAT],&GPS_coord[LON],&GPS_home[LAT],&GPS_home[LON],&dist);
GPS_distanceToHome = dist/100;
GPS_directionToHome = dir/100;
if (!f.GPS_FIX_HOME) { //If we don't have home set, do not display anything
GPS_distanceToHome = 0;
GPS_directionToHome = 0;
}
//Check fence setting and execute RTH if neccessary
//TODO: autolanding
if ((GPS_conf.fence > 0) && (GPS_conf.fence < GPS_distanceToHome) && (f.GPS_mode != GPS_MODE_RTH) ) {
init_RTH();
}
//calculate the current velocity based on gps coordinates continously to get a valid speed at the moment when we start navigating
GPS_calc_velocity();
//Navigation state engine
if (f.GPS_mode != GPS_MODE_NONE) { //ok we are navigating ###0002
//do gps nav calculations here, these are common for nav and poshold
GPS_bearing(&GPS_coord[LAT],&GPS_coord[LON],&GPS_WP[LAT],&GPS_WP[LON],&target_bearing);
if (GPS_conf.lead_filter) {
GPS_distance_cm(&GPS_coord_lead[LAT],&GPS_coord_lead[LON],&GPS_WP[LAT],&GPS_WP[LON],&wp_distance);
GPS_calc_location_error(&GPS_WP[LAT],&GPS_WP[LON],&GPS_coord_lead[LAT],&GPS_coord_lead[LON]);
} else {
GPS_distance_cm(&GPS_coord[LAT],&GPS_coord[LON],&GPS_WP[LAT],&GPS_WP[LON],&wp_distance);
GPS_calc_location_error(&GPS_WP[LAT],&GPS_WP[LON],&GPS_coord[LAT],&GPS_coord[LON]);
}
// Adjust altitude
// if we are holding position and reached target altitude, then ignore altitude nav, and let the user trim alt
if ( !((NAV_state == NAV_STATE_HOLD_INFINIT) && (alt_change_flag == REACHED_ALT))) {
if (!f.LAND_IN_PROGRESS) {
alt_to_hold = get_new_altitude();
AltHold = alt_to_hold;
}
}
int16_t speed = 0; //Desired navigation speed
switch(NAV_state) //Navigation state machine
{
case NAV_STATE_NONE: //Just for clarity, do nothing when nav_state is none
break;
case NAV_STATE_LAND_START:
GPS_calc_poshold(); //Land in position hold
land_settle_timer = millis();
NAV_state = NAV_STATE_LAND_SETTLE;
break;
case NAV_STATE_LAND_SETTLE:
GPS_calc_poshold();
if (millis()-land_settle_timer > 5000)
NAV_state = NAV_STATE_LAND_START_DESCENT;
break;
case NAV_STATE_LAND_START_DESCENT:
GPS_calc_poshold(); //Land in position hold
f.THROTTLE_IGNORED = 1; //Ignore Throtte stick input
f.GPS_BARO_MODE = 1; //Take control of BARO mode
land_detect = 0; //Reset land detector
f.LAND_COMPLETED = 0;
f.LAND_IN_PROGRESS = 1; // Flag land process
NAV_state = NAV_STATE_LAND_IN_PROGRESS;
break;
case NAV_STATE_LAND_IN_PROGRESS:
GPS_calc_poshold();
check_land(); //Call land detector
if (f.LAND_COMPLETED) {
nav_timer_stop = millis() + 5000;
NAV_state = NAV_STATE_LANDED;
}
break;
case NAV_STATE_LANDED:
// Disarm if THROTTLE stick is at minimum or 5sec past after land detected
if (rcData[THROTTLE]<MINCHECK || nav_timer_stop <= millis()) { //Throttle at minimum or 5sec passed.
go_disarm();
f.OK_TO_ARM = 0; //Prevent rearming
NAV_state = NAV_STATE_NONE; //Disable position holding.... prevent flippover
f.GPS_BARO_MODE = 0;
f.LAND_COMPLETED = 0;
f.LAND_IN_PROGRESS = 0;
land_detect = 0;
f.THROTTLE_IGNORED = 0;
GPS_reset_nav();
}
break;
case NAV_STATE_HOLD_INFINIT: //Constant position hold, no timer. Only an rcOption change can exit from this
GPS_calc_poshold();
break;
case NAV_STATE_HOLD_TIMED:
if (nav_timer_stop == 0) { //We are start a timed poshold
nav_timer_stop = millis() + 1000*nav_hold_time; //Set when we will continue
} else if (nav_timer_stop <= millis()) { //did we reach our time limit ?
if (mission_step.flag != MISSION_FLAG_END) {
NAV_state = NAV_STATE_PROCESS_NEXT; //if yes then process next mission step
}
NAV_error = NAV_ERROR_TIMEWAIT;
}
GPS_calc_poshold(); //BTW hold position till next command
break;
case NAV_STATE_RTH_START:
if ((alt_change_flag == REACHED_ALT) || (!GPS_conf.wait_for_rth_alt)) { //Wait until we reach RTH altitude
GPS_set_next_wp(&GPS_home[LAT],&GPS_home[LON], &GPS_coord[LAT], &GPS_coord[LON]); //If we reached then change mode and start RTH
NAV_state = NAV_STATE_RTH_ENROUTE;
NAV_error = NAV_ERROR_NONE;
} else {
GPS_calc_poshold(); //hold position till we reach RTH alt
NAV_error = NAV_ERROR_WAIT_FOR_RTH_ALT;
}
break;
case NAV_STATE_RTH_ENROUTE: //Doing RTH navigation
speed = GPS_calc_desired_speed(GPS_conf.nav_speed_max, GPS_conf.slow_nav);
GPS_calc_nav_rate(speed);
GPS_adjust_heading();
if ((wp_distance <= GPS_conf.wp_radius) || check_missed_wp()) { //if yes switch to poshold mode
if (mission_step.parameter1 == 0) NAV_state = NAV_STATE_HOLD_INFINIT;
else NAV_state = NAV_STATE_LAND_START; // if parameter 1 in RTH step is non 0 then land at home
if (GPS_conf.nav_rth_takeoff_heading) { magHold = nav_takeoff_bearing; }
}
break;
case NAV_STATE_WP_ENROUTE:
speed = GPS_calc_desired_speed(GPS_conf.nav_speed_max, GPS_conf.slow_nav);
GPS_calc_nav_rate(speed);
GPS_adjust_heading();
if ((wp_distance <= GPS_conf.wp_radius) || check_missed_wp()) { //This decides what happen when we reached the WP coordinates
if (mission_step.action == MISSION_LAND) { //Autoland
NAV_state = NAV_STATE_LAND_START; //Start landing
set_new_altitude(alt.EstAlt); //Stop any altitude changes
} else if (mission_step.flag == MISSION_FLAG_END) { //If this was the last mission step (flag set by the mission planner), then switch to poshold
NAV_state = NAV_STATE_HOLD_INFINIT;
NAV_error = NAV_ERROR_FINISH;
} else if (mission_step.action == MISSION_HOLD_UNLIM) { //If mission_step was POSHOLD_UNLIM and we reached the position then switch to poshold unlimited
NAV_state = NAV_STATE_HOLD_INFINIT;
NAV_error = NAV_ERROR_FINISH;
} else if (mission_step.action == MISSION_HOLD_TIME) { //If mission_step was a timed poshold then initiate timed poshold
nav_hold_time = mission_step.parameter1;
nav_timer_stop = 0; //This indicates that we are starting a timed poshold
NAV_state = NAV_STATE_HOLD_TIMED;
} else {
NAV_state = NAV_STATE_PROCESS_NEXT; //Otherwise process next step
}
}
break;
case NAV_STATE_DO_JUMP:
if (jump_times < 0) { //Jump unconditionally (supposed to be -1) -10 should not be here
next_step = mission_step.parameter1;
NAV_state = NAV_STATE_PROCESS_NEXT;
}
if (jump_times == 0) {
jump_times = -10; //reset jump counter
if (mission_step.flag == MISSION_FLAG_END) { //If this was the last mission step (flag set by the mission planner), then switch to poshold
NAV_state = NAV_STATE_HOLD_INFINIT;
NAV_error = NAV_ERROR_FINISH;
} else
NAV_state = NAV_STATE_PROCESS_NEXT;
}
if (jump_times > 0) { //if zero not reached do a jump
next_step = mission_step.parameter1;
NAV_state = NAV_STATE_PROCESS_NEXT;
jump_times--;
}
break;
case NAV_STATE_PROCESS_NEXT: //Processing next mission step
NAV_error = NAV_ERROR_NONE;
if (!recallWP(next_step)) {
abort_mission(NAV_ERROR_WP_CRC);
} else {
switch(mission_step.action)
{
//Waypoiny and hold commands all starts with an enroute status it includes the LAND command too
case MISSION_WAYPOINT:
case MISSION_HOLD_TIME:
case MISSION_HOLD_UNLIM:
case MISSION_LAND:
set_new_altitude(mission_step.altitude);
GPS_set_next_wp(&mission_step.pos[LAT], &mission_step.pos[LON], &GPS_prev[LAT], &GPS_prev[LON]);
if ((wp_distance/100) >= GPS_conf.safe_wp_distance) abort_mission(NAV_ERROR_TOOFAR);
else NAV_state = NAV_STATE_WP_ENROUTE;
GPS_prev[LAT] = mission_step.pos[LAT]; //Save wp coordinates for precise route calc
GPS_prev[LON] = mission_step.pos[LON];
break;
case MISSION_RTH:
f.GPS_head_set = 0;
if (GPS_conf.rth_altitude == 0 && mission_step.altitude == 0) //if config and mission_step alt is zero
set_new_altitude(alt.EstAlt); // RTH returns at the actual altitude
else {
uint32_t rth_alt;
if (mission_step.altitude == 0) rth_alt = GPS_conf.rth_altitude * 100; //altitude in mission step has priority
else rth_alt = mission_step.altitude;
if (alt.EstAlt < rth_alt) set_new_altitude(rth_alt); //BUt only if we are below it.
else set_new_altitude(alt.EstAlt);
}
NAV_state = NAV_STATE_RTH_START;
break;
case MISSION_JUMP:
if (jump_times == -10) jump_times = mission_step.parameter2;
if (mission_step.parameter1 > 0 && mission_step.parameter1 < mission_step.number)
NAV_state = NAV_STATE_DO_JUMP;
else //Error situation, invalid jump target
abort_mission(NAV_ERROR_INVALID_JUMP);
break;
case MISSION_SET_HEADING:
GPS_poi[LAT] = 0; GPS_poi[LON] = 0; // zeroing this out clears the possible pervious set_poi
if (mission_step.parameter1 < 0) f.GPS_head_set = 0;
else {
f.GPS_head_set = 1;
GPS_directionToPoi = mission_step.parameter1;
}
break;
case MISSION_SET_POI:
GPS_poi[LAT] = mission_step.pos[LAT];
GPS_poi[LON] = mission_step.pos[LON];
f.GPS_head_set = 1;
break;
default: //if we got an unknown action code abort mission and hold position
abort_mission(NAV_ERROR_INVALID_DATA);
break;
}
next_step++; //Prepare for the next step
}
break;
} // switch end
} //end of gps calcs ###0002
}
return 1;
} // End of GPS_compute
// Abort current mission with the given error code (switch to poshold_infinit)
void abort_mission(unsigned char error_code) {
GPS_set_next_wp(&GPS_coord[LAT], &GPS_coord[LON],&GPS_coord[LAT], &GPS_coord[LON]);
NAV_error = error_code;
NAV_state = NAV_STATE_HOLD_INFINIT;
}
//Adjusting heading according to settings - MAG mode must be enabled
void GPS_adjust_heading() {
//TODO: Add slow windup for large heading change
//This controls the heading
if (f.GPS_head_set) { // We have seen a SET_POI or a SET_HEADING command
if (GPS_poi[LAT] == 0)
magHold = wrap_18000((GPS_directionToPoi*100)-18000)/100;
else {
GPS_bearing(&GPS_coord[LAT],&GPS_coord[LON],&GPS_poi[LAT],&GPS_poi[LON],&GPS_directionToPoi);
GPS_distance_cm(&GPS_coord[LAT],&GPS_coord[LON],&GPS_poi[LAT],&GPS_poi[LON],&wp_distance);
magHold = GPS_directionToPoi /100;
}
} else { // heading controlled by the standard defines
if (GPS_conf.nav_controls_heading) {
if (GPS_conf.nav_tail_first) {
magHold = wrap_18000(target_bearing-18000)/100;
} else {
magHold = wrap_18000(target_bearing)/100;
}
}
}
}
#define LAND_DETECT_THRESHOLD 40 //Counts of land situation
#define BAROPIDMIN -180 //BaroPID reach this if we landed.....
//Check if we landed or not
void check_land() {
// detect whether we have landed by watching for low climb rate and throttle control
if ( (abs(alt.vario) < 20) && (BaroPID < BAROPIDMIN)) {
if (!f.LAND_COMPLETED) {
if( land_detect < LAND_DETECT_THRESHOLD) {
land_detect++;
} else {
f.LAND_COMPLETED = 1;
land_detect = 0;
}
}
} else {
// we've detected movement up or down so reset land_detector
land_detect = 0;
if(f.LAND_COMPLETED) {
f.LAND_COMPLETED = 0;
}
}
}
int32_t get_altitude_error() {
return alt_to_hold - alt.EstAlt;
}
void clear_new_altitude() {
alt_change_flag = REACHED_ALT;
}
void force_new_altitude(int32_t _new_alt) {
alt_to_hold = _new_alt;
target_altitude = _new_alt;
alt_change_flag = REACHED_ALT;
}
void set_new_altitude(int32_t _new_alt) {
//Limit maximum altitude command
if(_new_alt > GPS_conf.nav_max_altitude*100) _new_alt = GPS_conf.nav_max_altitude * 100;
if(_new_alt == alt.EstAlt){
force_new_altitude(_new_alt);
return;
}
// We start at the current location altitude and gradually change alt
alt_to_hold = alt.EstAlt;
// for calculating the delta time
alt_change_timer = millis();
// save the target altitude
target_altitude = _new_alt;
// reset our altitude integrator
alt_change = 0;
// save the original altitude
original_altitude = alt.EstAlt;
// to decide if we have reached the target altitude
if(target_altitude > original_altitude){
// we are below, going up
alt_change_flag = ASCENDING;
} else if(target_altitude < original_altitude){
// we are above, going down
alt_change_flag = DESCENDING;
} else {
// No Change
alt_change_flag = REACHED_ALT;
}
}
int32_t get_new_altitude() {
// returns a new altitude which feeded into the alt.hold controller
if(alt_change_flag == ASCENDING) {
// we are below, going up
if(alt.EstAlt >= target_altitude) alt_change_flag = REACHED_ALT;
// we shouldn't command past our target
if(alt_to_hold >= target_altitude) return target_altitude;
} else if (alt_change_flag == DESCENDING) {
// we are above, going down
if(alt.EstAlt <= target_altitude) alt_change_flag = REACHED_ALT;
// we shouldn't command past our target
if(alt_to_hold <= target_altitude) return target_altitude;
}
// if we have reached our target altitude, return the target alt
if(alt_change_flag == REACHED_ALT) return target_altitude;
int32_t diff = abs(alt_to_hold - target_altitude);
// scale is how we generate a desired rate from the elapsed time
// a smaller scale means faster rates
int8_t _scale = 4;
if (alt_to_hold < target_altitude) {
// we are below the target alt
if(diff < 200) _scale = 4;
else _scale = 3;
} else {
// we are above the target, going down
if(diff < 400) _scale = 5; //Slow down if only 4meters above
if(diff < 100) _scale = 6; //Slow down further if within 1meter
}
// we use the elapsed time as our altitude offset
// 1000 = 1 sec
// 1000 >> 4 = 64cm/s descent by default
int32_t change = (millis() - alt_change_timer) >> _scale;
if(alt_change_flag == ASCENDING){
alt_change += change;
} else {
alt_change -= change;
}
// for generating delta time
alt_change_timer = millis();
return original_altitude + alt_change;
}
////////////////////////////////////////////////////////////////////////////////////
//PID based GPS navigation functions
//Author : EOSBandi
//Based on code and ideas from the Arducopter team: Jason Short,Randy Mackay, Pat Hickey, Jose Julio, Jani Hirvinen
//Andrew Tridgell, Justin Beech, Adam Rivera, Jean-Louis Naudin, Roberto Navoni
//original constraint does not work with variables
int16_t constrain_int16(int16_t amt, int16_t low, int16_t high) {
return ((amt)<(low)?(low):((amt)>(high)?(high):(amt)));
}
////////////////////////////////////////////////////////////////////////////////////
// this is used to offset the shrinking longitude as we go towards the poles
// It's ok to calculate this once per waypoint setting, since it changes a little within the reach of a multicopter
//
void GPS_calc_longitude_scaling(int32_t lat) {
GPS_scaleLonDown = cos(lat * 1.0e-7f * 0.01745329251f);
}
////////////////////////////////////////////////////////////////////////////////////
// Sets the waypoint to navigate, reset neccessary variables and calculate initial values
//
void GPS_set_next_wp(int32_t* lat_to, int32_t* lon_to, int32_t* lat_from, int32_t* lon_from) {
GPS_WP[LAT] = *lat_to;
GPS_WP[LON] = *lon_to;
GPS_FROM[LAT] = *lat_from;
GPS_FROM[LON] = *lon_from;
GPS_calc_longitude_scaling(*lat_to);
GPS_bearing(&GPS_FROM[LAT],&GPS_FROM[LON],&GPS_WP[LAT],&GPS_WP[LON],&target_bearing);
GPS_distance_cm(&GPS_FROM[LAT],&GPS_FROM[LON],&GPS_WP[LAT],&GPS_WP[LON],&wp_distance);
GPS_calc_location_error(&GPS_WP[LAT],&GPS_WP[LON],&GPS_FROM[LAT],&GPS_FROM[LON]);
waypoint_speed_gov = GPS_conf.nav_speed_min;
original_target_bearing = target_bearing;
}
////////////////////////////////////////////////////////////////////////////////////
// Check if we missed the destination somehow
//
static bool check_missed_wp(void) {
int32_t temp;
temp = target_bearing - original_target_bearing;
temp = wrap_18000(temp);
return (abs(temp) > 10000); // we passed the waypoint by 100 degrees
}
////////////////////////////////////////////////////////////////////////////////////
// Get distance between two points in cm
// Get bearing from pos1 to pos2, returns an 1deg = 100 precision
void GPS_bearing(int32_t* lat1, int32_t* lon1, int32_t* lat2, int32_t* lon2, int32_t* bearing) {
int32_t off_x = *lon2 - *lon1;
int32_t off_y = (*lat2 - *lat1) / GPS_scaleLonDown;
*bearing = 9000 + atan2(-off_y, off_x) * 5729.57795f; //Convert the output redians to 100xdeg
if (*bearing < 0) *bearing += 36000;
}
void GPS_distance_cm(int32_t* lat1, int32_t* lon1, int32_t* lat2, int32_t* lon2,uint32_t* dist) {
float dLat = (float)(*lat2 - *lat1); // difference of latitude in 1/10 000 000 degrees
float dLon = (float)(*lon2 - *lon1) * GPS_scaleLonDown; //x
*dist = sqrt(sq(dLat) + sq(dLon)) * 1.11318845f;
}
//*******************************************************************************************************
// calc_velocity_and_filtered_position - velocity in lon and lat directions calculated from GPS position
// and accelerometer data
// lon_speed expressed in cm/s. positive numbers mean moving east
// lat_speed expressed in cm/s. positive numbers when moving north
// Note: we use gps locations directly to calculate velocity instead of asking gps for velocity because
// this is more accurate below 1.5m/s
// Note: even though the positions are projected using a lead filter, the velocities are calculated
// from the unaltered gps locations. We do not want noise from our lead filter affecting velocity
//*******************************************************************************************************
static void GPS_calc_velocity(void){
static int16_t speed_old[2] = {0,0};
static int32_t last[2] = {0,0};
static uint8_t init = 0;
if (init) {
float tmp = 1.0/dTnav;
actual_speed[_X] = (float)(GPS_coord[LON] - last[LON]) * GPS_scaleLonDown * tmp;
actual_speed[_Y] = (float)(GPS_coord[LAT] - last[LAT]) * tmp;
//TODO: Check unrealistic speed changes and signal navigation about posibble gps signal degradation
if (!GPS_conf.lead_filter) {
actual_speed[_X] = (actual_speed[_X] + speed_old[_X]) / 2;
actual_speed[_Y] = (actual_speed[_Y] + speed_old[_Y]) / 2;
speed_old[_X] = actual_speed[_X];
speed_old[_Y] = actual_speed[_Y];
}
}
init=1;
last[LON] = GPS_coord[LON];
last[LAT] = GPS_coord[LAT];
if (GPS_conf.lead_filter) {
GPS_coord_lead[LON] = xLeadFilter.get_position(GPS_coord[LON], actual_speed[_X], GPS_LAG);
GPS_coord_lead[LAT] = yLeadFilter.get_position(GPS_coord[LAT], actual_speed[_Y], GPS_LAG);
}
}
////////////////////////////////////////////////////////////////////////////////////
// Calculate a location error between two gps coordinates
// Because we are using lat and lon to do our distance errors here's a quick chart:
// 100 = 1m
// 1000 = 11m = 36 feet
// 1800 = 19.80m = 60 feet
// 3000 = 33m
// 10000 = 111m
//
static void GPS_calc_location_error( int32_t* target_lat, int32_t* target_lng, int32_t* gps_lat, int32_t* gps_lng ) {
error[LON] = (float)(*target_lng - *gps_lng) * GPS_scaleLonDown; // X Error
error[LAT] = *target_lat - *gps_lat; // Y Error
}
////////////////////////////////////////////////////////////////////////////////////
// Calculate nav_lat and nav_lon from the x and y error and the speed
//
// TODO: check that the poshold target speed constraint can be increased for snappier poshold lock
static void GPS_calc_poshold(void) {
int32_t d;
int32_t target_speed;
uint8_t axis;
for (axis=0;axis<2;axis++) {
target_speed = get_P(error[axis], &posholdPID_PARAM); // calculate desired speed from lat/lon error
target_speed = constrain(target_speed,-100,100); // Constrain the target speed in poshold mode to 1m/s it helps avoid runaways..
rate_error[axis] = target_speed - actual_speed[axis]; // calc the speed error
nav[axis] =
get_P(rate_error[axis], &poshold_ratePID_PARAM)
+get_I(rate_error[axis] + error[axis], &dTnav, &poshold_ratePID[axis], &poshold_ratePID_PARAM);
d = get_D(error[axis], &dTnav, &poshold_ratePID[axis], &poshold_ratePID_PARAM);
d = constrain(d, -2000, 2000);
// get rid of noise
if(abs(actual_speed[axis]) < 50) d = 0;
nav[axis] +=d;
// nav[axis] = constrain(nav[axis], -NAV_BANK_MAX, NAV_BANK_MAX);
nav[axis] = constrain_int16(nav[axis], -GPS_conf.nav_bank_max, GPS_conf.nav_bank_max);
navPID[axis].integrator = poshold_ratePID[axis].integrator;
}
}
////////////////////////////////////////////////////////////////////////////////////
// Calculate the desired nav_lat and nav_lon for distance flying such as RTH and WP
//
static void GPS_calc_nav_rate( uint16_t max_speed) {
float trig[2];
int32_t target_speed[2];
int32_t tilt;
uint8_t axis;
GPS_update_crosstrack();
int16_t cross_speed = crosstrack_error * (GPS_conf.crosstrack_gain / 100.0); //check is it ok ?
cross_speed = constrain(cross_speed,-200,200);
cross_speed = -cross_speed;
float temp = (9000l - target_bearing) * RADX100;
trig[_X] = cos(temp);
trig[_Y] = sin(temp);
target_speed[_X] = max_speed * trig[_X] - cross_speed * trig[_Y];
target_speed[_Y] = cross_speed * trig[_X] + max_speed * trig[_Y];
for (axis=0;axis<2;axis++) {
rate_error[axis] = target_speed[axis] - actual_speed[axis];
rate_error[axis] = constrain(rate_error[axis],-1000,1000);
nav[axis] =
get_P(rate_error[axis], &navPID_PARAM)
+get_I(rate_error[axis], &dTnav, &navPID[axis], &navPID_PARAM)
+get_D(rate_error[axis], &dTnav, &navPID[axis], &navPID_PARAM);
// nav[axis] = constrain(nav[axis],-NAV_BANK_MAX,NAV_BANK_MAX);
nav[axis] = constrain_int16(nav[axis], -GPS_conf.nav_bank_max, GPS_conf.nav_bank_max);
poshold_ratePID[axis].integrator = navPID[axis].integrator;
}
}
static void GPS_update_crosstrack(void) {
// Crosstrack Error
// ----------------
// If we are too far off or too close we don't do track following
float temp = (target_bearing - original_target_bearing) * RADX100;
crosstrack_error = sin(temp) * wp_distance; // Meters we are off track line
}
////////////////////////////////////////////////////////////////////////////////////
// Determine desired speed when navigating towards a waypoint, also implement slow
// speed rampup when starting a navigation
//
// |< WP Radius
// 0 1 2 3 4 5 6 7 8m
// ...|...|...|...|...|...|...|...|
// 100 | 200 300 400cm/s
// | +|+
// |< we should slow to 1 m/s as we hit the target
//
static uint16_t GPS_calc_desired_speed(uint16_t max_speed, bool _slow) {
if(_slow){
max_speed = min(max_speed, wp_distance / 2);
} else {
max_speed = min(max_speed, wp_distance);
max_speed = max(max_speed, GPS_conf.nav_speed_min); // go at least nav_speed_min
}
// limit the ramp up of the speed
// waypoint_speed_gov is reset to 0 at each new WP command
if(max_speed > waypoint_speed_gov){
waypoint_speed_gov += (int)(100.0 * dTnav); // increase at .5/ms
max_speed = waypoint_speed_gov;
}
return max_speed;
}
////////////////////////////////////////////////////////////////////////////////////
// Utilities
//
int32_t wrap_36000(int32_t ang) {
if (ang > 36000) ang -= 36000;
if (ang < 0) ang += 36000;
return ang;
}
/*
* EOS increased the precision here, even if we think that the gps is not precise enough, with 10e5 precision it has 76cm resolution
* with 10e7 it's around 1 cm now. Increasing it further is irrelevant, since even 1cm resolution is unrealistic, however increased
* resolution also increased precision of nav calculations
*/
#define DIGIT_TO_VAL(_x) (_x - '0')
uint32_t GPS_coord_to_degrees(char* s) {
char *p, *q;
uint8_t deg = 0, min = 0;
unsigned int frac_min = 0;
uint8_t i;
// scan for decimal point or end of field
for (p = s; isdigit(*p); p++) ;