rusefi
/
Android-DFU-Library
mirror of https://github.com/rusefi/Android-DFU-Library.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation updated

This commit is contained in:
Aleksander Nowakowski 2016-09-26 16:23:03 +02:00
parent 08e2cb3896
commit 9cd78d010a
10 changed files with 451 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -7,7 +7,7 @@
The compat library may be found on jcenter and Maven Central repository. Add it to your project by adding the following dependency:
```Groovy
compile 'no.nordicsemi.android:dfu:1.0.3'
compile 'no.nordicsemi.android:dfu:1.0.4'
```
If you use proguard, add the following line to your proguard rules:

125
documentation/javadoc/constant-values.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>Constant Field Values</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@ -115,14 +115,14 @@
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/BuildConfig.html#VERSION_CODE">VERSION_CODE</a></code></td>
<td class="colLast"><code>8</code></td>
<td class="colLast"><code>9</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.BuildConfig.VERSION_NAME">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/BuildConfig.html#VERSION_NAME">VERSION_NAME</a></code></td>
<td class="colLast"><code>"1.0.3"</code></td>
<td class="colLast"><code>"1.0.4"</code></td>
</tr>
</tbody>
</table>
@ -466,258 +466,279 @@
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_FILE_URI"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_FORCE_DFU">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_FORCE_DFU">EXTRA_FORCE_DFU</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_FORCE_DFU"</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_INIT_FILE_PATH">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_PATH">EXTRA_INIT_FILE_PATH</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_INIT_FILE_PATH"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_INIT_FILE_RES_ID">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_RES_ID">EXTRA_INIT_FILE_RES_ID</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_INIT_FILE_RES_ID"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_INIT_FILE_URI">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_URI">EXTRA_INIT_FILE_URI</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_INIT_FILE_URI"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_KEEP_BOND">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_KEEP_BOND">EXTRA_KEEP_BOND</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_KEEP_BOND"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_LOG_LEVEL">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_LOG_LEVEL">EXTRA_LOG_LEVEL</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_LOG_LEVEL"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_LOG_MESSAGE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_LOG_MESSAGE">EXTRA_LOG_MESSAGE</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_LOG_INFO"</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED">EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_PRN_ENABLED"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE">EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_PRN_VALUE"</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PART_CURRENT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PART_CURRENT">EXTRA_PART_CURRENT</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_PART_CURRENT"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PARTS_TOTAL">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PARTS_TOTAL">EXTRA_PARTS_TOTAL</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_PARTS_TOTAL"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PROGRESS">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PROGRESS">EXTRA_PROGRESS</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_PROGRESS"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_RESTORE_BOND">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_RESTORE_BOND">EXTRA_RESTORE_BOND</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_RESTORE_BOND"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.EXTRA_SPEED_B_PER_MS">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_SPEED_B_PER_MS">EXTRA_SPEED_B_PER_MS</a></code></td>
<td class="colLast"><code>"no.nordicsemi.android.dfu.extra.EXTRA_SPEED_B_PER_MS"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.LOG_LEVEL_APPLICATION">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_APPLICATION">LOG_LEVEL_APPLICATION</a></code></td>
<td class="colLast"><code>10</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.LOG_LEVEL_DEBUG">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_DEBUG">LOG_LEVEL_DEBUG</a></code></td>
<td class="colLast"><code>0</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.LOG_LEVEL_ERROR">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_ERROR">LOG_LEVEL_ERROR</a></code></td>
<td class="colLast"><code>20</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.LOG_LEVEL_INFO">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_INFO">LOG_LEVEL_INFO</a></code></td>
<td class="colLast"><code>5</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.LOG_LEVEL_VERBOSE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_VERBOSE">LOG_LEVEL_VERBOSE</a></code></td>
<td class="colLast"><code>1</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.LOG_LEVEL_WARNING">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_WARNING">LOG_LEVEL_WARNING</a></code></td>
<td class="colLast"><code>15</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.MIME_TYPE_OCTET_STREAM">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#MIME_TYPE_OCTET_STREAM">MIME_TYPE_OCTET_STREAM</a></code></td>
<td class="colLast"><code>"application/octet-stream"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.MIME_TYPE_ZIP">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#MIME_TYPE_ZIP">MIME_TYPE_ZIP</a></code></td>
<td class="colLast"><code>"application/zip"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.NOTIFICATION_ID">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#NOTIFICATION_ID">NOTIFICATION_ID</a></code></td>
<td class="colLast"><code>283</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_ABORTED">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_ABORTED">PROGRESS_ABORTED</a></code></td>
<td class="colLast"><code>-7</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_COMPLETED">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_COMPLETED">PROGRESS_COMPLETED</a></code></td>
<td class="colLast"><code>-6</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_CONNECTING">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_CONNECTING">PROGRESS_CONNECTING</a></code></td>
<td class="colLast"><code>-1</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_DISCONNECTING">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_DISCONNECTING">PROGRESS_DISCONNECTING</a></code></td>
<td class="colLast"><code>-5</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_ENABLING_DFU_MODE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_ENABLING_DFU_MODE">PROGRESS_ENABLING_DFU_MODE</a></code></td>
<td class="colLast"><code>-3</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_STARTING">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_STARTING">PROGRESS_STARTING</a></code></td>
<td class="colLast"><code>-2</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.PROGRESS_VALIDATING">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_VALIDATING">PROGRESS_VALIDATING</a></code></td>
<td class="colLast"><code>-4</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.STATE_CLOSED">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CLOSED">STATE_CLOSED</a></code></td>
<td class="colLast"><code>-5</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.STATE_CONNECTED">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CONNECTED">STATE_CONNECTED</a></code></td>
<td class="colLast"><code>-2</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.STATE_CONNECTED_AND_READY">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CONNECTED_AND_READY">STATE_CONNECTED_AND_READY</a></code></td>
<td class="colLast"><code>-3</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.STATE_CONNECTING">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CONNECTING">STATE_CONNECTING</a></code></td>
<td class="colLast"><code>-1</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.STATE_DISCONNECTED">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#STATE_DISCONNECTED">STATE_DISCONNECTED</a></code></td>
<td class="colLast"><code>0</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.STATE_DISCONNECTING">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#STATE_DISCONNECTING">STATE_DISCONNECTING</a></code></td>
<td class="colLast"><code>-4</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.TYPE_APPLICATION">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_APPLICATION">TYPE_APPLICATION</a></code></td>
<td class="colLast"><code>4</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.TYPE_AUTO">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_AUTO">TYPE_AUTO</a></code></td>
<td class="colLast"><code>0</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.TYPE_BOOTLOADER">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_BOOTLOADER">TYPE_BOOTLOADER</a></code></td>
<td class="colLast"><code>2</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuBaseService.TYPE_SOFT_DEVICE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
@ -729,6 +750,25 @@
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>no.nordicsemi.android.dfu.<a href="no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuServiceInitiator.DEFAULT_PRN_VALUE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuServiceInitiator.html#DEFAULT_PRN_VALUE">DEFAULT_PRN_VALUE</a></code></td>
<td class="colLast"><code>12</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>no.nordicsemi.android.dfu.<a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu">DfuSettingsConstants</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@ -765,6 +805,13 @@
<td class="colLast"><code>"settings_number_of_packets"</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS_DEFAULT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS_DEFAULT">SETTINGS_NUMBER_OF_PACKETS_DEFAULT</a></code></td>
<td class="colLast"><code>12</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>

