Difference between revisions of "Component: GPS (EB056, Generic NMEA) (Wireless)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd.
 
| Matrix Ltd.
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.3 (Release)
+
| 2.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Wireless
 
| 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.
  
−
==[[File:Component Icon 575a3a3f_09b8_46be_8069_c4d1894d7e7e.png|Image]] GPS (EB056, Generic NMEA) component==
+
==Component Source Code==
−
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.
 
  
−
==Examples==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GPS.fcfx FC_Comp_Source_GPS.fcfx]
−
GPS Example File
 
−
{{Fcfile|GPS_test2.fcfx|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.
 
  
−
[[File:GPS.jpg]]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_GPS.fcfx FC_Comp_Source_GPS.fcfx]
  
 +
==Detailed description==
  
−
Example data provided by the GPS NMEA injector component
 
  
−
[[File:GPSCon.jpg]]
 
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>ReadGroundSpeed</tt></u></span>===
 
−
Returns the current ground speed.
 
  
−
Only returns correct data if Log Ground Speed property is set to yes.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadNumberOfSatellites</tt></u></span>===
 
−
Returns the current detected number of satellites.
 
  
−
Only returns correct data if Log Satellite Count property is set to yes.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadDilutionOfPrecision</tt></u></span>===
 
−
Returns the current dilution of precision.
 
  
−
Only returns correct data if Log Dilution Of Precision property is set to yes.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>CheckBufferOverflow</tt></u></span>===
 
−
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.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadLongitude</tt></u></span>===
 
−
Returns the current longitude.
 
  
−
Only returns correct data if Log Longitude property is set to yes.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadUTCTime</tt></u></span>===
 
−
Returns a segment of the current UTC Time.
 
  
−
Only returns correct data if Log UTC Time property is set to yes.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Unit''
 
−
::Specifies which segment to read - 'h', 'm', 's'
 
  
 +
GPS Example File
 +
{{Fcfile|GPS_test2.fcfx|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.
  
−
'''Return value'''
+
[[File:GPS.jpg]]
  
−
:[[Variable Types|BYTE]]
 
  
 +
Example data provided by the GPS NMEA injector component
  
−
===<span style="font-weight: normal;"><u><tt>IsDataValid</tt></u></span>===
+
[[File:GPSCon.jpg]]
−
Returns the state of the incoming data - 0 = NotValid, 1 = Valid
 
  
−
255 = No GPS Data Received.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
GPS tracking application using an Arduino and an SD card reader.
 +
{{Fcfile|GPSTracker.fcfx|GPS Tracker}}
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadHorizontalDilutionOfPrecision</tt></u></span>===
 
−
Returns the current horizontal dilution of precision.
 
  
−
Only returns correct data if Log HDOP property is set to yes.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
+
==Macro reference==
  
 +
===CheckBufferOverflow===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>ReadAltitude</tt></u></span>===
 
−
Returns the current altitude.
 
  
−
Only returns correct data if Log Altitude property is set to yes.
+
===Initialise===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Initialises the UART used to communicate with the GPS module.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
===IsDataValid===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsDataValid'''
 +
|-
 +
| colspan="2" | Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
===ReadAltitude===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAltitude'''
 +
|-
 +
| colspan="2" | Returns the current altitude. Only returns correct data if Log Altitude property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|FLOAT]]
 
  
 +
===ReadCourseOverGround===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadCourseOverGround'''
 +
|-
 +
| colspan="2" | Returns the current course over ground. Only returns correct data if Log Course Over Ground property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>ReadCourseOverGround</tt></u></span>===
 
−
Returns the current course over ground.
 
  
−
Only returns correct data if Log Course Over Ground property is set to yes.
+
===ReadDilutionOfPrecision===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDilutionOfPrecision'''
 +
|-
 +
| colspan="2" | Returns the current dilution of precision. Only returns correct data if Log Dilution Of Precision property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
===ReadGroundSpeed===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadGroundSpeed'''
 +
|-
 +
| colspan="2" | Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
===ReadHorizontalDilutionOfPrecision===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadHorizontalDilutionOfPrecision'''
 +
|-
 +
| colspan="2" | Returns the current horizontal dilution of precision. Only returns correct data if Log HDOP property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|FLOAT]]
 
  
 +
