DfuServiceInitiator (Device Firmware Update library)

java.lang.Object
- no.nordicsemi.android.dfu.DfuServiceInitiator

```
public final class DfuServiceInitiator
extends Object
```
Starting the DfuService service requires a knowledge of some EXTRA_* constants used to pass parameters to the service. The DfuServiceInitiator class may be used to make this process easier. It provides simple API that covers all low lever operations.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MBR_SIZE`
`static int`	`DEFAULT_PRN_VALUE`
`static int`	`SCOPE_APPLICATION` Constant used to narrow the scope of the update to application only.
`static int`	`SCOPE_SYSTEM_COMPONENTS` Constant used to narrow the scope of the update to system components (SD+BL) only.

Constructor Summary

Constructors
Constructor and Description

DfuServiceInitiator(String deviceAddress)
Creates the builder.

Constructors
Constructor and Description
`DfuServiceInitiator(String deviceAddress)` Creates the builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`createDfuNotificationChannel(Context context)`
`DfuServiceInitiator`	`disableMtuRequest()` Disables MTU request.
`DfuServiceInitiator`	`disableResume()` This options allows to disable the resume feature in Secure DFU.
`DfuServiceInitiator`	`setBinOrHex(int fileType, int rawResId)` Deprecated.
`DfuServiceInitiator`	`setBinOrHex(int fileType, String path)` Deprecated.
`DfuServiceInitiator`	`setBinOrHex(int fileType, Uri uri)` Deprecated.
`DfuServiceInitiator`	`setBinOrHex(int fileType, Uri uri, String path)` Deprecated. The Distribution packet (ZIP) should be used for DFU Bootloader version 0.5 or newer
`DfuServiceInitiator`	`setCurrentMtu(int mtu)` Sets the current MTU value.
`DfuServiceInitiator`	`setCustomUuidsForButtonlessDfuWithBondSharing(UUID buttonlessDfuServiceUuid, UUID buttonlessDfuControlPointUuid)` Sets custom UUIDs for the Buttonless DFU Service from SDK 14 (or later).
`DfuServiceInitiator`	`setCustomUuidsForButtonlessDfuWithoutBondSharing(UUID buttonlessDfuServiceUuid, UUID buttonlessDfuControlPointUuid)` Sets custom UUIDs for the Buttonless DFU Service from SDK 13.
`DfuServiceInitiator`	`setCustomUuidsForExperimentalButtonlessDfu(UUID buttonlessDfuServiceUuid, UUID buttonlessDfuControlPointUuid)` Sets custom UUIDs for the experimental Buttonless DFU Service from SDK 12.x.
`DfuServiceInitiator`	`setCustomUuidsForLegacyDfu(UUID dfuServiceUuid, UUID dfuControlPointUuid, UUID dfuPacketUuid, UUID dfuVersionUuid)` Sets custom UUIDs for Legacy DFU and Legacy Buttonless DFU.
`DfuServiceInitiator`	`setCustomUuidsForSecureDfu(UUID dfuServiceUuid, UUID dfuControlPointUuid, UUID dfuPacketUuid)` Sets custom UUIDs for Secure DFU.
`DfuServiceInitiator`	`setDeviceName(String name)` Sets the device name.
`DfuServiceInitiator`	`setDisableNotification(boolean disableNotification)` Sets whether the progress notification in the status bar should be disabled.
`DfuServiceInitiator`	`setForceDfu(boolean force)` Setting force DFU to true will prevent from jumping to the DFU Bootloader mode in case there is no DFU Version characteristic (Legacy DFU only!).
`DfuServiceInitiator`	`setForeground(boolean foreground)` Sets whether the DFU service should be started as a foreground service.
`DfuServiceInitiator`	`setInitFile(int initFileResId)` Deprecated.
`DfuServiceInitiator`	`setInitFile(String initFilePath)` Deprecated.
`DfuServiceInitiator`	`setInitFile(Uri initFileUri)` Deprecated.
`DfuServiceInitiator`	`setInitFile(Uri initFileUri, String initFilePath)` Deprecated.
`DfuServiceInitiator`	`setKeepBond(boolean keepBond)` Sets whether the bond information should be preserver after flashing new application.
`DfuServiceInitiator`	`setMbrSize(int mbrSize)` This method sets the size of an MBR (Master Boot Record).
`DfuServiceInitiator`	`setMtu(int mtu)` Sets the Maximum Transfer Unit (MTU) value that the Secure DFU service will try to request before performing DFU.
`DfuServiceInitiator`	`setNumberOfRetries(int max)` Sets the number of retries that the DFU service will use to complete DFU.
`DfuServiceInitiator`	`setPacketsReceiptNotificationsEnabled(boolean enabled)` Enables or disables the Packet Receipt Notification (PRN) procedure.
`DfuServiceInitiator`	`setPacketsReceiptNotificationsValue(int number)` If Packet Receipt Notification procedure is enabled, this method sets number of packets to be sent before receiving a PRN.
`DfuServiceInitiator`	`setRestoreBond(boolean restoreBond)` Sets whether the bond should be created after the DFU is complete.
`DfuServiceInitiator`	`setScope(int scope)` This method allows to narrow the update to selected parts from the ZIP, for example to allow only application update from a ZIP file that has SD+BL+App.
`DfuServiceInitiator`	`setUnsafeExperimentalButtonlessServiceInSecureDfuEnabled(boolean enable)` Set this flag to true to enable experimental buttonless feature in Secure DFU.
`DfuServiceInitiator`	`setZip(int rawResId)` Sets the resource ID of the Distribution packet (ZIP) or the a ZIP file matching the deprecated naming convention.
`DfuServiceInitiator`	`setZip(String path)` Sets the path to the Distribution packet (ZIP) or the a ZIP file matching the deprecated naming convention.
`DfuServiceInitiator`	`setZip(Uri uri)` Sets the URI to the Distribution packet (ZIP) or to a ZIP file matching the deprecated naming convention.
`DfuServiceInitiator`	`setZip(Uri uri, String path)` Sets the URI or path of the ZIP file.
`DfuServiceController`	`start(Context context, Class<? extends DfuBaseService> service)` Starts the DFU service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PRN_VALUE
```
public static final int DEFAULT_PRN_VALUE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MBR_SIZE
```
public static final int DEFAULT_MBR_SIZE
```
    See Also:
    
    Constant Field Values
  - SCOPE_SYSTEM_COMPONENTS
