-
-
Notifications
You must be signed in to change notification settings - Fork 5
[DESIGN] Dashboard create command [IOT-1388] #40
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 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
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,72 @@ | ||
# Dashboard create command | ||
|
||
## Review Period | ||
|
||
Best before October, 5, 2021. | ||
|
||
## Overview | ||
Arduino Cloud CLI should allow users to create a dashboard starting from a cloud template. | ||
|
||
The following User story has been taken from the [RFC](https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/2761064740/Arduino+Cloud+CLI). | ||
* User is able to launch a simple CLI command to create a Dashboard in Cloud | ||
* the new Dashboard to create is a logical copy of another existing “template” Dashboard | ||
* the newly created Dashboard is displaying variables coming from a Thing specified during creation | ||
|
||
## Problem | ||
**An implementation for this command should be chosen.** | ||
|
||
The RFC specifies that this command is going to work only for dashboards with a single thing. However, dashboards with multiple things are common and **it would be better to introduce this feature from the beginning.** | ||
|
||
The problem in supporting multiple things for a single dashboard lays in mapping the things described in the dashboard template to the actual things. | ||
Indeed, if a single thing is used, it can be passed as a simple flag into the command. | ||
|
||
## Implementation alternatives | ||
|
||
### Single thing support | ||
|
||
Let's take a simple example: | ||
```YAML | ||
id: home-security-alarm-dashboard | ||
name: Home Security Alarm | ||
widgets: | ||
- type: Messenger | ||
name: message_update | ||
variables: | ||
- thing_id: home-security-alarm | ||
variable_id: message_update | ||
``` | ||
In this example, the dashboard uses a single thing. So the command could easily be something like: | ||
|
||
```sh | ||
arduino-cloud-cli dashboard create --name <dashname> --template <yamldashtemplfile> --thing-id <mythingid> | ||
``` | ||
|
||
or even: | ||
|
||
```sh | ||
arduino-cloud-cli dashboard create --name <dashname> --template <yamldashtemplfile> --thing-override <home-security-alarm>=<mythingid> | ||
``` | ||
|
||
### Multiple things support | ||
|
||
Let's take another dashboard template: | ||
```YAML | ||
id: home-security-alarm-dashboard | ||
name: Home Security Alarm | ||
widgets: | ||
- type: Messenger | ||
name: message_update | ||
variables: | ||
- thing_id: home-security-messenger | ||
variable_id: message_update | ||
- type: Switch | ||
name: light_alarm | ||
variables: | ||
- thing_id: home-security-alarm | ||
variable_id: light_alarm | ||
``` | ||
Here the mapping could be: | ||
|
||
```sh | ||
arduino-cloud-cli dashboard create --name <dashname> --template <yamldashtemplfile> --thing-override home-security-alarm=<mythingid1>,home-security-messenger=<mythingid2> | ||
polldo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` |
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.