Component: GPS (EB056, Generic NMEA) (Wireless): Difference between revisions
Appearance
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 101: | Line 101: | ||
===CheckBufferOverflow=== | ===CheckBufferOverflow=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CheckBufferOverflow''' | ||
|- | |- | ||
| colspan="2" | Returns the state of the buffer - 0 = OK, 1 = BufferTooShort, 2 = ItemNotFound. Only returns correct data if Log Buffer Overflow Property is set to Yes. | | colspan="2" | Returns the state of the buffer - 0 = OK, 1 = BufferTooShort, 2 = ItemNotFound. Only returns correct data if Log Buffer Overflow Property is set to Yes. | ||
| Line 115: | Line 115: | ||
===Initialise=== | ===Initialise=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Initialise''' | ||
|- | |- | ||
| colspan="2" | Initialises the UART used to communicate with the GPS module. | | colspan="2" | Initialises the UART used to communicate with the GPS module. | ||
| Line 129: | Line 129: | ||
===IsDataValid=== | ===IsDataValid=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''IsDataValid''' | ||
|- | |- | ||
| colspan="2" | Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received. | | colspan="2" | Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received. | ||
| Line 143: | Line 143: | ||
===ReadAltitude=== | ===ReadAltitude=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadAltitude''' | ||
|- | |- | ||
| colspan="2" | Returns the current altitude. Only returns correct data if Log Altitude property is set to yes. | | colspan="2" | Returns the current altitude. Only returns correct data if Log Altitude property is set to yes. | ||
| Line 157: | Line 157: | ||
===ReadCourseOverGround=== | ===ReadCourseOverGround=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadCourseOverGround''' | ||
|- | |- | ||
| colspan="2" | Returns the current course over ground. Only returns correct data if Log Course Over Ground property is set to yes. | | colspan="2" | Returns the current course over ground. Only returns correct data if Log Course Over Ground property is set to yes. | ||
| Line 171: | Line 171: | ||
===ReadDilutionOfPrecision=== | ===ReadDilutionOfPrecision=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadDilutionOfPrecision''' | ||
|- | |- | ||
| colspan="2" | Returns the current dilution of precision. Only returns correct data if Log Dilution Of Precision property is set to yes. | | colspan="2" | Returns the current dilution of precision. Only returns correct data if Log Dilution Of Precision property is set to yes. | ||
| Line 185: | Line 185: | ||
===ReadGroundSpeed=== | ===ReadGroundSpeed=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadGroundSpeed''' | ||
|- | |- | ||
| colspan="2" | Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes. | | colspan="2" | Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes. | ||
| Line 199: | Line 199: | ||
===ReadHorizontalDilutionOfPrecision=== | ===ReadHorizontalDilutionOfPrecision=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadHorizontalDilutionOfPrecision''' | ||
|- | |- | ||
| colspan="2" | Returns the current horizontal dilution of precision. Only returns correct data if Log HDOP property is set to yes. | | colspan="2" | Returns the current horizontal dilution of precision. Only returns correct data if Log HDOP property is set to yes. | ||
| Line 213: | Line 213: | ||
===ReadLatitude=== | ===ReadLatitude=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadLatitude''' | ||
|- | |- | ||
| colspan="2" | Returns the current latitude. Only returns correct data if Log Latitude property is set to yes. | | colspan="2" | Returns the current latitude. Only returns correct data if Log Latitude property is set to yes. | ||
| Line 227: | Line 227: | ||
===ReadLongitude=== | ===ReadLongitude=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadLongitude''' | ||
|- | |- | ||
| colspan="2" | Returns the current longitude. Only returns correct data if Log Longitude property is set to yes. | | colspan="2" | Returns the current longitude. Only returns correct data if Log Longitude property is set to yes. | ||
| Line 241: | Line 241: | ||
===ReadNumberOfSatellites=== | ===ReadNumberOfSatellites=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadNumberOfSatellites''' | ||
|- | |- | ||
| colspan="2" | Returns the current detected number of satellites. Only returns correct data if Log Satellite Count property is set to yes. | | colspan="2" | Returns the current detected number of satellites. Only returns correct data if Log Satellite Count property is set to yes. | ||
| Line 255: | Line 255: | ||
===ReadUTCDate=== | ===ReadUTCDate=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadUTCDate''' | ||
|- | |- | ||
| colspan="2" | Returns a segment of the current UTC Date. Only returns correct data if Log UTC Date property is set to yes. | | colspan="2" | Returns a segment of the current UTC Date. Only returns correct data if Log UTC Date property is set to yes. | ||
| Line 274: | Line 274: | ||
===ReadUTCTime=== | ===ReadUTCTime=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadUTCTime''' | ||
|- | |- | ||
| colspan="2" | Returns a segment of the current UTC Time. Only returns correct data if Log UTC Time property is set to yes. | | colspan="2" | Returns a segment of the current UTC Time. Only returns correct data if Log UTC Time property is set to yes. | ||
| Line 293: | Line 293: | ||
===ReadVerticalDilutionOfPrecision=== | ===ReadVerticalDilutionOfPrecision=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadVerticalDilutionOfPrecision''' | ||
|- | |- | ||
| colspan="2" | Returns the current vertical dilution of precision. Only returns correct data if Log VDOP property is set to yes. | | colspan="2" | Returns the current vertical dilution of precision. Only returns correct data if Log VDOP property is set to yes. | ||
| Line 308: | Line 308: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 379: | Line 379: | ||
| colspan="2" | Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision | | colspan="2" | Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 403: | Line 403: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix Ltd. |
| Version | 2.1 |
| Category | Wireless |
GPS (EB056, Generic NMEA) component
Component designed to process incoming NMEA style GPS data and convert into meaningful values such as longitude, lattitude, ground speed, UTC date and time. Also available in the form of the EB056 GPS E-block.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_GPS.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_GPS.fcfx
Detailed description
No detailed description exists yet for this component
Examples
GPS Example File
GPS Example
Example should show the Latitude generated by the GPS injector as well as the system time in simulation or UTC time on hardware.
Example data provided by the GPS NMEA injector component
GPS tracking application using an Arduino and an SD card reader.
GPS Tracker
Macro reference
CheckBufferOverflow
| CheckBufferOverflow | |
| Returns the state of the buffer - 0 = OK, 1 = BufferTooShort, 2 = ItemNotFound. Only returns correct data if Log Buffer Overflow Property is set to Yes. | |
| Return | |
Initialise
| Initialise | |
| Initialises the UART used to communicate with the GPS module. | |
| Return | |
IsDataValid
| IsDataValid | |
| Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received. | |
| Return | |
ReadAltitude
| ReadAltitude | |
| Returns the current altitude. Only returns correct data if Log Altitude property is set to yes. | |
| Return | |
ReadCourseOverGround
| ReadCourseOverGround | |
| Returns the current course over ground. Only returns correct data if Log Course Over Ground property is set to yes. | |
| Return | |
ReadDilutionOfPrecision
| ReadDilutionOfPrecision | |
| Returns the current dilution of precision. Only returns correct data if Log Dilution Of Precision property is set to yes. | |
| Return | |
ReadGroundSpeed
| ReadGroundSpeed | |
| Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes. | |
| Return | |
ReadHorizontalDilutionOfPrecision
| ReadHorizontalDilutionOfPrecision | |
| Returns the current horizontal dilution of precision. Only returns correct data if Log HDOP property is set to yes. | |
| Return | |
ReadLatitude
| ReadLatitude | |
| Returns the current latitude. Only returns correct data if Log Latitude property is set to yes. | |
| Return | |
ReadLongitude
| ReadLongitude | |
| Returns the current longitude. Only returns correct data if Log Longitude property is set to yes. | |
| Return | |
ReadNumberOfSatellites
| ReadNumberOfSatellites | |
| Returns the current detected number of satellites. Only returns correct data if Log Satellite Count property is set to yes. | |
| Return | |
ReadUTCDate
| ReadUTCDate | |
| Returns a segment of the current UTC Date. Only returns correct data if Log UTC Date property is set to yes. | |
| Unit | |
| Specifies which segment to read - 'd', 'm', 'y' | |
| Return | |
ReadUTCTime
| ReadUTCTime | |
| Returns a segment of the current UTC Time. Only returns correct data if Log UTC Time property is set to yes. | |
| Unit | |
| Specifies which segment to read - 'h', 'm', 's' | |
| Return | |
ReadVerticalDilutionOfPrecision
| ReadVerticalDilutionOfPrecision | |
| Returns the current vertical dilution of precision. Only returns correct data if Log VDOP property is set to yes. | |
| Return | |

