Skip to content

Commit

Permalink
Update Smart Machines copy (#1794)
Browse files Browse the repository at this point in the history
npentrel authored Sep 12, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent e9143ca commit 4b2debe
Showing 5 changed files with 69 additions and 59 deletions.
20 changes: 10 additions & 10 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Viam Documentation"
linkTitle: "Viam Documentation"
description: "Viam is a complete software platform for robots that runs on any 64-bit Linux OS and macOS."
description: "Viam is a complete software platform for smart machines that runs on any 64-bit Linux OS and macOS."
weight: 1
no_list: true
type: "docs"
@@ -13,7 +13,7 @@ sitemap:
<div class="max-page">
<p>
Welcome to the Viam Documentation!
Viam is a complete software platform for robots that runs on Linux and macOS and supports a wide variety of popular systems, including:
Viam is a complete software platform for {{< glossary_tooltip term_id="smart-machine" text="smart machines">}} that runs on Linux and macOS and supports a wide variety of popular systems, including:
</p>
</div>

@@ -136,23 +136,23 @@ sitemap:
</div>
<div class="col hover-card landing purple">
<div>
<div>Configure your robots</div>
<div>Configure your smart machine</div>
<div style="text-align: left">
<ol style="padding-inline-start: 1.1rem">
<li><a href="manage/configuration/">Configure your robot</a> or <a href="manage/fleet/">fleet</a></li>
<li><a href="installation/">Install Viam on your robot</a></li>
<li><a href="components/">Configure robot components</a> and <a href="services/">add services</a></li>
<li><a href="manage/fleet/robots/#control">Control and test your robot</a></li>
<li>Configure a <a href="manage/configuration/"> machine</a> or a <a href="manage/fleet/">fleet</a></li>
<li><a href="installation/">Install Viam on your machine</a></li>
<li>Configure <a href="components/">components</a> and <a href="services/">add services</a></li>
<li><a href="manage/fleet/robots/#control">Control and test your machine</a></li>
</ol>
</div>
</div>
{{<gif webm_src="/blink.webm" mp4_src="/blink.mp4" alt="A blinking L.E.D. connected to a Raspberry Pi">}}
</div>
<div class="col hover-card landing teal">
<div>
<div>Program your robots</div>
<div>Program your machine</div>
<p style="text-align: left;">
Program and control your robots in <a href="program/apis/"> the languages you already know</a> like <a href="https://python.viam.dev/">Python</a>, <a href="https://pkg.go.dev/go.viam.com/rdk">Go</a>, <a href="https://ts.viam.dev/">TypeScript</a>, <a href="https://cpp.viam.dev/" target="_blank">C++</a>, or <a href="https://flutter.viam.dev/" target="_blank">Flutter</a>.
Program and control your machines in <a href="program/apis/"> the languages you already know</a> like <a href="https://python.viam.dev/">Python</a>, <a href="https://pkg.go.dev/go.viam.com/rdk">Go</a>, <a href="https://ts.viam.dev/">TypeScript</a>, <a href="https://cpp.viam.dev/" target="_blank">C++</a>, or <a href="https://flutter.viam.dev/" target="_blank">Flutter</a>.
</p>
</div>
<div class="hover-card-img">
@@ -162,7 +162,7 @@ sitemap:
<div class="col hover-card landing pink">
<div>
<div>Community</div>
<p style="text-align: left;">Have questions, or want to meet other people working on robots? <a href="https://discord.gg/viam">Join us in the Community Discord!</a></p>
<p style="text-align: left;">Have questions, or want to meet other people working on smart machines? <a href="https://discord.gg/viam">Join us in the Community Discord!</a></p>
</div>
{{<gif webm_src="/heart.webm" mp4_src="/heart.mp4" alt="A robot drawing a heart">}}
</div>
10 changes: 10 additions & 0 deletions docs/appendix/glossary/smart-machine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Smart Machine
id: smart-machine
full_link:
short_description: A machine or device that lives in the real world and has some ability to perceive the world (with a sensor, for example) and perform actions like operating a motor.
aka:
---

A machine or device that lives in the real world and has some ability to perceive the world (with a sensor, for example) and perform actions like operating a motor.
The machine might also interact with other systems, with the cloud, or with users.
14 changes: 7 additions & 7 deletions docs/program/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Program a Robot"
linkTitle: "Program Robots"
childTitleEndOverwrite: "Program Robots"
description: "Use the SDK of your preferred language to write code to control your robots."
title: "Program a Smart Machine"
linkTitle: "Program Machines"
childTitleEndOverwrite: "Program Machines"
description: "Use the SDK of your preferred language to write code to control your smart machines."
weight: 45
no_list: true
type: docs
image: "/general/code.png"
imageAlt: "Program a Robot"
imageAlt: "Program a smart machine"
images: ["/general/code.png"]
aliases:
- "product-overviews/sdk-as-client"
@@ -17,12 +17,12 @@ aliases:

Viam offers software development kits (SDKs) in popular languages which

- Broker connection, authentication, and encryption for communication with robots running `viam-server` using {{< glossary_tooltip term_id="webrtc" >}}
- Broker connection, authentication, and encryption for communication with {{< glossary_tooltip term_id="smart-machine" text="smart machines">}} running `viam-server` using {{< glossary_tooltip term_id="webrtc" >}}
- Enable you to interface with robot [gRPC APIs](https://github.com/viamrobotics/api) in a way that is idiomatic to that programming language

![Diagram showing how a client connects to a robot with Viam. Diagram shows a client as a computer sending commands to a robot. Robot 1 then communicates with other robotic parts over gRPC and WebRTC and communicating that information back to the client.](/program/sdks/robot-client.png)

Use the SDK of your preferred language to write code to control your robots.
Use the SDK of your preferred language to write code to control your smart machine.

Viam currently offers SDKs for the following languages:

4 changes: 2 additions & 2 deletions docs/try-viam/_index.md
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ aliases:
- "/getting-started/try-viam/"
---

Viam is a general robotics platform that can run on any hardware.
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>
@@ -35,7 +35,7 @@ See <a href="/try-viam/reserve-a-rover/">detailed instructions</a>.</p>
<tr>
<td>{{<imgproc src="/try-viam/try-viam-3.svg" class="fill alignright" style="max-width: 300px" declaredimensions=true alt="ALT">}}
<b>3. Get started with Viam</b>
<p>Try a Viam Rover in our robotics lab. <a href="/try-viam/try-viam-tutorial/">Control</a>, <a href="/try-viam/try-viam-tutorial/#base-control">drive</a>, or <a href="/tutorials/get-started/try-viam-sdk/">program</a> the rover to see how you can build a robot with Viam. You can also try services like <a href="/tutorials/services/try-viam-color-detection/">computer vision.</a></p>
<p>Try a Viam Rover in our robotics lab. <a href="/try-viam/try-viam-tutorial/">Control</a>, <a href="/try-viam/try-viam-tutorial/#base-control">drive</a>, or <a href="/tutorials/get-started/try-viam-sdk/">program</a> the rover to see how you can build a smart machine with Viam. You can also try services like <a href="/tutorials/services/try-viam-color-detection/">computer vision.</a></p>
</td>
</tr>
</table>
Loading

0 comments on commit 4b2debe

Please sign in to comment.