```
public static final int SCOPE_SYSTEM_COMPONENTS
```
    Constant used to narrow the scope of the update to system components (SD+BL) only.
    
    See Also:
    
    Constant Field Values
  - SCOPE_APPLICATION
```
public static final int SCOPE_APPLICATION
```
    Constant used to narrow the scope of the update to application only.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DfuServiceInitiator
```
public DfuServiceInitiator(String deviceAddress)
```
    Creates the builder. Use setZip(...), or setBinOrHex(...) methods to specify the file you want to upload. In the latter case an init file may also be set using the setInitFile(...) method. Init files are required by DFU Bootloader version 0.5 or newer (SDK 7.0.0+).
    
    Parameters:
    
    deviceAddress - the target device device address
- Method Detail
  - setDeviceName
```
public DfuServiceInitiator setDeviceName(String name)
```
    Sets the device name. The device name is not required. It's written in the notification during the DFU process. If not set the R.string.dfu_unknown_name value will be used.
    
    Parameters:
    
    name - the device name (optional)
    
    Returns:
    
    the builder
  - setDisableNotification
```
public DfuServiceInitiator setDisableNotification(boolean disableNotification)
```
    Sets whether the progress notification in the status bar should be disabled. Defaults to false.
    
    Parameters:
    
    disableNotification - whether to disable the notification
    
    Returns:
    
    the builder
  - setForeground
```
public DfuServiceInitiator setForeground(boolean foreground)
```
    Sets whether the DFU service should be started as a foreground service. By default it's true. According to https://developer.android.com/about/versions/oreo/background.html the background service may be killed by the system on Android Oreo after user quits the application so it is recommended to keep it as a foreground service (default) at least on Android Oreo+.
    
    Parameters:
    
    foreground - whether the service should be started in foreground state.
    
    Returns:
    
    the builder
  - setKeepBond
```
public DfuServiceInitiator setKeepBond(boolean keepBond)
```
    Sets whether the bond information should be preserver after flashing new application. This feature requires DFU Bootloader version 0.6 or newer (SDK 8.0.0+). Please see the DfuBaseService.EXTRA_KEEP_BOND for more information regarding requirements. Remember that currently updating the Soft Device will remove the bond information.
    This flag is ignored when Secure DFU Buttonless Service is used. It will keep or remove the bond depending on the Buttonless service type.
    
    Parameters:
    
    keepBond - whether the bond information should be preserved in the new application.
    
    Returns:
    
    the builder
  - setRestoreBond
