Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 86baa6e

Browse files
committedDec 21, 2024·
Address build apps feedback
1 parent b71e1bc commit 86baa6e

File tree

4 files changed

+68
-6
lines changed

4 files changed

+68
-6
lines changed
 
41.6 KB
Loading

‎docs/operate/control/headless-app.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,6 @@ Sharing this information could compromise your system security by allowing unaut
175175
176176
## Write your control script
177177
178-
179178
For API reference including code snippets for each method, see [Viam's Client APIs](/dev/reference/apis/).
180179
181180
{{< expand "Example code for moving a rover in a square" >}}
@@ -496,7 +495,7 @@ Read and filter a machine's logs to view updates from your machine's `viam-serve
496495

497496
Navigate to the **LOGS** tab of your machine's page in the [Viam app](https://app.viam.com).
498497

499-
Use the **Filter** input to filter the logs by key terms, and select from the **Levels** dropdown menu to filter the logs by warning level:
498+
Select from the **Levels** dropdown menu to filter the logs by severity level:
500499

501500
![Filtering by log level of info in the logs tab of the Viam app.](/build/program/sdks/log-level-info.png)
502501

‎docs/operate/control/mobile-app/_index.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,26 @@ The Flutter SDK includes:
1515
- Widgets to ease the development process
1616
- Authentication tools so users can log in securely
1717

18-
## Example usage
18+
## Install the Flutter SDK
19+
20+
Run the following command in your terminal to install the Viam Flutter SDK:
21+
22+
```sh {id="terminal-prompt" class="command-line" data-prompt="$"}
23+
flutter pub add viam_sdk
24+
```
25+
26+
## Connect to your machine
27+
28+
You can find sample connection code on each machine's **CONNECT** tab in the [Viam app](https://app.viam.com).
29+
Select **Flutter** to display a code snippet with connection code as well as some calls to the APIs of the resources you've configured on your machine.
30+
31+
You can use the toggle to include the machine API key and API key ID, though we strongly recommend storing your API keys in environment variables to reduce the risk of accidentally sharing your API key and granting access to your machines.
32+
33+
## Write your app
34+
35+
Refer to the [Viam Flutter SDK](https://flutter.viam.dev/) documentation for available methods and widgets.
36+
37+
### Example usage
1938

2039
The following code, part of [Drive a rover in a square in 2 minutes](/how-tos/drive-rover/), shows how you could move a robotic rover base in a square using the base API's [`moveStraight`](https://flutter.viam.dev/viam_sdk/Base/moveStraight.html) and [`spin`](https://flutter.viam.dev/viam_sdk/Base/spin.html) methods:
2140

@@ -66,8 +85,22 @@ For a more in-depth guide with more screens, see the following guide:
6685
{{% card link="/tutorials/control/flutter-app/" %}}
6786
{{< /cards >}}
6887

69-
## Set up authentication
88+
## Test your app
89+
90+
You can use the mobile app simulator on your development computer to test your app.
91+
The connection code will establish communication with your machine over LAN or WAN.
92+
93+
## Set up user authentication
7094

7195
Viam uses [FusionAuth](FusionAuth) for authentication and authorization.
7296

7397
Use the [Viam CLI `auth-app` command](/dev/tools/cli/#auth-app) to register your application with FusionAuth so that you or your users can log into your app with the same credentials they use to log into the [Viam app](https://app.viam.com).
98+
99+
For support building apps with custom login flows, [contact us](mailto:support@viam.com).
100+
101+
## Next steps
102+
103+
To publish your app to the app stores when you're done testing and adding authentication, see Flutter's articles:
104+
105+
- [iOS](https://docs.flutter.dev/deployment/ios)
106+
- [Android](https://docs.flutter.dev/deployment/android)

‎docs/operate/control/web-app.md

+32-2
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,46 @@ The TypeScript SDK includes:
1414
- Implementation of the standard component and service APIs to control your hardware and software
1515
- Authentication tools so users can log in securely
1616

17-
## Example usage
17+
## Install the TypeScript SDK
18+
19+
Run the following command in your terminal to install the Viam TypeScript SDK:
20+
21+
```sh {id="terminal-prompt" class="command-line" data-prompt="$"}
22+
npm install @viamrobotics/sdk
23+
```
24+
25+
## Connect to your machine
26+
27+
You can find sample connection code on each machine's **CONNECT** tab in the [Viam app](https://app.viam.com).
28+
Select **TypeScript** to display a code snippet, with connection code as well as some calls to the APIs of the resources you've configured on your machine.
29+
30+
You can use the toggle to include the machine API key and API key ID, though we strongly recommend storing your API keys in environment variables to reduce the risk of accidentally sharing your API key and granting access to your machines.
31+
32+
## Write your app
33+
34+
Refer to the [Viam TypeScript SDK](https://ts.viam.dev/) documentation for available methods.
35+
36+
### Example usage
37+
38+
For an example using Vite to connect to a machine, see [Viam's vanilla TypeScript quickstart example on GitHub](https://github.com/viamrobotics/viam-typescript-sdk/tree/main/examples/vanilla).
1839

1940
The following tutorial uses the Viam TypeScript SDK to query data that has been uploaded to the Viam cloud from a sensor, and display it in a web dashboard.
2041

2142
{{< cards >}}
2243
{{% card link="/tutorials/control/air-quality-fleet/" %}}
2344
{{< /cards >}}
2445

25-
## Set up authentication
46+
## Test your app
47+
48+
You can run your app directly on the machine's single-board computer (SBC) if applicable, or you can run it from a separate computer connected to the internet or to the same local network as your machine's SBC or microcontroller.
49+
The connection code will establish communication with your machine over LAN or WAN.
50+
51+
You can also host your app on a server or hosting service of your choice.
52+
53+
## Set up user authentication
2654

2755
Viam uses [FusionAuth](FusionAuth) for authentication and authorization.
2856

2957
Use the [Viam CLI `auth-app` command](/dev/tools/cli/#auth-app) to register your application with FusionAuth so that you or your users can log into your app with the same credentials they use to log into the [Viam app](https://app.viam.com).
58+
59+
For support building apps with custom login flows, [contact us](mailto:support@viam.com).

0 commit comments

Comments
 (0)
Please sign in to comment.