16
documentation/javadoc/deprecated-list.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>Deprecated List</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@ -105,6 +105,18 @@
<tr class="rowColor">
<td class="colOne"><a href="no/nordicsemi/android/dfu/DfuBaseService.html#DFU_STATUS_SUCCESS">no.nordicsemi.android.dfu.DfuBaseService.DFU_STATUS_SUCCESS</a></td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_ASSUME_DFU_NODE">no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_ASSUME_DFU_NODE</a></td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS">no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS</a></td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS_DEFAULT">no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS_DEFAULT</a></td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED">no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</a></td>
</tr>
</tbody>
</table>
</li>

26
documentation/javadoc/index-files/index-16.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>S-Index</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@ -115,6 +115,11 @@
<dd>
<div class="block">Sets whether the progress notification in the status bar should be disabled.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setForceDfu-boolean-">setForceDfu(boolean)</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></dt>
<dd>
<div class="block">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!).</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-android.net.Uri-">setInitFile(Uri)</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></dt>
<dd>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
@ -135,9 +140,18 @@
<dd>
<div class="block">Sets whether the bond information should be preserver after flashing new application.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsEnabled-boolean-">setPacketsReceiptNotificationsEnabled(boolean)</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></dt>
<dd>
<div class="block">Enables or disables the Packet Receipt Notification (PRN) procedure.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsValue-int-">setPacketsReceiptNotificationsValue(int)</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></dt>
<dd>
<div class="block">If Packet Receipt Notification procedure is enabled, this method sets number of packets to be sent before
receiving a PRN.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_ASSUME_DFU_NODE">SETTINGS_ASSUME_DFU_NODE</a></span> - Static variable in interface no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu">DfuSettingsConstants</a></dt>
<dd>
<div class="block">This property must contain a boolean value.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_DEFAULT_MBR_SIZE">SETTINGS_DEFAULT_MBR_SIZE</a></span> - Static variable in interface no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu">DfuSettingsConstants</a></dt>
<dd>
@ -149,15 +163,15 @@
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS">SETTINGS_NUMBER_OF_PACKETS</a></span> - Static variable in interface no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu">DfuSettingsConstants</a></dt>
<dd>
<div class="block">This property must contain a positive integer value, usually from range 1-200.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS_DEFAULT">SETTINGS_NUMBER_OF_PACKETS_DEFAULT</a></span> - Static variable in interface no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu">DfuSettingsConstants</a></dt>
<dd>
<div class="block">The default value of <a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS"><code>DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS</code></a> property.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED">SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</a></span> - Static variable in interface no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuSettingsConstants.html" title="interface in no.nordicsemi.android.dfu">DfuSettingsConstants</a></dt>
<dd>
<div class="block">This property must contain a boolean value.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setZip-android.net.Uri-">setZip(Uri)</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></dt>
<dd>

