Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MKC-1759 update "share your sketches" #2125

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please change this screenshot to one that doesn't have errors?

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: 'Importing files to the Web Editor'
description: 'Learn how to import your local sketchbook and custom libraries to the Web Editor.'
title: 'Importing files to the Cloud editor'
description: 'Learn how to import your local sketchbook and custom libraries to the Cloud editor.'
---

## Import Your Sketchbook and Libraries to the Web Editor
## Import Your Sketchbook and Libraries to the Cloud editor

Are you sticking to the desktop Arduino IDE because all your work is saved locally? That’s no longer a problem! Our brand new import tool enables you to upload your entire sketchbook with just a few clicks on the [Arduino Web Editor](https://create.arduino.cc/editor). It is particularly handy because it lets you **move all your sketches and libraries to the Cloud** in a single flow.
Are you sticking to the desktop Arduino IDE because all your work is saved locally? That’s no longer a problem! Our brand new import tool enables you to upload your entire sketchbook with just a few clicks on the [Arduino Cloud editor](https://create.arduino.cc/editor). It is particularly handy because it lets you **move all your sketches and libraries to the Cloud** in a single flow.

Once your sketchbook is online it will be available on any device and backed up.

![import_sketch_and_library_gif_1](assets/import_sketch_and_library_gif_1.gif)
![Importing a single sketch](assets/sketchImport.gif)

What can you import to the [Web Editor](https://create.arduino.cc/editor)?
What can you import to the [Cloud editor](https://create.arduino.cc/editor)?

* Single sketches in `.ino`, `.pde` and `.zip` format.

* Libraries in `.zip` format.

* Zipped folders containing sketches and libraries. Make sure your libraries are in a folder called `‘libraries’`. Be sure not to mix sketches and libraries in the same folder.

But let’s import your whole sketchbook in a few clicks, so you will be all set up to start using the Arduino Web Editor.
But let’s import your whole sketchbook in a few clicks, so you will be all set up to start using the Arduino Cloud editor.


### 1. Find your sketchbook
Expand All @@ -31,16 +31,15 @@ On your PC find out where your sketchbook folder is (it is called `‘Arduino’

Make a `.zip` pack of your sketchbook, you should obtain a file called *Arduino.zip*. Make sure it is `.zip` format, any other archive formats will not work.

![import_sketch_and_library_img_1](assets/import_sketch_and_library_img_1.jpg)
![import_sketch_and_library_img_2](assets/import_sketch_and_library_img_2.jpg)
![Compressing file (1/2)](assets/import_sketch_and_library_img_1.jpg)
![Compressing file (2/2)](assets/import_sketch_and_library_img_2.jpg)

### 3. Import your sketchbook to the Cloud

Go to [create.arduino.cc/editor](https://create.arduino.cc/editor). For some general information on how to get started on the Web Editor see [this tutorial](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-4b3e4a?ref=platform&ref_id=424_trending___&offset=0). When you are logged in and ready, hit the import button on the sketchbook panel. A popup with some instructions on how to import files into the Web Editor will be displayed. Press `“Import”` to continue.
Go to [create.arduino.cc/editor](https://create.arduino.cc/editor). For some general information on how to get started on the Cloud editor see [this tutorial](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-4b3e4a?ref=platform&ref_id=424_trending___&offset=0). When you are logged in and ready, hit the import button on the sketchbook panel. A popup with some instructions on how to import files into the Cloud editor will be displayed. Press `“Import”` to continue.

![Importing complete sketchbook](assets/sketchbookImport.gif)

![import_sketch_and_library_img_3](assets/import_sketch_and_library_img_3.jpg)
![import_sketch_and_library_img_4](assets/import_sketch_and_library_img_4.png)
![import_sketch_and_library_img_5](assets/import_sketch_and_library_img_5.png)

You will now see a file system window, select your *Arduino.zip* pack. Wait for the import process to finish. If your sketchbook is big (containing lots of files), this may take a while.

Expand All @@ -53,16 +52,16 @@ If you already have sketches with the same name on the online IDE, these sketche

If you have libraries in your sketchbook, another report will tell you those that got successfully imported. If you have existing custom libraries with the same names, it’ll prompt you to overwrite the existing ones. Be sure to proceed with caution!

![import_sketch_and_library_img_6](assets/import_sketch_and_library_img_6.png)
![import_sketch_and_library_img_7](assets/import_sketch_and_library_img_7.png)
![Import Done](assets/ImportDone.png)


### Importing a custom library

The Arduino community has written over 700 libraries that you can include in your sketches without having to install a thing. You can browse through all of them in the Library Manager and favorite the ones you like the most.

But what if you want to use your own custom library on the Web IDE? Just zip your custom library and click on the 'Import' button on the Library panel.

![import_sketch_and_library_img_8](assets/import_sketch_and_library_img_8.jpg)
![Import Library](assets/LibraryUpload.gif)

If you want to import multiple custom libraries at once you can do so by creating a single zip file which contains all of them and just import it.

Expand All @@ -76,9 +75,8 @@ If you want to import multiple custom libraries at once you can do so by creatin

* Remove backups, unrelated files and things you don’t want to import in general.

![import_sketch_and_library_img_9](assets/import_sketch_and_library_img_9.jpg)

Please note that **all the libraries that you have added via the Library Manager on the desktop IDE will be already available on the Web Editor without having to do anything**. If you want to see their related examples or select a specific version, look for them on the online Library Manager.
Please note that **all the libraries that you have added via the Library Manager on the desktop IDE will be already available on the Cloud editor without having to do anything**. If you want to see their related examples or select a specific version, look for them on the online Library Manager.

More info on the online Library Manager [on this tutorial](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-4b3e4a?ref=platform&ref_id=424_trending___&offset=0#toc-libraries-and-the-arduino-web-editor).

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading