public class ClientProtocolDefinition extends Object
Modifier and Type | Class and Description |
---|---|
static interface |
ClientProtocolDefinition.ActivationFinished
Indicates the activation was successfully finalized.
|
static interface |
ClientProtocolDefinition.ActivationStart
Indicates that a new activation was initiated.
|
static interface |
ClientProtocolDefinition.ClockSyncReasonForDeviceSetupRequest
Sends a reason entered by the user for a dongle that was disconnected in the meantime.
|
static interface |
ClientProtocolDefinition.ClockSyncReasonForDeviceSetupResponse
Indicates sending the reason was successful.
|
static interface |
ClientProtocolDefinition.ClockSyncReasonForDownloadRequest
Returns a reason entered by the user for a dongle that was disconnected in the meantime.
|
static interface |
ClientProtocolDefinition.ClockSyncReasonForDownloadRequired
Indicates a reason is required to be entered by the user for a dongle that was disconnected in the meantime.
|
static interface |
ClientProtocolDefinition.ClockSyncReasonForDownloadResponse
Indicates sending the reason for downloading the driving data was successful.
|
static interface |
ClientProtocolDefinition.ConnectionStatusDongle
Indicates the current connection status of the dongle.
|
static interface |
ClientProtocolDefinition.ConnectionStatusServer
Indicates the current connection status of WEBFLEET MESSAGING.
|
static interface |
ClientProtocolDefinition.CoreBoot
This command must be the first message the client needs to send after having established an Android service connection to the core service.
|
static interface |
ClientProtocolDefinition.CoreBooted
This message is sent back from the core to the client upon successful initialization.
|
static interface |
ClientProtocolDefinition.CoreStateRequest
Requests the current internal state of the core.
|
static interface |
ClientProtocolDefinition.CoreStateResponse
Returns the current internal state of the core.
|
static interface |
ClientProtocolDefinition.CrashDetectedDatagramTransmission
A transmission of a 'crash detected' datagram.
|
static interface |
ClientProtocolDefinition.DeviceStatusRequest
Requests status data information from the dongle.
|
static interface |
ClientProtocolDefinition.DeviceStatusResponse
Returns device status information of the dongle.
|
static interface |
ClientProtocolDefinition.DisconnectFromDongle
Disconnects from dongle.
|
static interface |
ClientProtocolDefinition.DisconnectFromServer
Disconnects from server.
|
static interface |
ClientProtocolDefinition.DongleDisconnectOnIdleTimeout
Requests an update of the odometer value of the dongle.
|
static interface |
ClientProtocolDefinition.DownloadFromDongleFailed
Indicates the download of data from dongle has failed on the dongle.
|
static interface |
ClientProtocolDefinition.DownloadFromDongleFinished
Indicates the download of data from dongle has finished.
|
static interface |
ClientProtocolDefinition.DownloadFromDongleProgress
Indicates the download of data from dongle is progressing.
|
static interface |
ClientProtocolDefinition.DownloadFromDongleStarted
Indicates the download of data from dongle has started.
|
static interface |
ClientProtocolDefinition.Error
This message is sent in case of an error.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateAvailable
Indicates that a new firmware is ready for download.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateDownloadFailed
Indicates that the smartphone failed to download the new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateDownloadFinished
Indicates that the smartphone finished downloading the new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateDownloadProgress
Indicates that the smartphone progressed downloading the new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateDownloadStarted
Indicates that the smartphone started to download a new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateUploadFailed
Indicates that the smartphone failed to upload the new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateUploadFinished
Indicates that the smartphone finished uploading the new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateUploadProgress
Indicates that the smartphone progressed uploading the new firmware.
|
static interface |
ClientProtocolDefinition.FirmwareUpdateUploadStarted
Indicates that the smartphone started to upload the new firmware.
|
static interface |
ClientProtocolDefinition.InboundMessage
Marker interface for indicating inbound messages.
|
static interface |
ClientProtocolDefinition.ObdDtcRequest
Requests current DTC information from the dongle.
|
static interface |
ClientProtocolDefinition.ObdDtcResponse
Returns current DTC information from the dongle.
|
static interface |
ClientProtocolDefinition.ObdRealTimeDatagramTransmission
A transmission of a OBD real time datagram.
|
static interface |
ClientProtocolDefinition.OdometerChangeRequest
Requests an update of the odometer value of the dongle.
|
static interface |
ClientProtocolDefinition.OdometerChangeResponse
Returns the status of the requested change of the odometer value.
|
static interface |
ClientProtocolDefinition.OutboundMessage
Marker interface for indicating outbound messages.
|
static interface |
ClientProtocolDefinition.OutboundQueueStatusUpdateDongle
Indicates the current status of the outbound queue of the dongle side.
|
static interface |
ClientProtocolDefinition.OutboundQueueStatusUpdateServer
Indicates the current status of the outbound queue of the WFM server side.
|
static interface |
ClientProtocolDefinition.ReconnectToDongle
Reconnects manually to the dongle if currently disconnected.
|
static interface |
ClientProtocolDefinition.ReconnectToServer
Reconnects manually to the WEBLFEET MESSAGING if currently disconnected.
|
static interface |
ClientProtocolDefinition.SendFcmRegistrationToken
Sends the FCM registration token.
|
static interface |
ClientProtocolDefinition.StartActivation
Starts the activation of the dongle.
|
static interface |
ClientProtocolDefinition.StartDrivingProfileRealTimeDataTransmission
Initiates the driving profile data stream.
|
static interface |
ClientProtocolDefinition.StartEngineStatusUpdateTransmission
Starts the engine status updates.
|
static interface |
ClientProtocolDefinition.StartObdRealTimeDataTransmission
Initiates the real time data stream.
|
static interface |
ClientProtocolDefinition.StartSynchronisation
Starts the data download from dongle and upload process to WEBFLEET MESSAGING.
|
static interface |
ClientProtocolDefinition.StopDrivingProfileRealTimeDataTransmission
Stops the real time data stream.
|
static interface |
ClientProtocolDefinition.StopEngineStatusUpdateTransmission
Stops the engine status updates.
|
static interface |
ClientProtocolDefinition.StopObdRealTimeDataTransmission
Stops the real time data stream.
|
static interface |
ClientProtocolDefinition.TransmissionFromDongle
Indicates that the dongle sent a message to the smartphone.
|
static interface |
ClientProtocolDefinition.TransmissionFromServer
Indicates that the WFM sent a message to the smartphone.
|
static interface |
ClientProtocolDefinition.TransmissionToDongle
Indicates that the smartphone sent a message to the dongle.
|
static interface |
ClientProtocolDefinition.TransmissionToServer
Indicates that the smartphone sent a message to the dongle.
|
static interface |
ClientProtocolDefinition.UpdateFirmware
Indicates that the client side confirmed starting the firmware update.
|
static interface |
ClientProtocolDefinition.UploadToServerFinished
Indicates the upload of data to the server has finished.
|
Modifier and Type | Field and Description |
---|---|
static String |
APPLICATION_PACKAGE_NAME
This is the app package name for the intent that is used to bind to the service.
|
static String |
EXTRA_MESSAGE_ID
This is the key of the extra that contains the message id in the Intent that is sent on each callback via
INTENT_CORE_CALLBACK_ACTION . |
static String |
FIRMWARE_FILE_ID
Contains a long uniquely denoting the firmware update this message was sent for.
|
static String |
INTENT_CORE_BOOT_ACTION
If an Intent containing this action is send the Core is automatically started.
|
static String |
INTENT_CORE_CALLBACK_ACTION
Register a BroadcastReceiver with an intent-filter that filters this action and receive
callbacks from a Core that was started before via
INTENT_CORE_BOOT_ACTION . |
static String |
INTENT_CORE_START_OBD_RT_TRANSMISSION_ACTION
Starts the transmission of real-time OBD data from the dongle via Intent.
|
static String |
INTENT_CORE_START_SYNC_ACTION
Starts the download of driving data from the dongle via Intent.
|
static String |
INTENT_CORE_STOP_OBD_RT_TRANSMISSION_ACTION
Stops the transmission of real-time OBD data from the dongle via Intent.
|
Constructor and Description |
---|
ClientProtocolDefinition() |
public static final String APPLICATION_PACKAGE_NAME
public static final String FIRMWARE_FILE_ID
public static final String INTENT_CORE_BOOT_ACTION
INTENT_CORE_CALLBACK_ACTION
.public static final String INTENT_CORE_CALLBACK_ACTION
INTENT_CORE_BOOT_ACTION
.
Please note: Not all Core events that are usually sent as with a normal Core binding are sent back
to the BroadcastReceiver that listens for callbacks. Mainly less important communication events
like ClientProtocolDefinition.TransmissionFromDongle
and the like are not being reported back to the callback receiver.public static final String INTENT_CORE_START_SYNC_ACTION
INTENT_CORE_BOOT_ACTION
.public static final String INTENT_CORE_START_OBD_RT_TRANSMISSION_ACTION
INTENT_CORE_BOOT_ACTION
.public static final String INTENT_CORE_STOP_OBD_RT_TRANSMISSION_ACTION
INTENT_CORE_BOOT_ACTION
.public static final String EXTRA_MESSAGE_ID
INTENT_CORE_CALLBACK_ACTION
.