Skip to content

Commit

Permalink
Update IA to move components and services (#2274)
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Dec 1, 2023
1 parent 6b51329 commit 73142a0
Show file tree
Hide file tree
Showing 405 changed files with 980 additions and 980 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check_python_methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ def parse(type, names):
with open(f"dist/{services_page_mapping[service]}/index.html") as fp:
soup2 = BeautifulSoup(fp, 'html.parser')
else:
with open(f"dist/build/configure/{type}/{service}/index.html") as fp:
with open(f"dist/{type}/{service}/index.html") as fp:
soup2 = BeautifulSoup(fp, 'html.parser')
else:
if type == "app" or type == "robot":
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> **Note**
> Looking to contribute? Check out the [Contributor Guide](https://docs.viam.com/appendix/contributing/).
> For help knowing what and how to write, check out our templates: our [tutorial template](docs/tutorials/template/) and [component page template](docs/build/configure/components/component/) are accessible on the site when building the docs in Draft mode, or accessible here on GitHub.
> For help knowing what and how to write, check out our templates: our [tutorial template](docs/tutorials/template/) and [component page template](docs/components/component/) are accessible on the site when building the docs in Draft mode, or accessible here on GitHub.
## Build the docs locally

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
14 changes: 7 additions & 7 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ sitemap:
</a>
</li>
<li id="c1_slide3">
<a href="build/configure/components/board/upboard/">
<a href="components/board/upboard/">
{{<imgproc src="get-started/installation/thumbnails/up_4000.png" resize="148x120" declaredimensions=true alt="Intel Up board 4000">}}
<p>Intel UP4000</p>
</a>
Expand Down Expand Up @@ -69,7 +69,7 @@ sitemap:
</a>
</li>
<li id="c1_slide9">
<a href="build/configure/components/board/jetson/">
<a href="components/board/jetson/">
{{<imgproc src="get-started/installation/thumbnails/jetson-xavier.png" alt="Jetson Xavier NX Dev Kit" resize="148x120" declaredimensions=true >}}
<p>NVIDIA Jetson Xavier NX</p>
</a>
Expand All @@ -93,13 +93,13 @@ sitemap:
</a>
</li>
<li id="c1_slide13">
<a href="build/configure/components/board/numato/">
<a href="components/board/numato/">
{{<imgproc src="get-started/installation/thumbnails/numato.png" alt="Numato GPIO Modules" resize="148x120" declaredimensions=true >}}
<p>Numato GPIO Modules</p>
</a>
</li>
<li id="c1_slide14">
<a href="build/configure/components/board/pca9685/">
<a href="components/board/pca9685/">
{{<imgproc src="get-started/installation/thumbnails/pca9685.png" alt="P C A 9685 I 2 C Interface" resize="148x120" declaredimensions=true >}}
<p>PCA9686 I<sup>2</sup>C Interface</p>
</a>
Expand Down Expand Up @@ -150,7 +150,7 @@ sitemap:
<ol style="padding-inline-start: 1.1rem">
<li>Configure a <a href="build/configure/"> machine</a> or a <a href="fleet/">fleet</a></li>
<li><a href="get-started/installation/">Install Viam on your machine</a></li>
<li>Configure <a href="build/configure/components/">components</a> and <a href="build/configure/services/">add services</a></li>
<li>Configure <a href="components/">components</a> and <a href="services/">add services</a></li>
<li><a href="fleet/machines/#control">Control and test your machine</a></li>
</ol>
</div>
Expand Down Expand Up @@ -185,11 +185,11 @@ sitemap:
<div class="col sectionlist">
<div>
<div>Components</div>
{{<sectionlist section="/build/configure/components/">}}
{{<sectionlist section="/components/">}}
</div>
</div>
<div class="col sectionlist">
<div><div>Services</div><ul class="sectionlist"><li><a href="data/" title="Data Management Service"><div><picture><img src="build/configure/services/icons/data-capture.svg" width="/services/icons/data-capture" height="/services/icons/data-capture" alt="Data Management" loading="lazy"></picture><p>Data Management</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/motion/" title="Motion Service"><div><picture><img src="build/configure/services/icons/motion.svg" width="/services/icons/motion" height="/services/icons/motion" alt="Motion" loading="lazy"></picture><p>Motion</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/frame-system/" title="The Robot Frame System"><div><picture><img src="build/configure/services/icons/frame-system.svg" width="/services/icons/frame-system" height="/services/icons/frame-system" alt="Frame System" loading="lazy"></picture><p>Frame System</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/base-rc/" title="Base Remote Control Service"><div><picture><img src="build/configure/services/icons/base-rc.svg" width="/services/icons/base-rc" height="/services/icons/base-rc" alt="Base Remote Control" loading="lazy"></picture><p>Base Remote Control</p></div></a></li></ul><ul class="sectionlist"><li><a href="ml/" title="ML Model Service"><div><picture><img src="build/configure/services/icons/ml.svg" width="/services/icons/ml" height="/services/icons/ml" alt="ML Model" loading="lazy"></picture><p>ML Model</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/navigation/" title="The Navigation Service"><div><picture><img src="build/configure/services/icons/navigation.svg" width="/services/icons/navigation" height="/services/icons/navigation" alt="Navigation" loading="lazy"></picture><p>Navigation</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/slam/" title="SLAM Service"><div><picture><img src="build/configure/services/icons/slam.svg" width="/services/icons/slam" height="/services/icons/slam" alt="SLAM" loading="lazy"></picture><p>SLAM</p></div></a></li></ul><ul class="sectionlist"><li><a href="ml/vision/" title="Vision Service"><div><picture><img src="build/configure/services/icons/vision.svg" width="/services/icons/vision" height="/services/icons/vision" alt="Vision" loading="lazy"></picture><p>Vision</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/sensors/" title="Sensors Service"><div><picture><img src="build/configure/services/icons/sensor.svg" width="/services/icons/sensor" height="/services/icons/sensor" alt="Sensors" loading="lazy"></picture><p>Sensors</p></div></a></li></ul></div>
<div><div>Services</div><ul class="sectionlist"><li><a href="data/" title="Data Management Service"><div><picture><img src="services/icons/data-capture.svg" width="/services/icons/data-capture" height="/services/icons/data-capture" alt="Data Management" loading="lazy"></picture><p>Data Management</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/motion/" title="Motion Service"><div><picture><img src="services/icons/motion.svg" width="/services/icons/motion" height="/services/icons/motion" alt="Motion" loading="lazy"></picture><p>Motion</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/frame-system/" title="The Robot Frame System"><div><picture><img src="services/icons/frame-system.svg" width="/services/icons/frame-system" height="/services/icons/frame-system" alt="Frame System" loading="lazy"></picture><p>Frame System</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/base-rc/" title="Base Remote Control Service"><div><picture><img src="services/icons/base-rc.svg" width="/services/icons/base-rc" height="/services/icons/base-rc" alt="Base Remote Control" loading="lazy"></picture><p>Base Remote Control</p></div></a></li></ul><ul class="sectionlist"><li><a href="ml/" title="ML Model Service"><div><picture><img src="services/icons/ml.svg" width="/services/icons/ml" height="/services/icons/ml" alt="ML Model" loading="lazy"></picture><p>ML Model</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/navigation/" title="The Navigation Service"><div><picture><img src="services/icons/navigation.svg" width="/services/icons/navigation" height="/services/icons/navigation" alt="Navigation" loading="lazy"></picture><p>Navigation</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/slam/" title="SLAM Service"><div><picture><img src="services/icons/slam.svg" width="/services/icons/slam" height="/services/icons/slam" alt="SLAM" loading="lazy"></picture><p>SLAM</p></div></a></li></ul><ul class="sectionlist"><li><a href="ml/vision/" title="Vision Service"><div><picture><img src="services/icons/vision.svg" width="/services/icons/vision" height="/services/icons/vision" alt="Vision" loading="lazy"></picture><p>Vision</p></div></a></li></ul><ul class="sectionlist"><li><a href="mobility/sensors/" title="Sensors Service"><div><picture><img src="services/icons/sensor.svg" width="/services/icons/sensor" height="/services/icons/sensor" alt="Sensors" loading="lazy"></picture><p>Sensors</p></div></a></li></ul></div>
</div>
<div class="col sectionlist">
<div>
Expand Down
2 changes: 1 addition & 1 deletion docs/appendix/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Appendix"
linkTitle: "Appendix"
weight: 90
weight: 900
simple_list: true
type: "docs"
description: "Reference and Background Material"
Expand Down
28 changes: 14 additions & 14 deletions docs/appendix/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You can use a [mobile application](/fleet/#the-viam-mobile-app), available for d

### Added: Power sensor component

You now have the capability to use a [power sensor component](/build/configure/components/power-sensor/) to monitor the voltage, current, and power consumption within your machine's system.
You now have the capability to use a [power sensor component](/components/power-sensor/) to monitor the voltage, current, and power consumption within your machine's system.

### Added: Filter component's data before the cloud

Expand All @@ -87,7 +87,7 @@ To learn more, see [this tutorial](/tutorials/configure/pet-photographer/) on cr

### Added: Configure a customlinux board

You can now use boards like the [Mediatek Genio 500 Pumpkin](https://ologicinc.com/portfolio/mediateki500/) that run Linux operating systems with the [`customlinux` board model](/build/configure/components/board/customlinux/).
You can now use boards like the [Mediatek Genio 500 Pumpkin](https://ologicinc.com/portfolio/mediateki500/) that run Linux operating systems with the [`customlinux` board model](/components/board/customlinux/).

### Added: Image inspection for ML training

Expand Down Expand Up @@ -120,7 +120,7 @@ Note that currently, accounts from different SSO providers are treated separatel

### Improved: Arm component API

Arm models now support the [`GetKinematics` method](/build/configure/components/arm/#getkinematics) in the arm API, allowing you to request and receive kinematic information.
Arm models now support the [`GetKinematics` method](/components/arm/#getkinematics) in the arm API, allowing you to request and receive kinematic information.

## June 2023

Expand All @@ -145,7 +145,7 @@ Visit the [GitHub repository](https://github.com/viamrobotics/odrive) to learn h
### Added: Implement custom robotic arms as Viam modules

When prototyping a robotic arm, you can now facilitate movement without creating your own motion planning.
This update enables you to implement custom models of an arm component as a [modular resource](/registry/) by coding three endpoints of the [Arm API](/build/configure/components/arm/#api):
This update enables you to implement custom models of an arm component as a [modular resource](/registry/) by coding three endpoints of the [Arm API](/components/arm/#api):

- `getJointPositions`
- `movetoJointPositions`
Expand All @@ -157,7 +157,7 @@ For more information, see this [tutorial on creating a custom arm](/registry/exa

### Added: Apply a crop transform to camera views

You can now apply a [crop transform](/build/configure/components/camera/transform/) to the views of your connected cameras in the Viam app.
You can now apply a [crop transform](/components/camera/transform/) to the views of your connected cameras in the Viam app.

This feature enables you to focus on a specific area of your camera feed.

Expand All @@ -167,7 +167,7 @@ For example, crop a video stream of a busy street to just the sidewalk.

To better control gantries with Viam, you can now:

- Specify speed values when calling the `MovetoPosition` method on [Gantry components](/build/configure/components/gantry/).
- Specify speed values when calling the `MovetoPosition` method on [Gantry components](/components/gantry/).
This allows you to define the speed at which each axis moves to the desired position, providing enhanced precision and control over the gantry's movement.
- Set a home position for Gantry components to facilitate position resetting or maintain consistent starting points.

Expand Down Expand Up @@ -662,16 +662,16 @@ Find more information in the [micro-RDK documentation](/get-started/installation

### Added: Remote control power input

On your robot's **Control** tab on the [Viam app](https://app.viam.com/), you can now set the power of a [base](/build/configure/components/base/).
On your robot's **Control** tab on the [Viam app](https://app.viam.com/), you can now set the power of a [base](/components/base/).
The base control UI previously always sent 100% power to the base's motors.

### Added: New encoder model: AMS AS5048

The [AMS AS5048](/build/configure/components/encoder/ams-as5048/) is now supported.
The [AMS AS5048](/components/encoder/ams-as5048/) is now supported.

### Added: GetLinearAcceleration method

The movement sensor API now includes a [GetLinearAcceleration](/build/configure/components/movement-sensor/#getlinearacceleration) method.
The movement sensor API now includes a [GetLinearAcceleration](/components/movement-sensor/#getlinearacceleration) method.

### Added: Support for capsule geometry

Expand Down Expand Up @@ -699,8 +699,8 @@ You can now supply kinematic information using URDF files when implementing your

There are two new movement sensor {{< glossary_tooltip term_id="model" text="models" >}}:

- [ADXL345](/build/configure/components/movement-sensor/adxl345/): A 3-axis accelerometer
- [MPU-6050](/build/configure/components/movement-sensor/mpu6050/): A 6-axis accelerometer and gyroscope
- [ADXL345](/components/movement-sensor/adxl345/): A 3-axis accelerometer
- [MPU-6050](/components/movement-sensor/mpu6050/): A 6-axis accelerometer and gyroscope

### Improved: Camera performance and reliability

Expand Down Expand Up @@ -739,15 +739,15 @@ Now is uses a simpler unary approach that is more performant on batched unary ca
- Transform
- Join pointclouds

For information on configuring any camera model, see [Camera Component](/build/configure/components/camera/).
For information on configuring any camera model, see [Camera Component](/components/camera/).

### Changed: App code sample tab name update

Changed the name of the **Connect** tab to **Code sample** based on user feedback.

### Added: New servo model

A new [servo model called `gpio`](/build/configure/components/servo/gpio/) supports servos connected to non-Raspberry Pi boards.
A new [servo model called `gpio`](/components/servo/gpio/) supports servos connected to non-Raspberry Pi boards.

### Added: RTT indicator in the app

Expand Down Expand Up @@ -785,6 +785,6 @@ Other service configurations are not affected.

### Removed: width and height fields from camera API

Removed `width` and `height` from the response of the [`GetImage`](/build/configure/components/camera/#getimage) method in the camera API.
Removed `width` and `height` from the response of the [`GetImage`](/components/camera/#getimage) method in the camera API.
This does not impact any existing camera models.
If you write a custom camera model, you no longer need to implement the `width` and `height` fields.
2 changes: 1 addition & 1 deletion docs/appendix/glossary/api-namespace-triplet.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ This requirement ensures that when a resource of that model is deployed, you can

For example:

- The API of the built-in component [camera](/build/configure/components/camera/) is `rdk:component:camera`, which exposes methods such as `GetImage()`.
- The API of the built-in component [camera](/components/camera/) is `rdk:component:camera`, which exposes methods such as `GetImage()`.
- The API of the built-in service [vision](/ml/vision/) is `rdk:service:vision`, which exposes methods such as `GetDetectionsFromCamera()`.
4 changes: 2 additions & 2 deletions docs/appendix/glossary/base.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Base
id: base
full_link: /build/configure/components/base/
full_link: /components/base/
short_description: A physical, mobile platform that the other parts of a mobile robot attach to.
aka:
---

A physical, mobile platform that the other parts of a mobile robot attach to.
For example, a wheeled rover, boat, or flying drone.

For more information see [Base Component](/build/configure/components/base/).
For more information see [Base Component](/components/base/).
4 changes: 2 additions & 2 deletions docs/appendix/glossary/board.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Board
id: board
full_link: /build/configure/components/board/
full_link: /components/board/
short_description: A board is the signal wire hub of a machine that provides access to GPIO pins, SPI or I2C.
aka:
---
Expand All @@ -10,4 +10,4 @@ A board is the signal wire hub of a machine that provides access to GPIO pins, S

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

For more information see [Board Component](/build/configure/components/board/).
For more information see [Board Component](/components/board/).
4 changes: 2 additions & 2 deletions docs/appendix/glossary/component.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Component
id: component
full_link: /build/configure/components/
full_link: /components/
short_description: A resource that represents a physical component in a robot which a computer controls; for example, a servo, a camera, or an arm.
aka:
---
Expand All @@ -10,4 +10,4 @@ A resource that represents a physical component in a robot which a computer cont

Each component is typed by a proto API, such as the [component proto definitions](https://github.com/viamrobotics/api/tree/main/proto/viam/component).

For more information, see [Components](/build/configure/components/).
For more information, see [Components](/components/).
2 changes: 1 addition & 1 deletion docs/appendix/glossary/gantry.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Gantry
id: attribute
full_link: /build/configure/components/gantry/
full_link: /components/gantry/
short_description: A mechanical system that only uses linear motion to carry out a task.
aka:
---
Expand Down
2 changes: 1 addition & 1 deletion docs/appendix/glossary/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A particular implementation of a {{< glossary_tooltip term_id="resource" text="r

Models allow you to control hardware or software of a similar category, such as motors, with a consistent set of methods as an interface, even if the underlying implementation differs.

For example, some _models_ of DC motors communicate using [GPIO](/build/configure/components/board/), while other DC motors use serial protocols like the [SPI bus](/build/configure/components/board/#spis).
For example, some _models_ of DC motors communicate using [GPIO](/components/board/), while other DC motors use serial protocols like the [SPI bus](/components/board/#spis).
Regardless, you can power any motor model that implements the `rdk:component:motor` API with the `SetPower()` method.

Models are either included with [`viam-server`](/get-started/installation/), provided in {{< glossary_tooltip term_id="module" text="custom modules" >}} available for download from the [Viam registry](https://app.viam.com/registry), or installed as [local modules](/registry/configure/#local-modules).
Expand Down
4 changes: 2 additions & 2 deletions docs/appendix/glossary/service.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Service
id: service
full_link: /build/configure/services/
full_link: /services/
short_description: Built-in software packages for complex capabilities such as SLAM, Computer Vision, Motion Planning, and Data Collection.
aka:
---
Expand All @@ -10,4 +10,4 @@ Services are built-in software packages for complex capabilities such as Simulta

Each service is typed by a proto API, such as the [service proto definitions](https://github.com/viamrobotics/api/tree/main/proto/viam/service).

For more information, see [Services](/build/configure/services/).
For more information, see [Services](/services/).
Loading

0 comments on commit 73142a0

Please sign in to comment.