Skip to content

Commit

Permalink
6.4.2
Browse files Browse the repository at this point in the history
  • Loading branch information
suda committed Jan 5, 2017
1 parent 2dae370 commit 663359c
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 38 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# changelog

## 6.4.2 - 05 Jan 2017

* Create a wrapper for `listDevices` in `Client.js`.

## 6.4.1 - 15 Dec 2016

* Add scopes to library listing
Expand Down
2 changes: 1 addition & 1 deletion dist/particle.min.js.map

Large diffs are not rendered by default.

72 changes: 36 additions & 36 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Particle

[src/Particle.js:17-593](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L17-L593 "Source code on GitHub")
[src/Particle.js:17-593](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L17-L593 "Source code on GitHub")

Particle Cloud API wrapper.

Expand All @@ -14,7 +14,7 @@ Most Particle methods take a single unnamed argument object documented as

## constructor

[src/Particle.js:25-28](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L25-L28 "Source code on GitHub")
[src/Particle.js:25-28](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L25-L28 "Source code on GitHub")

Contructor for the Cloud API wrapper.

Expand All @@ -26,7 +26,7 @@ Create a new Particle object and call methods below on it.

## login

[src/Particle.js:37-46](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L37-L46 "Source code on GitHub")
[src/Particle.js:37-46](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L37-L46 "Source code on GitHub")

Login to Particle Cloud using an existing Particle acccount.

Expand All @@ -41,7 +41,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## createUser

[src/Particle.js:55-61](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L55-L61 "Source code on GitHub")
[src/Particle.js:55-61](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L55-L61 "Source code on GitHub")

Create a user account for the Particle Cloud

Expand All @@ -56,7 +56,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## verifyUser

[src/Particle.js:68-72](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L68-L72 "Source code on GitHub")
[src/Particle.js:68-72](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L68-L72 "Source code on GitHub")

Verify new user account via verification email

Expand All @@ -69,7 +69,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## resetPassword

[src/Particle.js:79-81](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L79-L81 "Source code on GitHub")
[src/Particle.js:79-81](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L79-L81 "Source code on GitHub")

Send reset password email for a Particle Cloud user account

Expand All @@ -82,7 +82,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## removeAccessToken

[src/Particle.js:90-94](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L90-L94 "Source code on GitHub")
[src/Particle.js:90-94](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L90-L94 "Source code on GitHub")

Revoke an access token

Expand All @@ -97,7 +97,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## listAccessTokens

[src/Particle.js:102-104](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L102-L104 "Source code on GitHub")
[src/Particle.js:102-104](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L102-L104 "Source code on GitHub")

List all valid access tokens for a Particle Cloud account

Expand All @@ -111,7 +111,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## listDevices

[src/Particle.js:111-113](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L111-L113 "Source code on GitHub")
[src/Particle.js:111-113](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L111-L113 "Source code on GitHub")

List devices claimed to the account

Expand All @@ -124,7 +124,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getDevice

[src/Particle.js:121-123](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L121-L123 "Source code on GitHub")
[src/Particle.js:121-123](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L121-L123 "Source code on GitHub")

Get detailed informationa about a device

Expand All @@ -138,7 +138,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## claimDevice

[src/Particle.js:131-136](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L131-L136 "Source code on GitHub")
[src/Particle.js:131-136](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L131-L136 "Source code on GitHub")

Claim a device to the account. The device must be online and unclaimed.

Expand All @@ -153,7 +153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## removeDevice

[src/Particle.js:144-146](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L144-L146 "Source code on GitHub")
[src/Particle.js:144-146](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L144-L146 "Source code on GitHub")

Unclaim / Remove a device from your account

Expand All @@ -167,7 +167,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## renameDevice

[src/Particle.js:155-157](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L155-L157 "Source code on GitHub")
[src/Particle.js:155-157](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L155-L157 "Source code on GitHub")

Rename a device

Expand All @@ -182,7 +182,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getClaimCode

[src/Particle.js:165-167](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L165-L167 "Source code on GitHub")
[src/Particle.js:165-167](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L165-L167 "Source code on GitHub")

Generate a claim code to use in the device claiming process.

Expand All @@ -196,7 +196,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getVariable

[src/Particle.js:187-189](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L187-L189 "Source code on GitHub")
[src/Particle.js:187-189](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L187-L189 "Source code on GitHub")

Get the value of a device variable

Expand All @@ -211,7 +211,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## signalDevice

[src/Particle.js:198-202](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L198-L202 "Source code on GitHub")
[src/Particle.js:198-202](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L198-L202 "Source code on GitHub")

Instruct the device to turn on/off the LED in a rainbow pattern

Expand All @@ -226,7 +226,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## flashDevice

[src/Particle.js:212-221](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L212-L221 "Source code on GitHub")
[src/Particle.js:212-221](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L212-L221 "Source code on GitHub")

Compile and flash application firmware to a device

Expand All @@ -242,7 +242,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## flashTinker

[src/Particle.js:229-233](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L229-L233 "Source code on GitHub")
[src/Particle.js:229-233](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L229-L233 "Source code on GitHub")