===ReadLatitude===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadLatitude'''
 +
|-
 +
| colspan="2" | Returns the current latitude. Only returns correct data if Log Latitude property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>ReadUTCDate</tt></u></span>===
 
−
Returns a segment of the current UTC Date.
 
  
−
Only returns correct data if Log UTC Date property is set to yes.
+
===ReadLongitude===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadLongitude'''
 +
|-
 +
| colspan="2" | Returns the current longitude. Only returns correct data if Log Longitude property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Unit''
+
===ReadNumberOfSatellites===
−
::Specifies which segment to read - 'd', 'm', 'y'
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadNumberOfSatellites'''
 +
|-
 +
| colspan="2" | Returns the current detected number of satellites. Only returns correct data if Log Satellite Count property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
===ReadUTCDate===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadUTCDate'''
 +
|-
 +
| colspan="2" | Returns a segment of the current UTC Date. Only returns correct data if Log UTC Date property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Unit
 +
|-
 +
| colspan="2" | Specifies which segment to read - 'd', 'm', 'y'&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|BYTE]]
 
  
−
 
+
===ReadUTCTime===
−
===<span style="font-weight: normal;"><u><tt>ReadVerticalDilutionOfPrecision</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Returns the current vertical dilution of precision.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
Only returns correct data if Log VDOP property is set to yes.
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadUTCTime'''
−
 
+
|-
−
'''Parameters'''
+
| colspan="2" | Returns a segment of the current UTC Time. Only returns correct data if Log UTC Time property is set to yes.&nbsp;
−
 
+
|-
−
:''This macro has no parameters''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
 
+
| width="90%" | Unit
−
'''Return value'''
+
|-
−
 
+
| colspan="2" | Specifies which segment to read - 'h', 'm', 's'&nbsp;
−
:[[Variable Types|FLOAT]]
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
−
 
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
===<span style="font-weight: normal;"><u><tt>ReadLatitude</tt></u></span>===
+
|}
−
Returns the current latitude.
 
−
 
 
−
Only returns correct data if Log Latitude property is set to yes.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:[[Variable Types|FLOAT]]
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
Initialises the UART used to communicate with the GPS module.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
−
 
+
===ReadVerticalDilutionOfPrecision===
−
==Simulation macro reference==
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''This component does not contain any simulation macros''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadVerticalDilutionOfPrecision'''
 +
|-
 +
| colspan="2" | Returns the current vertical dilution of precision. Only returns correct data if Log VDOP property is set to yes.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Buffer Size</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''buff_size''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
The maximum number of bytes of a NMEA message we can store before processing the message.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Log Altitude</u></span>
+
|-
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''ALT_EN''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Buffer Size
−
Adds a variable to store the incoming altitude value
+
|-
−
 
+
| colspan="2" | The maximum number of bytes of a NMEA message we can store before processing the message.&nbsp;
−
Referenced by macro: ReadAltitude
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Log Buffer Overflow</u></span>
+
| width="90%" | Log Altitude
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''OVERFLOW_EN''.
+
| colspan="2" | Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude&nbsp;
−
 
+
|-
−
Adds a variable to store if the incoming message buffer overflows
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Log Buffer Overflow
−
Referenced by macro: CheckBufferOverflow
+
|-
−
 
+
| colspan="2" | Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow&nbsp;
−
<span style="font-weight: normal;"><u>Log Course Over Ground</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''COG_EN''.
+
| width="90%" | Log Course Over Ground
−
 
+
|-
−
Adds a variable to store the incoming course over ground value
+
| colspan="2" | Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround&nbsp;
−
 
+
|-
−
Referenced by macro: ReadCourseOverGround
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Log Dilution Of Precision
−
<span style="font-weight: normal;"><u>Log Dilution Of Precision</u></span>
+
|-
−
 
+
| colspan="2" | Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''DOP_EN''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Adds a variable to store the incoming DOP value
+
| width="90%" | Log Ground Speed
−
 
+
|-
−
Referenced by macro: ReadDilutionOfPrecision
+
| colspan="2" | Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Log Ground Speed</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Log Horizontal DOP
−
This property is of type ''True or false'' and can be referenced with the variable name ''SPD_EN''.
+
|-
−
 