```
public DfuServiceInitiator setRestoreBond(boolean restoreBond)
```
    Sets whether the bond should be created after the DFU is complete. Please see the DfuBaseService.EXTRA_RESTORE_BOND for more information regarding requirements.
    This flag is ignored when Secure DFU Buttonless Service is used. It will keep or will not restore the bond depending on the Buttonless service type.
    
    Parameters:
    
    restoreBond - whether the bond should be created after the DFU is complete.
    
    Returns:
    
    the builder
  - setPacketsReceiptNotificationsEnabled
```
public DfuServiceInitiator setPacketsReceiptNotificationsEnabled(boolean enabled)
```
    Enables or disables the Packet Receipt Notification (PRN) procedure.
    By default the PRNs are disabled on devices with Android Marshmallow or newer and enabled on older ones.
    
    Parameters:
    
    enabled - true to enabled PRNs, false to disable
    
    Returns:
    
    the builder
    
    See Also:
    
    DfuSettingsConstants.SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED
  - setPacketsReceiptNotificationsValue
```
public DfuServiceInitiator setPacketsReceiptNotificationsValue(int number)
```
    If Packet Receipt Notification procedure is enabled, this method sets number of packets to be sent before receiving a PRN. A PRN is used to synchronize the transmitter and receiver.
    If the value given is equal to 0, the DEFAULT_PRN_VALUE will be used instead.
    To disable PRNs use setPacketsReceiptNotificationsEnabled(boolean).
    
    Parameters:
    
    number - number of packets to be sent before receiving a PRN. Defaulted when set to 0.
    
    Returns:
    
    the builder
    
    See Also:
    
    setPacketsReceiptNotificationsEnabled(boolean), DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS
  - setForceDfu
```
public DfuServiceInitiator setForceDfu(boolean force)
```
    Setting force DFU to true will prevent from jumping to the DFU Bootloader mode in case there is no DFU Version characteristic (Legacy DFU only!). Use it if the DFU operation can be handled by your device running in the application mode.
    If the DFU Version characteristic exists, the information whether to begin DFU operation, or jump to bootloader, is taken from that characteristic's value. The value returned equal to 0x0100 (read as: minor=1, major=0, or version 0.1) means that the device is in the application mode and buttonless jump to DFU Bootloader is supported.
    However, if there is no DFU Version characteristic, a device may support only Application update (version from SDK 4.3.0), may support Soft Device, Bootloader and Application update but without buttonless jump to bootloader (SDK 6.0.0) or with buttonless jump (SDK 6.1.0).
    In the last case, the DFU Library determines whether the device is in application mode or in DFU Bootloader mode by counting number of services: if no DFU Service found - device is in app mode and does not support buttonless jump, if the DFU Service is the only service found (except General Access and General Attribute services) - it assumes it is in DFU Bootloader mode and may start DFU immediately, if there is at least one service except DFU Service - the device is in application mode and supports buttonless jump. In the last case, if you want to perform DFU operation without jumping - call the setForceDfu(boolean) method with parameter equal to true.
    This method is ignored in Secure DFU.
    
    Parameters:
    
    force - true to ensure the DFU will start if there is no DFU Version characteristic (Legacy DFU only)
    
    Returns:
    
    the builder
    
    See Also:
    
    DfuSettingsConstants.SETTINGS_ASSUME_DFU_NODE
  - disableResume
```
public DfuServiceInitiator disableResume()
```
    This options allows to disable the resume feature in Secure DFU. When the extra value is set to true, the DFU will send Init Packet and Data again, despite the firmware might have been send partially before. By default, without setting this extra, or by setting it to false, the DFU will resume the previously cancelled upload if CRC values match.
    It is ignored when Legacy DFU is used.
    This feature seems to help in some cases: #71.
    
    Returns:
    
    the builder
  - setNumberOfRetries
