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

Revision as of 09:57, 27 January 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 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

	ReadGroundSpeed
Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes.
- FLOAT	Return

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

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

	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.
- BYTE	Return

	ReadLongitude
Returns the current longitude. Only returns correct data if Log Longitude property is set to yes.
- FLOAT	Return

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

	IsDataValid
Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received.
- BYTE	Return

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

	ReadAltitude
Returns the current altitude. Only returns correct data if Log Altitude property is set to yes.
- FLOAT	Return

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

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

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

	ReadLatitude
Returns the current latitude. Only returns correct data if Log Latitude property is set to yes.
- FLOAT	Return

	Initialise
Initialises the UART used to communicate with the GPS module.
- VOID	Return

Property reference

	Properties
	Buffer Size
The maximum number of bytes of a NMEA message we can store before processing the message.
	Log Altitude
Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude
	Log Buffer Overflow
Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow
	Log Course Over Ground
Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround
	Log Dilution Of Precision
Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision
	Log Ground Speed
Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed
	Log Horizontal DOP
Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision
	Log Latitude
Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude
	Log Longitude
Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude
	Log Satellite Count
Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites
	Log UTC Time
Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime
	Log UTC Date
Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate
	Log Verticle DOP
Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision
	Connections
	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.
	RX
Pin to be used for Receive data
	Baud Options
Baud rate option selector
	Baud Rate

	Simulation
	Label
Label used to help identify the component on the panel.
	Show Globe
Allows a graphical globe to be shown on the panel along with a coordinate marker.
	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.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	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.

==Macro reference==

	ReadGroundSpeed
Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes.
- FLOAT	Return

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

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

	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.
- BYTE	Return

	ReadLongitude
Returns the current longitude. Only returns correct data if Log Longitude property is set to yes.
- FLOAT	Return

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

	IsDataValid
Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received.
- BYTE	Return

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

	ReadAltitude
Returns the current altitude. Only returns correct data if Log Altitude property is set to yes.
- FLOAT	Return

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

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

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

	ReadLatitude
Returns the current latitude. Only returns correct data if Log Latitude property is set to yes.
- FLOAT	Return

	Initialise
Initialises the UART used to communicate with the GPS module.
- VOID	Return

Property reference

	Properties
	Buffer Size
The maximum number of bytes of a NMEA message we can store before processing the message.
	Log Altitude
Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude
	Log Buffer Overflow
Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow
	Log Course Over Ground
Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround
	Log Dilution Of Precision
Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision
	Log Ground Speed
Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed
	Log Horizontal DOP
Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision
	Log Latitude
Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude
	Log Longitude
Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude
	Log Satellite Count
Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites
	Log UTC Time
Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime
	Log UTC Date
Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate
	Log Verticle DOP
Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision
	Connections
	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.
	RX
Pin to be used for Receive data
	Baud Options
Baud rate option selector
	Baud Rate

	Simulation
	Label
Label used to help identify the component on the panel.
	Show Globe
Allows a graphical globe to be shown on the panel along with a coordinate marker.
	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.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	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.

==Macro reference==

	ReadGroundSpeed
Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes.
- FLOAT	Return

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

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

	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.
- BYTE	Return

	ReadLongitude
Returns the current longitude. Only returns correct data if Log Longitude property is set to yes.
- FLOAT	Return

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

	IsDataValid
Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received.
- BYTE	Return

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

	ReadAltitude
Returns the current altitude. Only returns correct data if Log Altitude property is set to yes.
- FLOAT	Return

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

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

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

	ReadLatitude
Returns the current latitude. Only returns correct data if Log Latitude property is set to yes.
- FLOAT	Return

	Initialise
Initialises the UART used to communicate with the GPS module.
- VOID	Return

Property reference

	Properties
	Buffer Size
The maximum number of bytes of a NMEA message we can store before processing the message.
	Log Altitude
Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude
	Log Buffer Overflow
Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow
	Log Course Over Ground
Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround
	Log Dilution Of Precision
Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision
	Log Ground Speed
Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed
	Log Horizontal DOP
Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision
	Log Latitude
Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude
	Log Longitude
Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude
	Log Satellite Count
Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites
	Log UTC Time
Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime
	Log UTC Date
Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate
	Log Verticle DOP
Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision
	Connections
	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.
	RX
Pin to be used for Receive data
	Baud Options
Baud rate option selector
	Baud Rate

	Simulation
	Label
Label used to help identify the component on the panel.
	Show Globe
Allows a graphical globe to be shown on the panel along with a coordinate marker.
	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.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	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.

==Macro reference==

	ReadGroundSpeed
Returns the current ground speed. Only returns correct data if Log Ground Speed property is set to yes.
- FLOAT	Return

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

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

	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.
