mirror of https://github.com/arduino/arduino-ide.git synced 2025-06-13 15:46:34 +00:00

History

per1234 0ba88d5ab6 Move beta testing information to a dedicated documentation file

Previously, the information about tester builds was mixed in with the documentation about building the project from
source.

The two subjects are of relevance to two distinct contribution options. Building from source will primarily be done by
developers working on the project code base. Tester builds will be used by beta testers and reviewers.

For this reason, it doesn't make sense to require beta testers to wade through a lot of development documentation not
directly related to their work in order to find the instructions for obtaining tester builds. Likewise, it doesn't make
sense to clutter up the development documentation with such information.

Moving the information about tester builds to a dedicated file makes it easier for the interested parties to find, and
also allows the creation of a comprehensive guide for beta testers without making a negative impact on the development
documentation content.

2022-09-15 05:53:09 -07:00

assets

Move documentation assets to standard location

2022-09-15 05:53:09 -07:00

contributor-guide

Move beta testing information to a dedicated documentation file

2022-09-15 05:53:09 -07:00

internal

Move development documentation to a more suitable location

2022-09-15 05:53:09 -07:00

advanced-usage.md

Add instructions for accessing IDE's advanced settings

2022-09-07 00:16:14 -07:00

development.md

Move beta testing information to a dedicated documentation file

2022-09-15 05:53:09 -07:00

README.md

Move documentation assets to standard location

2022-09-15 05:53:09 -07:00

README.md

Remote Sketchbook

Arduino IDE provides a Remote Sketchbook feature that can be used to upload sketches to Arduino Cloud.

In order to use this feature, a user must be registered on Arduino Cloud and logged in. This feature is completely optional and can be disabled in the IDE via the "File > Advanced > Hide Remote Sketchbook" menu item.

Developer guide

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:

1. Changing remote connection parameters in the Preferences panel (be careful while editing the Preferences panel!)

Here a screenshot of the Preferences panel

The settings under Arduino > Auth should be edited to match the OAuth2 configuration of your custom remote sketchbook storage
The setting under Arduino > Sketch Sync Endpoint should be edited to point to your custom remote sketchbook storage service

2. Implementing the Arduino Cloud Store APIs for your custom remote sketchbook storage

Following the API Reference below:

API Call	OpenAPI documentation
DELETE create/v2/files/d/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_deletedir
DELETE create/v2/files/f/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_deletefile
GET create/v2/files/d/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_list
GET create/v2/files/f/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_read
GET create/v2/sketches	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_search
GET create/v2/sketches/byID/{id}	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_byID
GET create/v2/sketches/byPath{path}	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_byPath
POST create/v2/files/d/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_mkdir
POST create/v2/files/f/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_write
POST create/v2/sketches/{sketch.id}	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_edit
POST create/v3/files/cp	https://api2.arduino.cc/create/docs#!/files95v3/files_v3_copy
POST create/v3/files/mv	https://api2.arduino.cc/create/docs#!/files95v3/files_v3_move
PUT create/v2/sketches	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_create

Build the Arduino IDE with this extension

To build the Arduino IDE with this extension, run the following in a terminal. On Windows, use Git Bash.

./bootstrap.sh