This is a super quick overview of the steps you’ll need to take to get your Photon board up and running. You’ll need:
- A Particle Photon
- The USB cable
- A laptop / desktop computer (Windows or Mac)
- An internet connection (and potentially a connection on your mobile phone too)
This is a quickstart guide for using Particle Dev, connecting it to the CMU network for the first time, and claiming your device.
There are a few other ways to get your device online. If you’re using your own personal network, these are quicker and easier:
There’s also detailed guides provided by Particle and if you run into trouble, it will be worth lookin at their connecting your photon guide
Starting the Setup
Let’s follow these steps for a hopefully headache free installation which will let you use the CMU network with your particle.
This guide (and all subsequent tutorials and guides) assumes you’re using the the downloadable IDE (interactive development environment. Particle Dev is awesome - it’s got tonnes of really nice features for developing IoT solutions and working with the Particle cloud. I highly recommend it.
But Particle also have an online web client that allows you to write code, work with libraries and flash programs to your device: Particle Build. If you’re planning to use the web client, that’s great, but please see the documentation on the Particle.io - https://docs.particle.io/guide/getting-started/start/photon/
Step 1. Plug in Your Particle Photon
Connect your Particle board to your computer using the USB cord.
The devices’s light will flash Blue. This means it doesn’t know how to connect to the Wireless network… yet.
Hold on it’s not blinking blue…
- Hold down the SETUP button (button to the left of the main LED) until it starts blinking blue.
Step 2: Download Particle Dev
Visit https://www.particle.io/dev and download the software. It’s available for Windows and Mac.
Once downloaded, unzip the download and move “Particle Dev” to your Applications folder.
Launch the application.
Detailed information on using Particle Dev is at: http://docs.particle.io/dev/.
Step 3: Open Particle Dev
You should see something like this.
This is where the fun begins because the CMU network doesn’t play nice with devices. In order to get a device on the network we need to know its MAC address and to know its MAC address we need to have it on the network. Yowsers!
First, we need to find out a little information about our device. We need the
- Device ID - This is what the Particle Cloud knows the device as. It’s a big long string of letters and numbers that uniqiely identifies it. We don’t need to know this but we do need it to get our Particle device connected to the cloud.
- Mac Address - This is what a wireless network knows the device as. It’s a unique identifier for the hardware we’re putting on the network. We need to know this to put the device on the CMU network.
To get this information, open the Serial Monitor as shown in the image above.
Click on the Particle menu (top right) and select the ‘Show Serial Monitor’ option. A new panel will open.
Then select your USB port. It’ll look something like
/dev/cu.usbmodem1411and click Connect.
iin the text entry field at the bottom that says “Enter string to send…”
Some text should appear. Bingo. You just got the identity of the device
min the text entry field at the bottom that says “Enter string to send…”
Some text should appear. Awesome. You just got the mac address of the device
Keep it safe
You’ll need this information again and it’s important. Copy and paste it to a text file for safe keeping.
Not working or not displaying information?
If your device isn’t returning any information, there’s a couple of things to try
First, is it in listening mode? To check, just make sure the LED on your device is blinking deep blue. If its not, just hold down the
SETUP button for 3-5 seconds and try the steps again.
Second, you might need to update your firmware Firmware is the stuff that makes the board work - it monitors, controls and interfaces with the hardware, and it interprets the code you send it to make it work. Sometimes it needs to be updated to add new functionality or to patch problems. The easiest way to do this is to install the Particle CLI. Once installed, put the device in the DFU mode.
To do this, hold down the
RESET buttons together, then release the
RESET button. Wait a couple of seconds and the LED on the board will begin to flash yellow. When it does release the
SETUP. It should stay pulsing yellow. If it doesn’t or it’s another color, press reset and try again!
Then go to the command line and type
If all goes well your device will have the current firmware in 30 seconds, then you can try the above again!
Step 3: Register your device’s Mac Address with the CMU Network
Go to https://netreg.net.cmu.edu/ click enter and sign in with your CMU credentials.
Click the “Register New Machine” link.
Under “Network”, select “Wireless Network” and click continue.
Choose a host name for your machine’s DNS. Copy that url. for example: DARAGHSPARTICLEDEVICE.WV.CC.CMU.EDU
Enter the hardware address you copied earlier in the Hardware Address field and click continue.
It can take about an hour for your adapter to be registered with the network!
You don’t need to do this part everytime you connect your Particle device; just the first time you want to use it on the CMU network.
The next step will be to register (or claim) our device on the Particle Cloud. Unfortunately, you’ve got to wait until the NetReg piece is finished, before you can do this.
While we’re waiting, let’s create an account for Particle’s cloud.
Step 4: Sign Up for Particle Cloud
Open your web browser, and create an account on Particle
- Go to: https://build.particle.io/signup
- Follow the on screen instructions
This will also give you access to the online IDE (Particle Build) which you can use to develop applications within your web browser.
Step 5: Add your Login Details to Particle Dev
Launch Particle Dev (which you downloaded) and you will see a ‘Particle’ menu on the far right.
Click on this and you will see a dropdown asking you to ‘Log in to Particle Cloud’
Add your newly created account information and click ‘Log In’
Click on the menu again and you should see a bunch of options
You do? Great, we’re getting places…
Step 6: Connecting to WiFi
You’ve twiddled your thumbs and your network registration is applied and ready to roll. Now, let’s set up the CMU WiFi Details on your Particle Photon.
There’s a couple of ways to get your device onto WiFi:
a. RECOMMENDED: Using the Serial Monitor
Open Particle Dev, and select the ‘Show Serial Monitor’ option.
Connect to the serial monitor as before (see Step 3)
Type the letter ‘w’ immediately followed by the SSID of the wireless network i.e. CMU (all upper case)
You’ll be asked the settings for the network’s “Security 0=unsecured, 1 = WEP, 2=WPA, 3=WPA2”. Type 0 (unsecured)
The WiFi Settings will be applied.
If the device remains in the blinking blue (listening) mode, disconnect the USB power lead and plug it back in again. Works a charm!
b. Using Particle Dev (Caution!)
This doesn’t seem to work in the current version of Particle Dev, but will probably work again in a future release.
In Particle Dev: Select the ‘Particle’ Menu and the the option to ‘Setup Devices WiFi’ (__note: __)
It will scan for nearby WiFi signals, and select the hotspot or network you want to use. Select ‘CMU’ Wireless (not CMU-SECURE)
When selecting the SSID: For some reason, when you select the CMU SSID, it appears blank. Instead of pointing and clicking, you’ll just type in the SSID manually. Make sure it’s ALL CAPS too!
c. Using the Particle Command Line
If you’ve set up the Particle CLI, simply type
particle setup wifi and follow the prompts.
d. Using the Particle Tinker App
Open your smartphone, fire up the App,
- To add a new device, click the ‘+’ top right, select the ‘Photon’ as device, and follow the instructions.
- Set the Wireless network as
- SSID: CMU
- Authentication: None
- Password: none
- If you do this, you can also skip the remaining sections, as it will help you claim your device too!
Now… Cross your fingers. In a few seconds, your Particle Photon should flash green then slowly pulse cyan. This means it’s connected to your WiFi network. Super!
To set WiFi credientials your Particle device needs to be in listening mode. To check, just make sure the LED on your device is blinking deep blue.
If its not, just hold down the
SETUP button for 3-5 seconds and try the steps again.
Step 7: Claiming your device
Your Particle’s online and we’re ready to claim your device. Essentially we’re telling the Particle framework that this device belongs to your account and you’re the only person who should be able to access it’s data and send code to it. To do this we need:
- to know what the device is called in computer speak, or its hexadecimal ID (see step 2)
- to have the device connected to WiFi (see step 6)
Thankfully you’ve already got both of these… There’s two ways you can ‘claim’ your device using the Device ID - through Particle Dev on your desktop, or through the Build tool online.
Using Particle Dev.
Select the ‘Particle’ menu and choose ‘Claim Device’. Paste in the device ID, hit enter, and bobs your uncle, you now have a Photon linked to your account.
When you open the Particle Menu in Dev now, you should see something like this.
Now is a good time to name your device something memorable. Select “Rename xxxxxxxxxxx’ and add something in. If you have a problem naming it, you can always visit: https://www.particle.io/build#cores choose the cores option (bottom left) and add it via the online dashboard.
Using the Online Build tool
Visit: https://build.particle.io/build#devices choose the devices option (bottom left, looks like a cross-hairs)
Click the ‘Add a new Device’ button, paste in the device ID, and click to ‘claim device’.
Once added you can click on the name of any claimed device to rename it or view the device ID.
You’re all set to start using your Particle Photon!
If you leave campus and are working at home, or generally move places, remember that you’re also going to be changing WiFi networks! If you change networks you need to tell your device about it. If you’ve moved location and the device is stuck flashing green or rapidly blinking blue, you probably need to set new WiFi credentials
Particle devices remember the last WiFi network they were connected to, but if you change networks you have to tell it each time it should connect to a new or different network.
To do this, just put the device in listening mode (blinking deep blue) by holding down the
SETUP button for 3-5 seconds and follow the instructions in Step 6.