Flash the Tinker application to a device

Expand All @@ -256,7 +256,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## compileCode

[src/Particle.js:243-252](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L243-L252 "Source code on GitHub")
[src/Particle.js:243-252](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L243-L252 "Source code on GitHub")

Compile firmware using the Particle Cloud

Expand All @@ -272,7 +272,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## downloadFirmwareBinary

[src/Particle.js:260-269](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L260-L269 "Source code on GitHub")
[src/Particle.js:260-269](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L260-L269 "Source code on GitHub")

Download a firmware binary

Expand All @@ -286,7 +286,7 @@ Returns **[Request](https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_A

## sendPublicKey

[src/Particle.js:279-287](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L279-L287 "Source code on GitHub")
[src/Particle.js:279-287](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L279-L287 "Source code on GitHub")

Send a new device public key to the Particle Cloud

Expand All @@ -302,7 +302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## callFunction

[src/Particle.js:297-301](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L297-L301 "Source code on GitHub")
[src/Particle.js:297-301](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L297-L301 "Source code on GitHub")

Call a device function

Expand All @@ -318,7 +318,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getEventStream

[src/Particle.js:313-337](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L313-L337 "Source code on GitHub")
[src/Particle.js:313-337](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L313-L337 "Source code on GitHub")

Get a stream of events

Expand All @@ -336,7 +336,7 @@ emit 'event' events, as well as the specific named event.

## publishEvent

[src/Particle.js:347-353](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L347-L353 "Source code on GitHub")
[src/Particle.js:347-353](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L347-L353 "Source code on GitHub")

Publish a event to the Particle Cloud

Expand All @@ -352,7 +352,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## createWebhook

[src/Particle.js:372-380](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L372-L380 "Source code on GitHub")
[src/Particle.js:372-380](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L372-L380 "Source code on GitHub")

Create a webhook

Expand All @@ -377,7 +377,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## deleteWebhook

[src/Particle.js:388-390](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L388-L390 "Source code on GitHub")
[src/Particle.js:388-390](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L388-L390 "Source code on GitHub")

Delete a webhook

Expand All @@ -391,7 +391,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## listWebhooks

[src/Particle.js:397-399](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L397-L399 "Source code on GitHub")
[src/Particle.js:397-399](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L397-L399 "Source code on GitHub")

List all webhooks owned by the account

Expand All @@ -404,7 +404,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getUserInfo

[src/Particle.js:406-408](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L406-L408 "Source code on GitHub")
[src/Particle.js:406-408](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L406-L408 "Source code on GitHub")

Get details about the current user

Expand All @@ -417,7 +417,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## setUserInfo

[src/Particle.js:418-426](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L418-L426 "Source code on GitHub")
[src/Particle.js:418-426](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L418-L426 "Source code on GitHub")

Set details on the current user

Expand All @@ -433,7 +433,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## listBuildTargets

[src/Particle.js:446-452](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L446-L452 "Source code on GitHub")
[src/Particle.js:446-452](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L446-L452 "Source code on GitHub")

List valid build targets to be used for compiling

Expand All @@ -447,7 +447,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## listLibraries

[src/Particle.js:475-486](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L475-L486 "Source code on GitHub")
[src/Particle.js:475-486](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L475-L486 "Source code on GitHub")

List firmware libraries

Expand Down Expand Up @@ -475,7 +475,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getLibrary

[src/Particle.js:499-501](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L499-L501 "Source code on GitHub")
[src/Particle.js:499-501](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L499-L501 "Source code on GitHub")

Get firmware library details

Expand All @@ -490,7 +490,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## getLibraryVersions

[src/Particle.js:511-516](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L511-L516 "Source code on GitHub")
[src/Particle.js:511-516](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L511-L516 "Source code on GitHub")

Firmware library details for each version

Expand All @@ -506,7 +506,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## contributeLibrary

[src/Particle.js:524-531](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L524-L531 "Source code on GitHub")
[src/Particle.js:524-531](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L524-L531 "Source code on GitHub")

Contribute a new library version int the compressed archive

Expand All @@ -520,7 +520,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## deleteLibrary

[src/Particle.js:544-546](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L544-L546 "Source code on GitHub")
[src/Particle.js:544-546](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L544-L546 "Source code on GitHub")

Delete one version of a library or an entire published library

Expand All @@ -535,7 +535,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe

## downloadFile

[src/Particle.js:553-564](https://github.com/spark/particle-api-js/blob/d944607c989ce3017aae24d609c532cc70670672/src/Particle.js#L553-L564 "Source code on GitHub")
[src/Particle.js:553-564](https://github.com/spark/particle-api-js/blob/2dae3707db40120de2be11b8241a7fb15be18eac/src/Particle.js#L553-L564 "Source code on GitHub")

Download an external file that may not be on the API

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "particle-api-js",
"version": "6.4.1",
"version": "6.4.2",
"description": "Particle API Client",
"main": "lib/Particle.js",
"scripts": {
Expand Down

0 comments on commit 663359c

Please sign in to comment.