|
| 1 | +# Remote Sketchbook |
| 2 | + |
| 3 | +Arduino IDE provides a Remote Sketchbook feature that can be used to upload sketches to Arduino Cloud. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +In order to use this feature, a user must be registered on [Arduino Cloud](https://store.arduino.cc/digital/create) and logged in. |
| 9 | +This feature is completely optional and can be disabled in the IDE via _"File > Advanced > Hide Remote Sketchbook"_ menu item. |
| 10 | + |
| 11 | +## Developer guide |
| 12 | +A developer could use the content of this repo to create a customized version of this feature and implement a different remote storage as follows: |
| 13 | + |
| 14 | +### 1. Changing remote connection parameters in the Preferences panel (be careful while editing the Preferences panel!) |
| 15 | +Here a screenshot of the Preferences panel |
| 16 | + |
| 17 | +- The settings under _Arduino > Auth_ should be edited to match the OAuth2 configuration of your custom remote sketchbook storage |
| 18 | +- The setting under _Arduino > Sketch Sync Endpoint_ should be edited to point to your custom remote sketchbook storage service |
| 19 | +### 2. Implementing the Arduino Cloud Store APIs for your custom remote sketchbook storage |
| 20 | +Following the API Reference below: |
| 21 | + |
| 22 | +| API Call | OpenAPI documentation | |
| 23 | +| ------------- | ------------- | |
| 24 | +| DELETE create/v2/files/d/$HOME/sketches_v2{posixPath} | https://api2.arduino.cc/create/docs#!/files95v2/files_v2_deletedir | |
| 25 | +| DELETE create/v2/files/f/$HOME/sketches_v2{posixPath} | https://api2.arduino.cc/create/docs#!/files95v2/files_v2_deletefile | |
| 26 | +| GET create/v2/files/d/$HOME/sketches_v2{posixPath} | https://api2.arduino.cc/create/docs#!/files95v2/files_v2_list | |
| 27 | +| GET create/v2/files/f/$HOME/sketches_v2{posixPath} | https://api2.arduino.cc/create/docs#!/files95v2/files_v2_read | |
| 28 | +| GET create/v2/sketches | https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_search | |
| 29 | +| GET create/v2/sketches/byID/{id} | https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_byID | |
| 30 | +| GET create/v2/sketches/byPath{path} | https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_byPath | |
| 31 | +| POST create/v2/files/d/$HOME/sketches_v2{posixPath} | https://api2.arduino.cc/create/docs#!/files95v2/files_v2_mkdir | |
| 32 | +| POST create/v2/files/f/$HOME/sketches_v2{posixPath} | https://api2.arduino.cc/create/docs#!/files95v2/files_v2_write | |
| 33 | +| POST create/v2/sketches/{sketch.id} | https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_edit | |
| 34 | +| POST create/v3/files/cp | https://api2.arduino.cc/create/docs#!/files95v3/files_v3_copy | |
| 35 | +| POST create/v3/files/mv | https://api2.arduino.cc/create/docs#!/files95v3/files_v3_move | |
| 36 | +| PUT create/v2/sketches | https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_create | |
| 37 | + |
| 38 | +## Build the Arduino IDE with this extension |
| 39 | + |
| 40 | +To build the Arduino IDE with this extension, run the following in a terminal. On Windows, use _Git Bash_. |
| 41 | +```sh |
| 42 | +./bootstrap.sh |
| 43 | +``` |
0 commit comments