Skip to content

Commit 9cd78d0

Browse files
philips77philips77
committed
Documentation updated
1 parent 08e2cb3 commit 9cd78d0

File tree

10 files changed

+450
-125
lines changed

10 files changed

+450
-125
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
The compat library may be found on jcenter and Maven Central repository. Add it to your project by adding the following dependency:
88

99
```Groovy
10-
compile 'no.nordicsemi.android:dfu:1.0.3'
10+
compile 'no.nordicsemi.android:dfu:1.0.4'
1111
```
1212

1313
If you use proguard, add the following line to your proguard rules:

‎documentation/javadoc/constant-values.html

Lines changed: 86 additions & 39 deletions
Large diffs are not rendered by default.

‎documentation/javadoc/deprecated-list.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
66
<title>Deprecated List</title>
7-
<meta name="date" content="2016-09-23">
7+
<meta name="date" content="2016-09-26">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -105,6 +105,18 @@ <h2 title="Contents">Contents</h2>
105105
<tr class="rowColor">
106106
<td class="colOne"><a href="no/nordicsemi/android/dfu/DfuBaseService.html#DFU_STATUS_SUCCESS">no.nordicsemi.android.dfu.DfuBaseService.DFU_STATUS_SUCCESS</a></td>
107107
</tr>
108+
<tr class="altColor">
109+
<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>
110+
</tr>
111+
<tr class="rowColor">
112+
<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>
113+
</tr>
114+
<tr class="altColor">
115+
<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>
116+
</tr>
117+
<tr class="rowColor">
118+
<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>
119+
</tr>
108120
</tbody>
109121
</table>
110122
</li>

‎documentation/javadoc/index-files/index-16.html

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
66
<title>S-Index</title>
7-
<meta name="date" content="2016-09-23">
7+
<meta name="date" content="2016-09-26">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -115,6 +115,11 @@ <h2 class="title">S</h2>
115115
<dd>
116116
<div class="block">Sets whether the progress notification in the status bar should be disabled.</div>
117117
</dd>
118+
<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>
119+
<dd>
120+
<div class="block">Setting force DFU to true will prevent from jumping to the DFU Bootloader
121+
mode in case there is no DFU Version characteristic (Legacy DFU only!).</div>
122+
</dd>
118123
<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>
119124
<dd>
120125
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
@@ -135,9 +140,18 @@ <h2 class="title">S</h2>
135140
<dd>
136141
<div class="block">Sets whether the bond information should be preserver after flashing new application.</div>
137142
</dd>
143+
<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>
144+
<dd>
145+
<div class="block">Enables or disables the Packet Receipt Notification (PRN) procedure.</div>
146+
</dd>
147+
<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>
148+
<dd>
149+
<div class="block">If Packet Receipt Notification procedure is enabled, this method sets number of packets to be sent before
150+
receiving a PRN.</div>
151+
</dd>
138152
<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>
139153
<dd>
140-
<div class="block">This property must contain a boolean value.</div>
154+
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
141155
</dd>
142156
<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>
143157
<dd>
@@ -149,15 +163,15 @@ <h2 class="title">S</h2>
149163
</dd>
150164
<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>
151165
<dd>
152-
<div class="block">This property must contain a positive integer value, usually from range 1-200.</div>
166+
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
153167
</dd>
154168
<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>
155169
<dd>
156-
<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>
170+
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
157171
</dd>
158172
<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>
159173
<dd>
160-
<div class="block">This property must contain a boolean value.</div>
174+
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
161175
</dd>
162176
<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>
163177
<dd>

‎documentation/javadoc/index-files/index-4.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
66
<title>D-Index</title>
7-
<meta name="date" content="2016-09-23">
7+
<meta name="date" content="2016-09-26">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -79,6 +79,8 @@ <h2 class="title">D</h2>
7979
<dd>&nbsp;</dd>
8080
<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>
8181
<dd>&nbsp;</dd>
82+
<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>
83+
<dd>&nbsp;</dd>
8284
<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>
8385
<dd>
8486
<div class="block">Device has disconnected.</div>

‎documentation/javadoc/index-files/index-5.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
66
<title>E-Index</title>
7-
<meta name="date" content="2016-09-23">
7+
<meta name="date" content="2016-09-26">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -200,6 +200,10 @@ <h2 class="title">E</h2>
200200
<dd>
201201
<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>
202202
</dd>
203+
<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>
204+
<dd>
205+
<div class="block">This property must contain a boolean value.</div>
206+
</dd>
203207
<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>
204208
<dd>
205209
<div class="block">The Init packet URI.</div>
@@ -220,6 +224,14 @@ <h2 class="title">E</h2>
220224
<dd>&nbsp;</dd>
221225
<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>
222226
<dd>&nbsp;</dd>
227+
<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>
228+
<dd>
229+
<div class="block">This property must contain a boolean value.</div>
230+
</dd>
231+
<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>
232+
<dd>
233+
<div class="block">This property must contain a positive integer value, usually from range 1-200.</div>
234+
</dd>
223235
<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>
224236
<dd>
225237
<div class="block">The number of currently transferred part.</div>

‎documentation/javadoc/index-files/index-9.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Sep 23 12:39:49 CEST 2016 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Mon Sep 26 16:16:36 CEST 2016 -->
66
<title>I-Index</title>
7-
<meta name="date" content="2016-09-23">
7+
<meta name="date" content="2016-09-26">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -97,7 +97,7 @@ <h2 class="title">I</h2>
9797
</dd>
9898
<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>
9999
<dd>
100-
<div class="block">Using this method you may enable detail debug LogCat logs from DFU.</div>
100+
<div class="block">Override this method to enable detailed debug LogCat logs with DFU events.</div>
101101
</dd>
102102
<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>
103103
<dd>

0 commit comments

Comments
 (0)