profi-sdk-aos-model/com.sygic.profi.model.pm.cmd

Package-level declarations

Pure kotlin data classes for (Not only) Voice commands

Types

Represents the action of command requests/responses

data class PMCalculateRoute(val routeOptions: List<PMRouteOption>? = null, val destinationType: PMDestinationType, val position: PMGeoPosition? = null)

Calculate route request

PMCalculateRouteResult

data class PMCalculateRouteResult(val id: Int = 0, val label: String? = null, val duration: Int = 0, val distance: Int = 0, val eta: String? = null)

Calculate route response

PMCmdDistanceUnit

enum PMCmdDistanceUnit : Enum<PMCmdDistanceUnit>

Defines type of distance unit

PMCmdEnergyUnit

enum PMCmdEnergyUnit : Enum<PMCmdEnergyUnit>

Defines type of energy unit

PMCmdEVReport

data class PMCmdEVReport(val batteryUnit: PMCmdEnergyUnit, val level: Float = 0.0f, val capacity: Float = 0.0f)

Actual status report for electric vehicle ( battery status report )

PMCmdFuelReport

data class PMCmdFuelReport(val fuelUnit: PMCmdVolumeUnit, val level: Float = 0.0f, val capacity: Float = 0.0f, val warning: Boolean = false)

Actual fuel status report ( for gasoline, petrol, gas, diesel ... )

PMCmdItinerary

data class PMCmdItinerary(val id: String, val name: String, val description: String? = null, val allowItineraryEdit: Boolean = false, val parts: List<PMCmdItineraryPart>? = null, val report: PMCmdItineraryReport? = null)

Definition of route with all waypoints

PMCmdItineraryHitCriteria

data class PMCmdItineraryHitCriteria(val hitRadius: Int = 0, val hitRadiusUnit: PMCmdDistanceUnit, val hitSpeed: Int = 0, val hitSpeedUnit: PMCmdSpeedUnit)

PMCmdItineraryPart

data class PMCmdItineraryPart(val vehicle: List<PMCmdItineraryVehicleAttr>? = null, val options: List<PMRouteOption>? = null, val waypoints: List<PMCmdItineraryWaypoint>? = null, val report: PMCmdItineraryReport? = null)

One part of itinerary which could have own route options for computing.

PMCmdItineraryReport

data class PMCmdItineraryReport(val numSkipped: Int = 0, val numVisited: Int = 0, val numUnvisited: Int = 0, val numPredictedLateArrivals: Int = 0, val numPredictedEarlyArrivals: Int = 0, val timeRemaining: Int = 0, val timeRemainingUnit: PMCmdTimeUnit, val distanceRemaining: Int = 0, val distancePassed: Int = 0, val distanceUnit: PMCmdDistanceUnit)

Status report for whole itinerary or part of itinerary.

PMCmdItineraryTimeWindow

data class PMCmdItineraryTimeWindow(val startTime: String? = null, val endTime: String? = null)

Expected time window for waypoint ( delivery )

PMCmdItineraryVehicleAttr

data class PMCmdItineraryVehicleAttr(val id: String, val valueBool: Boolean = false, val valueString: String? = null, val valueInt: Int = 0, val valueSet: List<String>? = null)

Vehicle profile configuration overrides

PMCmdItineraryWaypoint

data class PMCmdItineraryWaypoint(val type: PMCmdItineraryWaypointType, val position: PMGeoPosition, val navigable: PMGeoPosition? = null, val id: String, val caption: String? = null, val delay: Int = 0, val delayUnit: PMCmdTimeUnit, val loadChange: Double = 0.0, val loadChangeUnit: PMCmdWeightUnit, val hitCriteria: PMCmdItineraryHitCriteria? = null, val timeWindow: PMCmdItineraryTimeWindow? = null, val report: PMCmdWaypointReport? = null)

One waypoint in itinerary part

PMCmdItineraryWaypointType

enum PMCmdItineraryWaypointType : Enum<PMCmdItineraryWaypointType>

Type of waypoint

PMCmdMapUpdateProgress

data class PMCmdMapUpdateProgress(val todo: List<PMCmdOneMapUpdateProgress>? = null)

Status report about map update progress

PMCmdMapUpdateRequest

data class PMCmdMapUpdateRequest(val what: PMCmdMapUpdateWhat)

Request for map update or download

PMCmdMapUpdateWhat

enum PMCmdMapUpdateWhat : Enum<PMCmdMapUpdateWhat>

Enumeration of possible

PMCmdNavigationReport

data class PMCmdNavigationReport(val timeStamp: String, val id: String, val vehicleReport: PMCmdVehicleReport? = null, val positionReport: PMCmdPositionReport? = null, val currentItineraryReport: PMCmdItinerary? = null, val allItineraryReports: List<PMCmdItinerary>? = null, val waypointReports: List<PMCmdItineraryWaypoint>? = null)

Actual status report of vehicle, route and itinerary

PMCmdNavigationReportRequest

data class PMCmdNavigationReportRequest(val includeVehicleReport: Boolean = false, val includeCurrentItinerary: Boolean = false, val includeAllItineraries: Boolean = false, val includeCurrentWaypoints: Boolean = false, val includeAllWaypoints: Boolean = false)

Actual status of route

PMCmdOneMapUpdateProgress

data class PMCmdOneMapUpdateProgress(val region: String? = null, val done: Int = 0, val total: Int = 0)

Progress information about update / download one map-region.

PMCmdPoiCategory

