Difference between revisions of "Component: Injector (GPS NMEA) ()"

From Flowcode Help
Jump to navigationJump to search
 
(6 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_InjectorGPS.fcfx FC_Comp_Source_InjectorGPS.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorGPS.fcfx FC_Comp_Source_InjectorGPS.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorGPS.fcfx FC_Comp_Source_InjectorGPS.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 42: Line 50:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
  
  
Line 73: Line 87:
 
[[File:GPSCon.jpg]]
 
[[File:GPSCon.jpg]]
  
−
==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;" | '''InitialiseInjector'''
 
−
|-
 
−
| colspan="2" | Sets up the injector ready to receive commands or send data 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | InjectorName
 
−
|-
 
−
| colspan="2" | Name of the console that will be created 
 
−
|-
 
−
| 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;" | '''RxByteCount'''
 
−
|-
 
−
| colspan="2" | Returns the number of bytes currently sat in the receive buffer. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| 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;" | '''RxByte'''
 
−
|-
 
−
| colspan="2" | Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
 +
 +
 +
 +
==Macro reference==
 +
 +
===GetConsoleHandle===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 132: Line 113:
  
  
−
 
+
===InitialiseInjector===
−
 
 
−
==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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | GPS Injector Settings
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Data Period (ms)
 
−
|-
 
−
| colspan="2" | Amount of time in milliseconds to wait between each GPS NMEA packet is sent. Default 1000. 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Circular Buffer Size
 
−
|-
 
−
| colspan="2" | Max number of bytes the receive queue can hold. Default 1000. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | GPS Location Settings
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Data Valid
 
−
|-
 
−
| colspan="2" | Injected GPS data validity 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Altitude
 
−
|-
 
−
| colspan="2" | Injected GPS Altitude 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Course Over Ground
 
−
|-
 
−
| colspan="2" | Injected GPS course over ground (COG) 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Dilution Of Precision
 
−
|-
 
−
| colspan="2" | Injected GPS dilution of precision (DOP) 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Ground Speed
 
−
|-
 
−
| colspan="2" | Injected GPS ground speed (Knotts) 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | HDOP
 
−
|-
 
−
| colspan="2" | Injected GPS horizontal dilution of precision (HDOP) 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Latitude
 
−
|-
 
−
| colspan="2" | Injected GPS lattitude 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Longitude
 
−
|-
 
−
| colspan="2" | Injected GPS longitude 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Number Of Satellites
 
−
|-
 
−
| colspan="2" | Injected GPS number of active satellites 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | VDOP
 
−
|-
 
−
| colspan="2" | Injected GPS vertical dilution of precision (VDOP) 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Time & Date Settings
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Data Source
 
−
|-
 
−
| colspan="2" | Injected GPS source for UTC time and date 
 
−
|}==Macro reference==
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 238: Line 132:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===RxByte===
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxByteCount'''
 
−
|-
 
−
| colspan="2" | Returns the number of bytes currently sat in the receive buffer. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 264: Line 146:
  
  
 +
===RxByteCount===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxByteCount'''
 
|-
 
|-
−
| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. 
+
| colspan="2" | Returns the number of bytes currently sat in the receive buffer. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 13:11, 7 February 2023

Author Matrix Ltd
Version 1.0
Category


Injector (GPS NMEA) component

Comms data injector to allow simulation of NMEA style GPS messages

Component Source Code

Please click here to download the component source project: FC_Comp_Source_InjectorGPS.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_InjectorGPS.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






Macro reference

GetConsoleHandle

Fc9-comp-macro.png GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc. 
Fc9-h32-icon.png - HANDLE Return


InitialiseInjector

Fc9-comp-macro.png InitialiseInjector
Sets up the injector ready to receive commands or send data 
Fc9-string-icon.png - STRING InjectorName
Name of the console that will be created 
Fc9-u8-icon.png - BYTE Return


RxByte

Fc9-comp-macro.png RxByte
Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available 
Fc9-u16-icon.png - UINT Return


RxByteCount

Fc9-comp-macro.png RxByteCount
Returns the number of bytes currently sat in the receive buffer. 
Fc9-u16-icon.png - UINT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png GPS Injector Settings
Fc9-type-21-icon.png Data Period (ms)
Amount of time in milliseconds to wait between each GPS NMEA packet is sent. Default 1000. 
Fc9-type-21-icon.png Circular Buffer Size
Max number of bytes the receive queue can hold. Default 1000. 
Fc9-conn-icon.png GPS Location Settings
Fc9-type-7-icon.png Data Valid
Injected GPS data validity 
Fc9-type-15-icon.png Altitude
Injected GPS Altitude 
Fc9-type-15-icon.png Course Over Ground
Injected GPS course over ground (COG) 
Fc9-type-15-icon.png Dilution Of Precision
Injected GPS dilution of precision (DOP) 
Fc9-type-15-icon.png Ground Speed
Injected GPS ground speed (Knotts) 
Fc9-type-15-icon.png HDOP
Injected GPS horizontal dilution of precision (HDOP) 
Fc9-type-15-icon.png Latitude
Injected GPS lattitude 
Fc9-type-15-icon.png Longitude
Injected GPS longitude 
Fc9-type-21-icon.png Number Of Satellites
Injected GPS number of active satellites 
Fc9-type-15-icon.png VDOP
Injected GPS vertical dilution of precision (VDOP) 
Fc9-conn-icon.png Time & Date Settings
Fc9-type-16-icon.png Data Source
Injected GPS source for UTC time and date 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Injector_(GPS_NMEA)_()&oldid=38092"