docs/Gps.md

   1 # GPS
   2
   3 GPS features in Cleanflight are experimental.  Please share your findings with the developers.
   4
   5 GPS works best if the GPS receiver is mounted above and away from other sources of interference.
   6
   7 The compass/mag sensor should be well away from sources of magnetic interference, e.g. keep it away from power wires, motors, ESCs.
   8
   9 Two GPS protocols are supported. NMEA text and UBLOX binary.
  10
  11 ## Configuration
  12
  13 Enable the GPS from the CLI as follows:
  14
  15 1. [configure a serial port to use for GPS.](Serial.md)
  16 1. set your GPS baud rate
  17 1. enable the `feature GPS`
  18 1. set the `gps_provider`
  19 1. connect your GPS to the serial port configured for GPS.
  20 1. save and reboot.
  21
  22 Note:  GPS packet loss has been observed at 115200.  Try using 57600 if you experience this.
  23
  24 For the connections step check the Board documentation for pins and port numbers.
  25
  26 ### GPS Provider
  27
  28 Set the `gps_provider` appropriately, for example `set gps_provider=UBLOX`
  29
  30 | Value    |
  31 | -------- |
  32 | NMEA     |
  33 | UBLOX    |
  34
  35 ### GPS Auto configuration
  36
  37 When using UBLOX it is a good idea to use GPS auto configuration so your FC gets the GPS messages it needs.
  38
  39 Enable GPS auto configuration as follows `set gps_auto_config=ON`.
  40
  41 If you are not using GPS auto configuration then ensure your GPS receiver sends out the correct messages at the right frequency.  See below for manual UBlox settings.
  42
  43 ### SBAS
  44
  45 When using a UBLOX GPS the SBAS mode can be configured using `gps_sbas_mode`.
  46
  47 The default is AUTO.
  48
  49 | Value    | Region        |
  50 | -------- | ------------- |
  51 | AUTO     | Global        |
  52 | EGNOS    | Europe        |
  53 | WAAS     | North America |
  54 | MSAS     | Asia          |
  55 | GAGAN    | India         |
  56
  57 If you use a regional specific setting you may achieve a faster GPS lock than using AUTO.
  58
  59 This setting only works when `gps_auto_config=ON`
  60
  61 ## GPS Receiver Configuration
  62
  63 UBlox GPS units can either be configured using the FC or manually.
  64
  65 ### UBlox GPS manual configuration
  66
  67 Use UBox U-Center and connect your GPS to your computer.  The CLI `gpspassthrough` command may be of use if you do not have a spare USART to USB adapter.
  68
  69 Note that many boards will not provide +5V from USB to the GPS module, such as the SPRacingF3; if you are using `gpspassthrough` you may need to connect a BEC to the controller if your board permits it, or use a standalone UART adapter. Check your board documentation to see if your GPS port is powered from USB.
  70
  71 Display the Packet Console (so you can see what messages your receiver is sending to your computer).
  72
  73 Display the Configation View.
  74
  75 Navigate to CFG (Configuration)
  76
  77 Select `Revert to default configuration`.
  78 Click `Send`.
  79
  80 At this point you might need to disconnect and reconnect at the default baudrate - probably 9600 baud.
  81
  82 Navigate to PRT (Ports)
  83
  84 Set `Target` to `1 - Uart 1`
  85 Set `Protocol In` to `0+1+2`
  86 Set `Protocol Out` to `0+1`
  87 Set `Buadrate` to `57600` `115200`
  88 Press `Send`
  89
  90 This will immediatly "break" communication to the GPS. Since you haven't saved the new baudrate setting to the non-volatile memory you need to change the baudrate you communicate to the GPS without resetting the GPS. So `Disconnect`, Change baud rate to match, then `Connect`.
  91
  92 Click on `PRT` in the Configuration view again and inspect the packet console to make sure messages are being sent and acknowledged.
  93
  94 Next, to ensure the FC doesn't waste time processing unneeded messages, click on `MSG` and enable the following on UART1 alone with a rate of 1. When changing message target and rates remember to click `Send` after changing each message.:
  95
  96     NAV-POSLLH
  97     NAV-DOP
  98     NAV-SOL
  99     NAV-VELNED
 100     NAV-TIMEUTC
 101
 102 Enable the following on UART1 with a rate of 5, to reduce bandwidth and load on the FC.
 103
 104     NAV-SVINFO
 105
 106 All other message types should be disabled.
 107
 108 Next change the global update rate, click `Rate (Rates)` in the Configuration view.
 109
 110 Set `Measurement period` to `100` ms.
 111 Set `Navigation rate` to `1`.
 112 Click `Send`.
 113
 114 This will cause the GPS receive to send the require messages out 10 times a second.  If your GPS receiver cannot be set to use `100`ms try `200`ms (5hz) - this is less precise.
 115
 116 Next change the mode, click `NAV5 (Navigation 5)` in the Configuration View.
 117
 118 Set to `Dynamic Model` to `Pedestrian` and click `Send`.
 119
 120 Next change the SBAS settings.  Click `SBAS (SBAS Settings)` in the Configuration View.
 121
 122 Set `Subsystem` to `Enabled`.
 123 Set `PRN Codes` to `Auto-Scan`.
 124 Click `Send`.
 125
 126 Finally, we need to save the configuration.
 127
 128 Click `CFG (Configuration` in the Configuration View.
 129
 130 Select `Save current configuration` and click `Send`.
 131
 132 ### UBlox Navigation model
 133
 134 Cleanflight will use `Pedestrian` when gps auto config is used.
 135
 136 From the UBlox documentation:
 137
 138 * Pedestrian - Applications with low acceleration and speed, e.g. how a pedestrian would move. Low acceleration assumed. MAX Altitude [m]: 9000, MAX Velocity [m/s]: 30, MAX Vertical, Velocity [m/s]: 20, Sanity check type: Altitude and Velocity, Max Position Deviation: Small.
 139 * Portable - Applications with low acceleration, e.g. portable devices. Suitable for most situations. MAX Altitude [m]: 12000, MAX Velocity [m/s]: 310, MAX Vertical Velocity [m/s]: 50, Sanity check type: Altitude and Velocity, Max Position Deviation: Medium.
 140 * Airborne < 1G - Used for applications with a higher dynamic range and vertical acceleration than a passenger car. No 2D position fixes supported. MAX Altitude [m]: 50000, MAX Velocity [m/s]: 100, MAX Vertical Velocity [m/s]: 100, Sanity check type: Altitude, Max Position Deviation: Large
 141
 142 ## Hardware
 143
 144 There are many GPS receivers available on the market.
 145 Below are some examples of user-tested hardware.
 146
 147 ### Ublox
 148
 149 ###U-Blox
 150
 151 #### NEO-M8
 152 Module | Comments
 153 -------|--------
 154 U-blox Neo-M8N w/Compass | Pinout can be found in Pixfalcon manual. SDA and SCL can be attached to I2C bus for compass, TX and RX can be attached to UART for GPS. Power must be applied for either to function.
 155 Reyax RY825AI | NEO-M8N, 18Hz UART USB interface GPS Glonass BeiDou QZSS antenna module flash. [eBay](http://www.ebay.com/itm/RY825AI-18Hz-UART-USB-interface-GPS-Glonass-BeiDou-QZSS-antenna-module-flash/181566850426)
 156 mRo uGPS w/ LIS3MDL | Ultra compact and weights just 7.7 grams. Multiple constellation capabilities (GPS and GLONASS).  Includes JST-GH pigtail. Available from [mRobotics](https://store.mrobotics.io/product-p/mro-ugps-samm8q-01.htm).
 157
 158 #### NEO-7
 159 Module | Comments
 160 -------|--------
 161 U-blox Neo-7M w/Compass | [HobbyKing](http://www.hobbyking.com/hobbyking/store/__55558__Ublox_Neo_7M_GPS_with_Compass_and_Pedestal_Mount.html) You have to set align_mag in the CLI to get the magnetometer working correctly: `set align_mag = 8` and don't forget to `save`.
 162
 163 #### NEO-6
 164 Module | Comments
 165 -------|--------
 166 Ublox NEO-6M GPS with Compass | [eBay](http://www.ebay.com/itm/111585855757)
 167
 168
 169 ### Serial NMEA
 170
 171 #### MediaTek
 172 Module | Comments
 173 -------|--------
 174 MTK 3329 | Tested on hardware serial at 115200 baud (default) and on softserial at 19200 baud. The baudrate and refresh rate can be adjusted using the MiniGPS software (recommended if you lower the baudrate). The software will estimate the percentage of UART bandwidth used for your chosen baudrate and update rate.
 175