```
public DfuServiceInitiator setNumberOfRetries(int max)
```
    Sets the number of retries that the DFU service will use to complete DFU. The default value is 0, for backwards compatibility reason.
    If the given value is greater than 0, the service will restart itself at most max times in case of an undesired disconnection during DFU operation. This attempt counter is independent from another counter, for reconnection attempts, which is equal to 3. The latter one will be used when connection will fail with an error (possible packet collision or any other reason). After successful connection, the reconnection counter is reset, while the retry counter is cleared after a DFU finishes with success.
    The service will not try to retry DFU in case of any other error, for instance an error sent from the target device.
    
    Parameters:
    
    max - Maximum number of retires to complete DFU. Usually around 2.
    
    Returns:
    
    the builder
  - setMtu
```
public DfuServiceInitiator setMtu(int mtu)
```
    Sets the Maximum Transfer Unit (MTU) value that the Secure DFU service will try to request before performing DFU. By default, value 517 will be used, which is the highest supported by Android. However, as the highest supported MTU by the Secure DFU from SDK 15 (first which supports higher MTU) is 247, the sides will agree on using MTU = 247 instead if the phone supports it (Lollipop or newer device).
    The higher the MTU, the faster the data may be sent.
    If you encounter problems with high MTU, you may lower the required value using this method. See: https://github.com/NordicSemiconductor/Android-DFU-Library/issues/111
    To disable requesting MTU, use value 0, or disableMtuRequest().
    Note: Higher (that is greater then 23) MTUs are supported on Lollipop or newer Android devices, and on DFU bootloader from SDK 15 or newer (Secure DFU only).
    
    Parameters:
    
    mtu - the MTU that wil be requested, 0 to disable MTU request.
    
    Returns:
    
    the builder
  - setCurrentMtu
```
public DfuServiceInitiator setCurrentMtu(int mtu)
```
    Sets the current MTU value. This method should be used only if the device is already connected and MTU has been requested before DFU service is started. The SoftDevice allows to change MTU only once, while the following requests fail with Invalid PDU error. In case this error is received, the MTU will be set to the value specified using this method. There is no verification of this value. If it's set to too high value, some of the packets will not be sent and DFU will not succeed.
    By default value 23 is used for compatibility reasons.
    Higher MTU values were supported since SDK 15.0.
    
    Parameters:
    
    mtu - the MTU value received in BluetoothGattCallback.onMtuChanged(BluetoothGatt, int, int) or BluetoothGattServerCallback.onMtuChanged(BluetoothDevice, int).
    
    Returns:
    
    the builder
  - disableMtuRequest
```
public DfuServiceInitiator disableMtuRequest()
```
    Disables MTU request.
    
    Returns:
    
    the builder
    
    See Also:
    
    setMtu(int)
  - setScope
