Skip to content

Commit

Permalink
Merge pull request #2221 from arduino/hannes7eicher/Cloud-Editor-File…
Browse files Browse the repository at this point in the history
…-Import

[MKC-1925] Update cloud import docs
  • Loading branch information
Hannes7eicher authored Oct 14, 2024
2 parents 670c90e + 82b82df commit cec72f2
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 26 deletions.
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.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
---
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://app.arduino.cc). 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)

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

* 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,38 +29,39 @@ 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)
![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)

### 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 [app.arduino.cc](https://app.arduino.cc). For some general information on how to get started on the Cloud Editor see [Getting Started with Arduino Cloud](https://docs.arduino.cc/arduino-cloud/guides/overview/). When you are logged in and ready, hit the "Create" button in the top right corner. Select "Import local file" and follow the instructions.

![import_sketch_and_library_img_3](./assets/import_1.png)
![import_sketch_and_library_img_4](./assets/import_2.png)

You can either upload single sketches or zip up your entire sketches folder, as described above and upload everything at once.

![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)
![import_sketch_and_library_img_4](./assets/import_3.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.
Wait for the upload process to complete.


### 4. You are done!

Once the import process is done there will be two reports, one for sketches and one for libraries.
Once the import process is done you're all set.

If you already have sketches with the same name on the online IDE, these sketches will fail to import to avoid conflicts.

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)

### 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.
But what if you want to use your own custom library on the Cloud Editor? To upload a custom library you need to open a sketch. Select "Libraries" on the left panel, click on "Custom" and press the upload button. Then just zip your custom library and upload it.

![import_sketch_and_library_img_8](assets/import_sketch_and_library_img_8.jpg)
![Upload Custom Library](./assets/custom_library_1.png)

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,12 +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.

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).
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 tutorials

You can find more tutorials in the [Arduino Cloud documentation page](/arduino-cloud).
You can find more tutorials in the [Arduino Cloud documentation page](https://docs.arduino.cc/arduino-cloud/).

0 comments on commit cec72f2

Please sign in to comment.