Manual setup

We highly recommend using the web-based setup as it is automatic and significantly easier to use, however you can also use the following steps to set up your device manually.

Note that these instructions are intended to be used to set up individual developer devices, not product fleets, though there are some common steps.

Prerequisites

  • Manual setup requires a Windows, Linux, or Mac computer. It cannot be completed on a phone, tablet, or Chromebook.

  • You must install the Particle CLI.

  • You must have a free Particle account. Sign in or sign up here:

  • The setup process will configure your device by USB, so you will need an appropriate USB cable to connect your device to your computer.

Show device cable types

  • Cellular devices with a 2G/3G or LTE/2G/3G cellular modem require a battery.

Show device battery requirement

Get a device identifier

In order to add your device to your product, you will need either:

  • The Device ID of the device (24-character hexadecimal).
  • The Serial Number of the device. On most devices, this is printed on a sticker on the device or package.

The CLI commands to claim a device and name a device require a Device ID. If you add a device to a product using the serial number, the console will show the Device ID corresponding to that serial number. The interactive tool below also does this.

Interactive - Get a device identifier

This tool will get information about your device connected to your computer by USB:


CLI - Get a device identifier

If the device is not currently in listening mode (blinking dark blue), you can put it in listening mode using one of the following methods:

  • Using the Particle CLI:

    particle usb start-listening
    

  • Alternatively, hold down the MODE (or SETUP) button until the status LED blinks dark blue.

Then use the Particle CLI command:

particle identify

This will output information about the device including the Device ID and Serial Number.

Create or select a product

Particle devices can be used in a product, or as sandbox developer devices. Even if you are not planning on creating a commercial product, using a product makes it possible to:

  • Use Device Vitals to get connectivity and battery information about your devices remotely
  • Flash code on wake from sleep
  • Allow controlled access to your devices by other users, if desired
  • Group devices
  • Easy migration to growth if you exceed the free plan limits

Using a product in the free plan is still free. You can have any combination of Wi-Fi and cellular devices in the free plan whether the devices are developer or product devices.

Interactive - Create or select a product

Device type  
 

Console - Create a product

  • Go to the Particle console.

  • Select Products in the left-hand icon bar.

  • Click New Product in the upper right corner of the window.

  • Fill in the fields and create the new product. Note the product ID of your new product. It's shown next to the key icon at the top of the window..

Console - Find an existing product

  • Go to the Particle console.

  • Select Products in the left-hand icon bar.

  • Note the Product ID in the grid of products in your account.

  • If you want to add to an organization product, select the Organization using the popup at the top of the window first.

Add your device to your product

Adding a cellular device to a product also activates its SIM. If you skip this step, a cellular device may end up blinking green forever because it won't be able to connect to the cellular network.

Interactive - Add your device to your product


Device to add
Type or paste a Device ID or Serial Number into the field above. You can also insert the full text contents of the data matrix code on the serial number label.
 
 

The options for claim, mark as development, and name device are explained below.

Console - Add your device to your product

  • Go to the Particle console.

  • Select Products in the left-hand icon bar, then the product you want to add your device to.

  • Select Devices (within the product, not at the top level).

  • Click Add Devices and Add One Device.

  • Enter the Device ID or Serial Number to add.

CLI - Add your device to your product

particle product device add <product_id> <device_id>

Claim your device

Claiming a device is separate from adding your device to a product. It makes your account the owner of the device, which allows to to so certain things like flash code directly to your device. Claiming is not always necessary; Tracker devices using Tracker Edge often run as unclaimed product devices. However, if you are going to be writing and testing firmware on devices, you almost certainly will need to claim the device.

CLI - Claim your device

This command looks similar to the one to add a device to a product, but it serves a different purpose: claiming a device to user account.

particle device add <device_id>

Mark as development device

In addition to claiming a device, it's useful to mark the device as a development device. The main purpose is to allow you to manage your own firmware flashing for the device, so you can directly program testing firmware and other custom firmware to your device. If you do not mark the device as a development device, the cloud will immediately replace your custom firmware with the default product firmware, which is probably not what you want.

Console - Mark as development device

  • Go to the Particle console.

  • Select Products in the left-hand icon bar, then the product you want to add your device to.

  • Select Devices (within the product, not at the top level).

  • Click the ... button to show the menu, and then select Mark as development.

There is no Particle CLI command to mark as a development device.

Name your device

Naming your device makes it easier to identify devices in the console, but is not required.

You should avoid using a name as a unique identifier for devices in your product, as it's not always set and not guaranteed to be unique. You should instead use the Device ID when identifying devices in a database or back-end service.

Console - Name your device

  • Go to the Particle console.

  • Select Products in the left-hand icon bar, then the product you want to add your device to.

  • Select Devices (within the product, not at the top level).

  • Click on the Device ID for the device you want to rename to open the Device Information window.

  • Click Edit in the upper right corner of the window.

  • Edit the name and click Save.

CLI - Name your device

particle device rename <device_id> <device_name>

Configure Wi-Fi

This step is not necessary for cellular devices (or the Tracker, which uses Wi-Fi only for geolocation).

For Wi-Fi devices you will need to set the Wi-Fi credentials. You can do this using the Particle CLI.

Make sure the device is connected to your computer using a USB cable. Make sure it's a data cable, not just a charging cable.

If the device is not currently in listening mode (blinking dark blue), you can put it in listening mode using one of the following methods:

  • Using the Particle CLI:

    particle usb start-listening
    

  • Alternatively, hold down the MODE (or SETUP) button until the status LED blinks dark blue.

Configure Wi-Fi:

particle serial wifi

This will interactively prompt for the SSID and password to use to connect to your Wi-Fi network.

After configuring Wi-Fi, the device should progress through the normal connection steps: blinking green, blinking cyan (light blue), fast blinking cyan, then breathing cyan.