6
documentation/javadoc/index-files/index-4.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>D-Index</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@ -79,6 +79,8 @@
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/BuildConfig.html#DEBUG">DEBUG</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/BuildConfig.html" title="class in no.nordicsemi.android.dfu">BuildConfig</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html#DEFAULT_PRN_VALUE">DEFAULT_PRN_VALUE</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../no/nordicsemi/android/dfu/internal/exception/DeviceDisconnectedException.html" title="class in no.nordicsemi.android.dfu.internal.exception"><span class="typeNameLink">DeviceDisconnectedException</span></a> - Exception in <a href="../no/nordicsemi/android/dfu/internal/exception/package-summary.html">no.nordicsemi.android.dfu.internal.exception</a></dt>
<dd>
<div class="block">Device has disconnected.</div>

16
documentation/javadoc/index-files/index-5.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>E-Index</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@ -200,6 +200,10 @@
<dd>
<div class="block">See <a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_FILE_PATH"><code>DfuBaseService.EXTRA_FILE_PATH</code></a> for details.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_FORCE_DFU">EXTRA_FORCE_DFU</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>
<div class="block">This property must contain a boolean value.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_PATH">EXTRA_INIT_FILE_PATH</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>
<div class="block">The Init packet URI.</div>
@ -220,6 +224,14 @@
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_LOG_MESSAGE">EXTRA_LOG_MESSAGE</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED">EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>
<div class="block">This property must contain a boolean value.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE">EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>
<div class="block">This property must contain a positive integer value, usually from range 1-200.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PART_CURRENT">EXTRA_PART_CURRENT</a></span> - Static variable in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>
<div class="block">The number of currently transferred part.</div>

6
documentation/javadoc/index-files/index-9.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>I-Index</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@ -97,7 +97,7 @@
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuBaseService.html#isDebug--">isDebug()</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a></dt>
<dd>
<div class="block">Using this method you may enable detail debug LogCat logs from DFU.</div>
<div class="block">Override this method to enable detailed debug LogCat logs with DFU events.</div>
</dd>
<dt><span class="memberNameLink"><a href="../no/nordicsemi/android/dfu/DfuServiceController.html#isPaused--">isPaused()</a></span> - Method in class no.nordicsemi.android.dfu.<a href="../no/nordicsemi/android/dfu/DfuServiceController.html" title="class in no.nordicsemi.android.dfu">DfuServiceController</a></dt>
<dd>