- BYTE	Return

	ReadLongitude
Returns the current longitude. Only returns correct data if Log Longitude property is set to yes.
- FLOAT	Return

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

	IsDataValid
Returns the state of the incoming data - 0 = NotValid, 1 = Valid 255 = No GPS Data Received.
- BYTE	Return

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

	ReadAltitude
Returns the current altitude. Only returns correct data if Log Altitude property is set to yes.
- FLOAT	Return

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

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

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

	ReadLatitude
Returns the current latitude. Only returns correct data if Log Latitude property is set to yes.
- FLOAT	Return

	Initialise
Initialises the UART used to communicate with the GPS module.
- VOID	Return

Property reference

	Properties
	Buffer Size
The maximum number of bytes of a NMEA message we can store before processing the message.
	Log Altitude
Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude
	Log Buffer Overflow
Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow
	Log Course Over Ground
Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround
	Log Dilution Of Precision
Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision
	Log Ground Speed
Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed
	Log Horizontal DOP
Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision
	Log Latitude
Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude
	Log Longitude
Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude
	Log Satellite Count
Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites
	Log UTC Time
Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime
	Log UTC Date
Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate
	Log Verticle DOP
Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision
	Connections
	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.
	RX
Pin to be used for Receive data
	Baud Options
Baud rate option selector
	Baud Rate

	Simulation
	Label
Label used to help identify the component on the panel.
	Show Globe
Allows a graphical globe to be shown on the panel along with a coordinate marker.
	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.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	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.

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

Revision as of 09:57, 27 January 2023

Contents

GPS (EB056, Generic NMEA) component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_GPS.fcfx FC_Comp_Source_GPS.fcfx]
+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]
 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==
@@ Line 44: / Line 46: @@
 ==Examples==
@@ Line 81: / Line 85: @@
 ==Macro reference==
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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;" | '''ReadUTCTime'''
+|-
+| colspan="2" | Returns a segment of the current UTC Time. Only returns correct data if Log UTC Time 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 - 'h', 'm', 's'&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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+{| 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;" | '''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''
+|}
+{| 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''
+|}
+{| 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''
+|}
+==Property reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+| width="90%" | Buffer Size
+|-
+| colspan="2" | The maximum number of bytes of a NMEA message we can store before processing the message.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Altitude
+|-
+| colspan="2" | Adds a variable to store the incoming altitude value Referenced by macro: ReadAltitude&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Buffer Overflow
+|-
+| colspan="2" | Adds a variable to store if the incoming message buffer overflows Referenced by macro: CheckBufferOverflow&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Course Over Ground
+|-
+| colspan="2" | Adds a variable to store the incoming course over ground value Referenced by macro: ReadCourseOverGround&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Dilution Of Precision
+|-
+| colspan="2" | Adds a variable to store the incoming DOP value Referenced by macro: ReadDilutionOfPrecision&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Ground Speed
+|-
+| colspan="2" | Adds a variable to store the incoming ground speed value Referenced by macro: ReadGroundSpeed&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Horizontal DOP
+|-
+| colspan="2" | Adds a variable to store the incoming HDOP value Referenced by macro: ReadHorizontalDilutionOfPrecision&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Latitude
+|-
+| colspan="2" | Adds a variable to store the incoming latitude value Referenced by macro: ReadLatitude&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Longitude
+|-
+| colspan="2" | Adds a variable to store the incoming longitude value Referenced by macro: Read Longitude&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Satellite Count
+|-
+| colspan="2" | Adds a variable to store the number of satellites in range Referenced by macro: ReadNumberOfSatellites&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log UTC Time
+|-
+| colspan="2" | Adds a variable to store the incoming UTC Time value Referenced by macro: ReadUTCTime&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log UTC Date
+|-
+| colspan="2" | Adds a variable to store the incoming UTC Date value Referenced by macro: ReadUTCDate&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Log Verticle DOP
+|-
+| colspan="2" | Adds a variable to store the incoming VDOP value Referenced by macro: ReadVerticalDilutionOfPrecision&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Channel
+|-
+| 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;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | RX
+|-
+| colspan="2" | Pin to be used for Receive data&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Baud Options
+|-
+| colspan="2" | Baud rate option selector&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Baud Rate
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
+| width="90%" | Label
+|-
+| colspan="2" | Label used to help identify the component on the panel.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Show Globe
+|-
+| colspan="2" | Allows a graphical globe to be shown on the panel along with a coordinate marker.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Scope Traces
+|-
+| 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;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Console Data
+|-
+| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+| width="90%" | Console Columns
+|-
+| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Data Source
+|-
+| 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;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"