```
public DfuServiceInitiator setScope(int scope)
```
    This method allows to narrow the update to selected parts from the ZIP, for example to allow only application update from a ZIP file that has SD+BL+App. System components scope include the Softdevice and/or the Bootloader (they can't be separated as they are packed in a single bin file and the library does not know whether it contains only the softdevice, the bootloader or both) Application scope includes the application only.
    
    Parameters:
    
    scope - the update scope, one of SCOPE_SYSTEM_COMPONENTS or SCOPE_APPLICATION.
    
    Returns:
    
    the builder
  - setMbrSize
```
public DfuServiceInitiator setMbrSize(int mbrSize)
```
    This method sets the size of an MBR (Master Boot Record). It should be used only when updating a file from a HEX file. If you use BIN or ZIP, value set here will be ignored.
    The MBR size is important for the HEX parser, which has to cut it from the Soft Device's HEX before sending it to the DFU target. The MBR can't be updated using DFU, and the bootloader expects only the Soft Device bytes. Usually, the Soft Device HEX provided by Nordic contains an MBR at addresses 0x0000 to 0x1000. 0x1000 is the default size of MBR which will be used.
    If you have a HEX file which address start from 0 and want to send the whole BIN content from it, you have to set the MBR size to 0, otherwise first 4096 bytes will be cut off.
    The value set here will not be used if the DfuSettingsConstants.SETTINGS_MBR_SIZE is set in Shared Preferences.
    
    Parameters:
    
    mbrSize - the MBR size in bytes. Defaults to 4096 (0x1000) bytes.
    
    Returns:
    
    the builder
    
    See Also:
    
    DfuSettingsConstants.SETTINGS_MBR_SIZE
  - setUnsafeExperimentalButtonlessServiceInSecureDfuEnabled
```
public DfuServiceInitiator setUnsafeExperimentalButtonlessServiceInSecureDfuEnabled(boolean enable)
```
    Set this flag to true to enable experimental buttonless feature in Secure DFU. When the experimental Buttonless DFU Service is found on a device, the service will use it to switch the device to the bootloader mode, connect to it in that mode and proceed with DFU.
    Please, read the information below before setting it to true.
    In the SDK 12.x the Buttonless DFU feature for Secure DFU was experimental. It is NOT recommended to use it: it was not properly tested, had implementation bugs (e.g. link) and does not required encryption and therefore may lead to DOS attack (anyone can use it to switch the device to bootloader mode). However, as there is no other way to trigger bootloader mode on devices without a button, this DFU Library supports this service, but the feature must be explicitly enabled here. Be aware, that setting this flag to false will no protect your devices from this kind of attacks, as an attacker may use another app for that purpose. To be sure your device is secure remove this experimental service from your device.
    Spec:
    Buttonless DFU Service UUID: 8E400001-F315-4F60-9FB8-838830DAEA50
    Buttonless DFU characteristic UUID: 8E400001-F315-4F60-9FB8-838830DAEA50 (the same)
    Enter Bootloader Op Code: 0x01
    Correct return value: 0x20-01-01 , where:
    0x20 - Response Op Code
    0x01 - Request Code
    0x01 - Success
    The device should disconnect and restart in DFU mode after sending the notification.
    The Buttonless service has changed in SDK 13 and later. Indications are used instead of notifications. Also, Buttonless service for bonded devices has been added. It is recommended to use any of the new services instead.
    
    Returns:
    
    the builder
  - setCustomUuidsForLegacyDfu
```
public DfuServiceInitiator setCustomUuidsForLegacyDfu(UUID dfuServiceUuid,
                                                      UUID dfuControlPointUuid,
                                                      UUID dfuPacketUuid,
                                                      UUID dfuVersionUuid)
```
    Sets custom UUIDs for Legacy DFU and Legacy Buttonless DFU. Use this method if your DFU implementation uses different UUID for at least one of the given UUIDs. Parameter set to null will reset the UUID to the default value.
    
    Parameters:
    
    dfuServiceUuid - custom Legacy DFU service UUID or null, if default is to be used
    
    dfuControlPointUuid - custom Legacy DFU Control Point characteristic UUID or null, if default is to be used
    
    dfuPacketUuid - custom Legacy DFU Packet characteristic UUID or null, if default is to be used
    
    dfuVersionUuid - custom Legacy DFU Version characteristic UUID or null, if default is to be used (SDK 7.0 - 11.0 only, set null for earlier SDKs)
    
    Returns:
    
    the builder
  - setCustomUuidsForSecureDfu
```
public DfuServiceInitiator setCustomUuidsForSecureDfu(UUID dfuServiceUuid,
                                                      UUID dfuControlPointUuid,
                                                      UUID dfuPacketUuid)
```
    Sets custom UUIDs for Secure DFU. Use this method if your DFU implementation uses different UUID for at least one of the given UUIDs. Parameter set to null will reset the UUID to the default value.
    
    Parameters:
    
    dfuServiceUuid - custom Secure DFU service UUID or null, if default is to be used
    
    dfuControlPointUuid - custom Secure DFU Control Point characteristic UUID or null, if default is to be used
    
    dfuPacketUuid - custom Secure DFU Packet characteristic UUID or null, if default is to be used
    
    Returns:
    
    the builder
  - setCustomUuidsForExperimentalButtonlessDfu
```
public DfuServiceInitiator setCustomUuidsForExperimentalButtonlessDfu(UUID buttonlessDfuServiceUuid,
                                                                      UUID buttonlessDfuControlPointUuid)
```
    Sets custom UUIDs for the experimental Buttonless DFU Service from SDK 12.x. Use this method if your DFU implementation uses different UUID for at least one of the given UUIDs. Parameter set to null will reset the UUID to the default value.
    Remember to call setUnsafeExperimentalButtonlessServiceInSecureDfuEnabled(boolean) with parameter true if you intent to use this service.
    
    Parameters:
    
    buttonlessDfuServiceUuid - custom Buttonless DFU service UUID or null, if default is to be used
    
    buttonlessDfuControlPointUuid - custom Buttonless DFU characteristic UUID or null, if default is to be used
    
    Returns:
    
    the builder
  - setCustomUuidsForButtonlessDfuWithBondSharing
```
public DfuServiceInitiator setCustomUuidsForButtonlessDfuWithBondSharing(UUID buttonlessDfuServiceUuid,
                                                                         UUID buttonlessDfuControlPointUuid)
```
    Sets custom UUIDs for the Buttonless DFU Service from SDK 14 (or later). Use this method if your DFU implementation uses different UUID for at least one of the given UUIDs. Parameter set to null will reset the UUID to the default value.
    
    Parameters:
    
    buttonlessDfuServiceUuid - custom Buttonless DFU service UUID or null, if default is to be used
    
    buttonlessDfuControlPointUuid - custom Buttonless DFU characteristic UUID or null, if default is to be used
    
    Returns:
    
    the builder
  - setCustomUuidsForButtonlessDfuWithoutBondSharing
```
public DfuServiceInitiator setCustomUuidsForButtonlessDfuWithoutBondSharing(UUID buttonlessDfuServiceUuid,
                                                                            UUID buttonlessDfuControlPointUuid)
```
    Sets custom UUIDs for the Buttonless DFU Service from SDK 13. Use this method if your DFU implementation uses different UUID for at least one of the given UUIDs. Parameter set to null will reset the UUID to the default value.
    
    Parameters:
    
    buttonlessDfuServiceUuid - custom Buttonless DFU service UUID or null, if default is to be used
    
    buttonlessDfuControlPointUuid - custom Buttonless DFU characteristic UUID or null, if default is to be used
    
    Returns:
    
    the builder
  - setZip
```
public DfuServiceInitiator setZip(Uri uri)
```
    Sets the URI to the Distribution packet (ZIP) or to a ZIP file matching the deprecated naming convention.
    
    Parameters:
    
    uri - the URI of the file
    
    Returns:
    
    the builder
    
    See Also:
    
    setZip(String), setZip(int)
  - setZip
```
public DfuServiceInitiator setZip(String path)
```
    Sets the path to the Distribution packet (ZIP) or the a ZIP file matching the deprecated naming convention.
    
    Parameters:
    
    path - path to the file
    
    Returns:
    
    the builder
    
    See Also:
    
    setZip(Uri), setZip(int)
  - setZip
```
public DfuServiceInitiator setZip(int rawResId)
```
    Sets the resource ID of the Distribution packet (ZIP) or the a ZIP file matching the deprecated naming convention. The file should be in the /res/raw folder.
    
    Parameters:
    
    rawResId - file's resource ID
    
    Returns:
    
    the builder
    
    See Also:
    
    setZip(Uri), setZip(String)
  - setZip
```
public DfuServiceInitiator setZip(Uri uri,
                                  String path)
```
    Sets the URI or path of the ZIP file. At least one of the parameters must not be null. If the URI and path are not null the URI will be used.
    
    Parameters:
    
    uri - the URI of the file
    
    path - the path of the file
    
    Returns:
    
    the builder
  - setBinOrHex
```
@Deprecated
public DfuServiceInitiator setBinOrHex(int fileType,
                                                    Uri uri)
```
    Deprecated.
    
    Sets the URI of the BIN or HEX file containing the new firmware. For DFU Bootloader version 0.5 or newer the init file must be specified using one of setInitFile(Uri) methods.
    Parameters:
    fileType - the file type, a bit field created from:
    
    DfuBaseService.TYPE_APPLICATION - the Application will be sent
    
    DfuBaseService.TYPE_SOFT_DEVICE - he Soft Device will be sent
    
    DfuBaseService.TYPE_BOOTLOADER - the Bootloader will be sent
    uri - the URI of the file
    
    Returns:
    
    the builder
  - setBinOrHex
```
@Deprecated
public DfuServiceInitiator setBinOrHex(int fileType,
                                                    String path)
```
    Deprecated.
    
    Sets the URI of the BIN or HEX file containing the new firmware. For DFU Bootloader version 0.5 or newer the init file must be specified using one of setInitFile(String) methods.
    
    Parameters:
    
    fileType - see setBinOrHex(int, Uri) for details
    
    path - path to the file
    
    Returns:
    
    the builder
  - setBinOrHex
```
@Deprecated
public DfuServiceInitiator setBinOrHex(int fileType,
                                                    Uri uri,
                                                    String path)
```
    Deprecated. The Distribution packet (ZIP) should be used for DFU Bootloader version 0.5 or newer
    
    Sets the URI or path to the BIN or HEX file containing the new firmware. For DFU Bootloader version 0.5 or newer the init file must be specified using one of setInitFile(String) methods.
    
    Parameters:
    
    fileType - see setBinOrHex(int, Uri) for details
    
    uri - the URI of the file
    
    path - path to the file
    
    Returns:
    
    the builder
  - setBinOrHex
```
@Deprecated
public DfuServiceInitiator setBinOrHex(int fileType,
                                                    int rawResId)
```
    Deprecated.
    
    Sets the resource ID pointing the BIN or HEX file containing the new firmware. The file should be in the /res/raw folder. For DFU Bootloader version 0.5 or newer the init file must be specified using one of setInitFile(int) methods.
    
    Parameters:
    
    fileType - see setBinOrHex(int, Uri) for details
    
    rawResId - resource ID
    
    Returns:
    
    the builder
  - setInitFile
```
@Deprecated
public DfuServiceInitiator setInitFile(Uri initFileUri)
```
    Deprecated.
    
    Sets the URI of the Init file. The init file for DFU Bootloader version pre-0.5 (SDK 4.3, 6.0, 6.1) contains only the CRC-16 of the firmware. Bootloader version 0.5 or newer requires the Extended Init Packet.
    
    Parameters:
    
    initFileUri - the URI of the init file
    
    Returns:
    
    the builder
  - setInitFile
```
@Deprecated
public DfuServiceInitiator setInitFile(String initFilePath)
```
    Deprecated.
    
    Sets the path to the Init file. The init file for DFU Bootloader version pre-0.5 (SDK 4.3, 6.0, 6.1) contains only the CRC-16 of the firmware. Bootloader version 0.5 or newer requires the Extended Init Packet.
    
    Parameters:
    
    initFilePath - the path to the init file
    
    Returns:
    
    the builder
  - setInitFile
```
@Deprecated
public DfuServiceInitiator setInitFile(int initFileResId)
```
    Deprecated.
    
    Sets the resource ID of the Init file. The init file for DFU Bootloader version pre-0.5 (SDK 4.3, 6.0, 6.1) contains only the CRC-16 of the firmware. Bootloader version 0.5 or newer requires the Extended Init Packet.
    
    Parameters:
    
    initFileResId - the resource ID of the init file
    
    Returns:
    
    the builder
  - setInitFile
```
@Deprecated
public DfuServiceInitiator setInitFile(Uri initFileUri,
                                                    String initFilePath)
```
    Deprecated.
    
    Sets the URI or path to the Init file. The init file for DFU Bootloader version pre-0.5 (SDK 4.3, 6.0, 6.1) contains only the CRC-16 of the firmware. Bootloader version 0.5 or newer requires the Extended Init Packet. If the URI and path are not null the URI will be used.
    
    Parameters:
    
    initFileUri - the URI of the init file
    
    initFilePath - the path of the init file
    
    Returns:
    
    the builder
  - start
```
public DfuServiceController start(Context context,
                                  Class<? extends DfuBaseService> service)
```
    Starts the DFU service.
    
    Parameters:
    
    context - the application context
    
    service - the class derived from the BaseDfuService
  - createDfuNotificationChannel
```
public static void createDfuNotificationChannel(Context context)
```

Class DfuServiceInitiator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PRN_VALUE

DEFAULT_MBR_SIZE

SCOPE_SYSTEM_COMPONENTS

SCOPE_APPLICATION

Constructor Detail

DfuServiceInitiator

Method Detail

setDeviceName

setDisableNotification

setForeground

setKeepBond

setRestoreBond

setPacketsReceiptNotificationsEnabled

setPacketsReceiptNotificationsValue

setForceDfu

disableResume

setNumberOfRetries

setMtu

setCurrentMtu

disableMtuRequest

setScope

setMbrSize

setUnsafeExperimentalButtonlessServiceInSecureDfuEnabled

setCustomUuidsForLegacyDfu

setCustomUuidsForSecureDfu

setCustomUuidsForExperimentalButtonlessDfu

setCustomUuidsForButtonlessDfuWithBondSharing

setCustomUuidsForButtonlessDfuWithoutBondSharing

setZip

setZip

setZip

setZip

setBinOrHex

setBinOrHex

setBinOrHex

setBinOrHex

setInitFile

setInitFile

setInitFile

setInitFile

start

createDfuNotificationChannel