-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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,5 @@ | ||
# Viam SDK Examples | ||
|
||
This directory contains examples on how to use the Viam Flutter SDK. | ||
|
||
- [Viam Example App](https://github.com/viamrobotics/viam-flutter-sdk/tree/main/example/viam_example_app) |
This file contains 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 |
---|---|---|
@@ -1,3 +1,22 @@ | ||
# Viam Example Flutter App | ||
|
||
This example app uses Viam's Flutter SDK to connect to and control a robot. It was created using VSCode's Flutter plugin. | ||
This example app uses Viam's Flutter SDK to connect to and control a robot. It was created using VSCode's Flutter plugin and shows the basic use cases for how the Viam Flutter SDK can be used to connect to, view, and control your robot. | ||
|
||
## Setup | ||
|
||
In this directory (the main project directory) create a `.env` file with the following fields: | ||
|
||
``` | ||
ROBOT_LOCATION=<ROBOT_LOCATION_URI> | ||
LOCATION_SECRET=<ROBOT_LOCATION_SECRET> | ||
``` | ||
|
||
Both these fields can be obtained from your robot's `Code Sample` tab on [app.viam.com](https://app.viam.com). | ||
|
||
## Run | ||
|
||
Run `lib/main.dart`: | ||
|
||
``` | ||
flutter run lib/main.dart | ||
``` |