Component: GPS (EB056, Generic NMEA) (Wireless)
| Author | Matrix Ltd. |
| Version | 2.0 (Release) |
| Category | Wireless |
Contents
- 1 GPS (EB056, Generic NMEA) component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 ReadGroundSpeed
- 3.2 ReadNumberOfSatellites
- 3.3 ReadDilutionOfPrecision
- 3.4 CheckBufferOverflow
- 3.5 ReadLongitude
- 3.6 ReadUTCTime
- 3.7 IsDataValid
- 3.8 ReadHorizontalDilutionOfPrecision
- 3.9 ReadAltitude
- 3.10 ReadCourseOverGround
- 3.11 ReadUTCDate
- 3.12 ReadVerticalDilutionOfPrecision
- 3.13 ReadLatitude
- 3.14 Initialise
- 4 Simulation macro reference
- 5 Property reference
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.
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
Downloadable macro reference
ReadGroundSpeed
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
ReadNumberOfSatellites
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
ReadDilutionOfPrecision
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
Return value
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.
Parameters
- This macro has no parameters
Return value
ReadLongitude
Returns the current longitude.
Only returns correct data if Log Longitude property is set to yes.
Parameters
- This macro has no parameters
Return value
ReadUTCTime
Returns a segment of the current UTC Time.
Only returns correct data if Log UTC Time property is set to yes.
Parameters
- BYTE Unit
- Specifies which segment to read - 'h', 'm', 's'
Return value
IsDataValid
Returns the state of the incoming data - 0 = NotValid, 1 = Valid
255 = No GPS Data Received.
Parameters
- This macro has no parameters
Return value
ReadHorizontalDilutionOfPrecision
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
ReadAltitude
Returns the current altitude.
Only returns correct data if Log Altitude property is set to yes.
Parameters
- This macro has no parameters
Return value
ReadCourseOverGround
Returns the current course over ground.
Only returns correct data if Log Course Over Ground property is set to yes.
Parameters
- This macro has no parameters
Return value
ReadUTCDate
Returns a segment of the current UTC Date.
Only returns correct data if Log UTC Date property is set to yes.
Parameters
- BYTE Unit
- Specifies which segment to read - 'd', 'm', 'y'
Return value
ReadVerticalDilutionOfPrecision
Returns the current vertical dilution of precision.
Only returns correct data if Log VDOP property is set to yes.
Parameters
- This macro has no parameters
Return value
ReadLatitude
Returns the current latitude.
Only returns correct data if Log Latitude property is set to yes.
Parameters
- This macro has no parameters
Return value
Initialise
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
Simulation macro reference
This component does not contain any simulation macros
Property reference
Buffer Size
This property is of type Unsigned integer and can be referenced with the variable name buff_size.
The maximum number of bytes of a NMEA message we can store before processing the message.
Log Altitude
This property is of type True or false and can be referenced with the variable name ALT_EN.
Adds a variable to store the incoming altitude value
Referenced by macro: ReadAltitude
Log Buffer Overflow
This property is of type True or false and can be referenced with the variable name OVERFLOW_EN.
Adds a variable to store if the incoming message buffer overflows
Referenced by macro: CheckBufferOverflow
Log Course Over Ground
This property is of type True or false and can be referenced with the variable name COG_EN.
Adds a variable to store the incoming course over ground value
Referenced by macro: ReadCourseOverGround
Log Dilution Of Precision
This property is of type True or false and can be referenced with the variable name DOP_EN.
Adds a variable to store the incoming DOP value
Referenced by macro: ReadDilutionOfPrecision
Log Ground Speed
This property is of type True or false and can be referenced with the variable name SPD_EN.
Adds a variable to store the incoming ground speed value
Referenced by macro: ReadGroundSpeed
Log Horizontal DOP
This property is of type True or false and can be referenced with the variable name HDOP_EN.
Adds a variable to store the incoming HDOP value
Referenced by macro: ReadHorizontalDilutionOfPrecision
Log Latitude
This property is of type True or false and can be referenced with the variable name LAT_EN.
Adds a variable to store the incoming latitude value
Referenced by macro: ReadLatitude
Log Longitude
This property is of type True or false and can be referenced with the variable name LON_EN.
Adds a variable to store the incoming longitude value
Referenced by macro: Read Longitude
Log Satellite Count
This property is of type True or false and can be referenced with the variable name CNT_EN.
Adds a variable to store the number of satellites in range
Referenced by macro: ReadNumberOfSatellites
Log UTC Time
This property is of type True or false and can be referenced with the variable name TIME_EN.
Adds a variable to store the incoming UTC Time value
Referenced by macro: ReadUTCTime
Log UTC Date
This property is of type True or false and can be referenced with the variable name DATE_EN.
Adds a variable to store the incoming UTC Date value
Referenced by macro: ReadUTCDate
Log Verticle DOP
This property is of type True or false and can be referenced with the variable name VDOP_EN.
Adds a variable to store the incoming VDOP value
Referenced by macro: ReadVerticalDilutionOfPrecision
Channel
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::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
This property is of type Single digital pin and can be referenced with the variable name cal_uart::RX.
Pin to be used for Receive data
Baud Options
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::BAUD_LIST.
Baud rate option selector
Baud Rate
This property is of type Signed integer and can be referenced with the variable name cal_uart::BAUD.
No additional information
Label
This property is of type Line of text and can be referenced with the variable name label.
Label used to help identify the component on the panel.
Show Globe
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.
Scope Traces
This property is of type True or false and can be referenced with the variable name cal_uart::ScopeTraces.
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
This property is of type True or false and can be referenced with the variable name cal_uart::ConsoleData.
Selects if the console data is automatically generated or not
Console Columns
This property is of type Unsigned integer and can be referenced with the variable name cal_uart::ConsoleColumns.
Number of characters that can be displayed on a single line of the console.
Data Source
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::DataSource.
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.