161
documentation/javadoc/no/nordicsemi/android/dfu/DfuBaseService.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>DfuBaseService</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@ -464,209 +464,227 @@ extends android.app.IntentService</pre>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_FORCE_DFU">EXTRA_FORCE_DFU</a></span></code>
<div class="block">This property must contain a boolean value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_PATH">EXTRA_INIT_FILE_PATH</a></span></code>
<div class="block">The Init packet URI.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_RES_ID">EXTRA_INIT_FILE_RES_ID</a></span></code>
<div class="block">The Init packet URI.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_INIT_FILE_URI">EXTRA_INIT_FILE_URI</a></span></code>
<div class="block">The Init packet URI.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_KEEP_BOND">EXTRA_KEEP_BOND</a></span></code>
<div class="block">This flag indicated whether the bond information should be kept or removed after an upgrade of the Application.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_LOG_LEVEL">EXTRA_LOG_LEVEL</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_LOG_MESSAGE">EXTRA_LOG_MESSAGE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED">EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED</a></span></code>
<div class="block">This property must contain a boolean value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE">EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</a></span></code>
<div class="block">This property must contain a positive integer value, usually from range 1-200.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PART_CURRENT">EXTRA_PART_CURRENT</a></span></code>
<div class="block">The number of currently transferred part.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PARTS_TOTAL">EXTRA_PARTS_TOTAL</a></span></code>
<div class="block">Number of parts in total.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PROGRESS">EXTRA_PROGRESS</a></span></code>
<div class="block">An extra field to send the progress or error information in the DFU notification.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_RESTORE_BOND">EXTRA_RESTORE_BOND</a></span></code>
<div class="block">
If the new firmware (application) does not share the bond information with the old one, the bond information is lost.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_SPEED_B_PER_MS">EXTRA_SPEED_B_PER_MS</a></span></code>
<div class="block">The current upload speed in bytes/millisecond.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_APPLICATION">LOG_LEVEL_APPLICATION</a></span></code>
<div class="block">Log entries level for applications</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_DEBUG">LOG_LEVEL_DEBUG</a></span></code>
<div class="block">Level used just for debugging purposes.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_ERROR">LOG_LEVEL_ERROR</a></span></code>
<div class="block">Log entries with very high importance, like errors</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_INFO">LOG_LEVEL_INFO</a></span></code>
<div class="block">Default logging level for important entries</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_VERBOSE">LOG_LEVEL_VERBOSE</a></span></code>
<div class="block">Log entries with minor importance</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#LOG_LEVEL_WARNING">LOG_LEVEL_WARNING</a></span></code>
<div class="block">Log entries with high importance</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#mConnectionState">mConnectionState</a></span></code>
<div class="block">The current connection state.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#MIME_TYPE_OCTET_STREAM">MIME_TYPE_OCTET_STREAM</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#MIME_TYPE_ZIP">MIME_TYPE_ZIP</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#NOTIFICATION_ID">NOTIFICATION_ID</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_ABORTED">PROGRESS_ABORTED</a></span></code>
<div class="block">The upload has been aborted.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_COMPLETED">PROGRESS_COMPLETED</a></span></code>
<div class="block">The connection is successful.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_CONNECTING">PROGRESS_CONNECTING</a></span></code>
<div class="block">Service is connecting to the remote DFU target.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_DISCONNECTING">PROGRESS_DISCONNECTING</a></span></code>
<div class="block">Service is disconnecting from the DFU target.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_ENABLING_DFU_MODE">PROGRESS_ENABLING_DFU_MODE</a></span></code>
<div class="block">Service has triggered a switch to bootloader mode.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_STARTING">PROGRESS_STARTING</a></span></code>
<div class="block">Service is enabling notifications and starting transmission.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#PROGRESS_VALIDATING">PROGRESS_VALIDATING</a></span></code>
<div class="block">Service is sending validation request to the remote DFU target.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CLOSED">STATE_CLOSED</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CONNECTED">STATE_CONNECTED</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CONNECTED_AND_READY">STATE_CONNECTED_AND_READY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#STATE_CONNECTING">STATE_CONNECTING</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#STATE_DISCONNECTED">STATE_DISCONNECTED</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#STATE_DISCONNECTING">STATE_DISCONNECTING</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_APPLICATION">TYPE_APPLICATION</a></span></code>
<div class="block">
The file contains a new version of Application.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_AUTO">TYPE_AUTO</a></span></code>
<div class="block">
A ZIP file that consists of more than 1 file.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_BOOTLOADER">TYPE_BOOTLOADER</a></span></code>
<div class="block">
The file contains a new version of Bootloader.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#TYPE_SOFT_DEVICE">TYPE_SOFT_DEVICE</a></span></code>
<div class="block">
@ -753,7 +771,7 @@ extends android.app.IntentService</pre>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#isDebug--">isDebug</a></span>()</code>
<div class="block">Using this method you may enable detail debug LogCat logs from DFU.</div>
<div class="block">Override this method to enable detailed debug LogCat logs with DFU events.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
@ -955,6 +973,69 @@ extends android.app.IntentService</pre>
</dl>
</li>
</ul>
<a name="EXTRA_FORCE_DFU">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXTRA_FORCE_DFU</h4>
<pre>public static final&nbsp;java.lang.String EXTRA_FORCE_DFU</pre>
<div class="block">This property must contain a boolean value.
<p>The <a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu"><code>DfuBaseService</code></a>, when connected to a DFU target will check whether it is in application or in DFU bootloader mode. For DFU implementations from SDK 7.0 or newer
this is done by reading the value of DFU Version characteristic. If the returned value is equal to 0x0100 (major = 0, minor = 1) it means that we are in the application mode and
jump to the bootloader mode is required.
<p>However, for DFU implementations from older SDKs, where there was no DFU Version characteristic, the service must guess. If this option is set to false (default) it will count
number of device's services. If the count is equal to 3 (Generic Access, Generic Attribute, DFU Service) it will assume that it's in DFU mode. If greater than 3 - in app mode.
This guessing may not be always correct. One situation may be when the nRF chip is used to flash update on external MCU using DFU. The DFU procedure may be implemented in the
application, which may (and usually does) have more services. In such case set the value of this property to true.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuBaseService.EXTRA_FORCE_DFU">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED</h4>
<pre>public static final&nbsp;java.lang.String EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED</pre>
<div class="block">This property must contain a boolean value.
<p>If true the Packet Receipt Notification procedure will be enabled. See DFU documentation on http://infocenter.nordicsemi.com for more details.
The number of packets before receiving a Packet Receipt Notification is set with property <a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE"><code>EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</code></a>.
The PRNs by default are enabled on devices running Android 4.3, 4.4.x and 5.x and disabled on 6.x and newer.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE"><code>EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</code></a>,
<a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</h4>
<pre>public static final&nbsp;java.lang.String EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE</pre>
<div class="block">This property must contain a positive integer value, usually from range 1-200.
<p>The default value is . Setting it to 0 will disable the Packet Receipt Notification procedure.
When sending a firmware using the DFU procedure the service will send this number of packets before waiting for a notification.
Packet Receipt Notifications are used to synchronize the sender with receiver.
<p>On Android, calling <code>BluetoothGatt.writeCharacteristic(BluetoothGattCharacteristic)</code>
simply adds the packet to outgoing queue before returning the callback. Adding the next packet in the callback is much faster than the real transmission
(also the speed depends on the device chip manufacturer) and the queue may reach its limit. When does, the transmission stops and Android Bluetooth hangs (see Note below).
Using PRN procedure eliminates this problem as the notification is send when all packets were delivered the queue is empty.
<p>Note: this bug has been fixed on Android 6.0 Marshmallow and now no notifications are required. The onCharacteristicWrite callback will be
postponed until half of the queue is empty and upload will be resumed automatically. Disabling PRNs speeds up the upload process on those devices.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html#EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED"><code>EXTRA_PACKET_RECEIPT_NOTIFICATIONS_ENABLED</code></a>,
<a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuBaseService.EXTRA_PACKET_RECEIPT_NOTIFICATIONS_VALUE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXTRA_FILE_PATH">
<!-- -->
</a>
@ -2378,7 +2459,7 @@ public static final&nbsp;int DFU_STATUS_OPERATION_FAILED</pre>
<li class="blockList">
<h4>isDebug</h4>
<pre>protected&nbsp;boolean&nbsp;isDebug()</pre>
<div class="block">Using this method you may enable detail debug LogCat logs from DFU.
<div class="block">Override this method to enable detailed debug LogCat logs with DFU events.
<p>Recommended use:</p>
<pre>
&#64;Override

