particle-api-js 9.0.0 → 9.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/particle.min.js +86 -89
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +154 -99
- package/lib/EventStream.js +0 -1
- package/lib/EventStream.js.map +1 -1
- package/lib/Particle.js +711 -610
- package/lib/Particle.js.map +1 -1
- package/package.json +2 -4
- package/test/EventStream.spec.js +0 -1
- package/test/Particle.spec.js +100 -4
package/docs/api.md
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
- [resetPassword](#resetpassword)
|
|
17
17
|
- [deleteAccessToken](#deleteaccesstoken)
|
|
18
18
|
- [deleteCurrentAccessToken](#deletecurrentaccesstoken)
|
|
19
|
+
- [deleteActiveAccessTokens](#deleteactiveaccesstokens)
|
|
19
20
|
- [deleteUser](#deleteuser)
|
|
20
21
|
- [listAccessTokens](#listaccesstokens)
|
|
21
22
|
- [trackingIdentity](#trackingidentity)
|
|
@@ -97,6 +98,8 @@
|
|
|
97
98
|
- [listMeshNetworkDevices](#listmeshnetworkdevices)
|
|
98
99
|
- [getProductConfiguration](#getproductconfiguration)
|
|
99
100
|
- [getProductConfigurationSchema](#getproductconfigurationschema)
|
|
101
|
+
- [getProductDeviceConfiguration](#getproductdeviceconfiguration)
|
|
102
|
+
- [getProductDeviceConfigurationSchema](#getproductdeviceconfigurationschema)
|
|
100
103
|
- [setProductConfiguration](#setproductconfiguration)
|
|
101
104
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration)
|
|
102
105
|
- [getProductLocations](#getproductlocations)
|
|
@@ -104,7 +107,7 @@
|
|
|
104
107
|
|
|
105
108
|
## Particle
|
|
106
109
|
|
|
107
|
-
[src/Particle.js:17-
|
|
110
|
+
[src/Particle.js:17-2147](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L17-L2147 "Source code on GitHub")
|
|
108
111
|
|
|
109
112
|
Particle Cloud API wrapper.
|
|
110
113
|
|
|
@@ -120,7 +123,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
120
123
|
|
|
121
124
|
### constructor
|
|
122
125
|
|
|
123
|
-
[src/Particle.js:25-30](https://github.com/
|
|
126
|
+
[src/Particle.js:25-30](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L25-L30 "Source code on GitHub")
|
|
124
127
|
|
|
125
128
|
Contructor for the Cloud API wrapper.
|
|
126
129
|
|
|
@@ -132,7 +135,7 @@ Create a new Particle object and call methods below on it.
|
|
|
132
135
|
|
|
133
136
|
### login
|
|
134
137
|
|
|
135
|
-
[src/Particle.js:66-81](https://github.com/
|
|
138
|
+
[src/Particle.js:66-81](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L66-L81 "Source code on GitHub")
|
|
136
139
|
|
|
137
140
|
Login to Particle Cloud using an existing Particle acccount.
|
|
138
141
|
|
|
@@ -149,7 +152,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
149
152
|
|
|
150
153
|
### sendOtp
|
|
151
154
|
|
|
152
|
-
[src/Particle.js:92-106](https://github.com/
|
|
155
|
+
[src/Particle.js:92-106](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L92-L106 "Source code on GitHub")
|
|
153
156
|
|
|
154
157
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
155
158
|
|
|
@@ -165,7 +168,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
165
168
|
|
|
166
169
|
### enableMfa
|
|
167
170
|
|
|
168
|
-
[src/Particle.js:116-118](https://github.com/
|
|
171
|
+
[src/Particle.js:116-118](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L116-L118 "Source code on GitHub")
|
|
169
172
|
|
|
170
173
|
Enable MFA on the currently logged in user
|
|
171
174
|
|
|
@@ -180,7 +183,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
180
183
|
|
|
181
184
|
### confirmMfa
|
|
182
185
|
|
|
183
|
-
[src/Particle.js:
|
|
186
|
+
[src/Particle.js:131-145](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L131-L145 "Source code on GitHub")
|
|
184
187
|
|
|
185
188
|
Confirm MFA for the user. This must be called with current TOTP code, determined from the results of enableMfa(). You will be prompted to enter an OTP code every time you login after enrollment is confirmed.
|
|
186
189
|
|
|
@@ -189,6 +192,7 @@ Confirm MFA for the user. This must be called with current TOTP code, determined
|
|
|
189
192
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
190
193
|
- `options.mfaToken` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Token given from previous step to
|
|
191
194
|
- `options.otp` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Current one-time-password generated from the authentication app
|
|
195
|
+
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
192
196
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
193
197
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
194
198
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -197,7 +201,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
197
201
|
|
|
198
202
|
### disableMfa
|
|
199
203
|
|
|
200
|
-
[src/Particle.js:
|
|
204
|
+
[src/Particle.js:156-164](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L156-L164 "Source code on GitHub")
|
|
201
205
|
|
|
202
206
|
Disable MFA for the user.
|
|
203
207
|
|
|
@@ -213,7 +217,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
213
217
|
|
|
214
218
|
### createCustomer
|
|
215
219
|
|
|
216
|
-
[src/Particle.js:
|
|
220
|
+
[src/Particle.js:176-190](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L176-L190 "Source code on GitHub")
|
|
217
221
|
|
|
218
222
|
Create Customer for Product.
|
|
219
223
|
|
|
@@ -230,7 +234,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
230
234
|
|
|
231
235
|
### loginAsClientOwner
|
|
232
236
|
|
|
233
|
-
[src/Particle.js:
|
|
237
|
+
[src/Particle.js:199-211](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L199-L211 "Source code on GitHub")
|
|
234
238
|
|
|
235
239
|
Login to Particle Cloud using an OAuth client.
|
|
236
240
|
|
|
@@ -244,7 +248,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
244
248
|
|
|
245
249
|
### createUser
|
|
246
250
|
|
|
247
|
-
[src/Particle.js:
|
|
251
|
+
[src/Particle.js:223-234](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L223-L234 "Source code on GitHub")
|
|
248
252
|
|
|
249
253
|
Create a user account for the Particle Cloud
|
|
250
254
|
|
|
@@ -261,7 +265,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
261
265
|
|
|
262
266
|
### verifyUser
|
|
263
267
|
|
|
264
|
-
[src/Particle.js:
|
|
268
|
+
[src/Particle.js:244-251](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L244-L251 "Source code on GitHub")
|
|
265
269
|
|
|
266
270
|
Verify new user account via verification email
|
|
267
271
|
|
|
@@ -276,7 +280,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
276
280
|
|
|
277
281
|
### resetPassword
|
|
278
282
|
|
|
279
|
-
[src/Particle.js:
|
|
283
|
+
[src/Particle.js:261-268](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L261-L268 "Source code on GitHub")
|
|
280
284
|
|
|
281
285
|
Send reset password email for a Particle Cloud user account
|
|
282
286
|
|
|
@@ -291,7 +295,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
291
295
|
|
|
292
296
|
### deleteAccessToken
|
|
293
297
|
|
|
294
|
-
[src/Particle.js:
|
|
298
|
+
[src/Particle.js:280-288](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L280-L288 "Source code on GitHub")
|
|
295
299
|
|
|
296
300
|
Revoke an access token
|
|
297
301
|
|
|
@@ -308,7 +312,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
308
312
|
|
|
309
313
|
### deleteCurrentAccessToken
|
|
310
314
|
|
|
311
|
-
[src/Particle.js:
|
|
315
|
+
[src/Particle.js:298-305](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L298-L305 "Source code on GitHub")
|
|
312
316
|
|
|
313
317
|
Revoke the current session access token
|
|
314
318
|
|
|
@@ -321,9 +325,24 @@ Revoke the current session access token
|
|
|
321
325
|
|
|
322
326
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
323
327
|
|
|
328
|
+
### deleteActiveAccessTokens
|
|
329
|
+
|
|
330
|
+
[src/Particle.js:315-322](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L315-L322 "Source code on GitHub")
|
|
331
|
+
|
|
332
|
+
Revoke all active access tokens
|
|
333
|
+
|
|
334
|
+
**Parameters**
|
|
335
|
+
|
|
336
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
337
|
+
- `options.auth` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access Token
|
|
338
|
+
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
339
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
340
|
+
|
|
341
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
342
|
+
|
|
324
343
|
### deleteUser
|
|
325
344
|
|
|
326
|
-
[src/Particle.js:
|
|
345
|
+
[src/Particle.js:333-341](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L333-L341 "Source code on GitHub")
|
|
327
346
|
|
|
328
347
|
Delete the current user
|
|
329
348
|
|
|
@@ -339,7 +358,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
339
358
|
|
|
340
359
|
### listAccessTokens
|
|
341
360
|
|
|
342
|
-
[src/Particle.js:
|
|
361
|
+
[src/Particle.js:353-361](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L353-L361 "Source code on GitHub")
|
|
343
362
|
|
|
344
363
|
List all valid access tokens for a Particle Cloud account
|
|
345
364
|
|
|
@@ -348,6 +367,7 @@ List all valid access tokens for a Particle Cloud account
|
|
|
348
367
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
349
368
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username
|
|
350
369
|
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
|
|
370
|
+
- `options.otp` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current one-time-password generated from the authentication application
|
|
351
371
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
352
372
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
353
373
|
|
|
@@ -355,7 +375,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
355
375
|
|
|
356
376
|
### trackingIdentity
|
|
357
377
|
|
|
358
|
-
[src/Particle.js:
|
|
378
|
+
[src/Particle.js:373-381](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L373-L381 "Source code on GitHub")
|
|
359
379
|
|
|
360
380
|
Retrieves the information that is used to identify the current login for tracking.
|
|
361
381
|
|
|
@@ -372,7 +392,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
372
392
|
|
|
373
393
|
### listDevices
|
|
374
394
|
|
|
375
|
-
[src/Particle.js:
|
|
395
|
+
[src/Particle.js:399-411](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L399-L411 "Source code on GitHub")
|
|
376
396
|
|
|
377
397
|
List devices claimed to the account or product
|
|
378
398
|
|
|
@@ -395,7 +415,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
395
415
|
|
|
396
416
|
### getDevice
|
|
397
417
|
|
|
398
|
-
[src/Particle.js:
|
|
418
|
+
[src/Particle.js:423-426](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L423-L426 "Source code on GitHub")
|
|
399
419
|
|
|
400
420
|
Get detailed informationa about a device
|
|
401
421
|
|
|
@@ -412,7 +432,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
412
432
|
|
|
413
433
|
### claimDevice
|
|
414
434
|
|
|
415
|
-
[src/Particle.js:
|
|
435
|
+
[src/Particle.js:437-448](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L437-L448 "Source code on GitHub")
|
|
416
436
|
|
|
417
437
|
Claim a device to the account. The device must be online and unclaimed.
|
|
418
438
|
|
|
@@ -429,7 +449,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
429
449
|
|
|
430
450
|
### addDeviceToProduct
|
|
431
451
|
|
|
432
|
-
[src/Particle.js:
|
|
452
|
+
[src/Particle.js:462-480](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L462-L480 "Source code on GitHub")
|
|
433
453
|
|
|
434
454
|
Add a device to a product or move device out of quarantine.
|
|
435
455
|
|
|
@@ -448,7 +468,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
448
468
|
|
|
449
469
|
### removeDevice
|
|
450
470
|
|
|
451
|
-
[src/Particle.js:
|
|
471
|
+
[src/Particle.js:493-497](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L493-L497 "Source code on GitHub")
|
|
452
472
|
|
|
453
473
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
454
474
|
|
|
@@ -466,7 +486,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
466
486
|
|
|
467
487
|
### removeDeviceOwner
|
|
468
488
|
|
|
469
|
-
[src/Particle.js:
|
|
489
|
+
[src/Particle.js:509-512](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L509-L512 "Source code on GitHub")
|
|
470
490
|
|
|
471
491
|
Unclaim a product device its the owner, but keep it in the product
|
|
472
492
|
|
|
@@ -483,7 +503,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
483
503
|
|
|
484
504
|
### renameDevice
|
|
485
505
|
|
|
486
|
-
[src/Particle.js:
|
|
506
|
+
[src/Particle.js:525-527](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L525-L527 "Source code on GitHub")
|
|
487
507
|
|
|
488
508
|
Rename a device
|
|
489
509
|
|
|
@@ -501,7 +521,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
501
521
|
|
|
502
522
|
### signalDevice
|
|
503
523
|
|
|
504
|
-
[src/Particle.js:
|
|
524
|
+
[src/Particle.js:540-542](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L540-L542 "Source code on GitHub")
|
|
505
525
|
|
|
506
526
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
507
527
|
|
|
@@ -519,7 +539,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
519
539
|
|
|
520
540
|
### setDeviceNotes
|
|
521
541
|
|
|
522
|
-
[src/Particle.js:
|
|
542
|
+
[src/Particle.js:555-557](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L555-L557 "Source code on GitHub")
|
|
523
543
|
|
|
524
544
|
Store some notes about device
|
|
525
545
|
|
|
@@ -537,7 +557,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
537
557
|
|
|
538
558
|
### markAsDevelopmentDevice
|
|
539
559
|
|
|
540
|
-
[src/Particle.js:
|
|
560
|
+
[src/Particle.js:570-572](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L570-L572 "Source code on GitHub")
|
|
541
561
|
|
|
542
562
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
543
563
|
|
|
@@ -555,7 +575,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
555
575
|
|
|
556
576
|
### lockDeviceProductFirmware
|
|
557
577
|
|
|
558
|
-
[src/Particle.js:
|
|
578
|
+
[src/Particle.js:586-588](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L586-L588 "Source code on GitHub")
|
|
559
579
|
|
|
560
580
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
561
581
|
|
|
@@ -574,7 +594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
574
594
|
|
|
575
595
|
### unlockDeviceProductFirmware
|
|
576
596
|
|
|
577
|
-
[src/Particle.js:
|
|
597
|
+
[src/Particle.js:600-602](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L600-L602 "Source code on GitHub")
|
|
578
598
|
|
|
579
599
|
Mark device as receiving automatic firmware updates
|
|
580
600
|
|
|
@@ -591,7 +611,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
591
611
|
|
|
592
612
|
### updateDevice
|
|
593
613
|
|
|
594
|
-
[src/Particle.js:
|
|
614
|
+
[src/Particle.js:621-632](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L621-L632 "Source code on GitHub")
|
|
595
615
|
|
|
596
616
|
Update multiple device attributes at the same time
|
|
597
617
|
|
|
@@ -615,7 +635,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
615
635
|
|
|
616
636
|
### provisionDevice
|
|
617
637
|
|
|
618
|
-
[src/Particle.js:
|
|
638
|
+
[src/Particle.js:643-651](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L643-L651 "Source code on GitHub")
|
|
619
639
|
|
|
620
640
|
Provision a new device for products that allow self-provisioning
|
|
621
641
|
|
|
@@ -631,7 +651,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
631
651
|
|
|
632
652
|
### getClaimCode
|
|
633
653
|
|
|
634
|
-
[src/Particle.js:
|
|
654
|
+
[src/Particle.js:665-668](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L665-L668 "Source code on GitHub")
|
|
635
655
|
|
|
636
656
|
Generate a claim code to use in the device claiming process.
|
|
637
657
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -650,7 +670,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
650
670
|
|
|
651
671
|
### getVariable
|
|
652
672
|
|
|
653
|
-
[src/Particle.js:
|
|
673
|
+
[src/Particle.js:700-706](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L700-L706 "Source code on GitHub")
|
|
654
674
|
|
|
655
675
|
Get the value of a device variable
|
|
656
676
|
|
|
@@ -668,7 +688,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
668
688
|
|
|
669
689
|
### flashDevice
|
|
670
690
|
|
|
671
|
-
[src/Particle.js:
|
|
691
|
+
[src/Particle.js:720-731](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L720-L731 "Source code on GitHub")
|
|
672
692
|
|
|
673
693
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
674
694
|
|
|
@@ -687,7 +707,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
687
707
|
|
|
688
708
|
### flashTinker
|
|
689
709
|
|
|
690
|
-
[src/Particle.js:
|
|
710
|
+
[src/Particle.js:742-755](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L742-L755 "Source code on GitHub")
|
|
691
711
|
|
|
692
712
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
693
713
|
|
|
@@ -703,7 +723,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
703
723
|
|
|
704
724
|
### compileCode
|
|
705
725
|
|
|
706
|
-
[src/Particle.js:
|
|
726
|
+
[src/Particle.js:768-786](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L768-L786 "Source code on GitHub")
|
|
707
727
|
|
|
708
728
|
Compile firmware using the Particle Cloud
|
|
709
729
|
|
|
@@ -721,7 +741,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
721
741
|
|
|
722
742
|
### downloadFirmwareBinary
|
|
723
743
|
|
|
724
|
-
[src/Particle.js:
|
|
744
|
+
[src/Particle.js:797-808](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L797-L808 "Source code on GitHub")
|
|
725
745
|
|
|
726
746
|
Download a firmware binary
|
|
727
747
|
|
|
@@ -737,7 +757,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A
|
|
|
737
757
|
|
|
738
758
|
### sendPublicKey
|
|
739
759
|
|
|
740
|
-
[src/Particle.js:
|
|
760
|
+
[src/Particle.js:821-835](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L821-L835 "Source code on GitHub")
|
|
741
761
|
|
|
742
762
|
Send a new device public key to the Particle Cloud
|
|
743
763
|
|
|
@@ -755,7 +775,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
755
775
|
|
|
756
776
|
### callFunction
|
|
757
777
|
|
|
758
|
-
[src/Particle.js:
|
|
778
|
+
[src/Particle.js:849-854](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L849-L854 "Source code on GitHub")
|
|
759
779
|
|
|
760
780
|
Call a device function
|
|
761
781
|
|
|
@@ -774,7 +794,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
774
794
|
|
|
775
795
|
### getEventStream
|
|
776
796
|
|
|
777
|
-
[src/Particle.js:
|
|
797
|
+
[src/Particle.js:867-891](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L867-L891 "Source code on GitHub")
|
|
778
798
|
|
|
779
799
|
Get a stream of events
|
|
780
800
|
|
|
@@ -792,7 +812,7 @@ emit 'event' events.
|
|
|
792
812
|
|
|
793
813
|
### publishEvent
|
|
794
814
|
|
|
795
|
-
[src/Particle.js:
|
|
815
|
+
[src/Particle.js:905-909](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L905-L909 "Source code on GitHub")
|
|
796
816
|
|
|
797
817
|
Publish a event to the Particle Cloud
|
|
798
818
|
|
|
@@ -811,7 +831,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
811
831
|
|
|
812
832
|
### createWebhook
|
|
813
833
|
|
|
814
|
-
[src/Particle.js:
|
|
834
|
+
[src/Particle.js:936-958](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L936-L958 "Source code on GitHub")
|
|
815
835
|
|
|
816
836
|
Create a webhook
|
|
817
837
|
|
|
@@ -843,7 +863,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
843
863
|
|
|
844
864
|
### deleteWebhook
|
|
845
865
|
|
|
846
|
-
[src/Particle.js:
|
|
866
|
+
[src/Particle.js:970-973](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L970-L973 "Source code on GitHub")
|
|
847
867
|
|
|
848
868
|
Delete a webhook
|
|
849
869
|
|
|
@@ -860,7 +880,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
860
880
|
|
|
861
881
|
### listWebhooks
|
|
862
882
|
|
|
863
|
-
[src/Particle.js:
|
|
883
|
+
[src/Particle.js:984-987](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L984-L987 "Source code on GitHub")
|
|
864
884
|
|
|
865
885
|
List all webhooks owned by the account or product
|
|
866
886
|
|
|
@@ -876,7 +896,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
876
896
|
|
|
877
897
|
### createIntegration
|
|
878
898
|
|
|
879
|
-
[src/Particle.js:
|
|
899
|
+
[src/Particle.js:1004-1008](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1004-L1008 "Source code on GitHub")
|
|
880
900
|
|
|
881
901
|
Create an integration to send events to an external service
|
|
882
902
|
|
|
@@ -897,7 +917,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
897
917
|
|
|
898
918
|
### editIntegration
|
|
899
919
|
|
|
900
|
-
[src/Particle.js:
|
|
920
|
+
[src/Particle.js:1026-1030](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1026-L1030 "Source code on GitHub")
|
|
901
921
|
|
|
902
922
|
Edit an integration to send events to an external service
|
|
903
923
|
|
|
@@ -919,7 +939,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
919
939
|
|
|
920
940
|
### deleteIntegration
|
|
921
941
|
|
|
922
|
-
[src/Particle.js:
|
|
942
|
+
[src/Particle.js:1043-1046](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1043-L1046 "Source code on GitHub")
|
|
923
943
|
|
|
924
944
|
Delete an integration to send events to an external service
|
|
925
945
|
|
|
@@ -936,7 +956,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
936
956
|
|
|
937
957
|
### listIntegrations
|
|
938
958
|
|
|
939
|
-
[src/Particle.js:
|
|
959
|
+
[src/Particle.js:1057-1060](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1057-L1060 "Source code on GitHub")
|
|
940
960
|
|
|
941
961
|
List all integrations owned by the account or product
|
|
942
962
|
|
|
@@ -952,7 +972,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
952
972
|
|
|
953
973
|
### getUserInfo
|
|
954
974
|
|
|
955
|
-
[src/Particle.js:
|
|
975
|
+
[src/Particle.js:1070-1072](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1070-L1072 "Source code on GitHub")
|
|
956
976
|
|
|
957
977
|
Get details about the current user
|
|
958
978
|
|
|
@@ -967,7 +987,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
967
987
|
|
|
968
988
|
### setUserInfo
|
|
969
989
|
|
|
970
|
-
[src/Particle.js:
|
|
990
|
+
[src/Particle.js:1083-1086](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1083-L1086 "Source code on GitHub")
|
|
971
991
|
|
|
972
992
|
Set details on the current user
|
|
973
993
|
|
|
@@ -983,7 +1003,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
983
1003
|
|
|
984
1004
|
### changeUsername
|
|
985
1005
|
|
|
986
|
-
[src/Particle.js:
|
|
1006
|
+
[src/Particle.js:1099-1107](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1099-L1107 "Source code on GitHub")
|
|
987
1007
|
|
|
988
1008
|
Change username (i.e, email)
|
|
989
1009
|
|
|
@@ -992,6 +1012,7 @@ Change username (i.e, email)
|
|
|
992
1012
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
993
1013
|
- `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
|
|
994
1014
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New email
|
|
1015
|
+
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
995
1016
|
- `options.auth` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access Token
|
|
996
1017
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
997
1018
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -1000,7 +1021,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1000
1021
|
|
|
1001
1022
|
### changeUserPassword
|
|
1002
1023
|
|
|
1003
|
-
[src/Particle.js:
|
|
1024
|
+
[src/Particle.js:1120-1128](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1120-L1128 "Source code on GitHub")
|
|
1004
1025
|
|
|
1005
1026
|
Change user's password
|
|
1006
1027
|
|
|
@@ -1018,7 +1039,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1018
1039
|
|
|
1019
1040
|
### listSIMs
|
|
1020
1041
|
|
|
1021
|
-
[src/Particle.js:
|
|
1042
|
+
[src/Particle.js:1144-1148](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1144-L1148 "Source code on GitHub")
|
|
1022
1043
|
|
|
1023
1044
|
List SIM cards owned by a user or product
|
|
1024
1045
|
|
|
@@ -1039,7 +1060,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1039
1060
|
|
|
1040
1061
|
### getSIMDataUsage
|
|
1041
1062
|
|
|
1042
|
-
[src/Particle.js:
|
|
1063
|
+
[src/Particle.js:1160-1166](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1160-L1166 "Source code on GitHub")
|
|
1043
1064
|
|
|
1044
1065
|
Get data usage for one SIM card for the current billing period
|
|
1045
1066
|
|
|
@@ -1056,7 +1077,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1056
1077
|
|
|
1057
1078
|
### getFleetDataUsage
|
|
1058
1079
|
|
|
1059
|
-
[src/Particle.js:
|
|
1080
|
+
[src/Particle.js:1177-1184](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1177-L1184 "Source code on GitHub")
|
|
1060
1081
|
|
|
1061
1082
|
Get data usage for all SIM cards in a product the current billing period
|
|
1062
1083
|
|
|
@@ -1072,7 +1093,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1072
1093
|
|
|
1073
1094
|
### checkSIM
|
|
1074
1095
|
|
|
1075
|
-
[src/Particle.js:
|
|
1096
|
+
[src/Particle.js:1195-1197](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1195-L1197 "Source code on GitHub")
|
|
1076
1097
|
|
|
1077
1098
|
Check SIM status
|
|
1078
1099
|
|
|
@@ -1088,7 +1109,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1088
1109
|
|
|
1089
1110
|
### activateSIM
|
|
1090
1111
|
|
|
1091
|
-
[src/Particle.js:
|
|
1112
|
+
[src/Particle.js:1211-1221](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1211-L1221 "Source code on GitHub")
|
|
1092
1113
|
|
|
1093
1114
|
Activate and add SIM cards to an account or product
|
|
1094
1115
|
|
|
@@ -1108,7 +1129,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1108
1129
|
|
|
1109
1130
|
### deactivateSIM
|
|
1110
1131
|
|
|
1111
|
-
[src/Particle.js:
|
|
1132
|
+
[src/Particle.js:1233-1237](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1233-L1237 "Source code on GitHub")
|
|
1112
1133
|
|
|
1113
1134
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1114
1135
|
|
|
@@ -1125,7 +1146,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1125
1146
|
|
|
1126
1147
|
### reactivateSIM
|
|
1127
1148
|
|
|
1128
|
-
[src/Particle.js:
|
|
1149
|
+
[src/Particle.js:1250-1254](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1250-L1254 "Source code on GitHub")
|
|
1129
1150
|
|
|
1130
1151
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1131
1152
|
|
|
@@ -1143,7 +1164,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1143
1164
|
|
|
1144
1165
|
### updateSIM
|
|
1145
1166
|
|
|
1146
|
-
[src/Particle.js:
|
|
1167
|
+
[src/Particle.js:1267-1271](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1267-L1271 "Source code on GitHub")
|
|
1147
1168
|
|
|
1148
1169
|
Update SIM card data limit
|
|
1149
1170
|
|
|
@@ -1161,7 +1182,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1161
1182
|
|
|
1162
1183
|
### removeSIM
|
|
1163
1184
|
|
|
1164
|
-
[src/Particle.js:
|
|
1185
|
+
[src/Particle.js:1283-1286](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1283-L1286 "Source code on GitHub")
|
|
1165
1186
|
|
|
1166
1187
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1167
1188
|
|
|
@@ -1178,7 +1199,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1178
1199
|
|
|
1179
1200
|
### listBuildTargets
|
|
1180
1201
|
|
|
1181
|
-
[src/Particle.js:
|
|
1202
|
+
[src/Particle.js:1297-1300](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1297-L1300 "Source code on GitHub")
|
|
1182
1203
|
|
|
1183
1204
|
List valid build targets to be used for compiling
|
|
1184
1205
|
|
|
@@ -1194,7 +1215,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1194
1215
|
|
|
1195
1216
|
### listLibraries
|
|
1196
1217
|
|
|
1197
|
-
[src/Particle.js:
|
|
1218
|
+
[src/Particle.js:1326-1343](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1326-L1343 "Source code on GitHub")
|
|
1198
1219
|
|
|
1199
1220
|
List firmware libraries
|
|
1200
1221
|
|
|
@@ -1223,7 +1244,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1223
1244
|
|
|
1224
1245
|
### getLibrary
|
|
1225
1246
|
|
|
1226
|
-
[src/Particle.js:
|
|
1247
|
+
[src/Particle.js:1359-1367](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1359-L1367 "Source code on GitHub")
|
|
1227
1248
|
|
|
1228
1249
|
Get firmware library details
|
|
1229
1250
|
|
|
@@ -1240,7 +1261,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1240
1261
|
|
|
1241
1262
|
### getLibraryVersions
|
|
1242
1263
|
|
|
1243
|
-
[src/Particle.js:
|
|
1264
|
+
[src/Particle.js:1380-1388](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1380-L1388 "Source code on GitHub")
|
|
1244
1265
|
|
|
1245
1266
|
Firmware library details for each version
|
|
1246
1267
|
|
|
@@ -1258,7 +1279,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1258
1279
|
|
|
1259
1280
|
### contributeLibrary
|
|
1260
1281
|
|
|
1261
|
-
[src/Particle.js:
|
|
1282
|
+
[src/Particle.js:1400-1413](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1400-L1413 "Source code on GitHub")
|
|
1262
1283
|
|
|
1263
1284
|
Contribute a new library version from a compressed archive
|
|
1264
1285
|
|
|
@@ -1275,7 +1296,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1275
1296
|
|
|
1276
1297
|
### publishLibrary
|
|
1277
1298
|
|
|
1278
|
-
[src/Particle.js:
|
|
1299
|
+
[src/Particle.js:1424-1433](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1424-L1433 "Source code on GitHub")
|
|
1279
1300
|
|
|
1280
1301
|
Publish the latest version of a library to the public
|
|
1281
1302
|
|
|
@@ -1291,7 +1312,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1291
1312
|
|
|
1292
1313
|
### deleteLibrary
|
|
1293
1314
|
|
|
1294
|
-
[src/Particle.js:
|
|
1315
|
+
[src/Particle.js:1445-1453](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1445-L1453 "Source code on GitHub")
|
|
1295
1316
|
|
|
1296
1317
|
Delete one version of a library or an entire private library
|
|
1297
1318
|
|
|
@@ -1308,7 +1329,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1308
1329
|
|
|
1309
1330
|
### downloadFile
|
|
1310
1331
|
|
|
1311
|
-
[src/Particle.js:
|
|
1332
|
+
[src/Particle.js:1463-1466](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1463-L1466 "Source code on GitHub")
|
|
1312
1333
|
|
|
1313
1334
|
Download an external file that may not be on the API
|
|
1314
1335
|
|
|
@@ -1323,7 +1344,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1323
1344
|
|
|
1324
1345
|
### listOAuthClients
|
|
1325
1346
|
|
|
1326
|
-
[src/Particle.js:
|
|
1347
|
+
[src/Particle.js:1477-1480](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1477-L1480 "Source code on GitHub")
|
|
1327
1348
|
|
|
1328
1349
|
List OAuth client created by the account
|
|
1329
1350
|
|
|
@@ -1339,7 +1360,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1339
1360
|
|
|
1340
1361
|
### createOAuthClient
|
|
1341
1362
|
|
|
1342
|
-
[src/Particle.js:
|
|
1363
|
+
[src/Particle.js:1495-1499](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1495-L1499 "Source code on GitHub")
|
|
1343
1364
|
|
|
1344
1365
|
Create an OAuth client
|
|
1345
1366
|
|
|
@@ -1359,7 +1380,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1359
1380
|
|
|
1360
1381
|
### updateOAuthClient
|
|
1361
1382
|
|
|
1362
|
-
[src/Particle.js:
|
|
1383
|
+
[src/Particle.js:1513-1517](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1513-L1517 "Source code on GitHub")
|
|
1363
1384
|
|
|
1364
1385
|
Update an OAuth client
|
|
1365
1386
|
|
|
@@ -1378,7 +1399,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1378
1399
|
|
|
1379
1400
|
### deleteOAuthClient
|
|
1380
1401
|
|
|
1381
|
-
[src/Particle.js:
|
|
1402
|
+
[src/Particle.js:1529-1532](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1529-L1532 "Source code on GitHub")
|
|
1382
1403
|
|
|
1383
1404
|
Delete an OAuth client
|
|
1384
1405
|
|
|
@@ -1395,7 +1416,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1395
1416
|
|
|
1396
1417
|
### listProducts
|
|
1397
1418
|
|
|
1398
|
-
[src/Particle.js:
|
|
1419
|
+
[src/Particle.js:1542-1544](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1542-L1544 "Source code on GitHub")
|
|
1399
1420
|
|
|
1400
1421
|
List products the account has access to
|
|
1401
1422
|
|
|
@@ -1410,7 +1431,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1410
1431
|
|
|
1411
1432
|
### getProduct
|
|
1412
1433
|
|
|
1413
|
-
[src/Particle.js:
|
|
1434
|
+
[src/Particle.js:1555-1557](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1555-L1557 "Source code on GitHub")
|
|
1414
1435
|
|
|
1415
1436
|
Get detailed information about a product
|
|
1416
1437
|
|
|
@@ -1426,7 +1447,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1426
1447
|
|
|
1427
1448
|
### listProductFirmware
|
|
1428
1449
|
|
|
1429
|
-
[src/Particle.js:
|
|
1450
|
+
[src/Particle.js:1568-1570](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1568-L1570 "Source code on GitHub")
|
|
1430
1451
|
|
|
1431
1452
|
List product firmware versions
|
|
1432
1453
|
|
|
@@ -1442,7 +1463,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1442
1463
|
|
|
1443
1464
|
### uploadProductFirmware
|
|
1444
1465
|
|
|
1445
|
-
[src/Particle.js:
|
|
1466
|
+
[src/Particle.js:1586-1602](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1586-L1602 "Source code on GitHub")
|
|
1446
1467
|
|
|
1447
1468
|
List product firmware versions
|
|
1448
1469
|
|
|
@@ -1463,7 +1484,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1463
1484
|
|
|
1464
1485
|
### getProductFirmware
|
|
1465
1486
|
|
|
1466
|
-
[src/Particle.js:
|
|
1487
|
+
[src/Particle.js:1614-1621](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1614-L1621 "Source code on GitHub")
|
|
1467
1488
|
|
|
1468
1489
|
Get information about a product firmware version
|
|
1469
1490
|
|
|
@@ -1480,7 +1501,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1480
1501
|
|
|
1481
1502
|
### updateProductFirmware
|
|
1482
1503
|
|
|
1483
|
-
[src/Particle.js:
|
|
1504
|
+
[src/Particle.js:1635-1638](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1635-L1638 "Source code on GitHub")
|
|
1484
1505
|
|
|
1485
1506
|
Update information for a product firmware version
|
|
1486
1507
|
|
|
@@ -1499,7 +1520,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1499
1520
|
|
|
1500
1521
|
### downloadProductFirmware
|
|
1501
1522
|
|
|
1502
|
-
[src/Particle.js:
|
|
1523
|
+
[src/Particle.js:1650-1661](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1650-L1661 "Source code on GitHub")
|
|
1503
1524
|
|
|
1504
1525
|
Download a product firmware binary
|
|
1505
1526
|
|
|
@@ -1516,7 +1537,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A
|
|
|
1516
1537
|
|
|
1517
1538
|
### releaseProductFirmware
|
|
1518
1539
|
|
|
1519
|
-
[src/Particle.js:
|
|
1540
|
+
[src/Particle.js:1685-1688](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1685-L1688 "Source code on GitHub")
|
|
1520
1541
|
|
|
1521
1542
|
Release a product firmware version as the default version
|
|
1522
1543
|
|
|
@@ -1533,7 +1554,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1533
1554
|
|
|
1534
1555
|
### listTeamMembers
|
|
1535
1556
|
|
|
1536
|
-
[src/Particle.js:
|
|
1557
|
+
[src/Particle.js:1699-1706](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1699-L1706 "Source code on GitHub")
|
|
1537
1558
|
|
|
1538
1559
|
List product team members
|
|
1539
1560
|
|
|
@@ -1549,7 +1570,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1549
1570
|
|
|
1550
1571
|
### inviteTeamMember
|
|
1551
1572
|
|
|
1552
|
-
[src/Particle.js:
|
|
1573
|
+
[src/Particle.js:1718-1726](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1718-L1726 "Source code on GitHub")
|
|
1553
1574
|
|
|
1554
1575
|
Invite Particle user to a product team
|
|
1555
1576
|
|
|
@@ -1566,7 +1587,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1566
1587
|
|
|
1567
1588
|
### removeTeamMember
|
|
1568
1589
|
|
|
1569
|
-
[src/Particle.js:
|
|
1590
|
+
[src/Particle.js:1738-1745](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1738-L1745 "Source code on GitHub")
|
|
1570
1591
|
|
|
1571
1592
|
Remove Particle user to a product team
|
|
1572
1593
|
|
|
@@ -1583,7 +1604,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1583
1604
|
|
|
1584
1605
|
### lookupSerialNumber
|
|
1585
1606
|
|
|
1586
|
-
[src/Particle.js:
|
|
1607
|
+
[src/Particle.js:1756-1763](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1756-L1763 "Source code on GitHub")
|
|
1587
1608
|
|
|
1588
1609
|
Fetch details about a serial number
|
|
1589
1610
|
|
|
@@ -1599,7 +1620,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1599
1620
|
|
|
1600
1621
|
### createMeshNetwork
|
|
1601
1622
|
|
|
1602
|
-
[src/Particle.js:
|
|
1623
|
+
[src/Particle.js:1776-1784](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1776-L1784 "Source code on GitHub")
|
|
1603
1624
|
|
|
1604
1625
|
Create a mesh network
|
|
1605
1626
|
|
|
@@ -1617,7 +1638,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1617
1638
|
|
|
1618
1639
|
### removeMeshNetwork
|
|
1619
1640
|
|
|
1620
|
-
[src/Particle.js:
|
|
1641
|
+
[src/Particle.js:1795-1797](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1795-L1797 "Source code on GitHub")
|
|
1621
1642
|
|
|
1622
1643
|
Remove a mesh network.
|
|
1623
1644
|
|
|
@@ -1633,7 +1654,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1633
1654
|
|
|
1634
1655
|
### listMeshNetworks
|
|
1635
1656
|
|
|
1636
|
-
[src/Particle.js:
|
|
1657
|
+
[src/Particle.js:1809-1812](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1809-L1812 "Source code on GitHub")
|
|
1637
1658
|
|
|
1638
1659
|
List all mesh networks
|
|
1639
1660
|
|
|
@@ -1650,7 +1671,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1650
1671
|
|
|
1651
1672
|
### getMeshNetwork
|
|
1652
1673
|
|
|
1653
|
-
[src/Particle.js:
|
|
1674
|
+
[src/Particle.js:1823-1825](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1823-L1825 "Source code on GitHub")
|
|
1654
1675
|
|
|
1655
1676
|
Get information about a mesh network.
|
|
1656
1677
|
|
|
@@ -1666,7 +1687,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1666
1687
|
|
|
1667
1688
|
### updateMeshNetwork
|
|
1668
1689
|
|
|
1669
|
-
[src/Particle.js:
|
|
1690
|
+
[src/Particle.js:1838-1846](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1838-L1846 "Source code on GitHub")
|
|
1670
1691
|
|
|
1671
1692
|
Modify a mesh network.
|
|
1672
1693
|
|
|
@@ -1684,7 +1705,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1684
1705
|
|
|
1685
1706
|
### addMeshNetworkDevice
|
|
1686
1707
|
|
|
1687
|
-
[src/Particle.js:
|
|
1708
|
+
[src/Particle.js:1858-1867](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1858-L1867 "Source code on GitHub")
|
|
1688
1709
|
|
|
1689
1710
|
Add a device to a mesh network.
|
|
1690
1711
|
|
|
@@ -1701,7 +1722,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1701
1722
|
|
|
1702
1723
|
### removeMeshNetworkDevice
|
|
1703
1724
|
|
|
1704
|
-
[src/Particle.js:
|
|
1725
|
+
[src/Particle.js:1879-1895](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1879-L1895 "Source code on GitHub")
|
|
1705
1726
|
|
|
1706
1727
|
Remove a device from a mesh network.
|
|
1707
1728
|
|
|
@@ -1718,7 +1739,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1718
1739
|
|
|
1719
1740
|
### listMeshNetworkDevices
|
|
1720
1741
|
|
|
1721
|
-
[src/Particle.js:
|
|
1742
|
+
[src/Particle.js:1909-1918](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1909-L1918 "Source code on GitHub")
|
|
1722
1743
|
|
|
1723
1744
|
List all devices of a mesh network.
|
|
1724
1745
|
|
|
@@ -1737,7 +1758,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1737
1758
|
|
|
1738
1759
|
### getProductConfiguration
|
|
1739
1760
|
|
|
1740
|
-
[src/Particle.js:
|
|
1761
|
+
[src/Particle.js:1929-1936](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1929-L1936 "Source code on GitHub")
|
|
1741
1762
|
|
|
1742
1763
|
Get product configuration
|
|
1743
1764
|
|
|
@@ -1753,7 +1774,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1753
1774
|
|
|
1754
1775
|
### getProductConfigurationSchema
|
|
1755
1776
|
|
|
1756
|
-
[src/Particle.js:
|
|
1777
|
+
[src/Particle.js:1947-1955](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1947-L1955 "Source code on GitHub")
|
|
1757
1778
|
|
|
1758
1779
|
Get product configuration schema
|
|
1759
1780
|
|
|
@@ -1767,9 +1788,43 @@ Get product configuration schema
|
|
|
1767
1788
|
|
|
1768
1789
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
1769
1790
|
|
|
1791
|
+
### getProductDeviceConfiguration
|
|
1792
|
+
|
|
1793
|
+
[src/Particle.js:1967-1974](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1967-L1974 "Source code on GitHub")
|
|
1794
|
+
|
|
1795
|
+
Get product device's configuration
|
|
1796
|
+
|
|
1797
|
+
**Parameters**
|
|
1798
|
+
|
|
1799
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1800
|
+
- `options.auth` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access Token
|
|
1801
|
+
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1802
|
+
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1803
|
+
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1804
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1805
|
+
|
|
1806
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
1807
|
+
|
|
1808
|
+
### getProductDeviceConfigurationSchema
|
|
1809
|
+
|
|
1810
|
+
[src/Particle.js:1986-1994](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L1986-L1994 "Source code on GitHub")
|
|
1811
|
+
|
|
1812
|
+
Get product device's configuration schema
|
|
1813
|
+
|
|
1814
|
+
**Parameters**
|
|
1815
|
+
|
|
1816
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1817
|
+
- `options.auth` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access Token
|
|
1818
|
+
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1819
|
+
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1820
|
+
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1821
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1822
|
+
|
|
1823
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
1824
|
+
|
|
1770
1825
|
### setProductConfiguration
|
|
1771
1826
|
|
|
1772
|
-
[src/Particle.js:
|
|
1827
|
+
[src/Particle.js:2006-2014](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L2006-L2014 "Source code on GitHub")
|
|
1773
1828
|
|
|
1774
1829
|
Set product configuration
|
|
1775
1830
|
|
|
@@ -1786,7 +1841,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1786
1841
|
|
|
1787
1842
|
### setProductDeviceConfiguration
|
|
1788
1843
|
|
|
1789
|
-
[src/Particle.js:
|
|
1844
|
+
[src/Particle.js:2027-2035](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L2027-L2035 "Source code on GitHub")
|
|
1790
1845
|
|
|
1791
1846
|
Set product configuration for a specific device within the product
|
|
1792
1847
|
|
|
@@ -1804,7 +1859,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1804
1859
|
|
|
1805
1860
|
### getProductLocations
|
|
1806
1861
|
|
|
1807
|
-
[src/Particle.js:
|
|
1862
|
+
[src/Particle.js:2054-2071](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L2054-L2071 "Source code on GitHub")
|
|
1808
1863
|
|
|
1809
1864
|
Query location for devices within a product
|
|
1810
1865
|
|
|
@@ -1828,7 +1883,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1828
1883
|
|
|
1829
1884
|
### getProductDeviceLocations
|
|
1830
1885
|
|
|
1831
|
-
[src/Particle.js:
|
|
1886
|
+
[src/Particle.js:2088-2100](https://github.com/particle-iot/particle-api-js/blob/409b555e35478a52f400fad65cf336af4f95f5d7/src/Particle.js#L2088-L2100 "Source code on GitHub")
|
|
1832
1887
|
|
|
1833
1888
|
Query location for one device within a product
|
|
1834
1889
|
|