enum PMCmdPoiCategory : Enum<PMCmdPoiCategory>

Available POI categories

PMCmdPositionReport

data class PMCmdPositionReport(val vehiclePosition: PMVehiclePosition? = null, val currentStreet: PMCurrentStreet? = null)

Actual status report of vehicle position

PMCmdSpeedUnit

enum PMCmdSpeedUnit : Enum<PMCmdSpeedUnit>

Defines type of speed unit

PMCmdTimeUnit

enum PMCmdTimeUnit : Enum<PMCmdTimeUnit>

Defines type of time unit

PMCmdVehicleReport

data class PMCmdVehicleReport(val odometer: Int = 0, val odometerUnit: PMCmdDistanceUnit, val rangeRemaining: Int = 0, val rangeRemainingUnit: PMCmdDistanceUnit, val fuel: PMCmdFuelReport? = null, val ev: PMCmdEVReport? = null)

Actual status report of vehicle

PMCmdVisitType

enum PMCmdVisitType : Enum<PMCmdVisitType>

Type of visit for already visited waypoints

PMCmdVolumeUnit

enum PMCmdVolumeUnit : Enum<PMCmdVolumeUnit>

Defines type of volume unit

PMCmdWaypointChanged

data class PMCmdWaypointChanged(val itineraryId: String, val waypoint: PMCmdItineraryWaypoint? = null, val vehicleReport: PMCmdVehicleReport? = null)

Navigation will send this event when car reached waypoint.

PMCmdWaypointEstimateReport

data class PMCmdWaypointEstimateReport(val estimatedTime: String? = null, val timeRemaining: Int = 0, val timeRemainingUnit: PMCmdTimeUnit, val distanceRemaining: Int = 0, val distanceUnit: PMCmdDistanceUnit)

Status report for one unvisited waypoint

PMCmdWaypointReport

data class PMCmdWaypointReport(val visited: Boolean = false, val edited: Boolean = false, val skipped: Boolean = false, val added: Boolean = false, val visitedReport: PMCmdWaypointVisitedReport? = null, val estimateReport: PMCmdWaypointEstimateReport? = null)

Status report for one waypoint

PMCmdWaypointVisitedReport

data class PMCmdWaypointVisitedReport(val arrivalTime: String? = null, val departureTime: String? = null, val visitType: PMCmdVisitType, val position: PMGeoPosition)

Status report for one visited waypoint

PMCmdWeightUnit

enum PMCmdWeightUnit : Enum<PMCmdWeightUnit>

Defines type of weight unit

PMCommandRequest

data class PMCommandRequest(val correlationId: String? = null, val action: PMAction, val position: PMGeoPosition? = null, val positions: List<PMGeoPosition>? = null, val locationInfo: PMLocationInfo? = null, val search: PMSearch? = null, val calculateRoute: PMCalculateRoute? = null, val startGuidance: PMStartGuidance? = null, val mapMode: PMSetMapMode? = null, val guidancePrompt: PMGuidancePrompt, val mapCamera: PMMapCamera, val argStr: String? = null, val argBool: Boolean = false, val argStrs: List<String>? = null, val itinerary: PMCmdItinerary? = null, val navigationReportRequest: PMCmdNavigationReportRequest? = null, val mapUpdateRequest: PMCmdMapUpdateRequest? = null, val routeOptions: List<PMSetRouteOption>? = null)

Represents request of user speech to a command containing context for Profi Navi

PMCommandResponse

data class PMCommandResponse(val correlationId: String? = null, val action: PMAction, val responseStatus: PMResponseStatus, val naviStatus: PMCurrentNaviStatus? = null, val positions: List<PMGeoPosition>? = null, val locationInfos: List<PMLocationInfo>? = null, val searchResults: List<PMSearchResult>? = null, val calculatedRoutes: List<PMCalculateRouteResult>? = null, val poiCategories: List<PMPoiCategoryResult>? = null, val activeMapModes: List<PMMapMode>? = null, val itineraries: List<PMCmdItinerary>? = null, val navigationReport: PMCmdNavigationReport? = null, val waypointChanged: PMCmdWaypointChanged? = null, val mapUpdateProgress: PMCmdMapUpdateProgress? = null, val trafficInfo: PMTrafficInfo? = null)

Represents converted user speech to a command containing context for Profi Navi

PMCurrentNaviStatus

data class PMCurrentNaviStatus(val guidanceActive: Boolean = false, val guidanceActiveRouteOptions: List<PMRouteOption>? = null, val guidanceMuted: Boolean = false)

Current navigation status response

PMDestinationType

enum PMDestinationType : Enum<PMDestinationType>

Type of destination

PMGeoPosition

data class PMGeoPosition(val latitude: Double, val longitude: Double)

Represents position in WGS84 coordinates with double precision

PMGuidancePrompt

enum PMGuidancePrompt : Enum<PMGuidancePrompt>

Represents available guidance prompt settings

PMLocationInfo

data class PMLocationInfo(val position: PMGeoPosition? = null, val category: PMCmdPoiCategory, val type: PMLocationType, val name: String? = null, val street: String? = null, val houseNumber: String? = null, val city: String? = null, val country: String? = null)

Represents information about a location

PMLocationType

enum PMLocationType : Enum<PMLocationType>

PMMapCamera

enum PMMapCamera : Enum<PMMapCamera>

Available map zoom settings

PMMapMode

enum PMMapMode : Enum<PMMapMode>

Represents available map mode settings

PMPoiCategoryResult