# Get started with Particle Workbench

**URL:** <https://community.particle.io/t/get-started-with-particle-workbench/50143>\
**Category:** Tutorials\
**Created:** [June 3, 2019, 4:03pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143 "2019-06-03T16:03:56Z")\
**Posts on this page:** 20\
**Page:** 1

<div class="post-metadata">

**Author:** ![bsatrom](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/bsatrom/32/16819_2.png) [@bsatrom](https://community.particle.io/u/bsatrom)\
**Post date:** [June 3, 2019, 4:03pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/1 "2019-06-03T16:03:56Z")

</div>

Originally published at: [https://blog.particle.io/2019/06/03/get-started-with-particle-workbench/](https://blog.particle.io/2019/06/03/get-started-with-particle-workbench/)

[Particle Workbench](https://particle.io/workbench) is a robust, local Integrated Development Environment for firmware development and debugging. It provides all of the tools, libraries, and extensions you need for IoT development, and because Workbench built on Visual Studio Code, you get all the features available in the world’s most popular, cross-platform text editor.

In this [video](https://www.youtube.com/watch?v=_ayljPW98oU), you’ll learn how to use [Particle Workbench](https://particle.io/workbench) as your local IDE for Particle projects. Particle Workbench is available for Windows, macOS and Linux, and provides all of the same capabilities as the Particle Web IDE, plus a number of other features that are perfect for Particle power users.

For other videos covering the basics of working with Particle devices, check out our [Particle 101 series on YouTube](https://www.youtube.com/watch?v=0T5rFu-9JAI&list=PLIeLC6NIW2tKvC5W007j_PU-dxONK_ZXR). If you have questions about using Particle Workbench, or anything else in the Particle platform, [visit us in the Particle Community](https://community.particle.io).

---

<div class="post-metadata">

**Author:** ![gusgonnet](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/gusgonnet/32/27491_2.png) [@gusgonnet](https://community.particle.io/u/gusgonnet)\
**Post date:** [June 28, 2019, 1:15pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/2 "2019-06-28T13:15:40Z")

</div>

I’ve been using VS Code for everything - and also for Particle dev for many years [with this hack](https://www.hackster.io/gusgonnet/use-visual-studio-code-for-your-particle-development-needs-9e23bc).  
I’ve been using now Workbench and I must say it’s great work.  
One thousand chapeau bas to you @m_m !!!

Nice video Brandon, you _almost_ convinced me to leave the VS Code dark theme behind.  
I like it that the video is short and to the point, 👍  
Gustavo.

---

<div class="post-metadata">

**Author:** ![m\_m](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/m_m/32/18365_2.png) [@m\_m](https://community.particle.io/u/m_m)\
**Post date:** [June 28, 2019, 4:52pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/3 "2019-06-28T16:52:15Z")

</div>

thank you @gusgonnet 🙏❤

we’re just getting started 😉

---

<div class="post-metadata">

**Author:** ![bsatrom](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/bsatrom/32/16819_2.png) [@bsatrom](https://community.particle.io/u/bsatrom)\
**Post date:** [June 28, 2019, 4:58pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/4 "2019-06-28T16:58:14Z")

</div>

Full-disclosure, @gusgonnet, I use a dark theme for my day-to-day work (currently the amazing Synthwave 84), but switch to lite for demos and videos. 😃

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [June 28, 2019, 5:45pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/5 "2019-06-28T17:45:36Z")

</div>

I need to use Visual Studio Work Bench now to start playing around with the Gen 3 Bluetooth features.

I have all my projects in folders that I build in using Particle DEV.

When I open the project folders in Work Bench its all there but when I then open the Particle Tab and choose which device I want to compile for I get this error message saying it’s needing a Project.Properties file?

I assume this is a file that Particle DEV did not need or generate that is generated when starting a new project in Work Bench.

So what do I need to do when loading project folders from Particle DEV into Work Bench to generate this Project.properties file it’s asking for?

 ![image](https://us1.discourse-cdn.com/flex026/uploads/particle/original/3X/5/2/52b0e80d719681a1b310463372e45d16322d6eb8.png)

 ![image](https://us1.discourse-cdn.com/flex026/uploads/particle/original/3X/8/3/83c382d7e2585caddab4c2bfd4c832bf53cb4ac9.png)

---

<div class="post-metadata">

**Author:** ![gusgonnet](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/gusgonnet/32/27491_2.png) [@gusgonnet](https://community.particle.io/u/gusgonnet)\
**Post date:** [June 28, 2019, 6:00pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/6 "2019-06-28T18:00:39Z")

</div>

> [@RWB](#):
>
> So what do I need to do when loading project folders from Particle DEV into Work Bench to generate this Project.properties file it’s asking for?

I don't know what you need to do, but I can tell you what I did.

- I left my old projects intact
- I chose my first old project as a candidate to be "migrated"
- I created a new project in VS Code//Workbench
- I copy-pasted the ino from the old project in the ino from VS Code/Workbench
- I added the libraries via VS Code//Workbench

boom, that worked fine for me.  
All the best Ryan!  
Gustavo.

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [June 28, 2019, 6:03pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/7 "2019-06-28T18:03:42Z")

</div>

Thanks!

I have a lot of custom/modified libraries so I’m hoping there is a easier way to create the Project.Properties file.

Looking forward to getting used to Work Bench, it’s look alot more powerful and feels cutting edge 🙂

---

<div class="post-metadata">

**Author:** ![gusgonnet](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/gusgonnet/32/27491_2.png) [@gusgonnet](https://community.particle.io/u/gusgonnet)\
**Post date:** [June 28, 2019, 6:06pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/8 "2019-06-28T18:06:49Z")

</div>

> [@RWB](#):
>
> I have a lot of custom/modified libraries so I’m hoping there is a easier way to create the Project.Properties file.

I have a few of those too.  
In those cases what I did is I copy-pasta the files right next to the ino file. The build process will pick them up.

> [@RWB](#):
>
> Looking forward to getting used to Work Bench, it’s look alot more powerful and feels cutting edge 🙂

VS Code is a great great great tool. I use it for all my coding needs, not only Particle. Love it. I'm ultra happy that we have Workbench now. 🍾

---

<div class="post-metadata">

**Author:** ![bsatrom](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/bsatrom/32/16819_2.png) [@bsatrom](https://community.particle.io/u/bsatrom)\
**Post date:** [June 28, 2019, 6:22pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/9 "2019-06-28T18:22:08Z")

</div>

Hey @RWB did you try running the “Import Project” command from the Workbench command palette?

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [June 28, 2019, 8:03pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/10 "2019-06-28T20:03:20Z")

</div>

Found some instructions @ScruffR had posted for somebody else which showed me how to create a new project.

> [@Workbench Visual Studio Code, cannot find the project.properties](https://community.particle.io/t/workbench-visual-studio-code-cannot-find-the-project-properties/47376/5):
>
> You should try Ctrl+Shift+P [image] Or maybe in your test folder you already have a project.

What I'm seeing is that your folder path cannot have any whitespace or blank spaces or it will not work. My folder path to all my projects had some whitespace so I had to erase the whitespace for them to work in Workbench.

So I can create a new blank project inside my current project folder that holds the code I want to use and then Workbench creates the project properties file which it is asking for. Then I copy the project code into the new project folder Workbench Created and were all good to go!

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [June 29, 2019, 8:57pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/11 "2019-06-29T20:57:06Z")

</div>

I finally have Particle Workbench up and running and I’m flashing code just like I used to on Particle IDE!

I’m very happy to have finally made the switch over to WorkBench and understand how to use the basic parts of the program now.

Excellent work Particle Team! @will @m_m @bsatrom @zach @zachary

---

<div class="post-metadata">

**Author:** ![bsatrom](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/bsatrom/32/16819_2.png) [@bsatrom](https://community.particle.io/u/bsatrom)\
**Post date:** [July 1, 2019, 2:09pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/12 "2019-07-01T14:09:52Z")

</div>

Awesome, glad to hear it @RWB! Let me know if you run into any other issues or have other questions!

For the whitespace issue, are you running WB on Windows?

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [July 1, 2019, 2:12pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/13 "2019-07-01T14:12:06Z")

</div>

Yes, Windows 10 on MacBook Pro

---

<div class="post-metadata">

**Author:** ![bsatrom](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/bsatrom/32/16819_2.png) [@bsatrom](https://community.particle.io/u/bsatrom)\
**Post date:** [July 1, 2019, 2:15pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/14 "2019-07-01T14:15:32Z")

</div>

Ok, I feel like that’s a known limitation I’ve seen before, but I don’t use Win10, so I can’t be certain. Is that right @m_m?

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [July 1, 2019, 3:20pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/15 "2019-07-01T15:20:35Z")

</div>

Should I clean the build every time I switch to compile the different Gen3 devices?

---

<div class="post-metadata">

**Author:** ![m\_m](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/m_m/32/18365_2.png) [@m\_m](https://community.particle.io/u/m_m)\
**Post date:** [July 1, 2019, 3:30pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/16 "2019-07-01T15:30:08Z")

</div>

> Should I clean the build every time I switch to compile the different Gen3 devices?

yes. workbench tries to detect a "dirty" state _at launch_ and will prompt you to clean if necessary but in general we say "when in doubt, clean" 👍

> What I’m seeing is that your folder path cannot have any whitespace or blank spaces or it will not work.

yes, an unfortunate limitation of our current build system - more info here:

> [@\[issue\] spaces in project path cause build errors (was: Workbench Build Errors)](https://community.particle.io/t/issue-spaces-in-project-path-cause-build-errors-was-workbench-build-errors/48767/8):
>
> is this the actual location of your project? “location”: “/home/john/Projects for ParticleIO/WorkbenchWorkspaceLocal/BLINKERLOCAL2” if so, we don’t support spaces in file paths since the underlying make system does not handle them well (if at all) - see: this would explain the error(s) you are seeing - e.g: recipe for targetParticleIO/WorkbenchWorkspaceLocal/BLINKERLOCAL2/target//Projects’ …/…/…/build/module.mk:235: target for' given more than once in the same rule. just to confirm, can …

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [July 1, 2019, 3:33pm UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/17 "2019-07-01T15:33:41Z")

</div>

> [@m\_m](#):
>
> yes. workbench tries to detect a “dirty” state _at launch_ and will prompt you to clean if necessary but in general we say “when in doubt, clean” 👍

Cool I turned off the Dirty Clean Check and quickly realized it's required which switching between devices so I turned the check back ON.

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [July 11, 2019, 12:50am UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/18 "2019-07-11T00:50:32Z")

</div>

Hey guys @m_m or anybody else 🙂

![image](https://us1.discourse-cdn.com/flex026/uploads/particle/original/3X/d/2/d249b746822eaf7c9a92473432c8f9f445a17492.png)

Do you guys know how to get this lightbulb problem finder back after it has been disabled?

I can’t find any info on how to get this little useful guy back 😄

---

<div class="post-metadata">

**Author:** ![m\_m](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/m_m/32/18365_2.png) [@m\_m](https://community.particle.io/u/m_m)\
**Post date:** [July 11, 2019, 1:06am UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/19 "2019-07-11T01:06:54Z")

</div>

🤔 i don’t recall the exact setting but i’m pretty sure you’ll find it if you open preferences - from the main menu click “Code” (or “File” on windows) \> “Preferences” to open the settings editor. from there you can click the “{}” icon top-right to toggle between editor and raw JSON views. raw JSON is a bit easier since it’ll just include your edits (vs. the editor which shows everything). check each level of settings - “User”, “Workspace”, and if applicable “Folder” - via the links top-left below the search bar.

---

<div class="post-metadata">

**Author:** ![RWB](https://sea2.discourse-cdn.com/flex026/user_avatar/community.particle.io/rwb/32/22599_2.png) [@RWB](https://community.particle.io/u/RWB)\
**Post date:** [July 11, 2019, 1:29am UTC](https://community.particle.io/t/get-started-with-particle-workbench/50143/20 "2019-07-11T01:29:30Z")

</div>

found it in settings!

Thanks!
