Skip to content

Commit 3587003

Browse files
santaimpersonatorsantaimpersonator
authored
Merge pull request #15 from sparkfun/quectel_boards
Update GNSS Headers section of all Quectel boards
2 parents 8087ea4 + 9f0e4de commit 3587003

File tree

5 files changed

+242
-65
lines changed

5 files changed

+242
-65
lines changed

‎flex_boards/SparkPNT_GNSS_Flex_Module_LG290P-Tilt/docs/assets/img/hookup_guide/qgc_protocol.png‎

239 KB
Loading

‎flex_boards/SparkPNT_GNSS_Flex_Module_LG290P-Tilt/docs/hardware_overview.md‎

Lines changed: 115 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,9 @@ One of the centerpieces of the GNSS Flex module, is the [LG290P GNSS module](./a
249249
### Power Consumption
250250
The power consumption of the LG290P GNSS module depends on the GNSS signals enabled and the positioning mode.
251251

252+
253+
<div class="grid" markdown>
254+
252255
<article style="text-align: center;" markdown>
253256

254257
| Mode | Power (mW) | Current (mA) |
@@ -259,6 +262,26 @@ The power consumption of the LG290P GNSS module depends on the GNSS signals enab
259262

260263
</article>
261264

265+
266+
<div markdown>
267+
268+
!!! info "Power Modes"
269+
270+
**Acquisition:**
271+
: Module searches for satellites and to determine visible satellites, coarse frequency, and the code phase of satellite signals
272+
273+
**Tracking:**
274+
: Once acquisition is completed, the module tracks satellites and demodulates the navigation data from specific satellites
275+
276+
**Backup Mode:**
277+
: Reduces power consumption. Only backup domain is active and keeps track of time.
278+
279+
</div>
280+
281+
</div>
282+
283+
284+
262285
### Frequency Bands
263286
The LG290P module is a multi-band, multi-constellation GNSS receiver. Below, is a chart illustrating the frequency bands utilized by all the global navigation satellite systems; along with a list of the frequency bands and GNSS systems supported by the LG290P GNSS module.
264287

@@ -647,14 +670,32 @@ Below, are the features that are available from the IM19 attitude module.
647670

648671

649672
??? info "UART Protocols"
650-
By default, these UART ports are configured to transmit and receive `NMEA 0183` and/or `RTCM 3.x` messages. These messages are generally used for transmitting PNT data; and providing or receiving RTK corrections, respectively. Quectel also implements a system of proprietary messages (`PQTM`) for users to configure the LG290P that follows a data format similar to the `NMEA` protocol. The expected structure of these proprietary messages is shown below:
673+
### UART Protocols
674+
By default, these UART ports are configured to transmit and receive `NMEA 0183`, `RTCM 3.x`, and/or `QGC` messages. These messages are generally used for transmitting PNT data; providing or receiving RTK corrections; and receiving PPP data, respectively. Quectel also implements a system of proprietary messages (`PQTM`) for users to configure the LG290P that follows a data format similar to the `NMEA` protocol. The expected structure of these proprietary messages is shown below:
651675

652676

677+
<div class="grid" markdown>
678+
679+
<div markdown>
680+
653681
<figure markdown>
654682
[![NMEA data structure](./assets/img/hookup_guide/nmea_protocol.png){ width="600" }](./assets/img/hookup_guide/nmea_protocol.png "Click to enlarge")
655-
<figcaption markdown>The data structure of Quectel messages for the `NMEA` protocol.</figcaption>
683+
<figcaption markdown>The data structure of Quectel messages for the `NMEA` and `PQTM` protocols.</figcaption>
656684
</figure>
657685

686+
</div>
687+
688+
689+
<div markdown>
690+
691+
<figure markdown>
692+
[![QGC data structure](./assets/img/hookup_guide/qgc_protocol.png){ width="600" }](./assets/img/hookup_guide/qgc_protocol.png "Click to enlarge")
693+
<figcaption markdown>The data structure of Quectel messages for the `QGC` protocol.</figcaption>
694+
</figure>
695+
696+
</div>
697+
698+
</div>
658699

659700

660701
=== "NMEA"
@@ -672,6 +713,12 @@ Below, are the features that are available from the IM19 attitude module.
672713
| GSA | Output | GNSS DOP and Active Satellites |
673714
| VTG | Output | Course Over Ground & Ground Speed |
674715
| GLL | Output | Geographic Position – Latitude/Longitude |
716+
| GBS | Output | GNSS Satellite Fault Detection |
717+
| GNS | Output | GNSS Fix Data |
718+
| GST | Output | GNSS Pseudorange Error Statistics |
719+
| ZDA | Output | UTC Time & Date |
720+
| HDT | Output | True Vessel Heading |
721+
| THS | Output | True, Heading, and Status |
675722

676723
</article>
677724

@@ -686,50 +733,82 @@ Below, are the features that are available from the IM19 attitude module.
686733
| Message | Type Mode | Message Description |
687734
| :----------------- | :----------: | :----------------------------------------------- |
688735
| PQTMVER | Output | Outputs the firmware version |
689-
| PQTMCOLD | Input | Performs a cold start |
690-
| PQTMWARM | Input | Performs a warm start |
691-
| PQTMHOT | Input | Performs a hot start |
692-
| PQTMSRR | Input | Performs a system reset and reboots the receiver |
693-
| PQTMUNIQID | Output | Queries the module unique ID |
694-
| PQTMSAVEPAR | Input | Saves the configurations into NVM |
695-
| PQTMRESTOREPAR | Input | Restores the parameters configured by all commands to their default values |
696-
| PQTMVERNO | Output | Queries the firmware version |
697-
| PQTMCFGUART | Input/Output | Sets/gets the UART interface |
698-
| PQTMCFGPPS | Input/Output | Sets/gets the PPS feature |
699-
| PQTMCFGPROT | Input/Output | Sets/gets the input and output protocol for a specified port |
700-
| PQTMCFGNMEADP | Input/Output | Sets/gets the decimal places of standard NMEA messages |
736+
| PQTMCOLD | Command | Performs a cold start |
737+
| PQTMWARM | Command | Performs a warm start |
738+
| PQTMHOT | Command | Performs a hot start |
739+
| PQTMSRR | Command | Performs a system reset and reboots the receiver |
740+
| PQTMUNIQID | Command | Queries the module unique ID |
741+
| PQTMSAVEPAR | Command | Saves the configurations into NVM |
742+
| PQTMRESTOREPAR | Command | Restores the parameters configured by all commands to their default values |
743+
| PQTMVERNO | Command | Queries the firmware version |
744+
| PQTMCFGUART | Set/Get | Sets/gets the UART interface |
745+
| PQTMCFGPPS | Set/Get | Sets/gets the PPS feature |
746+
| PQTMCFGPROT | Set/Get | Sets/gets the input and output protocol for a specified port |
747+
| PQTMCFGNMEADP | Set/Get | Sets/gets the decimal places of standard NMEA messages |
701748
| PQTMEPE | Output | Outputs the estimated position error |
702-
| PQTMCFGMSGRATE | Input/Output | Sets/gets the message output rate on the current interface |
749+
| PQTMCFGMSGRATE | Set/Get | Sets/gets the message output rate on the current interface |
703750
| PQTMVEL | Output | Outputs the velocity information |
704-
| PQTMCFGGEOFENCE | Input/Output | Sets/gets geofence feature |
751+
| PQTMCFGGEOFENCE | Set/Get | Sets/gets geofence feature |
705752
| PQTMGEOFENCESTATUS | Output | Outputs the geofence status |
706-
| PQTMGNSSSTART | Input | Starts GNSS engine |
707-
| PQTMGNSSSTOP | Input | Stops GNSS engine |
753+
| PQTMGNSSSTART | Command | Starts GNSS engine |
754+
| PQTMGNSSSTOP | Command | Stops GNSS engine |
708755
| PQTMTXT | Output | Outputs short text messages |
709-
| PQTMCFGSVIN | Input/Output | Sets/gets the Survey-in feature |
756+
| PQTMCFGSVIN | Set/Get | Sets/gets the Survey-in feature |
710757
| PQTMSVINSTATUS | Output | Outputs the Survey-in status |
711758
| PQTMPVT | Output | Outputs the PVT (GNSS only) result |
712-
| PQTMCFGRCVRMODE | Input/Output | Sets/gets the receiver working mode |
713-
| PQTMDEBUGON | Input | Enables debug log output |
714-
| PQTMDEBUGOFF | Input | Disables debug log output |
715-
| PQTMCFGFIXRATE | Input/Output | Sets/gets the fix interval |
716-
| PQTMCFGRTK | Input/Output | Sets/gets the RTK mode |
717-
| PQTMCFGCNST | Input/Output | Sets/gets the constellation configuration |
759+
| PQTMCFGRCVRMODE | Set/Get | Sets/gets the receiver working mode |
760+
| PQTMDEBUGON | Command | Enables debug log output |
761+
| PQTMDEBUGOFF | Command | Disables debug log output |
762+
| PQTMCFGFIXRATE | Set/Get | Sets/gets the fix interval |
763+
| PQTMCFGRTK | Set/Get | Sets/gets the RTK mode |
764+
| PQTMCFGCNST | Set/Get | Sets/gets the constellation configuration |
718765
| PQTMDOP | Output | Outputs dilution of precision |
719766
| PQTMPL | Output | Outputs protection level information |
720-
| PQTMCFGODO | Input/Output | Sets/gets the odometer feature |
721-
| PQTMRESETODO | Input | Resets the accumulated distance recorded by the odometer |
767+
| PQTMCFGODO | Set/Get | Sets/gets the odometer feature |
768+
| PQTMRESETODO | Command | Resets the accumulated distance recorded by the odometer |
722769
| PQTMODO | Output | Outputs the odometer information |
723-
| PQTMCFGSIGNAL | Input/Output | Sets/gets GNSS signal mask |
724-
| PQTMCFGSAT | Input/Output | Sets/gets GNSS satellite mask |
725-
| PQTMCFGRSID | Input/Output | Sets/gets the reference station ID |
726-
| PQTMCFGRTCM | Input/Output | Sets/gets RTCM |
770+
| PQTMCFGSIGNAL | Set/Get | Sets/gets GNSS signal mask |
771+
| PQTMCFGSAT | Set/Get | Sets/gets GNSS satellite mask |
772+
| PQTMCFGRSID | Set/Get | Sets/gets the reference station ID |
773+
| PQTMCFGRTCM | Set/Get | Sets/gets RTCM |
774+
| PQTMCFGSBAS | Set/Get | Configures SBAS |
775+
| PQTMCFGNMEATID | Set/Get | Configures the NMEA Talker ID |
776+
| PQTMTAR | Output | Outputs the time and attitude |
777+
| PQTMCFGBLD | Set/Get | Configures the baseline distance |
778+
| PQTMCFGRTKSRCTYPE | Set/Get | Configures RTK differential source type |
779+
| PQTMSN | Command | Reads the SN of module |
780+
| PQTMCFGANTINF | Set/Get | Configures the antenna information |
781+
| PQTMCFGANTDELTA | Set/Get | Configures the delta between antennas |
782+
| PQTMCFGSIGGRP | Set/Get | Configures the GNSS signal group |
783+
| PQTMCFGSIGNAL2 | Set/Get | Configures GNSS signal mask for second antenna |
784+
| PQTMCFGGEOSEP | Set/Get | Configures geoidal separation |
785+
| PQTMCFGCNRTHD | Set/Get | Configures the CNR threshold for position engine |
786+
| PQTMCFGELETHD | Set/Get | Configures the elevation threshold for position engine |
787+
| PQTMNAV | Output | Outputs the navigation information |
788+
| PQTMEOE | Output | Outputs the end of epoch information |
789+
| PQTMCFGWN | Set/Get | Configures the reference start week number |
790+
| PQTMANTENNASTATUS | Output | Reports the antenna status |
791+
792+
</article>
793+
794+
795+
=== "QGC"
796+
A full list of QGC messages (proprietary protocol defined by Quectel) supported by LG290P, is provided in section **3. QGC Protocol** of the [GNSS Protocol Specification](./assets/component_documentation/quectel_lg290p03lgx80p03_gnss_protocol_specification_v1-1.pdf) manual. This protocol is used to output the PPP raw data.
797+
798+
??? abstract "List of Proprietary Quectel Messages"
799+
<article style="text-align: center;" markdown>
800+
801+
| GQC Message Name | Message Group | Message Number | Type | Description |
802+
| :--------- | :--: | :--: | :----: | :--------------------------------- |
803+
| RAW-PPPB2B | 0x0A | 0xB2 | Output | BDS PPPB2B binary raw messages |
804+
| RAW-QZSSL6 | 0x0A | 0xB6 | Output | QZSSL6 binary raw messages |
805+
| RAW-HASE6 | 0x0A | 0xE6 | Output | Galileo HASE6 binary raw messages |
727806

728807
</article>
729808

730809

731810
=== "RTCM"
732-
A full list of compatible `RTCM v3` messages, is provided in section **3. RTCM Protocol** of the [GNSS Protocol Specification](./assets/component_documentation/quectel_lg290p03lgx80p03_gnss_protocol_specification_v1-1.pdf) manual. This protocol is used for transferring GNSS raw measurement data, as detailed by the [Radio Technical Commission for Maritime Services](https://www.rtcm.org/) organization.
811+
A full list of compatible `RTCM v3` messages, is provided in section **4. RTCM Protocol** of the [GNSS Protocol Specification](./assets/component_documentation/quectel_lg290p03lgx80p03_gnss_protocol_specification_v1-1.pdf) manual. This protocol is used for transferring GNSS raw measurement data, as detailed by the [Radio Technical Commission for Maritime Services](https://www.rtcm.org/) organization.
733812

734813

735814
??? abstract "List of Supported RTCMv3 *(MSM)* Messages"
@@ -890,6 +969,10 @@ Below, are the features that are available from the IM19 attitude module.
890969
</figure>
891970

892971

972+
!!! tip "Use Case"
973+
Users could use this pin in conjunction with the PPS signal to synchronize two modules with each other.
974+
975+
893976
=== "Reset"
894977
This pin can be used to reset both the LG290P GNSS module and IM19 attitude module. Driving the pin `LOW` for at least 100ms triggers a restart of both modules.
895978

‎flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/hookup_guide/qgc_protocol.png‎

239 KB
Loading

0 commit comments

Comments
 (0)