173
documentation/javadoc/no/nordicsemi/android/dfu/DfuServiceInitiator.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>DfuServiceInitiator</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":10,"i5":10,"i6":42,"i7":42,"i8":42,"i9":42,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":10,"i5":10,"i6":10,"i7":42,"i8":42,"i9":42,"i10":42,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@ -74,13 +74,13 @@ var activeTableTab = "activeTableTab";
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
@ -118,6 +118,25 @@ extends java.lang.Object</pre>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#DEFAULT_PRN_VALUE">DEFAULT_PRN_VALUE</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
@ -194,61 +213,81 @@ extends java.lang.Object</pre>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-int-">setInitFile</a></span>(int&nbsp;initFileResId)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setForceDfu-boolean-">setForceDfu</a></span>(boolean&nbsp;force)</code>
<div class="block">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!).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-java.lang.String-">setInitFile</a></span>(java.lang.String&nbsp;initFilePath)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-int-">setInitFile</a></span>(int&nbsp;initFileResId)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-android.net.Uri-">setInitFile</a></span>(android.net.Uri&nbsp;initFileUri)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-java.lang.String-">setInitFile</a></span>(java.lang.String&nbsp;initFilePath)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-android.net.Uri-">setInitFile</a></span>(android.net.Uri&nbsp;initFileUri)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setInitFile-android.net.Uri-java.lang.String-">setInitFile</a></span>(android.net.Uri&nbsp;initFileUri,
java.lang.String&nbsp;initFilePath)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i10" class="altColor">
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setKeepBond-boolean-">setKeepBond</a></span>(boolean&nbsp;keepBond)</code>
<div class="block">Sets whether the bond information should be preserver after flashing new application.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsEnabled-boolean-">setPacketsReceiptNotificationsEnabled</a></span>(boolean&nbsp;enabled)</code>
<div class="block">Enables or disables the Packet Receipt Notification (PRN) procedure.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsValue-int-">setPacketsReceiptNotificationsValue</a></span>(int&nbsp;number)</code>
<div class="block">If Packet Receipt Notification procedure is enabled, this method sets number of packets to be sent before
receiving a PRN.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setZip-int-">setZip</a></span>(int&nbsp;rawResId)</code>
<div class="block">Sets the resource ID of the Distribution packet (ZIP) or the a ZIP file matching the deprecated naming convention.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setZip-java.lang.String-">setZip</a></span>(java.lang.String&nbsp;path)</code>
<div class="block">Sets the path to the Distribution packet (ZIP) or the a ZIP file matching the deprecated naming convention.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setZip-android.net.Uri-">setZip</a></span>(android.net.Uri&nbsp;uri)</code>
<div class="block">Sets the URI to the Distribution packet (ZIP) or to a ZIP file matching the deprecated naming convention.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setZip-android.net.Uri-java.lang.String-">setZip</a></span>(android.net.Uri&nbsp;uri,
java.lang.String&nbsp;path)</code>
<div class="block">Sets the URI or path of the ZIP file.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../no/nordicsemi/android/dfu/DfuServiceController.html" title="class in no.nordicsemi.android.dfu">DfuServiceController</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#start-android.content.Context-java.lang.Class-">start</a></span>(android.content.Context&nbsp;context,
java.lang.Class&lt;? extends <a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu">DfuBaseService</a>&gt;&nbsp;service)</code>
@ -271,6 +310,27 @@ extends java.lang.Object</pre>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_PRN_VALUE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_PRN_VALUE</h4>
<pre>public static final&nbsp;int DEFAULT_PRN_VALUE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuServiceInitiator.DEFAULT_PRN_VALUE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
@ -351,6 +411,85 @@ extends java.lang.Object</pre>
</dl>
</li>
</ul>
<a name="setPacketsReceiptNotificationsEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPacketsReceiptNotificationsEnabled</h4>
<pre>public&nbsp;<a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a>&nbsp;setPacketsReceiptNotificationsEnabled(boolean&nbsp;enabled)</pre>
<div class="block">Enables or disables the Packet Receipt Notification (PRN) procedure.
<p>By default the PRNs are disabled on devices with Android Marshmallow or newer and enabled on older ones.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabled</code> - true to enabled PRNs, false to disable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED"><code>DfuSettingsConstants.SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</code></a></dd>
</dl>
</li>
</ul>
<a name="setPacketsReceiptNotificationsValue-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPacketsReceiptNotificationsValue</h4>
<pre>public&nbsp;<a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a>&nbsp;setPacketsReceiptNotificationsValue(int&nbsp;number)</pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - number of packets to be sent before receiving a PRN. Defaulted when set to 0.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsEnabled-boolean-"><code>setPacketsReceiptNotificationsEnabled(boolean)</code></a>,
<a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS"><code>DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS</code></a></dd>
</dl>
</li>
</ul>
<a name="setForceDfu-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForceDfu</h4>
<pre>public&nbsp;<a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html" title="class in no.nordicsemi.android.dfu">DfuServiceInitiator</a>&nbsp;setForceDfu(boolean&nbsp;force)</pre>
<div class="block">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.
<p>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.</p>
<p>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).</p>
<p>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 <a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setForceDfu-boolean-"><code>setForceDfu(boolean)</code></a>
method with parameter equal to true.</p>
<p>This method is ignored in Secure DFU.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>force</code> - true to ensure the DFU will start if there is no DFU Version characteristic (Legacy DFU only)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_ASSUME_DFU_NODE"><code>DfuSettingsConstants.SETTINGS_ASSUME_DFU_NODE</code></a></dd>
</dl>
</li>
</ul>
<a name="setZip-android.net.Uri-">
<!-- -->
</a>
@ -664,13 +803,13 @@ public&nbsp;<a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.h
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>