+
| colspan="2" | Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision&nbsp;
−
Adds a variable to store the incoming ground speed value
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Referenced by macro: ReadGroundSpeed
+
| width="90%" | Log Latitude
−
 
+
|-
−
<span style="font-weight: normal;"><u>Log Horizontal DOP</u></span>
+
| colspan="2" | Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude&nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''HDOP_EN''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Log Longitude
−
Adds a variable to store the incoming HDOP value
+
|-
−
 
+
| colspan="2" | Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude&nbsp;
−
Referenced by macro: ReadHorizontalDilutionOfPrecision
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Log Latitude</u></span>
+
| width="90%" | Log Satellite Count
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''LAT_EN''.
+
| colspan="2" | Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites&nbsp;
−
 
+
|-
−
Adds a variable to store the incoming latitude value
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Log UTC Time
−
Referenced by macro: ReadLatitude
+
|-
−
 
+
| colspan="2" | Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime&nbsp;
−
<span style="font-weight: normal;"><u>Log Longitude</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''LON_EN''.
+
| width="90%" | Log UTC Date
−
 
+
|-
−
Adds a variable to store the incoming longitude value
+
| colspan="2" | Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate&nbsp;
−
 
+
|-
−
Referenced by macro: Read Longitude
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Log Verticle DOP
−
<span style="font-weight: normal;"><u>Log Satellite Count</u></span>
+
|-
−
 
+
| colspan="2" | Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''CNT_EN''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Adds a variable to store the number of satellites in range
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
 
+
|-
−
Referenced by macro: ReadNumberOfSatellites
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Log UTC Time</u></span>
+
| width="90%" | Channel
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''TIME_EN''.
+
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.&nbsp;
−
 
+
|-
−
Adds a variable to store the incoming UTC Time value
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | RX
−
Referenced by macro: ReadUTCTime
+
|-
−
 
+
| colspan="2" | Pin to be used for Receive data&nbsp;
−
<span style="font-weight: normal;"><u>Log UTC Date</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''DATE_EN''.
+
| width="90%" | Baud Options
−
 
+
|-
−
Adds a variable to store the incoming UTC Date value
+
| colspan="2" | Baud rate option selector&nbsp;
−
 
+
|-
−
Referenced by macro: ReadUTCDate
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Baud Rate
−
<span style="font-weight: normal;"><u>Log Verticle DOP</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''VDOP_EN''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Adds a variable to store the incoming VDOP value
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
 
+
|-
−
Referenced by macro: ReadVerticalDilutionOfPrecision
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
| width="90%" | Label
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''CHANNEL''.
+
| colspan="2" | Label used to help identify the component on the panel.&nbsp;
−
 
+
|-
−
UART Channel Selection
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show Globe
−
<span style="font-weight: normal;"><u>Baud List</u></span>
+
|-
−
 
+
| colspan="2" | Allows a graphical globe to be shown on the panel along with a coordinate marker.&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''BAUD_LIST''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
UART Baud Setting - Check the datasheet of your GPS module to find the correct setting.
+
| width="90%" | Scope Traces
−
 
+
|-
−
<span style="font-weight: normal;"><u>TX</u></span>
+
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not.    Simulation - draws an approximation of the UART data onto the scope trace.    ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''TX''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Console Data
−
UART Transmit pin
+
|-
−
 
+
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
−
<span style="font-weight: normal;"><u>RX</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''RX''.
+
| width="90%" | Console Columns
−
 
+
|-
−
UART Receive pin
+
| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Data Source
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
+
|-
−
 
+
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices    Nothing - Simulation data is ignored    COM port - Routes the communication data to and from a physical or virtual COM port      Injector - Routes the communication data via a data injector component on the Panel.&nbsp;
−
Label used to help identify the component on the panel.
+
|}
−
 
 
−
<span style="font-weight: normal;"><u>Show Globe</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowGlobe''.
 
−
 
 
−
Allows a graphical globe to be shown on the panel along with a coordinate marker.
 
−
 
 
−
<span style="font-weight: normal;"><u>Data Source</u></span>
 
−
 
 
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DataSource''.
 
−
 
 
−
Allows real world hardware or data injectors to be attached to the simulation.
 
