-
-
Notifications
You must be signed in to change notification settings - Fork 443
[MKC-1750] Custom Cloud Templates Docs #2088
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
61aefd1
First Draft
jacobhylen 70d47e9
Update content.md
jacobhylen 019ba8f
Update content.md
jacobhylen 2d12980
add links
g-castronovo e3c742b
Update content.md
jacobhylen 89a6543
Merge branch 'jacobhylen/custom-templates' of https://github.com/ardu…
jacobhylen d0f70d8
Update content/arduino-cloud/06.features/13.custom-templates/content.md
jacobhylen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+208 KB
content/arduino-cloud/06.features/13.custom-templates/assets/ISDashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+297 KB
...rduino-cloud/06.features/13.custom-templates/assets/cloudinterfacetemplates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+239 KB
content/arduino-cloud/06.features/13.custom-templates/assets/description.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+225 KB
content/arduino-cloud/06.features/13.custom-templates/assets/newtemplate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+210 KB
content/arduino-cloud/06.features/13.custom-templates/assets/selectingThing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions
64
content/arduino-cloud/06.features/13.custom-templates/content.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: Custom Templates | ||
description: Learn how to use the custom templates feature, allowing you to easily recreate one of your existing projects, either for yourself or for sharing with the community. | ||
author: Jacob Hylén | ||
tags: [Arduino Cloud, templates] | ||
--- | ||
|
||
The **Custom Templates** feature is a part of the [Arduino Cloud](https://app.arduino.cc/) that allows you to create your own custom cloud templates, letting you configure a project complete with a [Thing](https://docs.arduino.cc/arduino-cloud/cloud-interface/things/), [Dashboard](https://docs.arduino.cc/arduino-cloud/cloud-interface/dashboard-widgets/), and [Triggers](https://docs.arduino.cc/arduino-cloud/cloud-interface/triggers/) with a step by step wizard guiding you through the process. | ||
|
||
With the Custom Templates feature, you can choose any of your existing cloud projects and walk through the process of turning it into a template within a few minutes. You can save it for you to use yourself, or export it as a `.tino` file to be shared with other people however you want. | ||
|
||
## Hardware & Software Needed | ||
To follow this guide, you will need: | ||
- An Arduino Cloud compatible board | ||
- An Arduino Cloud Project to turn into a template | ||
|
||
## Create Your Project | ||
First - we need our starting point. You may already have used the [Arduino Cloud](https://app.arduino.cc/) to create a project, if so you can go ahead with what you have already made. | ||
|
||
For the purposes of this guide, we'll use an example project that displays one of a few icons on the LED Matrix of an Arduino UNO R4 WiFi that you can choose from a selector widget. | ||
|
||
 | ||
|
||
## Creating the Template | ||
Now that we have a project that we want to turn into a template, let's get started. | ||
|
||
Go to the landing page of [Arduino Cloud](app.arduino.cc). In the sidebar to the left, find the button that says **Templates**. | ||
|
||
 | ||
|
||
Click into this page, and you should see that at the top there are two tabs, labelled "**Your Templates**" and "**Arduino Templates**", make sure you are in the one labelled "**Your Templates**". This is the tab that contains all the custom templates you've either made before or imported from a `.tino` file. | ||
|
||
Click Create in the top right, then Choose "New Template". | ||
|
||
 | ||
|
||
***Exiting the template creation process mid-way without saving by clicking "Generate Template" will cause any progress to be lost.*** | ||
|
||
### Selecting a Thing | ||
Now you should be taken to a new screen, where you add your IoT assets. Let's start with the Thing. | ||
|
||
Click "Thing" on the right side of the screen. | ||
 | ||
|
||
Then search for the Thing that you want to add to your template. "Icon Selector" in the case of this guide. Click your Thing, then "Add to Template". | ||
|
||
|
||
### Selecting a Dashboard | ||
Now do the same for the Dashboard. | ||
|
||
You may see a small prompt suggesting you to add a dashboard that was already associated with the Thing you're creating the template around, you can use this as a shortcut if you want to. Otherwise follow the same flow as for selecting your Thing. | ||
|
||
### Additional Documentation | ||
Now you may want to add a little bit more documentation for your project, such as a short description or images of schematics, wiring diagrams, and such. For the Icon Selector project there is no external circuit built around the board, so we're just going to write a small description, as such: | ||
|
||
 | ||
|
||
Once you've completed your template, click "Generate Template" and you're fininshed! It will now show up in the tab of "Your Templates" we saw at the beginning of this guide. | ||
|
||
## Exporting Your Template | ||
Once you're back on the Templates page, you can export the `.tino` file to be used by others by clicking the three dots on the side, and clicking "download (.tino)". This will start downloading the file that you can share with the community to let others recreate your project. | ||
|
||
## Conclusion | ||
In this article we've gone over how to use the **Custom Templates** feature of the Arduino Cloud to generate our own Cloud Templates that we and others can use to quickly recreate several instances of the same project. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.