Readd try viam

viamrobotics · Jan 7, 2025 · 351cafd · 351cafd
1 parent 7043103
commit 351cafd
Show file tree

Hide file tree

Showing 13 changed files with 1,603 additions and 7 deletions.
diff --git a/docs/dev/reference/try-viam/_index.md b/docs/dev/reference/try-viam/_index.md
@@ -0,0 +1,58 @@
+---
+title: "Try Viam"
+linkTitle: "Try Viam"
+childTitleEndOverwrite: "Try Viam"
+weight: 85
+type: "docs"
+description: "Try Viam by taking over a Viam Rover in our robotics lab."
+videos: ["/appendix/try-viam/rover.webm", "/appendix/try-viam/rover.mp4"]
+videoAlt: "Rover reservation management page"
+images: ["/appendix/try-viam/rover.gif"]
+no_list: true
+aliases:
+  - "/getting-started/try-viam/"
+  - "/tutorials/viam-rover/"
+  - /get-started/try-viam/tutorials/
+  - "/appendix/try-viam/tutorials/"
+  - "/try-viam/"
+  - "/get-started/try-viam/"
+  - "/appendix/try-viam-faq/"
+  - "/try-viam/faq/"
+  - "get-started/try-viam/faq/"
+  - /appendix/try-viam/
+date: "2022-01-01"
+# updated: ""  # When the content was last entirely checked
+---
+
+Viam is a general {{< glossary_tooltip term_id="smart-machine" text="smart machine">}} platform that can run on any hardware.
+The easiest way to try Viam is to [rent and remotely configure and control a Viam Rover](https://app.viam.com/try) located on-site at Viam in New York:
+
+<table>
+  <tr>
+    <th>{{<imgproc src="/appendix/try-viam/try-viam-1.svg" class="fill alignright" style="width: 300px" declaredimensions=true alt="ALT">}}
+      <b>1. Click on TRY in Viam</b>
+      <p>Log into the Viam app and go to the <a href="https://app.viam.com/try">TRY tab</a>. Don’t have a Viam account? Follow the <a href="/cloud/account/#create-account-and-log-in">instructions to sign up</a> for an account.</p>
+    </th>
+  </tr>
+  <tr>
+    <td>{{<imgproc src="/appendix/try-viam/try-viam-2.svg" class="fill alignleft" style="width: 300px" declaredimensions=true alt="ALT">}}
+      <b>2. Reserve your slot</b>
+      <p>If no one’s using a Viam Rover, you’ll take over immediately.
+Otherwise, you’ll see an estimated time for the next slot, and we’ll send you an email when it’s your turn.
+See <a href="/appendix/try-viam/reserve-a-rover/">detailed instructions</a>.</p>
+    </td>
+  </tr>
+  <tr>
+    <td>{{<imgproc src="/appendix/try-viam/try-viam-3.svg" class="fill alignright" style="width: 300px" declaredimensions=true alt="ALT">}}
+      <b>3. Get started with Viam</b>
+      <p>Try a Viam Rover in our robotics lab. <a href="/cloud/machines/#control">Drive</a> or <a href="/tutorials/control/drive-rover/">program</a> the rover to see how you can build a machine with Viam.</a></p>
+    </td>
+  </tr>
+</table>
+
+## Next steps
+
+{{< cards >}}
+{{% card link="/tutorials/control/drive-rover/" %}}
+{{% card link="/dev/reference/try-viam/rover-resources/" %}}
+{{< /cards >}}
diff --git a/docs/dev/reference/try-viam/reserve-a-rover.md b/docs/dev/reference/try-viam/reserve-a-rover.md
@@ -0,0 +1,142 @@
+---
+title: "Reserve a Viam Rover"
+linkTitle: "Reserve a Viam Rover"
+weight: 10
+type: "docs"
+description: "Reserve a Viam Rover located on-site at Viam in NYC."
+images: ["/appendix/try-viam/try-viam-reserve-preview.png"]
+imageAlt: "Rover reservation page"
+tags: ["try viam", "app"]
+aliases:
+  - "/try-viam/reserve-a-rover/"
+  - "/get-started/try-viam/reserve-a-rover/"
+toc_hide: true
+date: "2022-01-01"
+# updated: ""  # When the content was last entirely checked
+---
+
+_Try Viam_ is a way to try out the Viam platform without setting up any hardware yourself.
+You can take over a Viam Rover in our robotics lab to play around!
+
+Watch this tutorial video for a walkthrough of Try Viam, including [how to reserve a Viam Rover](#using-the-reservation-system), [navigate the Viam platform](/fleet/), and [drive the rover](/components/base/wheeled/#test-the-base):
+
+{{<youtube embed_url="https://www.youtube-nocookie.com/embed/YYpZ9CVDwMU" max-width="600px">}}
+
+## Using the reservation system
+
+### Create a reservation
+
+{{< readfile "/static/include/try-viam/create-a-reservation.md" >}}
+
+### Access your rover rental
+
+Once your reservation starts and the system has configured your rover, click **TRY MY ROVER** from the [**TRY VIAM** page](https://app.viam.com/try) or, if you were queuing, click **Take Me to My Rover** in the confirmation email.
+
+{{<gif webm_src="/appendix/try-viam/rover-reservation.webm" mp4_src="/appendix/try-viam/rover-reservation.mp4" alt="Rover reservation management page" max-width="1000px">}}
+
+{{<imgproc src="appendix/try-viam/navigation-bar.png" resize="800x" alt="Navigation bar of the Viam app with the Viam Rover time remaining indicator.">}}
+
+### Limitations
+
+When using a rented Viam rover, adding [modules](/registry/) is disabled for security purposes.
+
+### Extend your reservation
+
+{{< readfile "/static/include/try-viam/extend-a-reservation.md" >}}
+
+### Cancel my reservation
+
+{{< readfile "/static/include/try-viam/cancel-a-reservation.md" >}}
+
+## Next steps
+
+{{< cards >}}
+{{% card link="/tutorials/control/drive-rover/" %}}
+{{< /cards >}}
+
+## FAQ
+
+Try Viam allows you to try the Viam platform without setting up any hardware yourself.
+You can take over and play around with a Viam Rover in our robotics lab from anywhere in the world!
+
+### How do I make a reservation to take over a Viam Rover?
+
+{{< readfile "/static/include/try-viam/create-a-reservation.md" >}}
+
+### My machine had an error, a system crash, or is physically stuck
+
+1. Please notify Viam support on [our Community Discord](https://discord.gg/viam).
+2. Use the **Add Viam Support** button on your machine's Location page to give Viam Support access to your _location_.
+   Refer to [Managing Locations and sub-locations](/cloud/locations/).
+
+### Can I extend my time?
+
+Sure!
+
+{{< readfile "/static/include/try-viam/extend-a-reservation.md" >}}
+
+### Can I cancel my reservation/session?
+
+Yes.
+
+{{< readfile "/static/include/try-viam/cancel-a-reservation.md" >}}
+
+### How can I reuse my borrowed rover?
+
+After using Try Viam, your machine config stays in your Viam account.
+You can access your machine page, write code to control it, and modify its config after your reservation time ends.
+
+When you next borrow a rover you can choose to configure it with a previous rover configuration from your account or create a new rover with the standard starting config.
+
+{{< alert title="Tip" color="tip" >}}
+You can also reuse your code for the rover for other machines that you configure with Viam in the future.
+{{< /alert >}}
+
+### What happens to my borrowed rover after the rental session?
+
+1. On session expiration, Viam removes the "live" status from the machine.
+2. Viam then removes your config from the physical machine in preparation for its next rental.
+3. The Rover Rental Location and the final config of all previous rental rovers remain visible to your organization.
+   You can continue modifying the configurations as desired.
+
+### I accidentally deleted my machine
+
+Unfortunately, there is no recovery path for a deleted machine.
+If you delete your machine and have a current reservation, click **Cancel Reservation** and then request a new reservation.
+
+### Can I rename my machine or change the location?
+
+You can rename your machine or change the location.
+If you change the location, you must refresh the page.
+
+### Which organization does this machine e belong to?
+
+Your machine belongs to the [organization](/cloud/organizations/) you were in when you made the request.
+
+### Can I share this Location with a friend to work on the machine together?
+
+Sure, you can [invite other users to your organization](/cloud/locations/) to collaborate on your machine.
+As members of your organization, those users have full control of your machine.
+Another collaboration option is to use screen sharing in a Zoom or Webex session.
+
+### How many active rentals can I have?
+
+You can only borrow one rover at a time.
+You cannot join the queue for another reservation while you have an active rental session.
+If you would like to, you can [extend your reservation](/appendix/try-viam/reserve-a-rover/#can-i-extend-my-time).
+
+### I loved my experience - can I play around more?
+
+Yes! You can borrow the rover as many times as you’d like.
+Here are some tutorials which you can follow:
+
+- [Drive with the Viam SDK](/tutorials/control/drive-rover/)
+
+If you want to get your own Viam Rover, [you can](https://viam.com/resources/rover).
+
+### Why can't I use the rover's microphone?
+
+For security reasons, Viam has disabled the microphone on rover rentals.
+The microphone on [Viam Rovers shipped to you](/dev/reference/try-viam/rover-resources/) functions normally.
+
+{{< snippet "social.md" >}}
diff --git a/docs/dev/reference/try-viam/rover-resources/_index.md b/docs/dev/reference/try-viam/rover-resources/_index.md
@@ -0,0 +1,51 @@
+---
+title: "Your own Viam Rover"
+linkTitle: "Your own Viam Rover"
+weight: 80
+simple_list: true
+type: docs
+tags: ["rover", "viam rover"]
+images: ["/appendix/try-viam/rover-resources/viam-rover/box-contents.jpg"]
+imageAlt: "A Viam Rover in a box"
+aliases:
+  - "/viam-rover-resources/"
+  - "/rover-resources/"
+  - "/try-viam/rover-resources/"
+  - "/get-started/try-viam/rover-resources/"
+  - /appendix/try-viam/rover-resources/
+description: If you want a convenient mobile base for robotics projects, order a Viam rover and set it up.
+date: "2022-01-01"
+# updated: ""  # When the content was last entirely checked
+---
+
+{{< alert title="Tip" color="tip" >}}
+If you want a convenient mobile {{% glossary_tooltip term_id="base" text="base"%}} for a variety of robotics projects, you can now [order your own Viam rover](https://www.viam.com/resources/rover).
+{{< /alert >}}
+
+<div class="td-max-width-on-larger-screens">
+<div class="row">
+    <div class="col">
+        <a href="https://www.viam.com/resources/rover" target="_blank">
+            {{<imgproc src="appendix/try-viam/rover-resources/viam-rover/rover-front.jpg" resize="400x" alt="The front of the assembled Viam Rover" style="width:400px; min-width:300px; float: left" >}}
+    </div>
+    <div class="col" style= "min-width:300px;">
+        <p>
+            The <a href="https://www.viam.com/resources/rover" target="_blank">Viam Rover 2</a> arrives preassembled with two encoded motors with suspension, a webcam with a microphone unit, a 6 axis IMU, power management and more.
+            It is primarily designed for use with a Raspberry Pi 4.
+            Featuring an anodized aluminum chassis with expandable mounting features, the rover can comfortably navigate indoor environments with a 20 lb payload.
+            You can customize your rover by mounting <a href="/components/sensor/">sensors</a>, <a href="/components/camera/">LiDAR</a>, and <a href="/components/arm/">arms</a>.
+        </p>
+    </div>
+</div>
+</div>
+
+{{< alert title="Important" color="note" >}}
+You must purchase the following hardware separately:
+
+- A Raspberry Pi 4
+- Four 18650 batteries or RC-type battery (with charger)
+- A MicroSD card and an adapter/reader
+
+{{< /alert >}}
+
+### Next steps