DragonKeyboardFirmwareUpdater/dfu/src/no/nordicsemi/android/dfu/DfuProgressListener.java

/*************************************************************************************************************************************************
 * Copyright (c) 2015, Nordic Semiconductor
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ************************************************************************************************************************************************/

package no.nordicsemi.android.dfu;

/**
 * Listener for status, progress and error events. This listener should be used instead of creating the BroadcastReceiver on your own.
 * @see DfuServiceListenerHelper
 */
public interface DfuProgressListener {

	/**
	 * Method called when the DFU service started connecting with the DFU target.
	 * @param deviceAddress the target device address
	 */
	public void onDeviceConnecting(final String deviceAddress);

	/**
	 * Method called when the service has successfully connected, discovered services and found DFU service on the DFU target.
	 * @param deviceAddress the target device address
	 */
	public void onDeviceConnected(final String deviceAddress);

	/**
	 * Method called when the DFU process is starting. This includes reading the DFU Version characteristic, sending DFU_START command as well as the Init packet, if set.
	 * @param deviceAddress the target device address
	 */
	public void onDfuProcessStarting(final String deviceAddress);

	/**
	 * Method called when the DFU process was started and bytes about to be sent.
	 * @param deviceAddress the target device address
	 */
	public void onDfuProcessStarted(final String deviceAddress);

	/**
	 * Method called when the service discovered that the DFU target is in the application mode and must be switched to DFU mode.
	 * The switch command will be sent and the DFU process should start again. There will be no {@link #onDeviceDisconnected(String)} event following this call.
	 * @param deviceAddress the target device address
	 */
	public void onEnablingDfuMode(final String deviceAddress);

	/**
	 * Method called during uploading the firmware. It will not be called twice with the same value of percent, however, in case of small firmware files, some values may be omitted.
	 * @param deviceAddress the target device address
	 * @param percent the current status of upload (0-99)
	 * @param speed the current speed in bytes per millisecond
	 * @param avgSpeed the average speed in bytes per millisecond
	 * @param currentPart the number pf part being sent. In case the ZIP file contains a Soft Device and/or a Bootloader together with the application the SD+BL are sent as part 1,
	 *                    then the service starts again and send the application as part 2
	 * @param partsTotal total number of parts
	 */
	public void onProgressChanged(final String deviceAddress, final int percent, final float speed, final float avgSpeed, final int currentPart, final int partsTotal);

	/**
	 * Method called when the new firmware is being validated on the target device.
	 * @param deviceAddress the target device address
	 */
	public void onFirmwareValidating(final String deviceAddress);

	/**
	 * Method called when the service started to disconnect from the target device.
	 * @param deviceAddress the target device address
	 */
	public void onDeviceDisconnecting(final String deviceAddress);

	/**
	 * Method called when the service disconnected from the device. The device has been reset.
	 * @param deviceAddress the target device address
	 */
	public void onDeviceDisconnected(final String deviceAddress);

	/**
	 * Method called when the DFU process succeeded.
	 * @param deviceAddress the target device address
	 */
	public void onDfuCompleted(final String deviceAddress);

	/**
	 * Method called when the DFU process has been aborted.
	 * @param deviceAddress the target device address
	 */
	public void onDfuAborted(final String deviceAddress);

	/**
	 * Method called when an error occur.
	 * @param deviceAddress the target device address
	 * @param error error number
	 * @param errorType the error type, one of {@link DfuBaseService#ERROR_TYPE_COMMUNICATION_STATE}, {@link DfuBaseService#ERROR_TYPE_COMMUNICATION},
	 * 			{@link DfuBaseService#ERROR_TYPE_DFU_REMOTE}, {@link DfuBaseService#ERROR_TYPE_OTHER}.
	 * @param message the error message
	 */
	public void onError(final String deviceAddress, final int error, final int errorType, final String message);
}