Skip to content

Commit 261f2c4

Browse files
authored
DOCS-1101: Update to smart machine more broadly (#1863)
1 parent daf8f8a commit 261f2c4

26 files changed

+104
-104
lines changed

docs/appendix/glossary/board.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Board
33
id: board
44
full_link: /components/board/
5-
short_description: A board is the signal wire hub of a robot that provides access to GPIO pins, SPI or I2C.
5+
short_description: A board is the signal wire hub of a smart machine that provides access to GPIO pins, SPI or I2C.
66
aka:
77
---
88

9-
A board is the signal wire hub of a robot that provides access to GPIO pins, SPI or I2C.
9+
A board is the signal wire hub of a smart machine that provides access to GPIO pins, SPI or I2C.
1010

1111
Examples of boards include Jetson, Raspberry Pi, Numato, or Arduino.
1212

docs/appendix/glossary/client-application.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Client Application
33
id: client-application
44
full_link:
5-
short_description: Client applications run business logic to operate your robot.
5+
short_description: Client applications run business logic to operate your smart machine.
66
aka:
77
---
88

9-
Client applications run business logic to operate your robot.
9+
Client applications run business logic to operate your smart machine.
1010

1111
You can run a client application on the same {{< glossary_tooltip term_id="part" text="part" >}} that runs `viam-server`, or on a separate device.
12-
Client applications typically use an {{< glossary_tooltip term_id="sdk" text="SDK" >}} to talk to their robot.
12+
Client applications typically use an {{< glossary_tooltip term_id="sdk" text="SDK" >}} to talk to their smart machine.

docs/appendix/glossary/fragment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Fragment
33
id: fragment
44
full_link: /manage/configuration/#fragments
5-
short_description: A reusable configuration block that you can share across multiple robots.
5+
short_description: A reusable configuration block that you can share across multiple smart machines.
66
aka:
77
---
88

9-
A reusable configuration block that you can share across multiple robots.
9+
A reusable configuration block that you can share across multiple smart machines.
1010
For example, if you are deploying a specific mobile robot that is always physically connected the same way, you can create a fragment to make managing your fleet easy.
1111

1212
For more information, see [Fragments](../../manage/configuration/#fragments).

docs/appendix/glossary/location.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Location
33
id: location
44
full_link: /manage/fleet/locations/
5-
short_description: A location is a virtual grouping of robots that allows you to organize robots and manage access to your fleet.
5+
short_description: A location is a virtual grouping of smart machines that allows you to organize smart machines and manage access to your fleet.
66
aka:
77
---
88

9-
A location is a virtual grouping of robots that allows you to organize robots and manage access to your fleet.
9+
A location is a virtual grouping of smart machines that allows you to organize smart machines and manage access to your fleet.
1010

1111
For more information, see [Manage Locations and Sub-Locations](/manage/fleet/locations/).

docs/appendix/local-configuration-file.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ The `viam-server` binary uses a JSON-formatted configuration file to define all
1414

1515
When you [install `viam-server`](/installation/) from [the Viam app](https://app.viam.com), you configure your robot directly in the app, and the app will automatically sync your configuration to your robot.
1616

17-
However, if your robot will never connect to the internet, you will need to create your own local configuration file, using one of these options:
17+
However, if your smart machine will never connect to the internet, you will need to create your own local configuration file, using one of these options:
1818

19-
* [Build a local configuration file in the Viam app](#build-a-local-configuration-file-in-the-viam-app) - Use the Viam app to build the configuration file and copy it to your robot, without connecting your robot to the Viam app.
19+
* [Build a local configuration file in the Viam app](#build-a-local-configuration-file-in-the-viam-app) - Use the Viam app to build the configuration file and copy it to your smart machine, without connecting your smart machine to the Viam app.
2020
* [Build a local configuration file manually](#build-a-local-configuration-file-manually) - Build your own local configuration file based on the example file.
2121

2222
For information on the individual configuration options available, see [Configuration](/manage/configuration/).
2323

2424
## Build a local configuration file in the Viam app
2525

26-
If your robot will never connect to the internet, and you want to create a local configuration file manually, you can still use the Viam app to build the configuration file even without connecting your robot to it.
26+
If your robot will never connect to the internet, and you want to create a local configuration file manually, you can still use the Viam app to build the configuration file even without connecting your smart machine to it.
2727
Follow the steps below to build and then download your configuration file:
2828

2929
1. Navigate to [the Viam app](https://app.viam.com) and select the **Config** tab.

docs/components/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "In-depth information on the various components available within th
88
images: ["/icons/components.png"]
99
---
1010

11-
A *component* represents a physical piece of electrical or electromechanical hardware in a robot.
11+
A *component* represents a physical piece of electrical or electromechanical hardware in a smart machine.
1212

1313
The following component types are natively supported.
1414
If you would like to use additional component types, you can [extend Viam with custom components and services](/extend/).

docs/components/camera/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: "Camera"
44
childTitleEndOverwrite: "Camera Component"
55
weight: 40
66
type: "docs"
7-
description: "A camera captures 2D or 3D images and sends them to the computer controlling the robot."
7+
description: "A camera captures 2D or 3D images and sends them to the computer controlling the smart machine."
88
no_list: true
99
tags: ["camera", "components"]
1010
icon: "/icons/components/camera.svg"

docs/extend/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Viam's [Robot Development Kit (RDK)](/internals/rdk/) provides built-in support
1616
- Various types of hardware [components](/components/).
1717
- High-level functionality exposed as [services](/services/).
1818

19-
However, if you want to work with a new hardware component that is not already supported by Viam, or want to introduce a new software service or service model to support additional functionality on your robot, you can extend Viam by adding a [modular resource](/extend/modular-resources/) to your robot.
19+
However, if you want to work with a new hardware component that is not already supported by Viam, or want to introduce a new software service or service model to support additional functionality on your smart machine, you can extend Viam by adding a [modular resource](/extend/modular-resources/) to your smart machine.
2020

2121
Click on the cards below for instructions on implementing modular resources through {{< glossary_tooltip term_id="module" text="modules" >}} or {{< glossary_tooltip term_id="remote" text="remotes" >}}:
2222

docs/extend/modular-resources/_index.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ linkTitle: "Modular Resources"
44
weight: 10
55
type: "docs"
66
tags: ["server", "rdk", "extending viam", "modular resources", "components", "services"]
7-
description: "Use the Viam module system to implement modular resources that can be included in any Viam-powered robot."
7+
description: "Use the Viam module system to implement modular resources that can be included in any Viam-powered smart machine."
88
no_list: true
99
aliases:
1010
- "/program/extend/modular-resources/"
1111
---
1212

13-
At Viam, a robot is configured with one or more {{< glossary_tooltip term_id="resource" text="resources" >}} ([components](/components/) or [services](/services/)) which are each defined by a [public API](/extend/modular-resources/key-concepts/#valid-apis-to-implement-in-your-model).
14-
While Viam offers a number of built-in implementations against these APIs, such as the [wheeled base](/components/base/wheeled/), you may also write your own implementations in order to extend the capabilities of your robot.
13+
At Viam, a smart machine is configured with one or more {{< glossary_tooltip term_id="resource" text="resources" >}} ([components](/components/) or [services](/services/)) which are each defined by a [public API](/extend/modular-resources/key-concepts/#valid-apis-to-implement-in-your-model).
14+
While Viam offers a number of built-in implementations against these APIs, such as the [wheeled base](/components/base/wheeled/), you may also write your own implementations in order to extend the capabilities of your smart machine.
1515

1616
For example, you can:
1717

18-
- **Implement a custom component:** If your robot has specialty hardware, such as an unsupported [motor](/components/motor/), and you want to control it using Viam, you can write a driver to support your hardware by implementing the corresponding component API.
18+
- **Implement a custom component:** If your smart machine has specialty hardware, such as an unsupported [motor](/components/motor/), and you want to control it using Viam, you can write a driver to support your hardware by implementing the corresponding component API.
1919

20-
- **Implement a custom service:** If your robot makes use of a specialty algorithm or data model when working with services such as [SLAM](/services/slam/), [Vision](/services/vision/), or [Motion planning](/services/motion/), you can implement your own algorithm or model against the corresponding service API.
20+
- **Implement a custom service:** If your smart machine uses a custom algorithm or data model when working with services such as [SLAM](/services/slam/), [Vision](/services/vision/), or [Motion planning](/services/motion/), you can implement your own algorithm or model against the corresponding service API.
2121

22-
- **Implement fully custom logic:** If your robot runs specialty or proprietary logic, and you want to use Viam to manage and control that logic, such as when managing a software development lifecyle, you can implement your own custom logic by wrapping the generic API.
22+
- **Implement fully custom logic:** If your smart machine runs custom or proprietary logic and you want to use Viam to manage and control that logic, such as when managing a software development lifecyle, you can implement your own custom logic by wrapping the generic API.
2323

24-
These custom implementations are called *modular resources*, and are made available for use on a robot through {{< glossary_tooltip term_id="module" text="modules" >}}.
25-
A module can provide one or more modular resources, and can be added to your robot from the Viam registry.
24+
These custom implementations are called *modular resources*, and are made available for use on a smart machine through {{< glossary_tooltip term_id="module" text="modules" >}}.
25+
A module can provide one or more modular resources, and can be added to your smart machine from the Viam registry.
2626

2727
## The Viam registry
2828

@@ -34,12 +34,12 @@ Once the module has been uploaded to the registry, you can [deploy the module](/
3434

3535
### Uploading to Viam registry
3636

37-
After you finish programming your module, you can [upload your module to the Viam registry](/extend/modular-resources/upload/) to make it available for deployment to robots.
37+
After you finish programming your module, you can [upload your module to the Viam registry](/extend/modular-resources/upload/) to make it available for deployment to smart machines.
3838
As part of the upload process, you decide whether your module is *private* (visible only to other members of your [organization](/manage/fleet/organizations/)), or *public* (visible to all Viam users).
3939

4040
You can see details about each module in the [Viam registry](https://app.viam.com/registry) on its module details page.
4141
See the [Odrive module](https://app.viam.com/module/viam/odrive) for an example.
42-
Public modules also display the number of times a module has been deployed to a robot.
42+
Public modules also display the number of times a module has been deployed to a smart machine.
4343

4444
When you make changes to your module, you can [uploaded the newer version](/extend/modular-resources/upload/#update-an-existing-module) with a new version number, and the Viam registry will track each version that you upload.
4545

docs/extend/modular-resources/create/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ linkTitle: "Create"
44
weight: 20
55
type: "docs"
66
tags: ["server", "rdk", "extending viam", "modular resources", "components", "services"]
7-
description: "Use the Viam module system to implement modular resources that can be included in any Viam-powered robot."
7+
description: "Use the Viam module system to implement modular resources that can be included in any Viam-powered smart machine."
88
no_list: true
99
---
1010

11-
You can extend Viam by creating a custom {{< glossary_tooltip term_id="module" text="module" >}} that provides one or more modular {{< glossary_tooltip term_id="resource" text="resources" >}} ([components](/components/) and [services](/services/)) or {{< glossary_tooltip term_id="model" text="models" >}}, and can be added to any robot running on Viam.
11+
You can extend Viam by creating a custom {{< glossary_tooltip term_id="module" text="module" >}} that provides one or more modular {{< glossary_tooltip term_id="resource" text="resources" >}} ([components](/components/) and [services](/services/)) or {{< glossary_tooltip term_id="model" text="models" >}}, and can be added to any smart machine running on Viam.
1212

1313
A common use case for modular resources is to create a new [model](/extend/modular-resources/key-concepts/#models) that implements an existing Viam [API](/program/apis/).
1414

docs/extend/modular-resources/key-concepts.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ A custom module can provide one or more modular resource models.
1313

1414
## Modules
1515

16-
A *module* provides one or more [*modular resources*](#resources), and is a flexible way to extend the functionality of your Viam robot.
16+
A *module* provides one or more [*modular resources*](#resources), and is a flexible way to extend the functionality of your smart machine.
1717
Modules run alongside `viam-server` as a separate process, communicating with `viam-server` over a UNIX socket.
1818
A module provides definitions for one or more pairs of [APIs](#valid-apis-to-implement-in-your-model) and [models](#models).
1919

20-
When the module initializes, it registers those pairs on your robot, making the functionality defined by that pair available for use.
20+
When the module initializes, it registers those pairs on your smart machine, making the functionality defined by that pair available for use.
2121

2222
You can [upload your own modules to the Viam registry](/extend/modular-resources/upload/) or can [add existing modules from the registry](/extend/modular-resources/configure/).
2323

@@ -28,7 +28,7 @@ See [Creating a custom module](/extend/modular-resources/create/) for more infor
2828
A resource is a [component](/components/) or [service](/services/).
2929
Each component or service is typed by a proto API, such as the [component proto definitions](https://github.com/viamrobotics/api/tree/main/proto/viam/component).
3030

31-
Any resource on your robot needs to implement either one of these [existing Viam APIs](#valid-apis-to-implement-in-your-model), or a custom interface.
31+
Any resource on your smart machine needs to implement either one of these [existing Viam APIs](#valid-apis-to-implement-in-your-model), or a custom interface.
3232

3333
A *modular resource* is a resource that is provided by a [module](#modules), and not built-in to the RDK.
3434
A modular resource runs in the module process. This differs from built-in resources, which run as part of `viam-server`.
@@ -130,7 +130,7 @@ The RDK ensures that any configured modules are loaded automatically on start-up
130130

131131
### Reconfiguration
132132

133-
When you change the configuration of a Viam robot, the behavior of modular resource instances versus built-in resource instances is equivalent.
133+
When you change the configuration of a robot the behavior of modular resource instances versus built-in resource instances is equivalent.
134134
This means you can add, modify, and remove a modular resource instance from a running robot as normal.
135135

136136
### Data management

docs/installation/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type: docs
88
image: "/installation/thumbnails/install.png"
99
imageAlt: "Install Viam"
1010
images: ["/installation/thumbnails/install.png"]
11-
description: "To use Viam software with your robot, install and run the viam-server binary on the computer that you want to use to control the robot."
11+
description: "To use Viam software with your smart machine, install and run the viam-server binary on the computer that you want to use to control the smart machine."
1212
aliases:
1313
- /installation/prepare/
1414
- /installation/macos-install/
@@ -21,7 +21,7 @@ aliases:
2121
- /getting-started/linux-install/
2222
---
2323

24-
To use Viam software with your robot, install and run the `viam-server` binary on the computer that you want to use to control the robot.
24+
To use Viam software with your smart machine, install and run the `viam-server` binary on the computer that you want to use to control the smart machine.
2525
In most cases, this will be a [single board computer (SBC)](#install-on-a-single-board-computer), like a Raspberry Pi, but you can also install `viam-server` on a [macOS or Linux computer](#install-on-a-macos-or-linux-computer).
2626

2727
For an overview of the Viam software platform, see [Viam in 3 minutes](/viam/).

docs/manage/fleet/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Fleet Management"
33
linkTitle: "Fleet Management"
44
weight: 30
55
type: "docs"
6-
description: "Configure, control, debug, and manage your robots from the cloud at app.viam.com on your own or with a team."
6+
description: "Configure, control, debug, and manage your smart machines from the cloud at app.viam.com on your own or with a team."
77
tags: ["fleet management", "cloud", "app"]
88
no_list: true
99
aliases:
@@ -13,9 +13,9 @@ aliases:
1313
- "/fleet"
1414
---
1515

16-
The [Viam app](https://app.viam.com) provides fleet management allowing you to work on any number of robots alone or in collaboration with others.
16+
The [Viam app](https://app.viam.com) provides fleet management allowing you to work on any number of smart machines alone or in collaboration with others.
1717

18-
## Work with groups of robots
18+
## Work with groups of smart machines
1919

2020
With Viam, you can organize {{< glossary_tooltip term_id="robot" text="robots" >}} into {{< glossary_tooltip term_id="location" text="locations" >}} and {{< glossary_tooltip term_id="organization" text="organizations" >}}.
2121

docs/program/apis/cloud.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: "Manage Your Fleet with Viam's Cloud API"
33
linkTitle: "Cloud Management"
44
weight: 20
55
type: "docs"
6-
description: "Use the cloud app API with Viam's client SDKs to manage your robot fleet with code."
6+
description: "Use the cloud app API with Viam's client SDKs to manage your smart machine fleet with code."
77
tags: ["cloud", "sdk", "viam-server", "networking", "apis", "robot api", "cloud management"]
88
---
99

10-
The cloud app API allows you to [manage your robot fleet](/manage/fleet/) with code instead of with the graphical interface of the [Viam app](https://app.viam.com/).
10+
The cloud app API allows you to [manage your smart machine fleet](/manage/fleet/) with code instead of with the graphical interface of the [Viam app](https://app.viam.com/).
1111
With it you can
1212

13-
- create and manage organizations, locations, and individual robots
13+
- create and manage organizations, locations, and individual smart machines
1414
- manage permissions and authorization
1515
- create and manage fragments
1616

docs/program/apis/robot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Manage Robots with Viam's Robot API"
33
linkTitle: "Robot Management"
44
weight: 20
55
type: "docs"
6-
description: "How to use the Robot API to monitor and manage your robots."
6+
description: "How to use the Robot API to monitor and manage your smart machines."
77
tags: ["robot state", "sdk", "apis", "robot api"]
88
---
99

docs/services/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: "Services"
33
linkTitle: "Services"
44
weight: 40
55
type: docs
6-
description: "Services are built-in software packages that make it easier to add complex capabilities such as motion planning or object detection to your robot."
6+
description: "Services are built-in software packages that make it easier to add complex capabilities such as motion planning or object detection to your smart machine."
77
images: ["/general/services.png"]
88
---
99

10-
Services are built-in software packages that make it easier to add complex capabilities such as motion planning or object detection to your robot.
10+
Services are built-in software packages that make it easier to add complex capabilities such as motion planning or object detection to your smart machine.
1111
The following are the service types that Viam natively supports.
1212
If you would like to use additional service types, you can [extend Viam with custom services](/extend/modular-resources/).

0 commit comments

Comments
 (0)