−
 
 
−
<span style="font-weight: normal;"><u>COM Port</u></span>
 
−
 
 
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''com_port''.
 
−
 
 
−
COM port number allowing you to specify the port of a NMEA GPS data source.
 

Latest revision as of 13:10, 7 February 2023

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 FC6 Icon.png 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.

GPS.jpg


Example data provided by the GPS NMEA injector component

GPSCon.jpg


GPS tracking application using an Arduino and an SD card reader. FC6 Icon.png GPS Tracker






Macro reference

CheckBufferOverflow

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Initialise

Fc9-comp-macro.png Initialise
Initialises the UART used to communicate with the GPS module. 
Fc9-void-icon.png - VOID Return


IsDataValid

Fc9-comp-macro.png IsDataValid
Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received. 
Fc9-u8-icon.png - BYTE Return


ReadAltitude

Fc9-comp-macro.png ReadAltitude
Returns the current altitude. Only returns correct data if Log Altitude property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadCourseOverGround

Fc9-comp-macro.png ReadCourseOverGround
Returns the current course over ground. Only returns correct data if Log Course Over Ground property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadDilutionOfPrecision

Fc9-comp-macro.png ReadDilutionOfPrecision
Returns the current dilution of precision. Only returns correct data if Log Dilution Of Precision property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadGroundSpeed

Fc9-comp-macro.png ReadGroundSpeed
Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadHorizontalDilutionOfPrecision

Fc9-comp-macro.png ReadHorizontalDilutionOfPrecision
Returns the current horizontal dilution of precision. Only returns correct data if Log HDOP property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadLatitude

Fc9-comp-macro.png ReadLatitude
Returns the current latitude. Only returns correct data if Log Latitude property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadLongitude

Fc9-comp-macro.png ReadLongitude
Returns the current longitude. Only returns correct data if Log Longitude property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


ReadNumberOfSatellites

Fc9-comp-macro.png ReadNumberOfSatellites
Returns the current detected number of satellites. Only returns correct data if Log Satellite Count property is set to yes. 
Fc9-u8-icon.png - BYTE Return


ReadUTCDate

Fc9-comp-macro.png ReadUTCDate
Returns a segment of the current UTC Date. Only returns correct data if Log UTC Date property is set to yes. 
Fc9-u8-icon.png - BYTE Unit
Specifies which segment to read - 'd', 'm', 'y' 
Fc9-u8-icon.png - BYTE Return


ReadUTCTime

Fc9-comp-macro.png ReadUTCTime
Returns a segment of the current UTC Time. Only returns correct data if Log UTC Time property is set to yes. 
Fc9-u8-icon.png - BYTE Unit
Specifies which segment to read - 'h', 'm', 's' 
Fc9-u8-icon.png - BYTE Return


ReadVerticalDilutionOfPrecision

Fc9-comp-macro.png ReadVerticalDilutionOfPrecision
Returns the current vertical dilution of precision. Only returns correct data if Log VDOP property is set to yes. 
Fc9-f32-icon.png - FLOAT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Buffer Size
The maximum number of bytes of a NMEA message we can store before processing the message. 
Fc9-type-7-icon.png Log Altitude
Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude 
Fc9-type-7-icon.png Log Buffer Overflow
Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow 
Fc9-type-7-icon.png Log Course Over Ground
Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround 
Fc9-type-7-icon.png Log Dilution Of Precision
Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision 
Fc9-type-7-icon.png Log Ground Speed
Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed 
Fc9-type-7-icon.png Log Horizontal DOP
Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision 
Fc9-type-7-icon.png Log Latitude
Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude 
Fc9-type-7-icon.png Log Longitude
Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude 
Fc9-type-7-icon.png Log Satellite Count
Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites 
Fc9-type-7-icon.png Log UTC Time
Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime 
Fc9-type-7-icon.png Log UTC Date
Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate 
Fc9-type-7-icon.png Log Verticle DOP
Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Label used to help identify the component on the panel. 
Fc9-type-7-icon.png Show Globe
Allows a graphical globe to be shown on the panel along with a coordinate marker. 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_GPS_(EB056,_Generic_NMEA)_(Wireless)&oldid=38048"