Skip to content

Commit

Permalink
Add example readme
Browse files Browse the repository at this point in the history
  • Loading branch information
njooma committed Aug 8, 2023
1 parent cc61dcd commit bb69e88
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
5 changes: 5 additions & 0 deletions example/README.md
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)
21 changes: 20 additions & 1 deletion example/viam_example_app/README.md
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
```

0 comments on commit bb69e88

Please sign in to comment.