arcgis-maps-kotlin/com.arcgismaps.location/NmeaLocationDataSource

NmeaLocationDataSource

class NmeaLocationDataSource : LocationDataSource

An NMEA location data source object. This object will parse specific NMEA messages pushed into it. Valid GGA, GSA, GST, GSV, RMC, VTG messages are parsed and, depending upon the message type and contents, a LocationDataSourceLocationChangedEvent or NmeaLocationDataSourceSatellitesChangedEvent may be raised. The LocationDataSourceLocationChangedEvent will return a NmeaLocation object. The NmeaLocationDataSourceSatellitesChangedEvent will return an array of NmeaSatelliteInfo objects. This data source is based on NMEA version 4.11 (November 2018).

Constructors

fun NmeaLocationDataSource( receiverSpatialReference: SpatialReference = SpatialReference(4_326, 115_700), outputSpatialReference: SpatialReference? = null, outputDatumTransformation: DatumTransformation? = null)

Creates an NMEA data source object.

Functions

pushData

fun pushData(data: ByteArray?)

Reads the input NMEA data creating a NmeaLocation. The NMEA location data source needs to be started before calling this method. When pushing data:

start

suspend fun start(): Result<Unit>

Start the location data source asynchronously.

stop

suspend fun stop(): Result<Unit>

Stop the location data source asynchronously.

Properties

error

val error: StateFlow<Throwable?>

An error that describes a problem encountered while starting or running the LocationDataSource. This property is used to notify the user about errors that occur in LocationDataSource. Such errors are critical for LocationDataSource and will cause it stop. If LocationDataSource cannot be started, or it stopped after a successful start, this property will store information related to what caused LocationDataSource to stop.