Viam Rover

A vanilla port of the Typescript "try viam" script to Tauri version 2

Author: Jason Levitt

Initial Release Date: August 29th, 2024

viam-rover demonstrates Tauri version 2's ability to run Typescript-for-the-browser as an application across both desktop and mobile platforms using only one code base.

Running on MacOS

Building The App

For prerequisites, see this page: Tauri prerequisites

Note that iOS emulation requires a Mac.

After you clone this repo:

$ cd viam-rover

Install the Javascript packages

$ yarn

or

$ npm install

Then, to build and launch the desktop version (tested on MacOS and Windows):

$ yarn tauri dev

or

$ npm run tauri dev

To build and launch the Android version:

$ yarn tauri android init
$ yarn tauri android dev

or

$ npm run tauri android init
$ npm run tauri android dev

To build and launch the iOS version:

$ yarn tauri ios init
$ yarn tauri ios dev

or

$ npm run tauri ios init
$ npm run tauri ios dev

Using The App

This sample app requires:

• a Viam API key
• a Viam API key ID
• a Viam App Address

1. You must first create a login at Viam: https://viam.com
2. Go to your profile settings in the upper-right hand corner to create your API key and API key ID
3. Then go to the Try Viam page here: https://app.viam.com/try
4. Click on the "TRY NOW" button and wait for a rover reservation
5. When it succeeds, click on the "TRY MY ROVER" button
6. In the dashboard, click on "CONNECT" in the menu bar
7. Copy the "Machine address (URI)" which you will use in the form field labeled "APP ADDRESS"

You can now run this app and populate the three fields.

Up to 20 seconds after you submit the form, the "Click Me" button should change color and be enabled.

Clicking on the "Click Me" button will display some rover actions.

You can right-click on the app (or Ctrl-click on MacOS) and select "inspect element" to see the web console.

A successful run:

A Successful Run on MacOS

Creating an .env file

Once you have your Viam API key and API key ID, you can optionally

create a .env file at the top-level of the repo that looks like this:

VITE_APP_API_KEY=joy8glxxxxxxxxxxxxxxxcngs
VITE_APP_API_KEY_ID=0dxxxxxx-9xxx-4xxx-9xxx-8xxxxx22

This will automatically populate the fields in the authentication form

(TODO: they are not visible in the form).

Running on an iPhone Emulator as a Native iOS App