46
documentation/javadoc/no/nordicsemi/android/dfu/DfuSettingsConstants.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
<title>DfuSettingsConstants</title>
<meta name="date" content="2016-09-23">
<meta name="date" content="2016-09-26">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@ -116,7 +116,7 @@
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_ASSUME_DFU_NODE">SETTINGS_ASSUME_DFU_NODE</a></span></code>
<div class="block">This property must contain a boolean value.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="rowColor">
@ -134,19 +134,19 @@
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS">SETTINGS_NUMBER_OF_PACKETS</a></span></code>
<div class="block">This property must contain a positive integer value, usually from range 1-200.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS_DEFAULT">SETTINGS_NUMBER_OF_PACKETS_DEFAULT</a></span></code>
<div class="block">The default value of <a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS"><code>SETTINGS_NUMBER_OF_PACKETS</code></a> property.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED">SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</a></span></code>
<div class="block">This property must contain a boolean value.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
</table>
@ -170,10 +170,14 @@
<ul class="blockList">
<li class="blockList">
<h4>SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</h4>
<pre>static final&nbsp;java.lang.String SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</pre>
<pre>@Deprecated
static final&nbsp;java.lang.String SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This property must contain a boolean value.
<p>If true (default) the Packet Receipt Notification procedure will be enabled. See DFU documentation on http://infocenter.nordicsemi.com for more details.
The number of packets before receiving a Packet Receipt Notification is set with property <a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS"><code>SETTINGS_NUMBER_OF_PACKETS</code></a>.</div>
The number of packets before receiving a Packet Receipt Notification is set with property <a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS"><code>SETTINGS_NUMBER_OF_PACKETS</code></a>.
This constant is now deprecated. Please, use <a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsEnabled-boolean-"><code>DfuServiceInitiator.setPacketsReceiptNotificationsEnabled(boolean)</code></a> to set it.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_PACKET_RECEIPT_NOTIFICATION_ENABLED">Constant Field Values</a></dd>
@ -186,16 +190,20 @@
<ul class="blockList">
<li class="blockList">
<h4>SETTINGS_NUMBER_OF_PACKETS</h4>
<pre>static final&nbsp;java.lang.String SETTINGS_NUMBER_OF_PACKETS</pre>
<pre>@Deprecated
static final&nbsp;java.lang.String SETTINGS_NUMBER_OF_PACKETS</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This property must contain a positive integer value, usually from range 1-200.
<p>The default value is . Setting it to 0 will disable the Packet Receipt Notification procedure.
<p>The default value is <a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS_DEFAULT">12</a>. Setting it to 0 will disable the Packet Receipt Notification procedure.
When sending a firmware using the DFU procedure the service will send this number of packets before waiting for a notification.
Packet Receipt Notifications are used to synchronize the sender with receiver. On Android, calling <code>BluetoothGatt.writeCharacteristic(BluetoothGattCharacteristic)</code>
will simply add the packet to outgoing queue before returning the callback. Adding the next packet in the callback is much faster than the real transmission (also the speed depends on
the device chip manufacturer) and the queue may reach its limit. When does, the transmission stops and Android Bluetooth hangs. Using PRN procedure eliminates this problem as
the notification is send when all packets were delivered the queue is empty.
<p>Note: this bug has been fixed on Android 6.0 Marshmallow and now no notifications are required. The onCharacteristicWrite callback will be
postponed until half of the queue is empty.</div>
postponed until half of the queue is empty.
This constant is now deprecated. Please, use <a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsValue-int-"><code>DfuServiceInitiator.setPacketsReceiptNotificationsValue(int)</code></a> to set it.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS">Constant Field Values</a></dd>
@ -208,7 +216,9 @@
<ul class="blockList">
<li class="blockList">
<h4>SETTINGS_NUMBER_OF_PACKETS_DEFAULT</h4>
<pre>static final&nbsp;int SETTINGS_NUMBER_OF_PACKETS_DEFAULT</pre>
<pre>@Deprecated
static final&nbsp;int SETTINGS_NUMBER_OF_PACKETS_DEFAULT</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">The default value of <a href="../../../../no/nordicsemi/android/dfu/DfuSettingsConstants.html#SETTINGS_NUMBER_OF_PACKETS"><code>SETTINGS_NUMBER_OF_PACKETS</code></a> property. Different phones sent a different number of packets each connection interval. The values are (for tested phones):
<ul>
<li>1 packet - Nexus 4 and Nexus 7 and others</li>
@ -216,7 +226,13 @@
<li>6 packets - LG F60 and others</li>
</ul>
The least common multiplier is 12 which is reasonably small. You may try other values, like 24 etc.
Values higher than ~300 may cause the Bluetooth outgoing queue overflow error on Android versions before Marshmallow.</div>
Values higher than ~300 may cause the Bluetooth outgoing queue overflow error on Android versions before Marshmallow.
This constant is now deprecated. Please, use <a href="../../../../no/nordicsemi/android/dfu/DfuServiceInitiator.html#setPacketsReceiptNotificationsValue-int-"><code>DfuServiceInitiator.setPacketsReceiptNotificationsValue(int)</code></a> to set it.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#no.nordicsemi.android.dfu.DfuSettingsConstants.SETTINGS_NUMBER_OF_PACKETS_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SETTINGS_MBR_SIZE">
@ -258,7 +274,9 @@
<ul class="blockListLast">
<li class="blockList">
<h4>SETTINGS_ASSUME_DFU_NODE</h4>
<pre>static final&nbsp;java.lang.String SETTINGS_ASSUME_DFU_NODE</pre>
<pre>@Deprecated
static final&nbsp;java.lang.String SETTINGS_ASSUME_DFU_NODE</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This property must contain a boolean value.
<p>The <a href="../../../../no/nordicsemi/android/dfu/DfuBaseService.html" title="class in no.nordicsemi.android.dfu"><code>DfuBaseService</code></a>, when connected to a DFU target will check whether it is in application or in DFU bootloader mode. For DFU implementations from SDK 7.0 or newer
this is done by reading the value of DFU Version characteristic. If the returned value is equal to 0x0100 (major = 0, minor = 1) it means that we are in the application mode and