Lab 3: Using the Particle CLI & Exploring the Device Cloud API
This page is no longer maintained and is provided for historical reference only
|Project Goal||Use the Particle CLI & Device Cloud API to work with devices.|
|What you’ll learn||How to use the Particle CLI; Calling the Device CLoud API via cURL|
|Tools you’ll need||A Particle Argon, and the Grove Starter Kit for Particle Mesh, a Particle Debugger, the Particle CLI.|
|Time needed to complete||20 minutes|
In this session, we'll take a look at the Particle CLI and Device Cloud API. If you get stuck at any point during this session, click here for the completed, working source.
The Particle CLI
- If you haven't already, install the Particle CLI. Open a terminal window and type the following command:
bash <( curl -sL https://particle.io/install-cli )
particle loginand enter your Particle account email and password when prompted.
- Once you're logged in, type
particle listto see your list of online devices.
- The device you've been using for this workshop has two variables and one function. Get the value of the
tempvariable with the command
particle get temp.
- You can also call one of the two functions to light up the yellow or blue LED button. Type the command
particle call <your-device-name> toggleLedin the terminal. Run the same command again to turn the light off.
The Particle device cloud API
Behind the scenes, every interface that Particle provides to work with devices, from the Console, to mobile apps, SDKs, and the CLI, they all talk through a RESTful Device Cloud API. You can even call yourself, directly.
Tip: Make sure you have cURL on your machine
The next few steps assume you have cURL installed on your machine. If you don't have this command-line utility on your machine, you can download and install it here or use a GUI-based tool like Postman.
- First, you'll need to obtain an access token. You can create one using the Particle CLI.
- With your token and Device ID in hand, type the following cURL command into a terminal window, replacing the text below in
< >with your information.
By default, the response will generate a wall of text in your terminal. If you have Python 2.6+ installed on your machine, you can pipe the output to the
curl https://api.particle.io/v1/devices?access_token=<your token>
json.tooland get pretty-printed JSON.
curl https://api.particle.io/v1/devices\?access_token\=<your token> | python -m json.tool
- For this next command, you need the Device ID of the Photon attached to your badge. You can find that in the console or via the
particle listCLI command.
- Let's call the
toggleLedfunction using the Device Cloud API. Type the following, again replacing the text below in
< >with your information.
curl https://api.particle.io/v1/devices/<device id>/toggleLed \ -d access_token=<your token>
You've now explored a number of ways that you can interface with the Particle Device cloud and your connected devices! Next, let's explore using BLE with Particle Gen3 Devices.