Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/reference/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
linkTitle: "Reference"
title: "Reference"
weight: 600
layout: "docs"
type: "docs"
no_list: true
noedit: true
open_on_desktop: true
description: "Technical reference documentation for the Viam platform: APIs, SDKs, components, services, architecture, and more."
---
8 changes: 8 additions & 0 deletions docs/reference/account/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Account"
linkTitle: "Account"
weight: 80
type: "docs"
no_list: true
description: "Reference documentation for Viam accounts, billing, and organization management."
---
9 changes: 9 additions & 0 deletions docs/reference/account/accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Account management"
title: "Account management"
weight: 900
layout: "docs"
type: "docs"
no_list: true
description: "Log in and out of your Viam account."
---
11 changes: 11 additions & 0 deletions docs/reference/account/billing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Payment and billing"
linkTitle: "Billing"
weight: 50
type: "docs"
description: "An overview of the Payments & Billing page."
tags: ["fleet management", "cloud", "app"]
date: "2024-03-13"
no_list: true
# updated: "" # When the content was last entirely checked
---
9 changes: 9 additions & 0 deletions docs/reference/account/organize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
linkTitle: "Organize your machines"
title: "Organize your machines"
weight: 60
layout: "docs"
type: "docs"
no_list: true
description: "Organize and manage access to your fleet by grouping machines into organizations and locations."
---
19 changes: 19 additions & 0 deletions docs/reference/advanced-modules/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Advanced modular resources"
linkTitle: "Advanced modular resources"
weight: 70
type: docs
tags:
[
"server",
"rdk",
"extending viam",
"modular resources",
"components",
"services",
]
description: "Some usage may require you to define new APIs or deploy custom components in non-standard ways."
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
toc_hide: true
---
11 changes: 11 additions & 0 deletions docs/reference/advanced-modules/create-subtype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Define a new resource API"
linkTitle: "Custom API"
weight: 30
type: "docs"
tags: ["rdk", "extending viam", "modular resources", "API"]
description: "Define a custom API for a resource that does not fit into existing component or service APIs."
no_list: true
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
10 changes: 10 additions & 0 deletions docs/reference/advanced-modules/custom-components-remotes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Add custom components as remote parts"
linkTitle: "Custom components as remote parts"
weight: 99
type: "docs"
tags: ["server", "sdk"]
description: "If you are unable to use modular resources, you can implement custom components and register them on a server configured as a remote of your machine."
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/advanced-modules/docker-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Deploy a module using Docker"
linkTitle: "Docker Modules"
weight: 300
type: "docs"
tags: ["extending viam", "modular resources"]
description: "Deploy a module using Docker."
no_list: true
date: "2025-04-10"
# updated: "" # When the content was last entirely checked
---
12 changes: 12 additions & 0 deletions docs/reference/apis/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Viam's Client APIs"
linkTitle: "APIs"
weight: 10
type: "docs"
description: "Access and control your machine or fleet with the SDKs' client libraries for the resource and robot APIs."
images: ["/general/code.png"]
tags: ["client", "sdk", "viam-server", "networking", "apis", "robot api"]
no_list: true
date: "2024-10-01"
# updated: "" # When the content was last entirely checked
---
10 changes: 10 additions & 0 deletions docs/reference/apis/billing-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Retrieve billing information with Viam's billing client API"
linkTitle: "Billing client"
weight: 90
type: "docs"
description: "Use the billing client API to retrieve billing information from Viam."
tags: ["cloud", "sdk", "viam-server", "networking", "apis", "robot api"]
date: "2024-09-14"
# updated: "" # When the content was last entirely checked
---
10 changes: 10 additions & 0 deletions docs/reference/apis/components/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
linkTitle: "Component APIs"
title: "Component APIs"
weight: 5
empty_node: true
layout: "empty"
canonical: "/reference/apis/"
type: "docs"
description: "Component APIs."
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/arm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Arm API"
linkTitle: "Arm"
weight: 5
type: "docs"
description: "Give commands to your arm components for linear motion planning."
icon: true
images: ["/icons/components/arm.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/audio-in.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Audio in API"
linkTitle: "Audio in"
weight: 10
type: "docs"
description: "Give commands to your audio in components."
icon: true
# images: ["/icons/components/resource.svg"]
date: "2025-11-12"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/audio-out.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Audio out API"
linkTitle: "Audio out"
weight: 10
type: "docs"
description: "Give commands to your audio out components."
icon: true
# images: ["/icons/components/resource.svg"]
date: "2025-11-12"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Base API"
linkTitle: "Base"
weight: 20
type: "docs"
description: "Give commands for moving all configured components attached to a mobile platform as a whole without needing to send commands to individual components."
icon: true
images: ["/icons/components/base.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/board.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Board API"
linkTitle: "Board"
weight: 30
type: "docs"
description: "Give commands for setting GPIO pins to high or low, setting PWM, and working with analog and digital interrupts."
icon: true
images: ["/icons/components/board.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/button.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Button API"
linkTitle: "Button"
weight: 35
type: "docs"
description: "Give commands for getting presses from a physical button."
icon: true
images: ["/icons/components/button.svg"]
date: "2025-02-20"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/camera.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Camera API"
linkTitle: "Camera"
weight: 40
type: "docs"
description: "Give commands for getting images or point clouds."
icon: true
images: ["/icons/components/camera.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/encoder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Encoder API"
linkTitle: "Encoder"
weight: 50
type: "docs"
description: "Give commands for getting the position of a motor or a joint in ticks or degrees."
icon: true
images: ["/icons/components/encoder.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/gantry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Gantry API"
linkTitle: "Gantry"
weight: 60
type: "docs"
description: "Give commands for coordinated control of one or more linear actuators."
icon: true
images: ["/icons/components/gantry.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/generic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Control your generic component with the generic API"
linkTitle: "Generic"
weight: 70
type: "docs"
description: "Give commands for running custom model-specific commands using DoCommand on your generic components."
icon: true
images: ["/icons/components/generic.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/gripper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Control your gripper with the gripper API"
linkTitle: "Gripper"
weight: 80
type: "docs"
description: "Give commands for opening and closing a gripper device."
icon: true
images: ["/icons/components/gripper.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
12 changes: 12 additions & 0 deletions docs/reference/apis/components/input-controller.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Input controller API"
linkTitle: "Input controller"
titleMustBeLong: true
weight: 90
type: "docs"
description: "Give commands to register callbacks for events, allowing you to use input devices to control your machines."
icon: true
images: ["/icons/components/controller.svg"]
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/motor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Motor API"
linkTitle: "Motor"
weight: 100
type: "docs"
description: "Give commands to operate a motor or get its current status."
icon: true
images: ["/icons/components/motor.svg"]
date: "2024-10-10"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/movement-sensor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Movement sensor API"
linkTitle: "Movement sensor"
weight: 110
type: "docs"
description: "Give commands for getting the current GPS location, linear velocity and acceleration, angular velocity and acceleration and heading."
icon: true
images: ["/icons/components/imu.svg"]
date: "2022-10-10"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/power-sensor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Power sensor API"
linkTitle: "Power sensor"
weight: 120
type: "docs"
description: "Commands for getting measurements of voltage, current, and power consumption."
icon: true
images: ["/icons/components/power-sensor.svg"]
date: "2022-10-10"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/sensor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Sensor API"
linkTitle: "Sensor"
weight: 130
type: "docs"
description: "Give commands for getting sensor readings."
icon: true
images: ["/icons/components/sensor.svg"]
date: "2022-10-10"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/servo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Servo API"
linkTitle: "Servo"
weight: 140
type: "docs"
description: "Give commands for controlling the angular position of a servo precisely or getting its current status."
icon: true
images: ["/icons/components/servo.svg"]
date: "2022-10-10"
# updated: "" # When the content was last entirely checked
---
11 changes: 11 additions & 0 deletions docs/reference/apis/components/switch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Switch API"
linkTitle: "Switch"
weight: 200
type: "docs"
description: "Give commands for getting the state of a physical switch that has two or more discrete positions."
icon: true
images: ["/icons/components/switch.svg"]
date: "2025-02-20"
# updated: "" # When the content was last entirely checked
---
23 changes: 23 additions & 0 deletions docs/reference/apis/data-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Upload and retrieve data with Viam's data client API"
linkTitle: "Data client"
weight: 10
type: "docs"
description: "Use the data client API to upload and retrieve data directly."
icon: true
images: ["/services/icons/sdk.svg"]
tags:
[
"cloud",
"sdk",
"viam-server",
"networking",
"apis",
"robot api",
"data management",
"data",
]

date: "2024-09-19"
# updated: "" # When the content was last entirely checked
---
Loading
Loading