diff --git a/assets/scss/_sidebar-tree.scss b/assets/scss/_sidebar-tree.scss index 6cd2996d26..02bfe1e50b 100644 --- a/assets/scss/_sidebar-tree.scss +++ b/assets/scss/_sidebar-tree.scss @@ -187,7 +187,7 @@ li .indent { } .ul-2 > li:not(:last-child) { - padding-bottom: 8px; + padding-bottom: 2px; } } diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index 39bdc445c2..b06a7ad257 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -177,6 +177,20 @@ h7, .td-content > h3 { margin-bottom: 0.667rem; + margin-top: 1.5rem; +} + +// The float:left on ol > li::before creates floats that escape the ol's +// block formatting context. Since h3 has clear:both, it clears past those +// floats, creating an oversized gap. flow-root contains the floats in +// the ol's own BFC so they don't affect adjacent elements. +// Zero the last li's margin-bottom because flow-root prevents it from +// collapsing with the ol's margin, which would add unwanted extra space. +.td-content > ol { + display: flow-root; +} +.td-content > ol > li:last-child { + margin-bottom: 0; } /* END Adjust Heading sizes*/ @@ -3191,57 +3205,9 @@ nav { background-color: rgb(232, 232, 234); } -.second-nav { - min-width: 100%; - padding: 0.25rem 1rem; - border-top: 1px solid #e4e4e6; - border-bottom: 1px solid #e4e4e6; -} - -.second-nav > ul { - padding: 0; - padding-left: 0.25rem; - margin: 0; -} - -.second-nav > ul > li { - display: inline-block; - font-family: - "Public Sans", - -apple-system, - BlinkMacSystemFont, - "Segoe UI", - Roboto, - "Helvetica Neue", - Arial, - sans-serif, - "Apple Color Emoji", - "Segoe UI Emoji", - "Segoe UI Symbol"; - font-size: 0.875rem; - line-height: 1.25rem; - margin: 5px 0px; - font-weight: 300; -} - -.second-nav > ul > li > a { - color: #333; - padding: 5px 0.5rem; - margin-right: 0.5rem; -} - -.second-nav > ul > li > a:hover, -.second-nav > ul > li > a.active-path { - text-decoration: none; - background-color: rgba(0, 0, 0, 0.03); - border-radius: 4px; - color: #282829; - font-weight: 500; -} - @media (min-width: 768px) { .td-main main { - padding-top: 7.5rem; + padding-top: 5rem; } } @@ -3249,11 +3215,6 @@ nav { min-height: 3.5rem; } -@media (max-width: 767px) { - .second-nav { - display: none; - } -} @media (min-width: 992px) { .d-lg-block { @@ -3261,23 +3222,17 @@ nav { } } -span.section-overview { - display: none; -} ul > li.nav-fold > span > span.link-and-toggle { display: flex !important; flex-direction: row; } -ul > li.nav-fold:last-child { +ul.ul-0 > li.nav-fold:last-child { padding-bottom: 0.5rem; } @media (min-width: 768px) { - .ul-1 > li.nav-fold.hide-if-desktop { - display: none; - } #landing-page-sidebar { display: none; @@ -3290,24 +3245,38 @@ ul > li.nav-fold:last-child { li.nav-fold.header-only > span > span { color: #000000; - margin-top: 1rem; + margin-top: 0.25rem; } li.nav-fold.header-only:first-child > span > a { - margin-top: 0.5rem; + margin-top: 0.25rem; } li.nav-fold.header-only * li { text-transform: unset; } - li > span > ul.ul-2 { - padding-left: 0; + li.nav-top-section > span > span.link-and-toggle > a, + li.nav-top-section > a { + text-transform: uppercase; + font-size: 0.75rem; + letter-spacing: 0.05em; + font-weight: 600; + color: #666; + } + + li.nav-top-section > span > ul.ul-2 { + margin-left: 0.5rem; } ul.ul-2 > li > span > span { color: #282829; - font-weight: 600; + font-weight: 400; + font-size: 0.833rem; + } + + ul.ul-2 > li > a { + font-size: 0.833rem; } li.header-only > span > ul.ul-3 { @@ -3320,21 +3289,26 @@ ul > li.nav-fold:last-child { padding-left: 0.5rem; } - span.section-overview-title { - display: none; - } - .ul-1 > li.nav-fold > span > span.link-and-toggle { - display: none !important; - } .td-sidebar-nav__section .ul-1 ul.ul-2 { - padding-left: 0; + padding-left: 0.5rem; + border-left: 1px solid #e4e4e6; + margin-left: 0.5rem; } .td-sidebar-nav__section ul.ul-1 { margin-left: 0; } + + li.nav-top-section { + margin-bottom: 0.5rem; + border-bottom: 1px solid #e4e4e6; + } + + li.nav-top-section:last-child { + border-bottom: none; + } } .menu-toggle { diff --git a/config.toml b/config.toml index 2f47b84c1f..6c870a4af5 100644 --- a/config.toml +++ b/config.toml @@ -115,9 +115,9 @@ breadcrumb_disable = false footer_about_disable = false navbar_logo = true navbar_translucent_over_cover_disable = false -sidebar_menu_compact = true # When true, the section headings work like an accordian. +sidebar_menu_compact = true # When true, only the active path is expanded in the sidebar. sidebar_search_disable = true -ul_show = 3 # Always expand every first level section of the sidenav -- due to tabs, our 'first level' is 3 +ul_show = 1 # Show only top-level sections; deeper levels collapse unless active [params.ui.feedback] enable = true diff --git a/docs/build-modules/_index.md b/docs/build-modules/_index.md new file mode 100644 index 0000000000..bfe31eb1f7 --- /dev/null +++ b/docs/build-modules/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Build and Deploy Modules" +title: "Build and Deploy Modules" +weight: 60 +layout: "docs" +type: "docs" +no_list: true +description: "Understand the two kinds of modules, then write, test, and deploy your own." +--- diff --git a/docs/build-modules/dependencies.md b/docs/build-modules/dependencies.md new file mode 100644 index 0000000000..a1883e483f --- /dev/null +++ b/docs/build-modules/dependencies.md @@ -0,0 +1,9 @@ +--- +title: "Access machine resources from within a module" +linkTitle: "Module dependencies" +weight: 36 +layout: "docs" +type: "docs" +description: "From within a modular resource, you can access other machine resources using dependencies." +date: "2025-11-11" +--- diff --git a/docs/build-modules/deploy-a-module.md b/docs/build-modules/deploy-a-module.md new file mode 100644 index 0000000000..cf78f2ede2 --- /dev/null +++ b/docs/build-modules/deploy-a-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Deploy a Module" +title: "Deploy a Module" +weight: 30 +layout: "docs" +type: "docs" +description: "Package, upload, and distribute a module through the Viam registry." +date: "2025-01-30" +--- diff --git a/docs/build-modules/from-hardware-to-logic.md b/docs/build-modules/from-hardware-to-logic.md new file mode 100644 index 0000000000..ada8499bcf --- /dev/null +++ b/docs/build-modules/from-hardware-to-logic.md @@ -0,0 +1,9 @@ +--- +linkTitle: "What is a module?" +title: "What is a module?" +weight: 1 +layout: "docs" +type: "docs" +description: "Understand the two kinds of modules and how configured hardware connects to application logic." +date: "2025-03-07" +--- diff --git a/docs/build-modules/manage-modules.md b/docs/build-modules/manage-modules.md new file mode 100644 index 0000000000..c4383cb233 --- /dev/null +++ b/docs/build-modules/manage-modules.md @@ -0,0 +1,17 @@ +--- +title: "Update and manage modules you created" +linkTitle: "Update and manage modules" +type: "docs" +weight: 32 +images: ["/registry/create-module.svg"] +icon: true +tags: ["modular resources", "components", "services", "registry"] +description: "Update or delete your existing modules, or change their privacy settings." +languages: [] +viamresources: [] +platformarea: ["registry"] +level: "Beginner" +date: "2024-06-30" +# updated: "" # When the tutorial was last entirely checked +cost: "0" +--- diff --git a/docs/build-modules/module-reference.md b/docs/build-modules/module-reference.md new file mode 100644 index 0000000000..207c65ffec --- /dev/null +++ b/docs/build-modules/module-reference.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Module Reference" +title: "Module Developer Reference" +weight: 40 +layout: "docs" +type: "docs" +description: "Reference for module developers: lifecycle, interfaces, meta.json schema, CLI commands, environment variables, and registry rules." +date: "2025-03-05" +--- diff --git a/docs/build-modules/platform-apis.md b/docs/build-modules/platform-apis.md new file mode 100644 index 0000000000..dab3f8f73b --- /dev/null +++ b/docs/build-modules/platform-apis.md @@ -0,0 +1,9 @@ +--- +title: "Access platform APIs from within a module" +linkTitle: "Use platform APIs" +weight: 35 +layout: "docs" +type: "docs" +description: "Write your validate and reconfigure functions to handle dependencies in your custom modular resource." +date: "2025-11-05" +--- diff --git a/docs/build-modules/write-a-cpp-module.md b/docs/build-modules/write-a-cpp-module.md new file mode 100644 index 0000000000..c63ef578e0 --- /dev/null +++ b/docs/build-modules/write-a-cpp-module.md @@ -0,0 +1,17 @@ +--- +title: "Create a new module with C++" +linkTitle: "Create a C++ module" +type: "docs" +weight: 27 +images: ["/registry/module-puzzle-piece.svg"] +tags: ["modular resources", "components", "services", "registry"] +description: "Add support for a new component or service model by writing a module in C++." +languages: ["c++"] +viamresources: [] +platformarea: ["registry"] +level: "Intermediate" +date: "2024-07-30" +# updated: "" # When the tutorial was last entirely checked +cost: "0" +draft: true # Take out Go and Python, and check updatedness before un-drafting. +--- diff --git a/docs/build-modules/write-a-driver-module.md b/docs/build-modules/write-a-driver-module.md new file mode 100644 index 0000000000..212e601906 --- /dev/null +++ b/docs/build-modules/write-a-driver-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Write a Driver Module" +title: "Write a Driver Module" +weight: 20 +layout: "docs" +type: "docs" +description: "Build a module that implements a resource API and runs as a separate process." +date: "2025-01-30" +--- diff --git a/docs/build-modules/write-a-logic-module.md b/docs/build-modules/write-a-logic-module.md new file mode 100644 index 0000000000..74f67a7c48 --- /dev/null +++ b/docs/build-modules/write-a-logic-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Write a Logic Module" +title: "Write a Logic Module" +weight: 25 +layout: "docs" +type: "docs" +description: "Build a module that monitors sensors, coordinates components, or runs automation logic." +date: "2025-03-06" +--- diff --git a/docs/build-modules/write-an-inline-module.md b/docs/build-modules/write-an-inline-module.md new file mode 100644 index 0000000000..732b6c92d6 --- /dev/null +++ b/docs/build-modules/write-an-inline-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Write an Inline Module" +title: "Write an Inline Module" +weight: 10 +layout: "docs" +type: "docs" +description: "Write and deploy a custom module directly in the browser using Viam's inline module editor." +date: "2025-01-30" +--- diff --git a/docs/data-ai/_index.md b/docs/data-ai/_index.md index 07064b724e..46ac5bc443 100644 --- a/docs/data-ai/_index.md +++ b/docs/data-ai/_index.md @@ -3,6 +3,7 @@ linkTitle: "AI and Data" title: "Work with Data and AI" weight: 250 layout: "docs" +toc_hide: true type: "docs" no_list: true noedit: true diff --git a/docs/data/_index.md b/docs/data/_index.md new file mode 100644 index 0000000000..fc58ca217e --- /dev/null +++ b/docs/data/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Manage data" +title: "Manage data" +weight: 40 +layout: "docs" +type: "docs" +no_list: true +description: "Capture, query, filter, pipeline, export, and visualize data." +--- diff --git a/docs/data/capture-sync/_index.md b/docs/data/capture-sync/_index.md new file mode 100644 index 0000000000..6f817bfd6c --- /dev/null +++ b/docs/data/capture-sync/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Capture and sync" +title: "Capture and sync" +weight: 10 +layout: "docs" +type: "docs" +no_list: true +description: "Capture data from your machines and sync it to the cloud." +--- diff --git a/docs/data/capture-sync/advanced-data-capture-sync.md b/docs/data/capture-sync/advanced-data-capture-sync.md new file mode 100644 index 0000000000..0086aded3e --- /dev/null +++ b/docs/data/capture-sync/advanced-data-capture-sync.md @@ -0,0 +1,12 @@ +--- +linkTitle: "Advanced configuration" +title: "Advanced configuration" +tags: ["data management", "data", "services"] +weight: 10 +layout: "docs" +type: "docs" +platformarea: ["data"] +description: "JSON-level configuration for retention policies, sync optimization, remote parts capture, and direct MongoDB capture." +date: "2025-02-10" +updated: "2025-12-04" +--- diff --git a/docs/data/capture-sync/capture-and-sync-data.md b/docs/data/capture-sync/capture-and-sync-data.md new file mode 100644 index 0000000000..dd0753e849 --- /dev/null +++ b/docs/data/capture-sync/capture-and-sync-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Capture and sync data" +title: "Capture and sync data" +weight: 5 +layout: "docs" +type: "docs" +description: "Capture data from any resource and sync it to the cloud." +date: "2025-01-30" +--- diff --git a/docs/data/capture-sync/conditional-sync.md b/docs/data/capture-sync/conditional-sync.md new file mode 100644 index 0000000000..190fb9c31e --- /dev/null +++ b/docs/data/capture-sync/conditional-sync.md @@ -0,0 +1,14 @@ +--- +title: "Conditional sync" +linkTitle: "Conditional sync" +description: "Control when captured data syncs to the cloud using a sensor that decides whether to sync." +type: "docs" +weight: 7 +tags: ["data management", "cloud", "sync"] +images: ["/services/icons/data-cloud-sync.svg"] +icon: true +viamresources: ["sensor", "data_manager"] +platformarea: ["data", "registry"] +date: "2024-12-04" +updated: "2025-12-04" +--- diff --git a/docs/data/capture-sync/lorawan.md b/docs/data/capture-sync/lorawan.md new file mode 100644 index 0000000000..02ca4b9621 --- /dev/null +++ b/docs/data/capture-sync/lorawan.md @@ -0,0 +1,10 @@ +--- +title: "Create a LoRaWAN network" +linkTitle: "Create a LoRaWAN network" +weight: 60 +type: "docs" +description: "Configure a gateway and nodes to communicate over the LoRaWAN protocol." +tags: ["sensor", "components", "lorawan", "gateway", "node"] +icon: true +images: ["/icons/components/sensor.svg"] +--- diff --git a/docs/data/capture-sync/stop-data-capture.md b/docs/data/capture-sync/stop-data-capture.md new file mode 100644 index 0000000000..9fe502d194 --- /dev/null +++ b/docs/data/capture-sync/stop-data-capture.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Stop data capture" +title: "Stop or disable data capture" +weight: 6 +layout: "docs" +type: "docs" +description: "Stop capturing data for specific resources, all resources, or disable cloud sync." +date: "2025-01-30" +--- diff --git a/docs/data/capture-sync/upload-other-data.md b/docs/data/capture-sync/upload-other-data.md new file mode 100644 index 0000000000..35c03ed2fc --- /dev/null +++ b/docs/data/capture-sync/upload-other-data.md @@ -0,0 +1,13 @@ +--- +linkTitle: "Upload external data" +title: "Upload external data" +images: ["/services/icons/data-folder.svg"] +weight: 8 +layout: "docs" +type: "docs" +languages: ["python"] +viamresources: ["data_manager"] +date: "2024-12-04" +updated: "2025-09-11" +description: "Upload data to Viam from your local computer or mobile device using the data client API or the Viam mobile app." +--- diff --git a/docs/data/export/_index.md b/docs/data/export/_index.md new file mode 100644 index 0000000000..f4db832bdd --- /dev/null +++ b/docs/data/export/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Export and integrate" +title: "Export and integrate" +weight: 40 +layout: "docs" +type: "docs" +no_list: true +description: "Export captured data or sync it to your own database." +--- diff --git a/docs/data/export/export-data.md b/docs/data/export/export-data.md new file mode 100644 index 0000000000..f452ef13f5 --- /dev/null +++ b/docs/data/export/export-data.md @@ -0,0 +1,11 @@ +--- +linkTitle: "Export data" +title: "Export data" +weight: 50 +layout: "docs" +type: "docs" +description: "Download data from Viam using the data client API or the CLI." +tags: ["data management", "cloud", "sync"] +date: "2024-12-03" +updated: "2025-09-12" +--- diff --git a/docs/data/export/sync-data-to-your-database.md b/docs/data/export/sync-data-to-your-database.md new file mode 100644 index 0000000000..462a40d806 --- /dev/null +++ b/docs/data/export/sync-data-to-your-database.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Sync data to your database" +title: "Sync data to your database" +weight: 40 +layout: "docs" +type: "docs" +description: "Use Viam as an ingestion layer and sync captured data to your own MongoDB database." +date: "2025-01-30" +--- diff --git a/docs/data/filter-at-the-edge.md b/docs/data/filter-at-the-edge.md new file mode 100644 index 0000000000..54b819089b --- /dev/null +++ b/docs/data/filter-at-the-edge.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Filter at the edge" +title: "Filter at the edge" +weight: 50 +layout: "docs" +type: "docs" +description: "Reduce bandwidth and storage costs by filtering data on the machine before syncing to the cloud." +date: "2025-01-30" +--- diff --git a/docs/data/query/_index.md b/docs/data/query/_index.md new file mode 100644 index 0000000000..5e9cf7e936 --- /dev/null +++ b/docs/data/query/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Query" +title: "Query" +weight: 30 +layout: "docs" +type: "docs" +no_list: true +description: "Query, aggregate, and analyze captured data." +--- diff --git a/docs/data/query/configure-data-pipelines.md b/docs/data/query/configure-data-pipelines.md new file mode 100644 index 0000000000..83589542e3 --- /dev/null +++ b/docs/data/query/configure-data-pipelines.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Configure data pipelines" +title: "Configure data pipelines" +weight: 30 +layout: "docs" +type: "docs" +description: "Create scheduled MQL pipelines that automatically aggregate and summarize captured data." +date: "2025-01-30" +--- diff --git a/docs/data/query/hot-data-store.md b/docs/data/query/hot-data-store.md new file mode 100644 index 0000000000..3002539673 --- /dev/null +++ b/docs/data/query/hot-data-store.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Hot data store" +title: "Hot data store" +weight: 35 +layout: "docs" +type: "docs" +description: "Store a rolling window of recent data for fast queries while continuing to write all data to blob storage." +date: "2025-01-30" +--- diff --git a/docs/data/query/query-data.md b/docs/data/query/query-data.md new file mode 100644 index 0000000000..1ae715f4df --- /dev/null +++ b/docs/data/query/query-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Query data" +title: "Query data" +weight: 10 +layout: "docs" +type: "docs" +description: "Write SQL and MQL queries against captured data in the Viam app or programmatically." +date: "2025-01-30" +--- diff --git a/docs/data/query/query-reference.md b/docs/data/query/query-reference.md new file mode 100644 index 0000000000..4a8021f23b --- /dev/null +++ b/docs/data/query/query-reference.md @@ -0,0 +1,10 @@ +--- +linkTitle: "Query reference" +title: "Query reference" +weight: 15 +layout: "docs" +type: "docs" +date: "2024-12-03" +updated: "2025-09-12" +description: "Query reference: supported operators, SQL limitations, third-party tools, and performance best practices." +--- diff --git a/docs/data/trigger-on-data.md b/docs/data/trigger-on-data.md new file mode 100644 index 0000000000..e0901ab3d8 --- /dev/null +++ b/docs/data/trigger-on-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Trigger on data events" +title: "Trigger on data events" +weight: 60 +layout: "docs" +type: "docs" +description: "Use triggers to send email notifications or webhook requests when data from the machine is synced." +date: "2025-09-12" +--- diff --git a/docs/data/visualize-data.md b/docs/data/visualize-data.md new file mode 100644 index 0000000000..fb37abbc66 --- /dev/null +++ b/docs/data/visualize-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Visualize data" +title: "Visualize data" +weight: 55 +layout: "docs" +type: "docs" +description: "Build dashboards with Teleop, Grafana, or programmatic charts to visualize captured data." +date: "2025-01-30" +--- diff --git a/docs/dev/tools/contributing.md b/docs/dev/tools/contributing.md new file mode 100644 index 0000000000..2bfad2b468 --- /dev/null +++ b/docs/dev/tools/contributing.md @@ -0,0 +1,8 @@ +--- +title: "Contributing to the Docs" +linkTitle: "Contributing to the docs" +weight: 99 +type: "docs" +description: "Learn about our style guide and how to work with hugo to contribute to these docs." +toc_hide: true +--- diff --git a/docs/fleet/_index.md b/docs/fleet/_index.md new file mode 100644 index 0000000000..6fa0939554 --- /dev/null +++ b/docs/fleet/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Fleet Deployment" +title: "Fleet Deployment" +weight: 200 +layout: "docs" +type: "docs" +no_list: true +description: "Deploy machines at scale: templatize configurations with fragments, provision devices, push software updates, and manage system settings." +--- diff --git a/docs/fleet/change-network.md b/docs/fleet/change-network.md new file mode 100644 index 0000000000..70975e366e --- /dev/null +++ b/docs/fleet/change-network.md @@ -0,0 +1,8 @@ +--- +linkTitle: "change network" +title: "change network" +weight: 10 +layout: "docs" +type: "docs" +description: "change network." +--- diff --git a/docs/fleet/deploy-software.md b/docs/fleet/deploy-software.md new file mode 100644 index 0000000000..8a984858bc --- /dev/null +++ b/docs/fleet/deploy-software.md @@ -0,0 +1,8 @@ +--- +linkTitle: "deploy software" +title: "deploy software" +weight: 10 +layout: "docs" +type: "docs" +description: "deploy software." +--- diff --git a/docs/fleet/end-user-setup.md b/docs/fleet/end-user-setup.md new file mode 100644 index 0000000000..38f07699ac --- /dev/null +++ b/docs/fleet/end-user-setup.md @@ -0,0 +1,8 @@ +--- +linkTitle: "end user setup" +title: "end user setup" +weight: 10 +layout: "docs" +type: "docs" +description: "end user setup." +--- diff --git a/docs/fleet/metadata.md b/docs/fleet/metadata.md new file mode 100644 index 0000000000..ccb0594853 --- /dev/null +++ b/docs/fleet/metadata.md @@ -0,0 +1,8 @@ +--- +linkTitle: "metadata" +title: "metadata" +weight: 10 +layout: "docs" +type: "docs" +description: "metadata." +--- diff --git a/docs/fleet/provision-devices.md b/docs/fleet/provision-devices.md new file mode 100644 index 0000000000..11a2a9ef8a --- /dev/null +++ b/docs/fleet/provision-devices.md @@ -0,0 +1,8 @@ +--- +linkTitle: "provision devices" +title: "provision devices" +weight: 10 +layout: "docs" +type: "docs" +description: "provision devices." +--- diff --git a/docs/fleet/reuse-configuration.md b/docs/fleet/reuse-configuration.md new file mode 100644 index 0000000000..c82da06e65 --- /dev/null +++ b/docs/fleet/reuse-configuration.md @@ -0,0 +1,8 @@ +--- +linkTitle: "reuse configuration" +title: "reuse configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "reuse configuration." +--- diff --git a/docs/fleet/scheduled-jobs.md b/docs/fleet/scheduled-jobs.md new file mode 100644 index 0000000000..998f735744 --- /dev/null +++ b/docs/fleet/scheduled-jobs.md @@ -0,0 +1,8 @@ +--- +linkTitle: "scheduled jous" +title: "scheduled jous" +weight: 10 +layout: "docs" +type: "docs" +description: "scheduled jous." +--- diff --git a/docs/fleet/system-settings.md b/docs/fleet/system-settings.md new file mode 100644 index 0000000000..e6f1674795 --- /dev/null +++ b/docs/fleet/system-settings.md @@ -0,0 +1,8 @@ +--- +linkTitle: "system settings" +title: "system settings" +weight: 10 +layout: "docs" +type: "docs" +description: "system settings." +--- diff --git a/docs/fleet/update-software.md b/docs/fleet/update-software.md new file mode 100644 index 0000000000..3d7ff09787 --- /dev/null +++ b/docs/fleet/update-software.md @@ -0,0 +1,8 @@ +--- +linkTitle: "update software" +title: "update software" +weight: 10 +layout: "docs" +type: "docs" +description: "update software." +--- diff --git a/docs/foundation/_index.md b/docs/foundation/_index.md new file mode 100644 index 0000000000..bf2ba6becc --- /dev/null +++ b/docs/foundation/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Get Started" +title: "Get Started" +weight: 30 +layout: "docs" +type: "docs" +no_list: true +description: "Install Viam on your machine and connect it to the cloud." +--- diff --git a/docs/foundation/initialize-a-viam-machine.md b/docs/foundation/initialize-a-viam-machine.md new file mode 100644 index 0000000000..a393bace35 --- /dev/null +++ b/docs/foundation/initialize-a-viam-machine.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Initialize a Viam machine" +title: "Initialize a Viam machine" +weight: 10 +layout: "docs" +type: "docs" +description: "Initialize a Viam machine." +--- diff --git a/docs/foundation/setup-micro/_index.md b/docs/foundation/setup-micro/_index.md new file mode 100644 index 0000000000..013e87972d --- /dev/null +++ b/docs/foundation/setup-micro/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Set up micro-controller" +title: "Set up micro-controller" +weight: 20 +layout: "docs" +type: "docs" +description: "Set up micro-controller." +--- diff --git a/docs/foundation/setup-micro/micro-module.md b/docs/foundation/setup-micro/micro-module.md new file mode 100644 index 0000000000..238d6831a5 --- /dev/null +++ b/docs/foundation/setup-micro/micro-module.md @@ -0,0 +1,13 @@ +--- +title: "Create modules for ESP32 microcontrollers" +linkTitle: "Modules for ESP32" +type: "docs" +weight: 50 +images: ["/installation/thumbnails/esp32-espressif.png"] +imageAlt: "E S P 32 - espressif" +tags: ["modular resources", "components", "services", "registry"] +description: "Create your own modules for use with an Espressif ESP32 microcontroller." +languages: ["rust"] +date: "2024-12-11" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/foundation/setup-micro/micro-troubleshooting.md b/docs/foundation/setup-micro/micro-troubleshooting.md new file mode 100644 index 0000000000..55bfd1b619 --- /dev/null +++ b/docs/foundation/setup-micro/micro-troubleshooting.md @@ -0,0 +1,11 @@ +--- +title: "Micro-RDK Troubleshooting" +linkTitle: "Micro-RDK Troubleshooting" +weight: 100 +type: docs +images: ["/installation/thumbnails/install.png"] +imageAlt: "Install viam-micro-server" +description: "Troubleshooting tips and best practices for installing and using viam-micro-server or other Micro-RDK-based firmware on a microcontroller." +# date: "2024-10-07" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/hardware/_index.md b/docs/hardware/_index.md new file mode 100644 index 0000000000..0352ca461a --- /dev/null +++ b/docs/hardware/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Configure hardware" +title: "Configure hardware" +weight: 35 +layout: "docs" +type: "docs" +no_list: true +description: "Understand how Viam represents hardware, add components to your machine, and configure them." +--- diff --git a/docs/hardware/common-components/_index.md b/docs/hardware/common-components/_index.md new file mode 100644 index 0000000000..c3b20e15cb --- /dev/null +++ b/docs/hardware/common-components/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Add a component" +title: "Add a component" +weight: 20 +layout: "docs" +type: "docs" +no_list: true +description: "Step-by-step guides for adding and configuring each component type." +--- diff --git a/docs/hardware/common-components/add-a-base.md b/docs/hardware/common-components/add-a-base.md new file mode 100644 index 0000000000..5769b4e777 --- /dev/null +++ b/docs/hardware/common-components/add-a-base.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Base" +title: "Add a base" +weight: 10 +layout: "docs" +type: "docs" +description: "Add and configure a wheeled base to drive a mobile robot as a single unit." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-board.md b/docs/hardware/common-components/add-a-board.md new file mode 100644 index 0000000000..ecb2f42409 --- /dev/null +++ b/docs/hardware/common-components/add-a-board.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Board" +title: "Add a board" +weight: 15 +layout: "docs" +type: "docs" +description: "Add and configure a board component to expose GPIO pins, analog readers, and digital interrupts." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-button.md b/docs/hardware/common-components/add-a-button.md new file mode 100644 index 0000000000..6f6dae3b2e --- /dev/null +++ b/docs/hardware/common-components/add-a-button.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Button" +title: "Add a button" +weight: 20 +layout: "docs" +type: "docs" +description: "Add and configure a button component to detect presses from a physical button." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-camera.md b/docs/hardware/common-components/add-a-camera.md new file mode 100644 index 0000000000..3d81af9b0c --- /dev/null +++ b/docs/hardware/common-components/add-a-camera.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Camera" +title: "Add a camera" +weight: 25 +layout: "docs" +type: "docs" +description: "Add and configure a camera component, verify the feed, and capture an image programmatically." +date: "2025-01-30" +--- diff --git a/docs/hardware/common-components/add-a-gantry.md b/docs/hardware/common-components/add-a-gantry.md new file mode 100644 index 0000000000..2adfb1a08d --- /dev/null +++ b/docs/hardware/common-components/add-a-gantry.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Gantry" +title: "Add a gantry" +weight: 35 +layout: "docs" +type: "docs" +description: "Add and configure a gantry component for precise linear positioning along one or more axes." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-generic.md b/docs/hardware/common-components/add-a-generic.md new file mode 100644 index 0000000000..a4905c9a4a --- /dev/null +++ b/docs/hardware/common-components/add-a-generic.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Generic" +title: "Add a generic component" +weight: 40 +layout: "docs" +type: "docs" +description: "Add and configure a generic component for hardware that doesn't fit any other component type." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-gripper.md b/docs/hardware/common-components/add-a-gripper.md new file mode 100644 index 0000000000..922c797b3c --- /dev/null +++ b/docs/hardware/common-components/add-a-gripper.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Gripper" +title: "Add a gripper" +weight: 45 +layout: "docs" +type: "docs" +description: "Add and configure a gripper component to open, close, and grasp objects." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-motor.md b/docs/hardware/common-components/add-a-motor.md new file mode 100644 index 0000000000..f3f7749323 --- /dev/null +++ b/docs/hardware/common-components/add-a-motor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Motor" +title: "Add a motor" +weight: 55 +layout: "docs" +type: "docs" +description: "Add and configure a motor component controlled by GPIO pins, and test it from the Viam app." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-movement-sensor.md b/docs/hardware/common-components/add-a-movement-sensor.md new file mode 100644 index 0000000000..92214fbeb6 --- /dev/null +++ b/docs/hardware/common-components/add-a-movement-sensor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Movement sensor" +title: "Add a movement sensor" +weight: 60 +layout: "docs" +type: "docs" +description: "Add and configure a movement sensor like a GPS, IMU, or odometry source." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-power-sensor.md b/docs/hardware/common-components/add-a-power-sensor.md new file mode 100644 index 0000000000..d8d38ca511 --- /dev/null +++ b/docs/hardware/common-components/add-a-power-sensor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Power sensor" +title: "Add a power sensor" +weight: 65 +layout: "docs" +type: "docs" +description: "Add and configure a power sensor to monitor voltage, current, and power consumption." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-sensor.md b/docs/hardware/common-components/add-a-sensor.md new file mode 100644 index 0000000000..e9625920ee --- /dev/null +++ b/docs/hardware/common-components/add-a-sensor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Sensor" +title: "Add a sensor" +weight: 70 +layout: "docs" +type: "docs" +description: "Add and configure a sensor to read environmental data like temperature, humidity, or distance." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-servo.md b/docs/hardware/common-components/add-a-servo.md new file mode 100644 index 0000000000..0f9ad1af02 --- /dev/null +++ b/docs/hardware/common-components/add-a-servo.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Servo" +title: "Add a servo" +weight: 75 +layout: "docs" +type: "docs" +description: "Add and configure a hobby servo controlled by a GPIO PWM pin." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-switch.md b/docs/hardware/common-components/add-a-switch.md new file mode 100644 index 0000000000..5f3f0d213c --- /dev/null +++ b/docs/hardware/common-components/add-a-switch.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Switch" +title: "Add a switch" +weight: 80 +layout: "docs" +type: "docs" +description: "Add and configure a switch component to read and set the position of a multi-position switch." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-an-arm.md b/docs/hardware/common-components/add-an-arm.md new file mode 100644 index 0000000000..238208374d --- /dev/null +++ b/docs/hardware/common-components/add-an-arm.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Arm" +title: "Add an arm" +weight: 5 +layout: "docs" +type: "docs" +description: "Add and configure a robotic arm, verify joint motion, and test end-effector positioning." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-an-encoder.md b/docs/hardware/common-components/add-an-encoder.md new file mode 100644 index 0000000000..da5e3806d0 --- /dev/null +++ b/docs/hardware/common-components/add-an-encoder.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Encoder" +title: "Add an encoder" +weight: 30 +layout: "docs" +type: "docs" +description: "Add and configure an encoder to track motor position and direction." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-an-input-controller.md b/docs/hardware/common-components/add-an-input-controller.md new file mode 100644 index 0000000000..98803dfcbb --- /dev/null +++ b/docs/hardware/common-components/add-an-input-controller.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Input controller" +title: "Add an input controller" +weight: 50 +layout: "docs" +type: "docs" +description: "Add and configure a gamepad, joystick, or other input device for manual machine control." +date: "2025-03-07" +--- diff --git a/docs/hardware/component-types.md b/docs/hardware/component-types.md new file mode 100644 index 0000000000..e7233ec88a --- /dev/null +++ b/docs/hardware/component-types.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Component types" +title: "Component types" +weight: 5 +layout: "docs" +type: "docs" +description: "All the component types Viam supports and when to use each one." +date: "2025-03-07" +--- diff --git a/docs/hardware/configure-hardware.md b/docs/hardware/configure-hardware.md new file mode 100644 index 0000000000..393ad028e8 --- /dev/null +++ b/docs/hardware/configure-hardware.md @@ -0,0 +1,9 @@ +--- +linkTitle: "How components work" +title: "How components work" +weight: 1 +layout: "docs" +type: "docs" +description: "Understand how Viam represents hardware, add components to your machine, and configure them." +date: "2025-03-07" +--- diff --git a/docs/hardware/fragments.md b/docs/hardware/fragments.md new file mode 100644 index 0000000000..443f581bf9 --- /dev/null +++ b/docs/hardware/fragments.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Fragments" +title: "Fragments" +weight: 12 +layout: "docs" +type: "docs" +description: "Use, create, and share reusable hardware configurations." +date: "2025-03-07" +--- diff --git a/docs/hardware/machine-configuration.md b/docs/hardware/machine-configuration.md new file mode 100644 index 0000000000..e89bb036ff --- /dev/null +++ b/docs/hardware/machine-configuration.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Machine configuration" +title: "Machine configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "Understand the JSON configuration that defines your machine's components, and how to edit it." +date: "2025-03-07" +--- diff --git a/docs/manage/_index.md b/docs/manage/_index.md index 7f5604cdcf..00aac45a70 100644 --- a/docs/manage/_index.md +++ b/docs/manage/_index.md @@ -3,6 +3,7 @@ linkTitle: "Deploy and Manage" title: "Deploy, manage, and troubleshoot" weight: 300 layout: "docs" +toc_hide: true type: "docs" no_list: true notoc: true diff --git a/docs/monitor/_index.md b/docs/monitor/_index.md new file mode 100644 index 0000000000..8e288e0993 --- /dev/null +++ b/docs/monitor/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Monitor and Operate" +title: "Monitor and Operate" +weight: 220 +layout: "docs" +type: "docs" +no_list: true +description: "Monitor machine status, set up alerts, teleoperate machines remotely, and troubleshoot issues." +--- diff --git a/docs/monitor/alert.md b/docs/monitor/alert.md new file mode 100644 index 0000000000..fba27eba5a --- /dev/null +++ b/docs/monitor/alert.md @@ -0,0 +1,8 @@ +--- +linkTitle: "alert" +title: "alert" +weight: 10 +layout: "docs" +type: "docs" +description: "alert." +--- diff --git a/docs/monitor/custom-interface.md b/docs/monitor/custom-interface.md new file mode 100644 index 0000000000..6f7f609e23 --- /dev/null +++ b/docs/monitor/custom-interface.md @@ -0,0 +1,8 @@ +--- +linkTitle: "custom interface" +title: "custom interface" +weight: 10 +layout: "docs" +type: "docs" +description: "custom interface." +--- diff --git a/docs/monitor/monitor.md b/docs/monitor/monitor.md new file mode 100644 index 0000000000..d8560d6048 --- /dev/null +++ b/docs/monitor/monitor.md @@ -0,0 +1,8 @@ +--- +linkTitle: "monitor" +title: "monitor" +weight: 10 +layout: "docs" +type: "docs" +description: "monitor." +--- diff --git a/docs/monitor/teleoperate.md b/docs/monitor/teleoperate.md new file mode 100644 index 0000000000..4f0c085d58 --- /dev/null +++ b/docs/monitor/teleoperate.md @@ -0,0 +1,8 @@ +--- +linkTitle: "teleoperate" +title: "teleoperate" +weight: 10 +layout: "docs" +type: "docs" +description: "teleoperate." +--- diff --git a/docs/monitor/troubleshoot.md b/docs/monitor/troubleshoot.md new file mode 100644 index 0000000000..495fda9bbb --- /dev/null +++ b/docs/monitor/troubleshoot.md @@ -0,0 +1,8 @@ +--- +linkTitle: "trouuleshoot" +title: "trouuleshoot" +weight: 10 +layout: "docs" +type: "docs" +description: "trouuleshoot." +--- diff --git a/docs/motion-planning/_index.md b/docs/motion-planning/_index.md new file mode 100644 index 0000000000..3e191fc25e --- /dev/null +++ b/docs/motion-planning/_index.md @@ -0,0 +1,13 @@ +--- +linkTitle: "Motion Planning" +title: "Motion Planning" +weight: 160 +layout: "docs" +type: "docs" +no_list: true +noedit: true +open_on_desktop: true +overview: true +description: "Plan and execute collision-free movements for robot arms and gantries." +notoc: true +--- diff --git a/docs/motion-planning/camera-calibration.md b/docs/motion-planning/camera-calibration.md new file mode 100644 index 0000000000..b9dceb3ed1 --- /dev/null +++ b/docs/motion-planning/camera-calibration.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Camera Calibration" +title: "Calibrate a Camera for Motion Planning" +weight: 60 +layout: "docs" +type: "docs" +description: "Compute camera intrinsic and distortion parameters for accurate 2D-to-3D projection." +--- diff --git a/docs/motion-planning/constraints.md b/docs/motion-planning/constraints.md new file mode 100644 index 0000000000..dc1beeba65 --- /dev/null +++ b/docs/motion-planning/constraints.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Constraints" +title: "Configure Motion Constraints" +weight: 40 +layout: "docs" +type: "docs" +description: "Restrict how the arm moves between poses using linear, orientation, and collision constraints." +--- diff --git a/docs/motion-planning/frame-system-how-to/_index.md b/docs/motion-planning/frame-system-how-to/_index.md new file mode 100644 index 0000000000..4c2521956f --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Frame How-Tos" +title: "Frame System How-Tos" +weight: 15 +layout: "docs" +type: "docs" +description: "Configure the frame system for common hardware setups." +--- diff --git a/docs/motion-planning/frame-system-how-to/arm-fixed-camera.md b/docs/motion-planning/frame-system-how-to/arm-fixed-camera.md new file mode 100644 index 0000000000..0e8cf9dac0 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/arm-fixed-camera.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Arm with Fixed External Camera" +title: "Arm with Fixed External Camera" +weight: 20 +layout: "docs" +type: "docs" +description: "Configure frames for a table-mounted arm with a camera mounted separately, such as overhead or on a tripod." +--- diff --git a/docs/motion-planning/frame-system-how-to/arm-gripper-camera.md b/docs/motion-planning/frame-system-how-to/arm-gripper-camera.md new file mode 100644 index 0000000000..37333e95c8 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/arm-gripper-camera.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Arm with Gripper and Wrist Camera" +title: "Arm with Gripper and Wrist Camera" +weight: 10 +layout: "docs" +type: "docs" +description: "Configure frames for a table-mounted arm with an attached gripper and wrist-mounted camera." +--- diff --git a/docs/motion-planning/frame-system-how-to/mobile-base-arm.md b/docs/motion-planning/frame-system-how-to/mobile-base-arm.md new file mode 100644 index 0000000000..10bf3a56d3 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/mobile-base-arm.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Mobile Base with Arm" +title: "Mobile Base with Arm" +weight: 40 +layout: "docs" +type: "docs" +description: "Configure frames for a mobile base with a mounted arm, gripper, and sensors." +--- diff --git a/docs/motion-planning/frame-system-how-to/mobile-base-sensors.md b/docs/motion-planning/frame-system-how-to/mobile-base-sensors.md new file mode 100644 index 0000000000..d88c28f955 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/mobile-base-sensors.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Mobile Base with Sensors" +title: "Mobile Base with Sensors" +weight: 30 +layout: "docs" +type: "docs" +description: "Configure frames for a mobile base with mounted cameras and LIDAR sensors." +--- diff --git a/docs/motion-planning/frame-system.md b/docs/motion-planning/frame-system.md new file mode 100644 index 0000000000..62d0c80e74 --- /dev/null +++ b/docs/motion-planning/frame-system.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Frame System" +title: "Frame System" +weight: 10 +layout: "docs" +type: "docs" +description: "Build a unified coordinate tree so all components agree on where things are in physical space." +--- diff --git a/docs/motion-planning/motion-how-to/_index.md b/docs/motion-planning/motion-how-to/_index.md new file mode 100644 index 0000000000..9409167f9e --- /dev/null +++ b/docs/motion-planning/motion-how-to/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Motion How-Tos" +title: "Motion Planning How-Tos" +weight: 100 +layout: "docs" +type: "docs" +description: "Task-oriented guides for moving arms, gantries, and other kinematic chains." +--- diff --git a/docs/motion-planning/motion-how-to/avoid-obstacles.md b/docs/motion-planning/motion-how-to/avoid-obstacles.md new file mode 100644 index 0000000000..4a7684f7be --- /dev/null +++ b/docs/motion-planning/motion-how-to/avoid-obstacles.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Avoid Obstacles" +title: "Plan Collision-Free Paths" +weight: 30 +layout: "docs" +type: "docs" +description: "Configure obstacles and plan motion paths that avoid collisions." +--- diff --git a/docs/motion-planning/motion-how-to/monitor-plan-execution.md b/docs/motion-planning/motion-how-to/monitor-plan-execution.md new file mode 100644 index 0000000000..99add252ad --- /dev/null +++ b/docs/motion-planning/motion-how-to/monitor-plan-execution.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Monitor Execution" +title: "Monitor and Control Plan Execution" +weight: 70 +layout: "docs" +type: "docs" +description: "Track plan status, retrieve plan details, and stop executing plans." +--- diff --git a/docs/motion-planning/motion-how-to/move-arm-to-pose.md b/docs/motion-planning/motion-how-to/move-arm-to-pose.md new file mode 100644 index 0000000000..60955f0e47 --- /dev/null +++ b/docs/motion-planning/motion-how-to/move-arm-to-pose.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move Arm to Pose" +title: "Move an Arm to a Target Pose" +weight: 10 +layout: "docs" +type: "docs" +description: "Use the motion service to move a robot arm to a position in 3D space." +--- diff --git a/docs/motion-planning/motion-how-to/move-arm-with-constraints.md b/docs/motion-planning/motion-how-to/move-arm-with-constraints.md new file mode 100644 index 0000000000..fb7b7403ec --- /dev/null +++ b/docs/motion-planning/motion-how-to/move-arm-with-constraints.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move with Constraints" +title: "Move an Arm with Motion Constraints" +weight: 20 +layout: "docs" +type: "docs" +description: "Move an arm along a straight line or with a fixed orientation using motion constraints." +--- diff --git a/docs/motion-planning/motion-how-to/move-gantry.md b/docs/motion-planning/motion-how-to/move-gantry.md new file mode 100644 index 0000000000..3fb7863a2b --- /dev/null +++ b/docs/motion-planning/motion-how-to/move-gantry.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move a Gantry" +title: "Move a Gantry" +weight: 40 +layout: "docs" +type: "docs" +description: "Control gantry axes directly or plan complex gantry motion." +--- diff --git a/docs/motion-planning/motion-how-to/pick-an-object.md b/docs/motion-planning/motion-how-to/pick-an-object.md new file mode 100644 index 0000000000..a303e34499 --- /dev/null +++ b/docs/motion-planning/motion-how-to/pick-an-object.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Pick an Object" +title: "Pick an Object" +weight: 50 +layout: "docs" +type: "docs" +description: "Detect, localize, and grasp an object with a robot arm and gripper." +--- diff --git a/docs/motion-planning/motion-how-to/place-an-object.md b/docs/motion-planning/motion-how-to/place-an-object.md new file mode 100644 index 0000000000..15bbfe8606 --- /dev/null +++ b/docs/motion-planning/motion-how-to/place-an-object.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Place an Object" +title: "Place an Object" +weight: 60 +layout: "docs" +type: "docs" +description: "Move a grasped object to a target location and release it." +--- diff --git a/docs/motion-planning/obstacles.md b/docs/motion-planning/obstacles.md new file mode 100644 index 0000000000..6ef2e00956 --- /dev/null +++ b/docs/motion-planning/obstacles.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Obstacles" +title: "Define Obstacles" +weight: 30 +layout: "docs" +type: "docs" +description: "Define collision geometry so the motion planner computes safe, collision-free paths." +--- diff --git a/docs/motion-planning/reference/_index.md b/docs/motion-planning/reference/_index.md new file mode 100644 index 0000000000..50d20725f1 --- /dev/null +++ b/docs/motion-planning/reference/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Reference" +title: "Motion Planning Reference" +weight: 200 +layout: "docs" +type: "docs" +description: "Configuration, API, and technical reference for the motion service." +--- diff --git a/docs/motion-planning/reference/algorithms.md b/docs/motion-planning/reference/algorithms.md new file mode 100644 index 0000000000..6a0b2c707e --- /dev/null +++ b/docs/motion-planning/reference/algorithms.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Algorithms" +title: "Motion Planning Algorithms" +weight: 50 +layout: "docs" +type: "docs" +description: "How Viam's motion planner computes collision-free paths for robot arms." +--- diff --git a/docs/motion-planning/reference/api.md b/docs/motion-planning/reference/api.md new file mode 100644 index 0000000000..90cf2a08b5 --- /dev/null +++ b/docs/motion-planning/reference/api.md @@ -0,0 +1,8 @@ +--- +linkTitle: "API" +title: "Motion Service API" +weight: 20 +layout: "docs" +type: "docs" +description: "The motion service API for planning and executing component movements." +--- diff --git a/docs/motion-planning/reference/kinematics.md b/docs/motion-planning/reference/kinematics.md new file mode 100644 index 0000000000..659f34da2c --- /dev/null +++ b/docs/motion-planning/reference/kinematics.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Arm Kinematics" +title: "Arm Kinematics" +weight: 20 +layout: "docs" +type: "docs" +description: "Set up the kinematic model that describes how your arm's joints and links create motion." +--- diff --git a/docs/motion-planning/reference/motion-service.md b/docs/motion-planning/reference/motion-service.md new file mode 100644 index 0000000000..31b43d23d1 --- /dev/null +++ b/docs/motion-planning/reference/motion-service.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Motion Service" +title: "Motion Service Configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "Configure the motion service for planning and executing component movements." +--- diff --git a/docs/motion-planning/reference/orientation-vectors.md b/docs/motion-planning/reference/orientation-vectors.md new file mode 100644 index 0000000000..8807cc966e --- /dev/null +++ b/docs/motion-planning/reference/orientation-vectors.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Orientation Vectors" +title: "Orientation Vector Reference" +weight: 30 +layout: "docs" +type: "docs" +description: "Reference for specifying component orientation using orientation vectors and other rotation formats." +--- diff --git a/docs/navigation/_index.md b/docs/navigation/_index.md new file mode 100644 index 0000000000..64da7b25bf --- /dev/null +++ b/docs/navigation/_index.md @@ -0,0 +1,13 @@ +--- +linkTitle: "Navigation" +title: "Navigation" +weight: 170 +layout: "docs" +type: "docs" +no_list: true +noedit: true +open_on_desktop: true +overview: true +description: "Autonomous GPS-based navigation for mobile robot bases." +notoc: true +--- diff --git a/docs/navigation/how-to/_index.md b/docs/navigation/how-to/_index.md new file mode 100644 index 0000000000..34b4912a32 --- /dev/null +++ b/docs/navigation/how-to/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "How-Tos" +title: "Navigation How-Tos" +weight: 100 +layout: "docs" +type: "docs" +description: "Task-oriented guides for driving and navigating mobile robot bases." +--- diff --git a/docs/navigation/how-to/avoid-obstacles.md b/docs/navigation/how-to/avoid-obstacles.md new file mode 100644 index 0000000000..64e0a7e169 --- /dev/null +++ b/docs/navigation/how-to/avoid-obstacles.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Avoid Obstacles" +title: "Avoid Obstacles During Navigation" +weight: 40 +layout: "docs" +type: "docs" +description: "Configure vision-based obstacle detection for autonomous navigation." +--- diff --git a/docs/navigation/how-to/detect-while-moving.md b/docs/navigation/how-to/detect-while-moving.md new file mode 100644 index 0000000000..b63449fe48 --- /dev/null +++ b/docs/navigation/how-to/detect-while-moving.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Detect While Moving" +title: "Detect Objects While Navigating" +weight: 60 +layout: "docs" +type: "docs" +description: "Run vision services concurrently with navigation to detect and react to objects." +--- diff --git a/docs/navigation/how-to/drive-the-base.md b/docs/navigation/how-to/drive-the-base.md new file mode 100644 index 0000000000..9e1d755302 --- /dev/null +++ b/docs/navigation/how-to/drive-the-base.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Drive the Base" +title: "Drive a Mobile Base" +weight: 10 +layout: "docs" +type: "docs" +description: "Control a mobile robot base with direct movement commands." +--- diff --git a/docs/navigation/how-to/follow-a-patrol-route.md b/docs/navigation/how-to/follow-a-patrol-route.md new file mode 100644 index 0000000000..c957da3da6 --- /dev/null +++ b/docs/navigation/how-to/follow-a-patrol-route.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Follow a Patrol Route" +title: "Follow a Patrol Route" +weight: 30 +layout: "docs" +type: "docs" +description: "Define a sequence of waypoints and navigate them in a loop." +--- diff --git a/docs/navigation/how-to/move-to-gps-coordinate.md b/docs/navigation/how-to/move-to-gps-coordinate.md new file mode 100644 index 0000000000..a61e8ed846 --- /dev/null +++ b/docs/navigation/how-to/move-to-gps-coordinate.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move to GPS Coordinate" +title: "Move to a GPS Coordinate" +weight: 50 +layout: "docs" +type: "docs" +description: "Move a base to a specific GPS coordinate using MoveOnGlobe." +--- diff --git a/docs/navigation/how-to/navigate-to-waypoint.md b/docs/navigation/how-to/navigate-to-waypoint.md new file mode 100644 index 0000000000..6a08dfcf38 --- /dev/null +++ b/docs/navigation/how-to/navigate-to-waypoint.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Navigate to Waypoint" +title: "Navigate to a Waypoint" +weight: 20 +layout: "docs" +type: "docs" +description: "Configure the navigation service and autonomously navigate to GPS waypoints." +--- diff --git a/docs/navigation/reference/_index.md b/docs/navigation/reference/_index.md new file mode 100644 index 0000000000..5f105d17d9 --- /dev/null +++ b/docs/navigation/reference/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Reference" +title: "Navigation Reference" +weight: 200 +layout: "docs" +type: "docs" +description: "Configuration and API reference for the navigation service." +--- diff --git a/docs/navigation/reference/api.md b/docs/navigation/reference/api.md new file mode 100644 index 0000000000..406f119359 --- /dev/null +++ b/docs/navigation/reference/api.md @@ -0,0 +1,8 @@ +--- +linkTitle: "API" +title: "Navigation Service API" +weight: 20 +layout: "docs" +type: "docs" +description: "The navigation service API for autonomous GPS-based navigation." +--- diff --git a/docs/navigation/reference/navigation-service.md b/docs/navigation/reference/navigation-service.md new file mode 100644 index 0000000000..4d35544526 --- /dev/null +++ b/docs/navigation/reference/navigation-service.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Navigation Service" +title: "Navigation Service Configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "Configure the navigation service for autonomous GPS-based waypoint navigation." +--- diff --git a/docs/operate/_index.md b/docs/operate/_index.md index 81f9881f66..df7ce3a6ad 100644 --- a/docs/operate/_index.md +++ b/docs/operate/_index.md @@ -3,6 +3,7 @@ linkTitle: "Build and Integrate" title: "Build and Integrate" weight: 150 layout: "docs" +toc_hide: true type: "docs" no_list: true noedit: true diff --git a/docs/organization/_index.md b/docs/organization/_index.md new file mode 100644 index 0000000000..058c9458fa --- /dev/null +++ b/docs/organization/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Admin and Access" +title: "Admin and Access" +weight: 225 +layout: "docs" +type: "docs" +no_list: true +description: "Manage access, roles, authentication, data regions, and billing for your organization." +--- diff --git a/docs/organization/access.md b/docs/organization/access.md new file mode 100644 index 0000000000..f8293301dd --- /dev/null +++ b/docs/organization/access.md @@ -0,0 +1,8 @@ +--- +linkTitle: "access" +title: "access" +weight: 10 +layout: "docs" +type: "docs" +description: "access." +--- diff --git a/docs/organization/billing.md b/docs/organization/billing.md new file mode 100644 index 0000000000..211c113011 --- /dev/null +++ b/docs/organization/billing.md @@ -0,0 +1,8 @@ +--- +linkTitle: "uilling" +title: "uilling" +weight: 10 +layout: "docs" +type: "docs" +description: "uilling." +--- diff --git a/docs/organization/data-regions.md b/docs/organization/data-regions.md new file mode 100644 index 0000000000..e96f0bc6e2 --- /dev/null +++ b/docs/organization/data-regions.md @@ -0,0 +1,8 @@ +--- +linkTitle: "data regions" +title: "data regions" +weight: 10 +layout: "docs" +type: "docs" +description: "data regions." +--- diff --git a/docs/organization/oauth.md b/docs/organization/oauth.md new file mode 100644 index 0000000000..07c35cd5c2 --- /dev/null +++ b/docs/organization/oauth.md @@ -0,0 +1,8 @@ +--- +linkTitle: "oauth" +title: "oauth" +weight: 10 +layout: "docs" +type: "docs" +description: "oauth." +--- diff --git a/docs/organization/rbac.md b/docs/organization/rbac.md new file mode 100644 index 0000000000..f3eeb72a26 --- /dev/null +++ b/docs/organization/rbac.md @@ -0,0 +1,8 @@ +--- +linkTitle: "ruac" +title: "ruac" +weight: 10 +layout: "docs" +type: "docs" +description: "ruac." +--- diff --git a/docs/reference/_index.md b/docs/reference/_index.md new file mode 100644 index 0000000000..8d0258ed21 --- /dev/null +++ b/docs/reference/_index.md @@ -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." +--- diff --git a/docs/reference/account/_index.md b/docs/reference/account/_index.md new file mode 100644 index 0000000000..aec166ad8f --- /dev/null +++ b/docs/reference/account/_index.md @@ -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." +--- diff --git a/docs/reference/account/accounts.md b/docs/reference/account/accounts.md new file mode 100644 index 0000000000..e2b5735a27 --- /dev/null +++ b/docs/reference/account/accounts.md @@ -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." +--- diff --git a/docs/reference/account/billing.md b/docs/reference/account/billing.md new file mode 100644 index 0000000000..5ef9a3c47d --- /dev/null +++ b/docs/reference/account/billing.md @@ -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 +--- diff --git a/docs/reference/account/organize.md b/docs/reference/account/organize.md new file mode 100644 index 0000000000..91ebee439a --- /dev/null +++ b/docs/reference/account/organize.md @@ -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." +--- diff --git a/docs/reference/advanced-modules/_index.md b/docs/reference/advanced-modules/_index.md new file mode 100644 index 0000000000..6b68ce5b4b --- /dev/null +++ b/docs/reference/advanced-modules/_index.md @@ -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 +--- diff --git a/docs/reference/advanced-modules/create-subtype.md b/docs/reference/advanced-modules/create-subtype.md new file mode 100644 index 0000000000..150589caab --- /dev/null +++ b/docs/reference/advanced-modules/create-subtype.md @@ -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 +--- diff --git a/docs/reference/advanced-modules/custom-components-remotes.md b/docs/reference/advanced-modules/custom-components-remotes.md new file mode 100644 index 0000000000..7980cee529 --- /dev/null +++ b/docs/reference/advanced-modules/custom-components-remotes.md @@ -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 +--- diff --git a/docs/reference/advanced-modules/docker-modules.md b/docs/reference/advanced-modules/docker-modules.md new file mode 100644 index 0000000000..270bca4546 --- /dev/null +++ b/docs/reference/advanced-modules/docker-modules.md @@ -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 +--- diff --git a/docs/reference/apis/_index.md b/docs/reference/apis/_index.md new file mode 100644 index 0000000000..959781a42a --- /dev/null +++ b/docs/reference/apis/_index.md @@ -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 +--- diff --git a/docs/reference/apis/billing-client.md b/docs/reference/apis/billing-client.md new file mode 100644 index 0000000000..55fe65632e --- /dev/null +++ b/docs/reference/apis/billing-client.md @@ -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 +--- diff --git a/docs/reference/apis/components/_index.md b/docs/reference/apis/components/_index.md new file mode 100644 index 0000000000..38181fdfcf --- /dev/null +++ b/docs/reference/apis/components/_index.md @@ -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." +--- diff --git a/docs/reference/apis/components/arm.md b/docs/reference/apis/components/arm.md new file mode 100644 index 0000000000..846b3eb915 --- /dev/null +++ b/docs/reference/apis/components/arm.md @@ -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 +--- diff --git a/docs/reference/apis/components/audio-in.md b/docs/reference/apis/components/audio-in.md new file mode 100644 index 0000000000..fc70fb8e77 --- /dev/null +++ b/docs/reference/apis/components/audio-in.md @@ -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 +--- diff --git a/docs/reference/apis/components/audio-out.md b/docs/reference/apis/components/audio-out.md new file mode 100644 index 0000000000..6828a96906 --- /dev/null +++ b/docs/reference/apis/components/audio-out.md @@ -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 +--- diff --git a/docs/reference/apis/components/base.md b/docs/reference/apis/components/base.md new file mode 100644 index 0000000000..91a47cc87b --- /dev/null +++ b/docs/reference/apis/components/base.md @@ -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 +--- diff --git a/docs/reference/apis/components/board.md b/docs/reference/apis/components/board.md new file mode 100644 index 0000000000..0dfd9c4b2f --- /dev/null +++ b/docs/reference/apis/components/board.md @@ -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 +--- diff --git a/docs/reference/apis/components/button.md b/docs/reference/apis/components/button.md new file mode 100644 index 0000000000..89d3993df7 --- /dev/null +++ b/docs/reference/apis/components/button.md @@ -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 +--- diff --git a/docs/reference/apis/components/camera.md b/docs/reference/apis/components/camera.md new file mode 100644 index 0000000000..d3552131e0 --- /dev/null +++ b/docs/reference/apis/components/camera.md @@ -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 +--- diff --git a/docs/reference/apis/components/encoder.md b/docs/reference/apis/components/encoder.md new file mode 100644 index 0000000000..74336ad245 --- /dev/null +++ b/docs/reference/apis/components/encoder.md @@ -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 +--- diff --git a/docs/reference/apis/components/gantry.md b/docs/reference/apis/components/gantry.md new file mode 100644 index 0000000000..e7ad051f52 --- /dev/null +++ b/docs/reference/apis/components/gantry.md @@ -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 +--- diff --git a/docs/reference/apis/components/generic.md b/docs/reference/apis/components/generic.md new file mode 100644 index 0000000000..ca8252867a --- /dev/null +++ b/docs/reference/apis/components/generic.md @@ -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 +--- diff --git a/docs/reference/apis/components/gripper.md b/docs/reference/apis/components/gripper.md new file mode 100644 index 0000000000..f4fa07987b --- /dev/null +++ b/docs/reference/apis/components/gripper.md @@ -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 +--- diff --git a/docs/reference/apis/components/input-controller.md b/docs/reference/apis/components/input-controller.md new file mode 100644 index 0000000000..74dbef6e06 --- /dev/null +++ b/docs/reference/apis/components/input-controller.md @@ -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 +--- diff --git a/docs/reference/apis/components/motor.md b/docs/reference/apis/components/motor.md new file mode 100644 index 0000000000..a3dca30592 --- /dev/null +++ b/docs/reference/apis/components/motor.md @@ -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 +--- diff --git a/docs/reference/apis/components/movement-sensor.md b/docs/reference/apis/components/movement-sensor.md new file mode 100644 index 0000000000..644d6c376a --- /dev/null +++ b/docs/reference/apis/components/movement-sensor.md @@ -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 +--- diff --git a/docs/reference/apis/components/power-sensor.md b/docs/reference/apis/components/power-sensor.md new file mode 100644 index 0000000000..97231f0ca9 --- /dev/null +++ b/docs/reference/apis/components/power-sensor.md @@ -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 +--- diff --git a/docs/reference/apis/components/sensor.md b/docs/reference/apis/components/sensor.md new file mode 100644 index 0000000000..636c4d4e57 --- /dev/null +++ b/docs/reference/apis/components/sensor.md @@ -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 +--- diff --git a/docs/reference/apis/components/servo.md b/docs/reference/apis/components/servo.md new file mode 100644 index 0000000000..1a3152873e --- /dev/null +++ b/docs/reference/apis/components/servo.md @@ -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 +--- diff --git a/docs/reference/apis/components/switch.md b/docs/reference/apis/components/switch.md new file mode 100644 index 0000000000..b959428616 --- /dev/null +++ b/docs/reference/apis/components/switch.md @@ -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 +--- diff --git a/docs/reference/apis/data-client.md b/docs/reference/apis/data-client.md new file mode 100644 index 0000000000..3a11b9a9e5 --- /dev/null +++ b/docs/reference/apis/data-client.md @@ -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 +--- diff --git a/docs/reference/apis/fleet.md b/docs/reference/apis/fleet.md new file mode 100644 index 0000000000..bb876846e0 --- /dev/null +++ b/docs/reference/apis/fleet.md @@ -0,0 +1,20 @@ +--- +title: "Manage your fleet with Viam's fleet management API" +linkTitle: "Fleet management" +weight: 20 +type: "docs" +description: "Use the fleet management API with Viam's client SDKs to manage your machine fleet with code." +tags: + [ + "cloud", + "sdk", + "viam-server", + "networking", + "apis", + "robot api", + "cloud management", + "fleet management", + ] +date: "2024-09-20" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/ml-training-client.md b/docs/reference/apis/ml-training-client.md new file mode 100644 index 0000000000..e8c48d4191 --- /dev/null +++ b/docs/reference/apis/ml-training-client.md @@ -0,0 +1,10 @@ +--- +title: "Work with ML training jobs with Viam's ML training API" +linkTitle: "ML training client" +weight: 10 +type: "docs" +description: "Use the ML training client API to manage ML training jobs taking place in Viam's cloud app." +tags: ["cloud", "sdk", "viam-server", "networking", "apis", "ml model", "ml"] +date: "2024-09-16" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/robot.md b/docs/reference/apis/robot.md new file mode 100644 index 0000000000..2a46b6b835 --- /dev/null +++ b/docs/reference/apis/robot.md @@ -0,0 +1,10 @@ +--- +title: "Manage machines with Viam's machine management API" +linkTitle: "Machine management" +weight: 20 +type: "docs" +description: "How to use the machine API to monitor and manage your machines." +tags: ["robot state", "sdk", "apis", "robot api"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/SLAM.md b/docs/reference/apis/services/SLAM.md new file mode 100644 index 0000000000..6d91d8bbb1 --- /dev/null +++ b/docs/reference/apis/services/SLAM.md @@ -0,0 +1,12 @@ +--- +title: "SLAM service API" +linkTitle: "SLAM" +weight: 60 +type: "docs" +tags: ["slam", "services"] +description: "Give commands to get a machine's position within a map." +icon: true +images: ["/services/icons/slam.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/_index.md b/docs/reference/apis/services/_index.md new file mode 100644 index 0000000000..752c30f21f --- /dev/null +++ b/docs/reference/apis/services/_index.md @@ -0,0 +1,10 @@ +--- +linkTitle: "Service APIs" +title: "Service APIs" +weight: 5 +empty_node: true +layout: "empty" +canonical: "/reference/apis/" +type: "docs" +description: "Service APIs." +--- diff --git a/docs/reference/apis/services/base-rc.md b/docs/reference/apis/services/base-rc.md new file mode 100644 index 0000000000..f07adac404 --- /dev/null +++ b/docs/reference/apis/services/base-rc.md @@ -0,0 +1,12 @@ +--- +title: "Base remote control service API" +linkTitle: "Base remote control" +weight: 70 +type: "docs" +tags: ["base", "services", "rover", "input controller", "remote control"] +description: "Give commands to get a list of inputs from the controller that are being monitored for that control mode." +icon: true +images: ["/services/icons/base-rc.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/data.md b/docs/reference/apis/services/data.md new file mode 100644 index 0000000000..52cfc9f1b0 --- /dev/null +++ b/docs/reference/apis/services/data.md @@ -0,0 +1,11 @@ +--- +title: "Data management service API" +linkTitle: "Data management" +weight: 10 +type: "docs" +description: "Give commands to your data management service to sync data stored on the machine it is deployed on to the cloud." +icon: true +images: ["/icons/components/arm.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/discovery.md b/docs/reference/apis/services/discovery.md new file mode 100644 index 0000000000..46939ec7cc --- /dev/null +++ b/docs/reference/apis/services/discovery.md @@ -0,0 +1,10 @@ +--- +title: "Discovery service API" +linkTitle: "Discovery" +weight: 80 +type: "docs" +tags: ["navigation", "services", "resources", "components"] +description: "Reveal which resources are available to configure on a machine based on the hardware that is physically present." +date: "2025-02-18" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/generic.md b/docs/reference/apis/services/generic.md new file mode 100644 index 0000000000..08f43a6c73 --- /dev/null +++ b/docs/reference/apis/services/generic.md @@ -0,0 +1,12 @@ +--- +title: "Generic service API" +linkTitle: "Generic" +weight: 60 +type: "docs" +tags: ["generic", "services"] +description: "Give commands to your generic components for running model-specific commands using DoCommand." +icon: true +images: ["/icons/components/generic.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/ml.md b/docs/reference/apis/services/ml.md new file mode 100644 index 0000000000..e11462f9d6 --- /dev/null +++ b/docs/reference/apis/services/ml.md @@ -0,0 +1,12 @@ +--- +title: "ML model service API" +linkTitle: "ML model" +weight: 30 +type: "docs" +tags: ["data management", "ml", "model training"] +description: "Give commands to your ML model service to make inferences based on a provided ML model." +icon: true +images: ["/services/icons/ml.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/motion.md b/docs/reference/apis/services/motion.md new file mode 100644 index 0000000000..f01ca9dfc1 --- /dev/null +++ b/docs/reference/apis/services/motion.md @@ -0,0 +1,11 @@ +--- +title: "Motion service API" +linkTitle: "Motion" +weight: 40 +type: "docs" +description: "Give commands to move a machine's components from one location or pose to another." +icon: true +images: ["/icons/components/arm.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/navigation.md b/docs/reference/apis/services/navigation.md new file mode 100644 index 0000000000..2892b7d18c --- /dev/null +++ b/docs/reference/apis/services/navigation.md @@ -0,0 +1,12 @@ +--- +title: "Navigation service API" +linkTitle: "Navigation" +weight: 50 +type: "docs" +tags: ["navigation", "services", "base", "rover"] +description: "Give commands to define waypoints and move your machine along those waypoints while avoiding obstacles." +icon: true +images: ["/services/icons/navigation.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/vision.md b/docs/reference/apis/services/vision.md new file mode 100644 index 0000000000..c5c684e80a --- /dev/null +++ b/docs/reference/apis/services/vision.md @@ -0,0 +1,12 @@ +--- +title: "Vision service API" +linkTitle: "Vision" +weight: 20 +type: "docs" +description: "Give commands to get detections, classifications, or point cloud objects, depending on the ML model the vision service is using." +icon: true +images: ["/services/icons/vision.svg"] +tags: ["vision", "computer vision", "CV", "services"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/services/world-state-store.md b/docs/reference/apis/services/world-state-store.md new file mode 100644 index 0000000000..48568e8b22 --- /dev/null +++ b/docs/reference/apis/services/world-state-store.md @@ -0,0 +1,12 @@ +--- +title: "World state store API" +linkTitle: "World state store" +weight: 70 +type: "docs" +tags: ["world_state_store", "services"] +description: "Retrieve a list of world objects." +icon: true +images: ["/icons/components/generic.svg"] +date: "2025-09-12" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/apis/sessions.md b/docs/reference/apis/sessions.md new file mode 100644 index 0000000000..54868d798b --- /dev/null +++ b/docs/reference/apis/sessions.md @@ -0,0 +1,21 @@ +--- +title: "Session management with Viam's client SDKs" +linkTitle: "Session management" +weight: 20 +type: "docs" +description: "Manage sessions between your machine and clients connected through Viam's SDKs." +tags: + [ + "client", + "sdk", + "viam-server", + "networking", + "apis", + "robot api", + "session", + "sessions", + "session management", + ] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/architecture/_index.md b/docs/reference/architecture/_index.md new file mode 100644 index 0000000000..0b5d48c4a2 --- /dev/null +++ b/docs/reference/architecture/_index.md @@ -0,0 +1,12 @@ +--- +title: "Viam architecture" +linkTitle: "Viam architecture" +weight: 10 +type: "docs" +description: "How a machine running on Viam is structured, from on-device to cloud communications." +imageAlt: "Viam architecture" +images: ["/viam/machine-components.png"] +tags: ["components", "services", "communication"] +date: "2024-08-13" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/architecture/machine-to-machine-comms.md b/docs/reference/architecture/machine-to-machine-comms.md new file mode 100644 index 0000000000..e91d7baf77 --- /dev/null +++ b/docs/reference/architecture/machine-to-machine-comms.md @@ -0,0 +1,8 @@ +--- +title: "Machine-to-Machine Communication: End-to-End Flow" +linkTitle: "Machine-to-Machine Communication" +weight: 60 +type: "docs" +description: "Explanation of how a machine and its parts interact at the communication layer." +toc_hide: true +--- diff --git a/docs/reference/architecture/parts.md b/docs/reference/architecture/parts.md new file mode 100644 index 0000000000..17f662772e --- /dev/null +++ b/docs/reference/architecture/parts.md @@ -0,0 +1,10 @@ +--- +title: "Machine architecture: Parts" +linkTitle: "Parts, sub-parts, remotes" +weight: 40 +type: "docs" +description: "Connect multiple machine parts to each other as sub-parts or remotes." +tags: ["server", "components", "services"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/changelog.md b/docs/reference/changelog.md new file mode 100644 index 0000000000..60154021c2 --- /dev/null +++ b/docs/reference/changelog.md @@ -0,0 +1,14 @@ +--- +title: "Changelog" +linkTitle: "Changelog" +weight: 20 +draft: false +type: "docs" +description: "A log of added features, improvements, and changes over time." +layout: "changelog" +outputs: + - rss + - html +date: "2024-09-18" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/components/_index.md b/docs/reference/components/_index.md new file mode 100644 index 0000000000..21d61b2615 --- /dev/null +++ b/docs/reference/components/_index.md @@ -0,0 +1,8 @@ +--- +title: "Components" +linkTitle: "Components" +weight: 20 +type: "docs" +no_list: true +description: "Components represent physical hardware on your machine, including motors, cameras, sensors, and more." +--- diff --git a/docs/reference/components/arm/_index.md b/docs/reference/components/arm/_index.md new file mode 100644 index 0000000000..b1a2c121d0 --- /dev/null +++ b/docs/reference/components/arm/_index.md @@ -0,0 +1,19 @@ +--- +title: "Arm Component" +linkTitle: "Arm" +childTitleEndOverwrite: "Arm Component" +weight: 10 +type: "docs" +description: "A robotic arm is made up of a series of links and joints, ending with a device you can position." +no_list: true +tags: ["arm", "components"] +icon: true +images: ["/icons/components/arm.svg"] +modulescript: true +hide_children: true +outputs: + - html + - typesense +date: "2024-10-21" +# SME: Peter L +--- diff --git a/docs/reference/components/arm/eva.md b/docs/reference/components/arm/eva.md new file mode 100644 index 0000000000..5f7160722f --- /dev/null +++ b/docs/reference/components/arm/eva.md @@ -0,0 +1,12 @@ +--- +title: "Configure an Eva Arm" +linkTitle: "eva" +weight: 34 +type: "docs" +draft: "true" +description: "Configure an Eva arm." +images: ["/icons/components/arm.svg"] +tags: ["arm", "components"] +toc_hide: true +# SMEs: Bucket, Motion +--- diff --git a/docs/reference/components/arm/fake.md b/docs/reference/components/arm/fake.md new file mode 100644 index 0000000000..91f3b0d438 --- /dev/null +++ b/docs/reference/components/arm/fake.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Fake Arm" +linkTitle: "fake" +weight: 34 +type: "docs" +description: "Configure a fake arm to use for testing." +images: ["/icons/components/arm.svg"] +tags: ["arm", "components"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SMEs: Bucket, Motion +--- diff --git a/docs/reference/components/arm/yahboom-dofbot.md b/docs/reference/components/arm/yahboom-dofbot.md new file mode 100644 index 0000000000..f36d1ca95e --- /dev/null +++ b/docs/reference/components/arm/yahboom-dofbot.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Yahboom DOFBOT Arm" +linkTitle: "yahboom-dofbot" +weight: 50 +type: "docs" +draft: "true" +description: "Configure a Yahboom DOFBOT modular arm." +images: ["/icons/components/arm.svg"] +tags: ["arm", "components"] +toc_hide: true +--- diff --git a/docs/reference/components/base/_index.md b/docs/reference/components/base/_index.md new file mode 100644 index 0000000000..78d80287e9 --- /dev/null +++ b/docs/reference/components/base/_index.md @@ -0,0 +1,15 @@ +--- +title: "Base Component" +linkTitle: "Base" +weight: 14 +type: "docs" +no_list: true +description: "The base component allows you to move a mobile robot without needing to send commands to individual components like motors." +tags: ["base", "components"] +icon: true +images: ["/icons/components/base.svg"] +modulescript: true +hide_children: true +date: "2024-10-21" +# SMEs: Steve B +--- diff --git a/docs/reference/components/base/boat.md b/docs/reference/components/base/boat.md new file mode 100644 index 0000000000..780ac71ab5 --- /dev/null +++ b/docs/reference/components/base/boat.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Boat Base" +linkTitle: "boat" +weight: 35 +type: "docs" +draft: "true" +description: "Configure a boat base." +images: ["/icons/components/base.svg"] +tags: ["base", "components"] +toc_hide: true +# SMEs: Eliot +--- diff --git a/docs/reference/components/base/fake.md b/docs/reference/components/base/fake.md new file mode 100644 index 0000000000..d9927e653d --- /dev/null +++ b/docs/reference/components/base/fake.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Fake Base" +linkTitle: "fake" +weight: 20 +type: "docs" +description: "Configure a fake base to use for testing without physical hardware." +images: ["/icons/components/base.svg"] +tags: ["base", "components"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SMEs: Steve B +--- diff --git a/docs/reference/components/base/sensor-controlled.md b/docs/reference/components/base/sensor-controlled.md new file mode 100644 index 0000000000..97bb66c333 --- /dev/null +++ b/docs/reference/components/base/sensor-controlled.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Sensor-Controlled Base" +linkTitle: "sensor-controlled" +weight: 40 +type: "docs" +description: "Configure a sensor-controlled base, a robotic base with feedback control from a movement sensor." +images: ["/icons/components/base.svg"] +tags: ["base", "components"] +component_description: "Wrap other base models and add feedback control using a movement sensor." +toc_hide: true +# SMEs: Rand H., Martha J. +--- diff --git a/docs/reference/components/base/two_wheeled_base.md b/docs/reference/components/base/two_wheeled_base.md new file mode 100644 index 0000000000..a80f04e103 --- /dev/null +++ b/docs/reference/components/base/two_wheeled_base.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Two-Wheeled Base (Micro-RDK)" +linkTitle: "two_wheeled_base (Micro-RDK)" +weight: 30 +type: "docs" +description: "Configure and wire a two-wheeled base with a microcontroller." +images: ["/icons/components/base.svg"] +tags: ["base", "components"] +micrordk_component: true +toc_hide: true +# SMEs: Gautham V. +--- diff --git a/docs/reference/components/base/wheeled.md b/docs/reference/components/base/wheeled.md new file mode 100644 index 0000000000..2d39346935 --- /dev/null +++ b/docs/reference/components/base/wheeled.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Wheeled Base" +linkTitle: "wheeled" +weight: 30 +type: "docs" +description: "Configure and wire a wheeled base." +images: ["/icons/components/base.svg"] +tags: ["base", "components"] +component_description: "Supports mobile wheeled robotic bases with motors on both sides for differential steering." +toc_hide: true +# SMEs: Steve B +--- diff --git a/docs/reference/components/board/_index.md b/docs/reference/components/board/_index.md new file mode 100644 index 0000000000..11130ed3c8 --- /dev/null +++ b/docs/reference/components/board/_index.md @@ -0,0 +1,16 @@ +--- +title: "Board Component" +linkTitle: "Board" +childTitleEndOverwrite: "Board Component" +weight: 17 +type: "docs" +no_list: true +description: "The signal wire hub of a machine, with GPIO pins for transmitting signals between the machine's computer and its other components." +tags: ["board", "components"] +icon: true +images: ["/icons/components/board.svg"] +modulescript: true +hide_children: true +date: "2024-10-21" +# SMEs: Gautham, Rand +--- diff --git a/docs/reference/components/board/esp32.md b/docs/reference/components/board/esp32.md new file mode 100644 index 0000000000..12e8e1e402 --- /dev/null +++ b/docs/reference/components/board/esp32.md @@ -0,0 +1,13 @@ +--- +title: "Configure an ESP32 Board (Micro-RDK)" +linkTitle: "esp32 (Micro-RDK)" +weight: 20 +type: "docs" +description: "Configure an ESP32 board running viam-micro-server." +images: ["/installation/thumbnails/esp32-espressif.png"] +imageAlt: "E S P 32 - espressif" +tags: ["board", "components"] +micrordk_component: true +toc_hide: true +# SMEs: Gautham, Nico, Andrew +--- diff --git a/docs/reference/components/board/fake.md b/docs/reference/components/board/fake.md new file mode 100644 index 0000000000..bcfe8ef58e --- /dev/null +++ b/docs/reference/components/board/fake.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Fake Board" +linkTitle: "fake" +weight: 20 +type: "docs" +description: "Configure a fake board." +images: ["/icons/components/board.svg"] +tags: ["board", "components"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SMEs: Gautham, Rand +--- diff --git a/docs/reference/components/button/_index.md b/docs/reference/components/button/_index.md new file mode 100644 index 0000000000..810a58e8a5 --- /dev/null +++ b/docs/reference/components/button/_index.md @@ -0,0 +1,15 @@ +--- +title: "Button Component" +linkTitle: "Button" +childTitleEndOverwrite: "Button Component" +weight: 20 +type: "docs" +description: "A physical button on a machine." +tags: ["button", "components"] +icon: true # this should be used when the image is an icon, it will adjust the sizing and object-fit +images: ["/icons/components/button.svg"] +no_list: true +modulescript: true +date: "2025-02-20" +# SMEs: +--- diff --git a/docs/reference/components/camera/_index.md b/docs/reference/components/camera/_index.md new file mode 100644 index 0000000000..d13b3e800f --- /dev/null +++ b/docs/reference/components/camera/_index.md @@ -0,0 +1,15 @@ +--- +title: "Camera Component" +linkTitle: "Camera" +childTitleEndOverwrite: "Camera Component" +weight: 40 +type: "docs" +description: "A camera captures 2D or 3D images and sends them to the computer controlling the machine." +no_list: true +tags: ["camera", "components"] +icon: true +images: ["/icons/components/camera.svg"] +modulescript: true +date: "2024-10-21" +# SMEs: Bijan, vision team +--- diff --git a/docs/reference/components/camera/calibrate.md b/docs/reference/components/camera/calibrate.md new file mode 100644 index 0000000000..eff147720a --- /dev/null +++ b/docs/reference/components/camera/calibrate.md @@ -0,0 +1,12 @@ +--- +title: "Calibrate a Camera" +linkTitle: "Calibrate a Camera" +weight: 80 +type: "docs" +description: "Calibrate a camera and extract the intrinsic and distortion parameters." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +no_component: true +date: "2024-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/components/camera/esp32-camera.md b/docs/reference/components/camera/esp32-camera.md new file mode 100644 index 0000000000..16fa09786b --- /dev/null +++ b/docs/reference/components/camera/esp32-camera.md @@ -0,0 +1,15 @@ +--- +title: "Configure an esp32-camera (Micro-RDK)" +linkTitle: "esp32-camera (Micro-RDK)" +weight: 33 +type: "docs" +description: "Configure a camera connected to an esp32 board, initialized and configured using esp-idf." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components", "Micro-RDK"] +component_description: "An `OV2640` or `OV3660` camera connected to an esp32 board." +micrordk_component: true +toc_hide: true +date: "2024-08-28" +# updated: "" # When the content was last entirely checked +# SMEs: Matt Perez, Micro-RDK team +--- diff --git a/docs/reference/components/camera/fake-micro-server.md b/docs/reference/components/camera/fake-micro-server.md new file mode 100644 index 0000000000..9c61592cfe --- /dev/null +++ b/docs/reference/components/camera/fake-micro-server.md @@ -0,0 +1,13 @@ +--- +title: "Configure a Fake Camera (Micro-RDK)" +linkTitle: "fake (Micro-RDK)" +weight: 20 +type: "docs" +description: Configure a camera to use for testing." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +component_description: "A camera model for testing." +micrordk_component: true +toc_hide: true +# SMEs: Matt Perez, Micro-RDK team +--- diff --git a/docs/reference/components/camera/fake.md b/docs/reference/components/camera/fake.md new file mode 100644 index 0000000000..bd07e53675 --- /dev/null +++ b/docs/reference/components/camera/fake.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Fake Camera" +linkTitle: "fake" +weight: 10 +type: "docs" +description: Configure a camera to use for testing." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +component_description: "A camera model for testing." +toc_hide: true +# SMEs: Bijan, vision team +--- diff --git a/docs/reference/components/camera/ffmpeg.md b/docs/reference/components/camera/ffmpeg.md new file mode 100644 index 0000000000..1a5640ee9a --- /dev/null +++ b/docs/reference/components/camera/ffmpeg.md @@ -0,0 +1,12 @@ +--- +title: "Configure an ffmpeg Camera" +linkTitle: "ffmpeg" +weight: 30 +type: "docs" +description: "Uses a camera device, a video file, or a stream as a camera." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +component_description: "Use a camera, a video file, or a stream as a camera component." +toc_hide: true +# SMEs: Sean Yu, audio/video team +--- diff --git a/docs/reference/components/camera/image-file.md b/docs/reference/components/camera/image-file.md new file mode 100644 index 0000000000..0842e8b7d0 --- /dev/null +++ b/docs/reference/components/camera/image-file.md @@ -0,0 +1,12 @@ +--- +title: "Configure an Image File Camera" +linkTitle: "image_file" +weight: 31 +type: "docs" +description: "Configure a camera that gets color or depth images frames from a file path." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +component_description: "Gets color and depth image frames from a file path." +toc_hide: true +# SMEs: Bijan, vision team +--- diff --git a/docs/reference/components/camera/transform.md b/docs/reference/components/camera/transform.md new file mode 100644 index 0000000000..4c5f093631 --- /dev/null +++ b/docs/reference/components/camera/transform.md @@ -0,0 +1,12 @@ +--- +title: "Transform Camera" +linkTitle: "transform" +weight: 60 +type: "docs" +description: "Use the transform camera model to apply transformation to a camera stream. For example, crop, resize, or add overlays with info about the camera stream." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +component_description: "Use pipelines for applying transformations to an input image source." +toc_hide: true +# SMEs: Rand, AV team +--- diff --git a/docs/reference/components/camera/webcam.md b/docs/reference/components/camera/webcam.md new file mode 100644 index 0000000000..9feb280bf6 --- /dev/null +++ b/docs/reference/components/camera/webcam.md @@ -0,0 +1,13 @@ +--- +title: "Configure a Webcam" +linkTitle: "webcam" +weight: 33 +type: "docs" +description: "Configure a standard camera that streams camera data." +images: ["/icons/components/camera.svg"] +tags: ["camera", "components"] +component_description: "A standard USB camera or other webcam that streams camera data." +usage: 999999 +toc_hide: true +# SMEs: Bijan, vision team +--- diff --git a/docs/reference/components/component/_index.md b/docs/reference/components/component/_index.md new file mode 100644 index 0000000000..df39629a8b --- /dev/null +++ b/docs/reference/components/component/_index.md @@ -0,0 +1,15 @@ +--- +title: "Template Component" +linkTitle: "Template" +childTitleEndOverwrite: "Template Component" +weight: 10 +type: "docs" +description: "A NAME is a ... description of what the component is." +tags: ["camera", "components"] +icon: true # this should be used when the image is an icon, it will adjust the sizing and object-fit +images: ["/icons/components.png"] +draft: true +no_list: true +modulescript: true +# SMEs: +--- diff --git a/docs/reference/components/component/board1.md b/docs/reference/components/component/board1.md new file mode 100644 index 0000000000..01456624b4 --- /dev/null +++ b/docs/reference/components/component/board1.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Board" +linkTitle: "" +weight: 20 +type: "docs" +description: "Configure a board." +images: ["/icons/components/board.svg"] +tags: ["board", "components"] +draft: true +# SMEs: +--- diff --git a/docs/reference/components/component/model1.md b/docs/reference/components/component/model1.md new file mode 100644 index 0000000000..4735854f51 --- /dev/null +++ b/docs/reference/components/component/model1.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Model1" +linkTitle: "Model1" +weight: 12 +type: "docs" +description: "Configure a model1 arm." +images: ["/icons/components.png"] +tags: ["name", "components"] +draft: true +# SMEs: +--- diff --git a/docs/reference/components/encoder/_index.md b/docs/reference/components/encoder/_index.md new file mode 100644 index 0000000000..477f7aa630 --- /dev/null +++ b/docs/reference/components/encoder/_index.md @@ -0,0 +1,16 @@ +--- +title: "Encoder Component" +linkTitle: "Encoder" +childTitleEndOverwrite: "Encoder Component" +weight: 50 +type: "docs" +description: "A special type of sensor that measures rotation of a motor or joint." +tags: ["encoder", "components"] +icon: true +images: ["/icons/components/encoder.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2024-10-21" +# SME: Rand +--- diff --git a/docs/reference/components/encoder/arduino.md b/docs/reference/components/encoder/arduino.md new file mode 100644 index 0000000000..e9fcf19cbc --- /dev/null +++ b/docs/reference/components/encoder/arduino.md @@ -0,0 +1,11 @@ +--- +title: "Configure an Arduino Encoder" +linkTitle: "arduino" +type: "docs" +description: "Configure an Arduino encoder." +images: ["/icons/components/encoder.svg"] +tags: ["encoder", "components"] +draft: true +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/encoder/fake.md b/docs/reference/components/encoder/fake.md new file mode 100644 index 0000000000..e8f931f4d4 --- /dev/null +++ b/docs/reference/components/encoder/fake.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Fake Encoder" +linkTitle: "fake" +type: "docs" +description: "Configure a fake encoder." +images: ["/icons/components/encoder.svg"] +tags: ["encoder", "components"] +weight: 10 +component_description: "An encoder model for testing." +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/encoder/incremental-micro-rdk.md b/docs/reference/components/encoder/incremental-micro-rdk.md new file mode 100644 index 0000000000..daf93628e9 --- /dev/null +++ b/docs/reference/components/encoder/incremental-micro-rdk.md @@ -0,0 +1,12 @@ +--- +title: "Configure an Incremental Encoder (Micro-RDK)" +linkTitle: "incremental (Micro-RDK)" +titleMustBeLong: true +type: "docs" +description: "Configure an incremental encoder." +images: ["/icons/components/encoder.svg"] +tags: ["encoder", "components"] +micrordk_component: true +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/encoder/incremental.md b/docs/reference/components/encoder/incremental.md new file mode 100644 index 0000000000..c6eccf974b --- /dev/null +++ b/docs/reference/components/encoder/incremental.md @@ -0,0 +1,11 @@ +--- +title: "Configure an Incremental Encoder" +linkTitle: "incremental" +type: "docs" +description: "Configure an incremental encoder." +images: ["/icons/components/encoder.svg"] +tags: ["encoder", "components"] +component_description: "Supports a two phase encoder, which can measure the speed and direction of rotation in relation to a given reference point." +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/encoder/single-micro-rdk.md b/docs/reference/components/encoder/single-micro-rdk.md new file mode 100644 index 0000000000..b4b28956f8 --- /dev/null +++ b/docs/reference/components/encoder/single-micro-rdk.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Single Encoder (Micro-RDK)" +linkTitle: "single (Micro-RDK)" +type: "docs" +description: "Configure a single encoder with a microcontroller." +images: ["/icons/components/encoder.svg"] +tags: ["encoder", "components"] +micrordk_component: true +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/encoder/single.md b/docs/reference/components/encoder/single.md new file mode 100644 index 0000000000..a1b2a8f6cc --- /dev/null +++ b/docs/reference/components/encoder/single.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Single Encoder" +linkTitle: "single" +type: "docs" +description: "Configure a single encoder." +images: ["/icons/components/encoder.svg"] +tags: ["encoder", "components"] +component_description: "A single pin 'pulse output' encoder which returns its relative position but no direction." +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/gantry/_index.md b/docs/reference/components/gantry/_index.md new file mode 100644 index 0000000000..78b58d990e --- /dev/null +++ b/docs/reference/components/gantry/_index.md @@ -0,0 +1,16 @@ +--- +title: "Gantry Component" +linkTitle: "Gantry" +childTitleEndOverwrite: "Gantry Component" +no_list: true +weight: 50 +type: "docs" +description: "A mechanical system of linear rails that can precisely position an attached device." +tags: ["gantry", "components"] +icon: true +images: ["/icons/components/gantry.svg"] +modulescript: true +hide_children: true +date: "2024-10-21" +# SME: Rand +--- diff --git a/docs/reference/components/gantry/fake.md b/docs/reference/components/gantry/fake.md new file mode 100644 index 0000000000..cabab21e9f --- /dev/null +++ b/docs/reference/components/gantry/fake.md @@ -0,0 +1,13 @@ +--- +title: "Configure a Fake Gantry" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake gantry." +tags: ["gantry", "components"] +icon: true +images: ["/icons/components/gantry.svg"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SME: Rand +--- diff --git a/docs/reference/components/gantry/multi-axis.md b/docs/reference/components/gantry/multi-axis.md new file mode 100644 index 0000000000..1242793302 --- /dev/null +++ b/docs/reference/components/gantry/multi-axis.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Multi-Axis Gantry" +linkTitle: "multi-axis" +weight: 80 +type: "docs" +description: "Configure a multi-axis gantry." +images: ["/icons/components/gantry.svg"] +tags: ["gantry", "components"] +component_description: "Supports a gantry with multiple linear rails. Composed of multiple single-axis gantries." +toc_hide: true +# SME: Rand, Martha +--- diff --git a/docs/reference/components/gantry/single-axis.md b/docs/reference/components/gantry/single-axis.md new file mode 100644 index 0000000000..6ae2f4521b --- /dev/null +++ b/docs/reference/components/gantry/single-axis.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Single-Axis Gantry" +linkTitle: "single-axis" +weight: 70 +type: "docs" +description: "Configure a single-axis gantry." +images: ["/icons/components/gantry.svg"] +tags: ["gantry", "components"] +component_description: "Supports a gantry with a singular linear rail." +toc_hide: true +# SME: Rand, Martha +--- diff --git a/docs/reference/components/generic/_index.md b/docs/reference/components/generic/_index.md new file mode 100644 index 0000000000..ceec7516d2 --- /dev/null +++ b/docs/reference/components/generic/_index.md @@ -0,0 +1,16 @@ +--- +title: "Generic Component" +linkTitle: "Generic" +childTitleEndOverwrite: "Generic Component" +weight: 55 +type: "docs" +description: "A component that does not fit any of the other APIs." +tags: ["generic", "components"] +icon: true +images: ["/icons/components/generic.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2024-10-21" +# SMEs: +--- diff --git a/docs/reference/components/generic/fake.md b/docs/reference/components/generic/fake.md new file mode 100644 index 0000000000..7e069767cf --- /dev/null +++ b/docs/reference/components/generic/fake.md @@ -0,0 +1,10 @@ +--- +title: "Configure a Fake Generic Component" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake generic component." +tags: ["generic", "components"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +--- diff --git a/docs/reference/components/gripper/_index.md b/docs/reference/components/gripper/_index.md new file mode 100644 index 0000000000..6f2f9c2488 --- /dev/null +++ b/docs/reference/components/gripper/_index.md @@ -0,0 +1,16 @@ +--- +title: "Gripper Component" +linkTitle: "Gripper" +childTitleEndOverwrite: "Gripper Component" +weight: 60 +type: "docs" +description: "A gripper is a robotic grasping device that can open and close." +tags: ["gripper", "components"] +icon: true +images: ["/icons/components/gripper.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2024-10-21" +# SMEs: Bucket Team +--- diff --git a/docs/reference/components/gripper/fake.md b/docs/reference/components/gripper/fake.md new file mode 100644 index 0000000000..a19c79d335 --- /dev/null +++ b/docs/reference/components/gripper/fake.md @@ -0,0 +1,13 @@ +--- +title: "Configure a Fake Gripper" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake gripper." +tags: ["gripper", "components"] +icon: true +images: ["/icons/components/gripper.svg"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SME: Rand +--- diff --git a/docs/reference/components/input-controller/_index.md b/docs/reference/components/input-controller/_index.md new file mode 100644 index 0000000000..4738d15c42 --- /dev/null +++ b/docs/reference/components/input-controller/_index.md @@ -0,0 +1,15 @@ +--- +title: "Input Controller Component" +linkTitle: "Input Controller" +weight: 60 +type: "docs" +no_list: true +description: "An input controller, like a gamepad or joystick, is a device humans use to control a machine's actions." +tags: ["input controller", "components"] +icon: true +images: ["/icons/components/controller.svg"] +modulescript: true +hide_children: true +date: "2024-10-21" +# SME: James +--- diff --git a/docs/reference/components/input-controller/fake.md b/docs/reference/components/input-controller/fake.md new file mode 100644 index 0000000000..1f33b5a5b6 --- /dev/null +++ b/docs/reference/components/input-controller/fake.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Fake Input Controller for Testing" +linkTitle: "fake" +weight: 30 +type: "docs" +description: "Configure a fake input controller for testing." +images: ["/icons/components/controller.svg"] +tags: ["input controller", "components"] +component_description: "A model for testing, with no physical hardware." +toc_hide: true +# SMEs: James +--- diff --git a/docs/reference/components/input-controller/gamepad.md b/docs/reference/components/input-controller/gamepad.md new file mode 100644 index 0000000000..6adb34da1b --- /dev/null +++ b/docs/reference/components/input-controller/gamepad.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Linux-supported Gamepad" +linkTitle: "gamepad" +weight: 30 +type: "docs" +description: "Configure a linux-supported gamepad as an input controller." +images: ["/icons/components/controller.svg"] +tags: ["input controller", "components"] +component_description: "Supports X-box, Playstation, and similar controllers with Linux support." +toc_hide: true +# SMEs: James +--- diff --git a/docs/reference/components/input-controller/gpio.md b/docs/reference/components/input-controller/gpio.md new file mode 100644 index 0000000000..e3e27c94d5 --- /dev/null +++ b/docs/reference/components/input-controller/gpio.md @@ -0,0 +1,12 @@ +--- +title: "Configure a GPIO/ADC-Based Input Controller" +linkTitle: "gpio" +weight: 30 +type: "docs" +description: "Configure a GPIO- or ADC-based device as an input controller." +images: ["/icons/components/controller.svg"] +tags: ["input controller", "components"] +component_description: "Customizable GPIO/ADC based device using a board component." +toc_hide: true +# SMEs: James +--- diff --git a/docs/reference/components/input-controller/mux.md b/docs/reference/components/input-controller/mux.md new file mode 100644 index 0000000000..6d22165237 --- /dev/null +++ b/docs/reference/components/input-controller/mux.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Mux Input Controller" +linkTitle: "mux" +weight: 30 +type: "docs" +description: "Configure a mux input controller to combine one or more input controllers." +images: ["/icons/components/controller.svg"] +tags: ["input controller", "components"] +component_description: "Supports multiplexed controllers, combining multiple sources of input." +toc_hide: true +# SMEs: James +--- diff --git a/docs/reference/components/input-controller/webgamepad.md b/docs/reference/components/input-controller/webgamepad.md new file mode 100644 index 0000000000..277c68ec18 --- /dev/null +++ b/docs/reference/components/input-controller/webgamepad.md @@ -0,0 +1,12 @@ +--- +title: "Configure a Web Gamepad" +linkTitle: "webgamepad" +weight: 30 +type: "docs" +description: "Configure a web-based gamepad as an input controller." +images: ["/icons/components/controller.svg"] +tags: ["input controller", "components"] +component_description: "Supports a remote, web based gamepad." +toc_hide: true +# SMEs: James +--- diff --git a/docs/reference/components/motor/_index.md b/docs/reference/components/motor/_index.md new file mode 100644 index 0000000000..811623532c --- /dev/null +++ b/docs/reference/components/motor/_index.md @@ -0,0 +1,16 @@ +--- +title: "Motor Component" +linkTitle: "Motor" +childTitleEndOverwrite: "Motor Component" +weight: 70 +type: "docs" +description: "A motor is a rotating machine that transforms electrical energy into mechanical energy." +tags: ["motor", "components"] +icon: true +images: ["/icons/components/motor.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2024-10-21" +# SME: Rand +--- diff --git a/docs/reference/components/motor/dmc4000.md b/docs/reference/components/motor/dmc4000.md new file mode 100644 index 0000000000..e19cb82454 --- /dev/null +++ b/docs/reference/components/motor/dmc4000.md @@ -0,0 +1,11 @@ +--- +title: "Configure a DMC4000-Controlled Motor" +linkTitle: "DMC4000" +weight: 60 +type: "docs" +description: "Configure a stepper motor controlled by a DMC-40x0 series motion controller." +images: ["/icons/components/motor.svg"] +component_description: "Stepper motor driven by a DMC-40x0 series motion controller." +# SMEs: Rand, James +toc_hide: true +--- diff --git a/docs/reference/components/motor/encoded-motor.md b/docs/reference/components/motor/encoded-motor.md new file mode 100644 index 0000000000..b01d1eb962 --- /dev/null +++ b/docs/reference/components/motor/encoded-motor.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Motor with an Encoder" +linkTitle: "Encoded Motors" +weight: 90 +type: "docs" +description: "How to configure an encoded motor." +images: ["/icons/components/motor.svg"] +component_description: "Standard brushed or brushless DC motor with an encoder." +toc_hide: true +# SMEs: Rand, James +--- diff --git a/docs/reference/components/motor/fake.md b/docs/reference/components/motor/fake.md new file mode 100644 index 0000000000..82fed87bb5 --- /dev/null +++ b/docs/reference/components/motor/fake.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Fake Motor" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake motor to test software without any hardware." +images: ["/icons/components/motor.svg"] +component_description: "A model for testing, with no physical hardware." +toc_hide: true +# SMEs: Rand, James +--- diff --git a/docs/reference/components/motor/gpio-micro-rdk.md b/docs/reference/components/motor/gpio-micro-rdk.md new file mode 100644 index 0000000000..5402c4b622 --- /dev/null +++ b/docs/reference/components/motor/gpio-micro-rdk.md @@ -0,0 +1,11 @@ +--- +title: "Configure a GPIO Motor (Micro-RDK)" +linkTitle: "gpio (Micro-RDK)" +weight: 10 +type: "docs" +description: "Configure brushed or brushless DC motors with a microcontroller." +images: ["/icons/components/motor.svg"] +micrordk_component: true +toc_hide: true +# SMEs: Rand, James +--- diff --git a/docs/reference/components/motor/gpio.md b/docs/reference/components/motor/gpio.md new file mode 100644 index 0000000000..b25b503533 --- /dev/null +++ b/docs/reference/components/motor/gpio.md @@ -0,0 +1,13 @@ +--- +title: "Configure a GPIO-Controlled Motor" +linkTitle: "gpio" +weight: 10 +type: "docs" +description: "Configure brushed or brushless DC motors." +images: ["/icons/components/motor.svg"] +no_list: true +component_description: "Supports standard brushed or brushless DC motors." +usage: 999999 +toc_hide: true +# SMEs: Rand, James +--- diff --git a/docs/reference/components/motor/gpiostepper.md b/docs/reference/components/motor/gpiostepper.md new file mode 100644 index 0000000000..d270efa70c --- /dev/null +++ b/docs/reference/components/motor/gpiostepper.md @@ -0,0 +1,12 @@ +--- +title: "Configure a GPIO-Controlled Stepper Motor" +linkTitle: "gpiostepper" +weight: 20 +type: "docs" +description: "Configure a bipolar stepper motor with current regulation and 1/32 microstepping driven by a basic driver." +images: ["/icons/components/motor.svg"] +component_description: "Supports stepper motors driven by basic GPIO-controlled stepper driver chips." +usage: 900000 +toc_hide: true +# SMEs: Rand, James +--- diff --git a/docs/reference/components/movement-sensor/_index.md b/docs/reference/components/movement-sensor/_index.md new file mode 100644 index 0000000000..99c4f496c8 --- /dev/null +++ b/docs/reference/components/movement-sensor/_index.md @@ -0,0 +1,16 @@ +--- +title: "Movement Sensor Component" +linkTitle: "Movement Sensor" +childTitleEndOverwrite: "Movement Sensor" +weight: 70 +type: "docs" +description: "A sensor that measures location, kinematic data, or both." +tags: ["movement sensor", "gps", "imu", "sensor", "components"] +icon: true +images: ["/icons/components/imu.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2024-10-21" +# SME: Rand +--- diff --git a/docs/reference/components/movement-sensor/accel-adxl345-micro-rdk.md b/docs/reference/components/movement-sensor/accel-adxl345-micro-rdk.md new file mode 100644 index 0000000000..d1116f0d26 --- /dev/null +++ b/docs/reference/components/movement-sensor/accel-adxl345-micro-rdk.md @@ -0,0 +1,12 @@ +--- +title: "Configure an ADXL345 Accelerometer (Micro-RDK)" +linkTitle: "accel-adxl345 (Micro-RDK)" +titleMustBeLong: true +weight: 20 +type: "docs" +description: "Configure an ADXL345 digital accelerometer with a microcontroller." +images: ["/icons/components/imu.svg"] +micrordk_component: true +toc_hide: true +# SMEs: Rand, Kim Mishra +--- diff --git a/docs/reference/components/movement-sensor/fake.md b/docs/reference/components/movement-sensor/fake.md new file mode 100644 index 0000000000..ebb663155e --- /dev/null +++ b/docs/reference/components/movement-sensor/fake.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Fake Movement Sensor" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake movement sensor to test software without any hardware." +images: ["/icons/components/imu.svg"] +component_description: "A model for testing, with no physical hardware." +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/movement-sensor/gyro-mpu6050-micro-rdk.md b/docs/reference/components/movement-sensor/gyro-mpu6050-micro-rdk.md new file mode 100644 index 0000000000..ea52b4dd5c --- /dev/null +++ b/docs/reference/components/movement-sensor/gyro-mpu6050-micro-rdk.md @@ -0,0 +1,11 @@ +--- +title: "Configure an MPU-6050 (Micro-RDK)" +linkTitle: "gyro-mpu6050 (Micro-RDK)" +weight: 40 +type: "docs" +description: "Configure an MPU-6050 movement sensor with a microcontroller." +images: ["/icons/components/imu.svg"] +micrordk_component: true +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/movement-sensor/merged.md b/docs/reference/components/movement-sensor/merged.md new file mode 100644 index 0000000000..92598701c3 --- /dev/null +++ b/docs/reference/components/movement-sensor/merged.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Merged Movement Sensor" +linkTitle: "merged" +weight: 40 +type: "docs" +description: "Configure a merged movement sensor." +images: ["/icons/components/imu.svg"] +component_description: "A model that allows you to aggregate the API methods supported by multiple sensors into a singular sensor client, effectively merging the models of the individual resources." +toc_hide: true +# SMEs: Rand +--- diff --git a/docs/reference/components/movement-sensor/set-up-base-station.md b/docs/reference/components/movement-sensor/set-up-base-station.md new file mode 100644 index 0000000000..96d48646fa --- /dev/null +++ b/docs/reference/components/movement-sensor/set-up-base-station.md @@ -0,0 +1,13 @@ +--- +title: "Set up a SparkFun RTK Reference Station" +linkTitle: "SparkFun RTK Reference Station Setup" +weight: 20 +type: "docs" +description: "Follow this guide to set up your own SparkFun RTK base station, a high-precision GPS module designed for use with the RTK satellite navigation technique." +images: ["/icons/components/imu.svg"] +no_component: true +date: "2024-01-01" +toc_hide: true +# updated: "" # When the content was last entirely checked +# SMEs: Susmita +--- diff --git a/docs/reference/components/movement-sensor/wheeled-odometry.md b/docs/reference/components/movement-sensor/wheeled-odometry.md new file mode 100644 index 0000000000..ad76754193 --- /dev/null +++ b/docs/reference/components/movement-sensor/wheeled-odometry.md @@ -0,0 +1,20 @@ +--- +title: "Configure a Wheeled Odometry Movement Sensor" +linkTitle: "wheeled-odometry" +type: "docs" +description: "Configure a wheeled odometry movement sensor." +images: ["/icons/components/imu.svg"] +tags: + [ + "movement sensor", + "components", + "encoder", + "motor", + "base", + "wheeled", + "odometry", + ] +component_description: "A model that uses encoders to get an odometry estimate from a wheeled base." +toc_hide: true +# SMEs: Rand, Martha +--- diff --git a/docs/reference/components/power-sensor/_index.md b/docs/reference/components/power-sensor/_index.md new file mode 100644 index 0000000000..9c270a3c7a --- /dev/null +++ b/docs/reference/components/power-sensor/_index.md @@ -0,0 +1,16 @@ +--- +title: "Power Sensor Component" +linkTitle: "Power Sensor" +childTitleEndOverwrite: "Power Sensor" +weight: 70 +no_list: true +type: "docs" +description: "A device that provides information about a machine's power systems, including voltage, current, and power consumption." +tags: ["sensor", "components", "power sensor", "ina219", "ina226", "renogy"] +icon: true +images: ["/icons/components/power-sensor.svg"] +modulescript: true +date: "2024-10-21" +hide_children: true +# SME: #team-bucket +--- diff --git a/docs/reference/components/power-sensor/fake.md b/docs/reference/components/power-sensor/fake.md new file mode 100644 index 0000000000..fe2ec43b9f --- /dev/null +++ b/docs/reference/components/power-sensor/fake.md @@ -0,0 +1,13 @@ +--- +title: "Configure a Fake Power Sensor" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake power sensor to test software without the physical hardware." +tags: ["sensor", "power sensor"] +icon: true +images: ["/icons/components/sensor.svg"] +component_description: "A model for testing, with no physical hardware." +toc_hide: true +# SME: #team-bucket +--- diff --git a/docs/reference/components/sensor/_index.md b/docs/reference/components/sensor/_index.md new file mode 100644 index 0000000000..77365c9f0d --- /dev/null +++ b/docs/reference/components/sensor/_index.md @@ -0,0 +1,16 @@ +--- +title: "Sensor Component" +linkTitle: "Sensor" +childTitleEndOverwrite: "Sensor Component" +weight: 70 +no_list: true +type: "docs" +description: "A device that sends information about the outside world to the computer controlling a machine." +tags: ["sensor", "components"] +icon: true +images: ["/icons/components/sensor.svg"] +modulescript: true +date: "2024-10-21" +hide_children: true +# SME: #team-bucket +--- diff --git a/docs/reference/components/sensor/fake.md b/docs/reference/components/sensor/fake.md new file mode 100644 index 0000000000..30da57ff0a --- /dev/null +++ b/docs/reference/components/sensor/fake.md @@ -0,0 +1,13 @@ +--- +title: "Create a Fake Sensor" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake sensor to use for testing." +tags: ["sensor", "components"] +icon: true +images: ["/icons/components/sensor.svg"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SME: #team-bucket +--- diff --git a/docs/reference/components/sensor/ultrasonic-micro-rdk.md b/docs/reference/components/sensor/ultrasonic-micro-rdk.md new file mode 100644 index 0000000000..f75e34c3c8 --- /dev/null +++ b/docs/reference/components/sensor/ultrasonic-micro-rdk.md @@ -0,0 +1,13 @@ +--- +title: "Configure an Ultrasonic Sensor (Micro-RDK)" +linkTitle: "ultrasonic (Micro-RDK)" +weight: 60 +type: "docs" +description: "Configure an ultrasonic sensor with a microcontroller." +tags: ["sensor", "components", "ultrasonic"] +icon: true +images: ["/icons/components/sensor.svg"] +micrordk_component: true +toc_hide: true +# SME: Andrew Morrow +--- diff --git a/docs/reference/components/servo/_index.md b/docs/reference/components/servo/_index.md new file mode 100644 index 0000000000..db1f742141 --- /dev/null +++ b/docs/reference/components/servo/_index.md @@ -0,0 +1,16 @@ +--- +title: "Servo Component" +linkTitle: "Servo" +childTitleEndOverwrite: "Servo Component" +weight: 80 +type: "docs" +description: "A hobby servo is a special type of small motor whose position you can precisely control." +tags: ["servo", "components"] +icon: true +images: ["/icons/components/servo.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2024-10-21" +# SME: #team-bucket +--- diff --git a/docs/reference/components/servo/fake.md b/docs/reference/components/servo/fake.md new file mode 100644 index 0000000000..ae3e67403f --- /dev/null +++ b/docs/reference/components/servo/fake.md @@ -0,0 +1,13 @@ +--- +title: "Configure a Fake Servo" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake servo." +tags: ["servo", "components"] +icon: true +images: ["/icons/components/servo.svg"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +# SME: Rand +--- diff --git a/docs/reference/components/servo/gpio-micro-rdk.md b/docs/reference/components/servo/gpio-micro-rdk.md new file mode 100644 index 0000000000..605a2b7779 --- /dev/null +++ b/docs/reference/components/servo/gpio-micro-rdk.md @@ -0,0 +1,13 @@ +--- +title: "Configure a GPIO Servo (Micro-RDK)" +linkTitle: "gpio (Micro-RDK)" +weight: 90 +type: "docs" +description: "Configure a gpio hobby servo with a microcontroller." +tags: ["servo", "components"] +icon: true +images: ["/icons/components/servo.svg"] +micrordk_component: true +toc_hide: true +# SME: Gautham +--- diff --git a/docs/reference/components/servo/gpio.md b/docs/reference/components/servo/gpio.md new file mode 100644 index 0000000000..077e0f2976 --- /dev/null +++ b/docs/reference/components/servo/gpio.md @@ -0,0 +1,13 @@ +--- +title: "Configure a GPIO-Controlled Servo" +linkTitle: "gpio" +weight: 90 +type: "docs" +description: "Configure a gpio servo." +tags: ["servo", "components"] +icon: true +images: ["/icons/components/servo.svg"] +component_description: "Supports a hobby servo wired to a board that supports PWM, for example Raspberry Pi 5, Orange Pi, Jetson, or PCAXXXX." +toc_hide: true +# SME: Rand +--- diff --git a/docs/reference/components/switch/_index.md b/docs/reference/components/switch/_index.md new file mode 100644 index 0000000000..8482ba7d26 --- /dev/null +++ b/docs/reference/components/switch/_index.md @@ -0,0 +1,16 @@ +--- +title: "Switch Component" +linkTitle: "Switch" +childTitleEndOverwrite: "Switch Component" +weight: 100 +type: "docs" +description: "A physical multi-position switch on a machine." +tags: ["switch", "components"] +icon: true # this should be used when the image is an icon, it will adjust the sizing and object-fit +images: ["/icons/components/switch.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2025-02-20" +# SMEs: +--- diff --git a/docs/reference/components/switch/fake.md b/docs/reference/components/switch/fake.md new file mode 100644 index 0000000000..059abebf40 --- /dev/null +++ b/docs/reference/components/switch/fake.md @@ -0,0 +1,11 @@ +--- +title: "Configure a Fake Switch" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake switch for testing." +images: ["/icons/components/switch.svg"] +tags: ["switch", "components"] +component_description: "A model used for testing, with no physical hardware." +toc_hide: true +--- diff --git a/docs/reference/configuration/_index.md b/docs/reference/configuration/_index.md new file mode 100644 index 0000000000..d34adc4ee6 --- /dev/null +++ b/docs/reference/configuration/_index.md @@ -0,0 +1,8 @@ +--- +title: "Configuration" +linkTitle: "Configuration" +weight: 60 +type: "docs" +no_list: true +description: "Detailed configuration reference for triggers, ML models, controls, and kinematics." +--- diff --git a/docs/reference/configuration/controls-package.md b/docs/reference/configuration/controls-package.md new file mode 100644 index 0000000000..1cbc320b86 --- /dev/null +++ b/docs/reference/configuration/controls-package.md @@ -0,0 +1,11 @@ +--- +title: "Control package" +linkTitle: "Control package" +weight: 60 +type: "docs" +description: "The Control Package implements feedback control on an endpoint." +# SME: Nicolas Menard, Rand, Martha +date: "2022-01-01" +no_list: true +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/configuration/kinematic-chain-config.md b/docs/reference/configuration/kinematic-chain-config.md new file mode 100644 index 0000000000..27663647be --- /dev/null +++ b/docs/reference/configuration/kinematic-chain-config.md @@ -0,0 +1,12 @@ +--- +title: "Configure complex kinematic chains" +linkTitle: "Complex kinematic chains" +weight: 200 +type: "docs" +description: "Define kinematic parameters to configure intermediate reference frames for components with complex kinematic chains." +tags: ["slam", "services"] +date: "2022-01-01" +updated: "2024-10-21" +no_list: true +# SMEs: Motion +--- diff --git a/docs/reference/configuration/mlmodel-design.md b/docs/reference/configuration/mlmodel-design.md new file mode 100644 index 0000000000..d783d663ff --- /dev/null +++ b/docs/reference/configuration/mlmodel-design.md @@ -0,0 +1,13 @@ +--- +title: "Design your ML models for vision" +linkTitle: "ML model service design" +weight: 60 +type: "docs" +tags: ["data management", "ml", "model training", "vision"] +description: "Design your ML Model service to work with Viam's vision services." +icon: true +images: ["/services/icons/ml.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SME: Bijan Haney +--- diff --git a/docs/reference/configuration/slam-background.md b/docs/reference/configuration/slam-background.md new file mode 100644 index 0000000000..40c85a66fd --- /dev/null +++ b/docs/reference/configuration/slam-background.md @@ -0,0 +1,12 @@ +--- +title: "SLAM service background" +linkTitle: "SLAM technical" +weight: 70 +type: "docs" +draft: true +description: "Background and technical information for the Simultaneous Localization And Mapping (SLAM) service, its configuration, its functionality, and its interfaces." +tags: ["slam", "services"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: Jeremy, Kat +--- diff --git a/docs/reference/configuration/triggers.md b/docs/reference/configuration/triggers.md new file mode 100644 index 0000000000..5ef796cede --- /dev/null +++ b/docs/reference/configuration/triggers.md @@ -0,0 +1,10 @@ +--- +title: "Trigger configuration" +linkTitle: "Trigger configuration" +weight: 60 +type: "docs" +tags: ["data management", "trigger", "webhook"] +description: "Detailed information about how to configure triggers and webhooks." +date: "2025-05-05" +updated: "2025-09-18" +--- diff --git a/docs/reference/device-setup/_index.md b/docs/reference/device-setup/_index.md new file mode 100644 index 0000000000..6f99a971e1 --- /dev/null +++ b/docs/reference/device-setup/_index.md @@ -0,0 +1,8 @@ +--- +title: "Device Setup" +linkTitle: "Device Setup" +weight: 55 +type: "docs" +no_list: true +description: "Setup guides for single-board computers and other devices supported by Viam." +--- diff --git a/docs/reference/device-setup/beaglebone-setup.md b/docs/reference/device-setup/beaglebone-setup.md new file mode 100644 index 0000000000..b4054b258d --- /dev/null +++ b/docs/reference/device-setup/beaglebone-setup.md @@ -0,0 +1,13 @@ +--- +title: "BeagleBone AI-64 Setup Guide" +linkTitle: "BeagleBone Setup" +weight: 20 +type: "docs" +description: "Flash a BeagleBone AI-64 to prepare it for viam-server installation." +images: ["/installation/thumbnails/beaglebone.png"] +imageAlt: "BeagleBone A I-64" +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: Shawn and Rand +--- diff --git a/docs/reference/device-setup/board1-setup.md b/docs/reference/device-setup/board1-setup.md new file mode 100644 index 0000000000..3348da4761 --- /dev/null +++ b/docs/reference/device-setup/board1-setup.md @@ -0,0 +1,13 @@ +--- +title: " Setup Guide" +linkTitle: " Setup" +weight: 16 +type: "docs" +description: "Flash an for the to prepare it for viam-server installation." +images: ["/installation/thumbnails/prepare.png"] +imageAlt: "" +no_list: true +draft: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/device-setup/jetson-agx-orin-setup.md b/docs/reference/device-setup/jetson-agx-orin-setup.md new file mode 100644 index 0000000000..6f593d1074 --- /dev/null +++ b/docs/reference/device-setup/jetson-agx-orin-setup.md @@ -0,0 +1,13 @@ +--- +title: "NVIDIA Jetson AGX Orin Setup Guide" +linkTitle: "Jetson AGX Orin Setup" +weight: 20 +type: "docs" +images: ["/installation/thumbnails/jetson-agx-orin-dev-kit.png"] +imageAlt: "Jetson A G X Orin Developer Kit" +description: "Set up the Jetson AGX Orin Developer Kit to prepare your NVIDIA Jetson AGX Orin for viam-server installation." +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: Pete Garafano +--- diff --git a/docs/reference/device-setup/jetson-nano-setup.md b/docs/reference/device-setup/jetson-nano-setup.md new file mode 100644 index 0000000000..acb3f9c99a --- /dev/null +++ b/docs/reference/device-setup/jetson-nano-setup.md @@ -0,0 +1,13 @@ +--- +title: "NVIDIA Jetson Nano and Orin Nano Setup Guide" +linkTitle: "Jetson Nano and Orin Nano Setup" +weight: 20 +type: "docs" +images: ["/installation/thumbnails/jetson-nano-dev-kit.png"] +imageAlt: "Jetson Nano" +description: "Prepare your Jetson Nano or Jetson Orin Nano for viam-server installation." +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: Pete Garafano +--- diff --git a/docs/reference/device-setup/odroid-c4-setup.md b/docs/reference/device-setup/odroid-c4-setup.md new file mode 100644 index 0000000000..9e97badbeb --- /dev/null +++ b/docs/reference/device-setup/odroid-c4-setup.md @@ -0,0 +1,13 @@ +--- +title: "Odroid C4 Setup Guide" +linkTitle: "Odroid-C4 Setup" +weight: 16 +type: "docs" +description: "Image a Odroid-C4 to prepare it for viam-server installation." +images: ["/installation/thumbnails/odroid-c4.png"] +imageAlt: "Odroid-C4" +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SME: Olivia Miller +--- diff --git a/docs/reference/device-setup/orange-pi-3-lts.md b/docs/reference/device-setup/orange-pi-3-lts.md new file mode 100644 index 0000000000..8921efe432 --- /dev/null +++ b/docs/reference/device-setup/orange-pi-3-lts.md @@ -0,0 +1,13 @@ +--- +title: "Orange Pi 3 LTS Setup Guide" +linkTitle: "Orange Pi 3 LTS Setup" +weight: 16 +type: "docs" +description: "Image an Orange Pi 3 LTS to prepare it for viam-server installation." +images: ["/installation/thumbnails/orange-pi-3-LTS.png"] +imageAlt: "Orange Pi 3 LTS" +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SME: Olivia Miller +--- diff --git a/docs/reference/device-setup/orange-pi-zero2.md b/docs/reference/device-setup/orange-pi-zero2.md new file mode 100644 index 0000000000..c3ead4bdf5 --- /dev/null +++ b/docs/reference/device-setup/orange-pi-zero2.md @@ -0,0 +1,13 @@ +--- +title: "Orange Pi Zero2 Setup Guide" +linkTitle: "Orange Pi Zero2 Setup" +weight: 16 +type: "docs" +description: "Image an Orange Pi Zero2 to prepare it for viam-server installation." +images: ["/installation/thumbnails/orange-pi-zero2.png"] +imageAlt: "Orange Pi Zero2" +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SME: Olivia Miller +--- diff --git a/docs/reference/device-setup/pumpkin.md b/docs/reference/device-setup/pumpkin.md new file mode 100644 index 0000000000..a070270429 --- /dev/null +++ b/docs/reference/device-setup/pumpkin.md @@ -0,0 +1,12 @@ +--- +title: "Pumpkin Board Setup Guide" +linkTitle: "Pumpkin Board Setup" +weight: 25 +type: "docs" +images: ["/installation/thumbnails/pumpkin.png"] +imageAlt: "Pumpkin board" +description: "Configure the pin mappings to use a pumpkin board." +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/device-setup/rpi-setup.md b/docs/reference/device-setup/rpi-setup.md new file mode 100644 index 0000000000..67fc8b97b3 --- /dev/null +++ b/docs/reference/device-setup/rpi-setup.md @@ -0,0 +1,13 @@ +--- +title: "Raspberry Pi Setup Guide" +linkTitle: "Raspberry Pi Setup" +weight: 15 +type: "docs" +description: "Image a Raspberry Pi to prepare it for viam-server installation." +images: ["/installation/thumbnails/raspberry-pi-4-b-2gb.png"] +imageAlt: "Raspberry Pi" +no_list: true +# SME: James +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/device-setup/sk-tda4vm.md b/docs/reference/device-setup/sk-tda4vm.md new file mode 100644 index 0000000000..f88f35a194 --- /dev/null +++ b/docs/reference/device-setup/sk-tda4vm.md @@ -0,0 +1,12 @@ +--- +title: "SK-TDA4VM Setup Guide" +linkTitle: "SK-TDA4VM Setup" +weight: 25 +type: "docs" +images: ["/installation/thumbnails/tda4vm.png"] +imageAlt: "S K - T D A 4 V M" +description: "Image a Texas Instruments TDA4VM starter kit board to prepare it for viam-server installation." +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/glossary/api-namespace-triplet.md b/docs/reference/glossary/api-namespace-triplet.md new file mode 100644 index 0000000000..6905c55e2e --- /dev/null +++ b/docs/reference/glossary/api-namespace-triplet.md @@ -0,0 +1,6 @@ +--- +title: API Namespace Triplet +id: api-namespace-triplet +full_link: +short_description: namespace:type:subtype, for example `rdk:component:sensor` +--- diff --git a/docs/reference/glossary/api.md b/docs/reference/glossary/api.md new file mode 100644 index 0000000000..e2e3b37ee4 --- /dev/null +++ b/docs/reference/glossary/api.md @@ -0,0 +1,8 @@ +--- +title: API +id: api +full_link: +short_description: Application programming interface, a set of defined rules that enable different applications to communicate with each other. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/attribute.md b/docs/reference/glossary/attribute.md new file mode 100644 index 0000000000..628036f59b --- /dev/null +++ b/docs/reference/glossary/attribute.md @@ -0,0 +1,8 @@ +--- +title: Attribute +id: attribute +full_link: +short_description: A configuration parameter of a resource. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/base.md b/docs/reference/glossary/base.md new file mode 100644 index 0000000000..ff3e212786 --- /dev/null +++ b/docs/reference/glossary/base.md @@ -0,0 +1,6 @@ +--- +title: Base +id: base +full_link: /components/base/ +short_description: A physical, mobile platform that the other parts of a mobile robot attach to. +--- diff --git a/docs/reference/glossary/blob-storage.md b/docs/reference/glossary/blob-storage.md new file mode 100644 index 0000000000..ea557f2a7b --- /dev/null +++ b/docs/reference/glossary/blob-storage.md @@ -0,0 +1,8 @@ +--- +title: Blob storage +id: blob-storage +full_link: +short_description: A cheap but slow storage medium. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/board.md b/docs/reference/glossary/board.md new file mode 100644 index 0000000000..ea877e6593 --- /dev/null +++ b/docs/reference/glossary/board.md @@ -0,0 +1,6 @@ +--- +title: Board +id: board +full_link: /components/board/ +short_description: A board is the signal wire hub of a machine that provides access to GPIO pins. +--- diff --git a/docs/reference/glossary/captive-web-portal.md b/docs/reference/glossary/captive-web-portal.md new file mode 100644 index 0000000000..38b24d4c3c --- /dev/null +++ b/docs/reference/glossary/captive-web-portal.md @@ -0,0 +1,5 @@ +--- +title: Captive web portal +id: captive-web-portal +short_description: A web page which is automatically displayed to users when connecting to a network. +--- diff --git a/docs/reference/glossary/client-application.md b/docs/reference/glossary/client-application.md new file mode 100644 index 0000000000..f3062213b7 --- /dev/null +++ b/docs/reference/glossary/client-application.md @@ -0,0 +1,6 @@ +--- +title: Client Application +id: client-application +full_link: +short_description: Client applications run business logic to operate your machine. +--- diff --git a/docs/reference/glossary/component.md b/docs/reference/glossary/component.md new file mode 100644 index 0000000000..4fbc8d514f --- /dev/null +++ b/docs/reference/glossary/component.md @@ -0,0 +1,5 @@ +--- +title: Component +id: component +short_description: A resource that often represents a physical piece of hardware which a computer controls; for example, a servo, a camera, or an arm. +--- diff --git a/docs/reference/glossary/flashed.md b/docs/reference/glossary/flashed.md new file mode 100644 index 0000000000..9d0ae31063 --- /dev/null +++ b/docs/reference/glossary/flashed.md @@ -0,0 +1,10 @@ +--- +title: Flash +id: flash +full_link: +short_description: The process of writing an operating system or firmware to a device's storage medium. +aka: + - flashed + - flashing +type: "page" +--- diff --git a/docs/reference/glossary/fragment.md b/docs/reference/glossary/fragment.md new file mode 100644 index 0000000000..9a2cf45f6c --- /dev/null +++ b/docs/reference/glossary/fragment.md @@ -0,0 +1,6 @@ +--- +title: Fragment +id: fragment +full_link: /fleet/reuse-configuration/ +short_description: A reusable configuration block that you can share across multiple machines. +--- diff --git a/docs/reference/glossary/frame-system.md b/docs/reference/glossary/frame-system.md new file mode 100644 index 0000000000..895b7b39f0 --- /dev/null +++ b/docs/reference/glossary/frame-system.md @@ -0,0 +1,6 @@ +--- +title: Frame System +id: frame-system +full_link: /motion-planning/frame-system/ +short_description: The frame system holds reference frame information for the relative position of components in space. +--- diff --git a/docs/reference/glossary/frame.md b/docs/reference/glossary/frame.md new file mode 100644 index 0000000000..d848ec0426 --- /dev/null +++ b/docs/reference/glossary/frame.md @@ -0,0 +1,6 @@ +--- +title: Frame +id: frame +full_link: +short_description: A frame represents a coordinate system that describes the position and orientation of an object. +--- diff --git a/docs/reference/glossary/gantry.md b/docs/reference/glossary/gantry.md new file mode 100644 index 0000000000..af0f21a5f7 --- /dev/null +++ b/docs/reference/glossary/gantry.md @@ -0,0 +1,6 @@ +--- +title: Gantry +id: attribute +full_link: /components/gantry/ +short_description: A mechanical system that only uses linear motion to carry out a task. +--- diff --git a/docs/reference/glossary/grpc.md b/docs/reference/glossary/grpc.md new file mode 100644 index 0000000000..7599e5a827 --- /dev/null +++ b/docs/reference/glossary/grpc.md @@ -0,0 +1,6 @@ +--- +title: gRPC +id: grpc +full_link: +short_description: An open source, cross-platform, high performance Remote Procedure Call (RPC) framework initially developed at Google in 2015. +--- diff --git a/docs/reference/glossary/index.md b/docs/reference/glossary/index.md new file mode 100644 index 0000000000..51eafd8fbc --- /dev/null +++ b/docs/reference/glossary/index.md @@ -0,0 +1,12 @@ +--- +title: "Glossary" +linkTitle: "Glossary" +weight: 999 +type: "docs" +layout: "glossary" +description: "A glossary that explains robotics and Viam-specific jargon." +card: + name: reference + weight: 10 + title: Glossary +--- diff --git a/docs/reference/glossary/job.md b/docs/reference/glossary/job.md new file mode 100644 index 0000000000..b83730b6a9 --- /dev/null +++ b/docs/reference/glossary/job.md @@ -0,0 +1,6 @@ +--- +title: Jobs +id: job +full_link: /fleet/scheduled-jobs/ +short_description: Automated tasks that run on machines at specified intervals to perform routine operations. +--- diff --git a/docs/reference/glossary/location.md b/docs/reference/glossary/location.md new file mode 100644 index 0000000000..b86dd3bb2e --- /dev/null +++ b/docs/reference/glossary/location.md @@ -0,0 +1,6 @@ +--- +title: Location +id: location +full_link: /reference/account/organize/ +short_description: A location is a virtual grouping of machines that allows you to organize machines and manage access to your fleet. +--- diff --git a/docs/reference/glossary/machine-config.md b/docs/reference/glossary/machine-config.md new file mode 100644 index 0000000000..9ddb032710 --- /dev/null +++ b/docs/reference/glossary/machine-config.md @@ -0,0 +1,6 @@ +--- +title: Machine Config +id: machine-config +full_link: /configure/ +short_description: The complete configuration of a single machine part. +--- diff --git a/docs/reference/glossary/machine-fqdn.md b/docs/reference/glossary/machine-fqdn.md new file mode 100644 index 0000000000..0d50be32df --- /dev/null +++ b/docs/reference/glossary/machine-fqdn.md @@ -0,0 +1,8 @@ +--- +title: Machine FQDN +id: machine-fqdn +full_link: +short_description: The fully qualified domain name (FQDN) of a machine in the Viam platform. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/machine-id.md b/docs/reference/glossary/machine-id.md new file mode 100644 index 0000000000..1c7491a8b9 --- /dev/null +++ b/docs/reference/glossary/machine-id.md @@ -0,0 +1,8 @@ +--- +title: Machine ID +id: machine-id +full_link: +short_description: A unique identifier assigned to each machine in the Viam platform. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/machine.md b/docs/reference/glossary/machine.md new file mode 100644 index 0000000000..60cccfe150 --- /dev/null +++ b/docs/reference/glossary/machine.md @@ -0,0 +1,6 @@ +--- +title: Machine +id: machine +full_link: /fleet/machines/ +short_description: An organizational concept, consisting of a computer and the components and services it controls, or sometimes multiple computers working closely together. +--- diff --git a/docs/reference/glossary/ml.md b/docs/reference/glossary/ml.md new file mode 100644 index 0000000000..9bdaf475b4 --- /dev/null +++ b/docs/reference/glossary/ml.md @@ -0,0 +1,8 @@ +--- +title: ML +id: ml +full_link: +short_description: Machine learning, a field of artificial intelligence focused on building systems that learn from data. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/model-namespace-triplet.md b/docs/reference/glossary/model-namespace-triplet.md new file mode 100644 index 0000000000..8a6aa545fd --- /dev/null +++ b/docs/reference/glossary/model-namespace-triplet.md @@ -0,0 +1,5 @@ +--- +title: Model Namespace Triplet +id: model-namespace-triplet +short_description: namespace:module-name:name or rdk:builtin:name +--- diff --git a/docs/reference/glossary/model.md b/docs/reference/glossary/model.md new file mode 100644 index 0000000000..951ff8b8eb --- /dev/null +++ b/docs/reference/glossary/model.md @@ -0,0 +1,6 @@ +--- +title: Model +id: model +full_link: +short_description: A particular implementation of a resource. For example, UR5e is a model of the arm component API. +--- diff --git a/docs/reference/glossary/modular-resource.md b/docs/reference/glossary/modular-resource.md new file mode 100644 index 0000000000..6b17c829f1 --- /dev/null +++ b/docs/reference/glossary/modular-resource.md @@ -0,0 +1,5 @@ +--- +title: Modular Resource +id: modular-resource +short_description: A modular resource is a model of a component or service provided by a module. +--- diff --git a/docs/reference/glossary/module.md b/docs/reference/glossary/module.md new file mode 100644 index 0000000000..5ea6dc8494 --- /dev/null +++ b/docs/reference/glossary/module.md @@ -0,0 +1,6 @@ +--- +title: Module +id: module +full_link: +short_description: Modules are the code packages that provide functionality like drivers, integrations, and control logic to your machines. +--- diff --git a/docs/reference/glossary/mql.md b/docs/reference/glossary/mql.md new file mode 100644 index 0000000000..7c39e34e94 --- /dev/null +++ b/docs/reference/glossary/mql.md @@ -0,0 +1,6 @@ +--- +title: MQL +id: mql +full_link: +short_description: MQL is the MongoDB query language, similar to SQL but specific to the MongoDB document model. +--- diff --git a/docs/reference/glossary/organization.md b/docs/reference/glossary/organization.md new file mode 100644 index 0000000000..b2d1f674da --- /dev/null +++ b/docs/reference/glossary/organization.md @@ -0,0 +1,6 @@ +--- +title: Organization +id: organization +full_link: /reference/account/organize/ +short_description: An organization is a group of one or more locations that helps you organize your fleet and manage who has access to your fleet. +--- diff --git a/docs/reference/glossary/origin-frame.md b/docs/reference/glossary/origin-frame.md new file mode 100644 index 0000000000..bd29cf5cc8 --- /dev/null +++ b/docs/reference/glossary/origin-frame.md @@ -0,0 +1,6 @@ +--- +title: Origin frame +id: origin-frame +full_link: +short_description: The origin frame is the frame at the base of an arm or other component that has a complex kinematics chain. +--- diff --git a/docs/reference/glossary/package.md b/docs/reference/glossary/package.md new file mode 100644 index 0000000000..cc78d4a131 --- /dev/null +++ b/docs/reference/glossary/package.md @@ -0,0 +1,6 @@ +--- +title: Package +id: package +full_link: +short_description: An archive, module, ML model, SLAM Map, or other bundle of binary code. +--- diff --git a/docs/reference/glossary/part.md b/docs/reference/glossary/part.md new file mode 100644 index 0000000000..3be1b32931 --- /dev/null +++ b/docs/reference/glossary/part.md @@ -0,0 +1,6 @@ +--- +title: Part +id: part +full_link: /reference/architecture/parts/ +short_description: A single-board computer, desktop, laptop, or other computer running viam-server, the hardware components attached to it, and any services or other resources running on it. +--- diff --git a/docs/reference/glossary/pi.md b/docs/reference/glossary/pi.md new file mode 100644 index 0000000000..37ed77b2d0 --- /dev/null +++ b/docs/reference/glossary/pi.md @@ -0,0 +1,8 @@ +--- +title: Pi +id: pi +full_link: +short_description: Short for Raspberry Pi, a series of small single-board computers developed by the Raspberry Pi Foundation. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/pin-number.md b/docs/reference/glossary/pin-number.md new file mode 100644 index 0000000000..95de28c2b0 --- /dev/null +++ b/docs/reference/glossary/pin-number.md @@ -0,0 +1,6 @@ +--- +title: Pin Number +id: pin-number +full_link: +short_description: A pin number is the index of the pin on the board. Not the same as a pin's GPIO number. +--- diff --git a/docs/reference/glossary/protobuf.md b/docs/reference/glossary/protobuf.md new file mode 100644 index 0000000000..66c946c447 --- /dev/null +++ b/docs/reference/glossary/protobuf.md @@ -0,0 +1,6 @@ +--- +title: Protocol Buffers (Protobuf) +id: protobuf +full_link: +short_description: A free and open-source, language-neutral, cross-platform data format for serializing structured data. +--- diff --git a/docs/reference/glossary/rdk.md b/docs/reference/glossary/rdk.md new file mode 100644 index 0000000000..c8bc04b6bc --- /dev/null +++ b/docs/reference/glossary/rdk.md @@ -0,0 +1,6 @@ +--- +title: RDK (Robot Development Kit) +id: rdk +full_link: /reference/platform/viam-server/ +short_description: The official Viam-developed codebase that provides all functionality of an SDK and more. +--- diff --git a/docs/reference/glossary/remote-part.md b/docs/reference/glossary/remote-part.md new file mode 100644 index 0000000000..0a270c292a --- /dev/null +++ b/docs/reference/glossary/remote-part.md @@ -0,0 +1,7 @@ +--- +title: Remote part +id: remote-part +full_link: /architecture/parts/ +short_description: A machine part which is controlled by another machine part. +aka: +--- diff --git a/docs/reference/glossary/resource.md b/docs/reference/glossary/resource.md new file mode 100644 index 0000000000..bd0b859655 --- /dev/null +++ b/docs/reference/glossary/resource.md @@ -0,0 +1,6 @@ +--- +title: Resource +id: resource +full_link: +short_description: Resources are individual, addressable elements of a machine such as components or services. +--- diff --git a/docs/reference/glossary/sdk.md b/docs/reference/glossary/sdk.md new file mode 100644 index 0000000000..a8cbd8f9ad --- /dev/null +++ b/docs/reference/glossary/sdk.md @@ -0,0 +1,6 @@ +--- +title: SDK (Software Development Kit) +id: sdk +full_link: /reference/apis/ +short_description: Viam provides software development kits (SDKs) to help you write client applications and create support for custom component types. +--- diff --git a/docs/reference/glossary/service.md b/docs/reference/glossary/service.md new file mode 100644 index 0000000000..7234d55742 --- /dev/null +++ b/docs/reference/glossary/service.md @@ -0,0 +1,5 @@ +--- +title: Service +id: service +short_description: Built-in software packages for complex capabilities such as SLAM, Computer Vision, Motion Planning, and Data Collection. +--- diff --git a/docs/reference/glossary/setup.md b/docs/reference/glossary/setup.md new file mode 100644 index 0000000000..a06d1881e9 --- /dev/null +++ b/docs/reference/glossary/setup.md @@ -0,0 +1,6 @@ +--- +title: View setup instructions +id: setup +full_link: +short_description: To view setup instructions for a machine part, navigate to the CONFIGURE tab, find the part's card, click the "..." menu in the upper right corner of the card, and select "View setup instructions". +--- diff --git a/docs/reference/glossary/slam.md b/docs/reference/glossary/slam.md new file mode 100644 index 0000000000..9b219afb5c --- /dev/null +++ b/docs/reference/glossary/slam.md @@ -0,0 +1,6 @@ +--- +title: SLAM +id: slam +full_link: /reference/services/slam/ +short_description: Simultaneous Localization And Mapping (SLAM) algorithms use data from a machine's sensors to generate a map of the environment and determine the machine's position within it. +--- diff --git a/docs/reference/glossary/smart-machine.md b/docs/reference/glossary/smart-machine.md new file mode 100644 index 0000000000..c3a442b772 --- /dev/null +++ b/docs/reference/glossary/smart-machine.md @@ -0,0 +1,6 @@ +--- +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. +--- diff --git a/docs/reference/glossary/sql.md b/docs/reference/glossary/sql.md new file mode 100644 index 0000000000..a5aeb07e76 --- /dev/null +++ b/docs/reference/glossary/sql.md @@ -0,0 +1,6 @@ +--- +title: SQL +id: sql +full_link: +short_description: SQL (structured query language) is the widely-used, industry-standard query language popular with relational databases. +--- diff --git a/docs/reference/glossary/subtype.md b/docs/reference/glossary/subtype.md new file mode 100644 index 0000000000..6888600813 --- /dev/null +++ b/docs/reference/glossary/subtype.md @@ -0,0 +1,6 @@ +--- +title: Subtype +id: subtype +full_link: +short_description: A group of component or service models that share the same API. For example, arm is a subtype of component. +--- diff --git a/docs/reference/glossary/trigger.md b/docs/reference/glossary/trigger.md new file mode 100644 index 0000000000..a754e10e3f --- /dev/null +++ b/docs/reference/glossary/trigger.md @@ -0,0 +1,6 @@ +--- +title: Trigger +id: trigger +full_link: /reference/configuration/triggers/ +short_description: A mechanism that sends alerts by email or webhook when specific events occur in your machine or data. +--- diff --git a/docs/reference/glossary/type.md b/docs/reference/glossary/type.md new file mode 100644 index 0000000000..fae6954123 --- /dev/null +++ b/docs/reference/glossary/type.md @@ -0,0 +1,6 @@ +--- +title: Type +id: type +full_link: +short_description: Component and service are the built-in types of resource API the RDK provides. +--- diff --git a/docs/reference/glossary/viam-agent.md b/docs/reference/glossary/viam-agent.md new file mode 100644 index 0000000000..9ade548edd --- /dev/null +++ b/docs/reference/glossary/viam-agent.md @@ -0,0 +1,6 @@ +--- +title: Viam Agent +id: viam-agent +full_link: +short_description: The Viam provisioning application for deploying viam-server. +--- diff --git a/docs/reference/glossary/viam-micro-server.md b/docs/reference/glossary/viam-micro-server.md new file mode 100644 index 0000000000..5776a9cae7 --- /dev/null +++ b/docs/reference/glossary/viam-micro-server.md @@ -0,0 +1,6 @@ +--- +title: viam-micro-server +id: viam-micro-server +full_link: /reference/platform/viam-micro-server/ +short_description: The lightweight version of viam-server that can run on ESP32 devices. +--- diff --git a/docs/reference/glossary/viam-robot-api.md b/docs/reference/glossary/viam-robot-api.md new file mode 100644 index 0000000000..c7072a564b --- /dev/null +++ b/docs/reference/glossary/viam-robot-api.md @@ -0,0 +1,6 @@ +--- +title: Viam Robot API +id: viam-robot-api +full_link: +short_description: The specification for communication with resources. +--- diff --git a/docs/reference/glossary/viam-server.md b/docs/reference/glossary/viam-server.md new file mode 100644 index 0000000000..967b7591d7 --- /dev/null +++ b/docs/reference/glossary/viam-server.md @@ -0,0 +1,6 @@ +--- +title: viam-server +id: viam-server +full_link: /reference/platform/viam-server/ +short_description: The executable binary which runs on and provides functionality to machines. +--- diff --git a/docs/reference/glossary/vision-service.md b/docs/reference/glossary/vision-service.md new file mode 100644 index 0000000000..44c9eeed37 --- /dev/null +++ b/docs/reference/glossary/vision-service.md @@ -0,0 +1,8 @@ +--- +title: Vision service +id: vision-service +full_link: /reference/services/vision/ +short_description: A service that enables machines to interpret visual data from cameras using computer vision and machine learning. +aka: +type: "page" +--- diff --git a/docs/reference/glossary/web-sockets.md b/docs/reference/glossary/web-sockets.md new file mode 100644 index 0000000000..d43f9cd613 --- /dev/null +++ b/docs/reference/glossary/web-sockets.md @@ -0,0 +1,6 @@ +--- +title: Websockets +id: web-sockets +full_link: +short_description: A computer communications protocol that provides full-duplex communication channels over a single Transmission Control Protocol (TCP) connection. +--- diff --git a/docs/reference/glossary/webrtc.md b/docs/reference/glossary/webrtc.md new file mode 100644 index 0000000000..94ce30a7bf --- /dev/null +++ b/docs/reference/glossary/webrtc.md @@ -0,0 +1,6 @@ +--- +title: WebRTC +id: webrtc +full_link: +short_description: An open source project which provides applications with real-time communication (RTC) using application programming interfaces (API) allowing powerful voice and video integration. +--- diff --git a/docs/reference/glossary/world-frame.md b/docs/reference/glossary/world-frame.md new file mode 100644 index 0000000000..7d9065772b --- /dev/null +++ b/docs/reference/glossary/world-frame.md @@ -0,0 +1,7 @@ +--- +title: World frame +id: world-frame +full_link: /motion-planning/frame-system/ +short_description: The fixed, user-defined global coordinate system that is the reference point for all other coordinate frames in a robotic system. +aka: world frame, world +--- diff --git a/docs/reference/glossary_tmp/api-namespace-triplet.md b/docs/reference/glossary_tmp/api-namespace-triplet.md new file mode 100644 index 0000000000..6905c55e2e --- /dev/null +++ b/docs/reference/glossary_tmp/api-namespace-triplet.md @@ -0,0 +1,6 @@ +--- +title: API Namespace Triplet +id: api-namespace-triplet +full_link: +short_description: namespace:type:subtype, for example `rdk:component:sensor` +--- diff --git a/docs/reference/glossary_tmp/api.md b/docs/reference/glossary_tmp/api.md new file mode 100644 index 0000000000..e2e3b37ee4 --- /dev/null +++ b/docs/reference/glossary_tmp/api.md @@ -0,0 +1,8 @@ +--- +title: API +id: api +full_link: +short_description: Application programming interface, a set of defined rules that enable different applications to communicate with each other. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/attribute.md b/docs/reference/glossary_tmp/attribute.md new file mode 100644 index 0000000000..628036f59b --- /dev/null +++ b/docs/reference/glossary_tmp/attribute.md @@ -0,0 +1,8 @@ +--- +title: Attribute +id: attribute +full_link: +short_description: A configuration parameter of a resource. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/base.md b/docs/reference/glossary_tmp/base.md new file mode 100644 index 0000000000..ff3e212786 --- /dev/null +++ b/docs/reference/glossary_tmp/base.md @@ -0,0 +1,6 @@ +--- +title: Base +id: base +full_link: /components/base/ +short_description: A physical, mobile platform that the other parts of a mobile robot attach to. +--- diff --git a/docs/reference/glossary_tmp/blob-storage.md b/docs/reference/glossary_tmp/blob-storage.md new file mode 100644 index 0000000000..ea557f2a7b --- /dev/null +++ b/docs/reference/glossary_tmp/blob-storage.md @@ -0,0 +1,8 @@ +--- +title: Blob storage +id: blob-storage +full_link: +short_description: A cheap but slow storage medium. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/board.md b/docs/reference/glossary_tmp/board.md new file mode 100644 index 0000000000..ea877e6593 --- /dev/null +++ b/docs/reference/glossary_tmp/board.md @@ -0,0 +1,6 @@ +--- +title: Board +id: board +full_link: /components/board/ +short_description: A board is the signal wire hub of a machine that provides access to GPIO pins. +--- diff --git a/docs/reference/glossary_tmp/captive-web-portal.md b/docs/reference/glossary_tmp/captive-web-portal.md new file mode 100644 index 0000000000..38b24d4c3c --- /dev/null +++ b/docs/reference/glossary_tmp/captive-web-portal.md @@ -0,0 +1,5 @@ +--- +title: Captive web portal +id: captive-web-portal +short_description: A web page which is automatically displayed to users when connecting to a network. +--- diff --git a/docs/reference/glossary_tmp/client-application.md b/docs/reference/glossary_tmp/client-application.md new file mode 100644 index 0000000000..f3062213b7 --- /dev/null +++ b/docs/reference/glossary_tmp/client-application.md @@ -0,0 +1,6 @@ +--- +title: Client Application +id: client-application +full_link: +short_description: Client applications run business logic to operate your machine. +--- diff --git a/docs/reference/glossary_tmp/component.md b/docs/reference/glossary_tmp/component.md new file mode 100644 index 0000000000..4fbc8d514f --- /dev/null +++ b/docs/reference/glossary_tmp/component.md @@ -0,0 +1,5 @@ +--- +title: Component +id: component +short_description: A resource that often represents a physical piece of hardware which a computer controls; for example, a servo, a camera, or an arm. +--- diff --git a/docs/reference/glossary_tmp/flashed.md b/docs/reference/glossary_tmp/flashed.md new file mode 100644 index 0000000000..9d0ae31063 --- /dev/null +++ b/docs/reference/glossary_tmp/flashed.md @@ -0,0 +1,10 @@ +--- +title: Flash +id: flash +full_link: +short_description: The process of writing an operating system or firmware to a device's storage medium. +aka: + - flashed + - flashing +type: "page" +--- diff --git a/docs/reference/glossary_tmp/fragment.md b/docs/reference/glossary_tmp/fragment.md new file mode 100644 index 0000000000..9a2cf45f6c --- /dev/null +++ b/docs/reference/glossary_tmp/fragment.md @@ -0,0 +1,6 @@ +--- +title: Fragment +id: fragment +full_link: /fleet/reuse-configuration/ +short_description: A reusable configuration block that you can share across multiple machines. +--- diff --git a/docs/reference/glossary_tmp/frame-system.md b/docs/reference/glossary_tmp/frame-system.md new file mode 100644 index 0000000000..895b7b39f0 --- /dev/null +++ b/docs/reference/glossary_tmp/frame-system.md @@ -0,0 +1,6 @@ +--- +title: Frame System +id: frame-system +full_link: /motion-planning/frame-system/ +short_description: The frame system holds reference frame information for the relative position of components in space. +--- diff --git a/docs/reference/glossary_tmp/frame.md b/docs/reference/glossary_tmp/frame.md new file mode 100644 index 0000000000..d848ec0426 --- /dev/null +++ b/docs/reference/glossary_tmp/frame.md @@ -0,0 +1,6 @@ +--- +title: Frame +id: frame +full_link: +short_description: A frame represents a coordinate system that describes the position and orientation of an object. +--- diff --git a/docs/reference/glossary_tmp/gantry.md b/docs/reference/glossary_tmp/gantry.md new file mode 100644 index 0000000000..af0f21a5f7 --- /dev/null +++ b/docs/reference/glossary_tmp/gantry.md @@ -0,0 +1,6 @@ +--- +title: Gantry +id: attribute +full_link: /components/gantry/ +short_description: A mechanical system that only uses linear motion to carry out a task. +--- diff --git a/docs/reference/glossary_tmp/grpc.md b/docs/reference/glossary_tmp/grpc.md new file mode 100644 index 0000000000..7599e5a827 --- /dev/null +++ b/docs/reference/glossary_tmp/grpc.md @@ -0,0 +1,6 @@ +--- +title: gRPC +id: grpc +full_link: +short_description: An open source, cross-platform, high performance Remote Procedure Call (RPC) framework initially developed at Google in 2015. +--- diff --git a/docs/reference/glossary_tmp/index.md b/docs/reference/glossary_tmp/index.md new file mode 100644 index 0000000000..51eafd8fbc --- /dev/null +++ b/docs/reference/glossary_tmp/index.md @@ -0,0 +1,12 @@ +--- +title: "Glossary" +linkTitle: "Glossary" +weight: 999 +type: "docs" +layout: "glossary" +description: "A glossary that explains robotics and Viam-specific jargon." +card: + name: reference + weight: 10 + title: Glossary +--- diff --git a/docs/reference/glossary_tmp/job.md b/docs/reference/glossary_tmp/job.md new file mode 100644 index 0000000000..b83730b6a9 --- /dev/null +++ b/docs/reference/glossary_tmp/job.md @@ -0,0 +1,6 @@ +--- +title: Jobs +id: job +full_link: /fleet/scheduled-jobs/ +short_description: Automated tasks that run on machines at specified intervals to perform routine operations. +--- diff --git a/docs/reference/glossary_tmp/location.md b/docs/reference/glossary_tmp/location.md new file mode 100644 index 0000000000..b86dd3bb2e --- /dev/null +++ b/docs/reference/glossary_tmp/location.md @@ -0,0 +1,6 @@ +--- +title: Location +id: location +full_link: /reference/account/organize/ +short_description: A location is a virtual grouping of machines that allows you to organize machines and manage access to your fleet. +--- diff --git a/docs/reference/glossary_tmp/machine-config.md b/docs/reference/glossary_tmp/machine-config.md new file mode 100644 index 0000000000..9ddb032710 --- /dev/null +++ b/docs/reference/glossary_tmp/machine-config.md @@ -0,0 +1,6 @@ +--- +title: Machine Config +id: machine-config +full_link: /configure/ +short_description: The complete configuration of a single machine part. +--- diff --git a/docs/reference/glossary_tmp/machine-fqdn.md b/docs/reference/glossary_tmp/machine-fqdn.md new file mode 100644 index 0000000000..0d50be32df --- /dev/null +++ b/docs/reference/glossary_tmp/machine-fqdn.md @@ -0,0 +1,8 @@ +--- +title: Machine FQDN +id: machine-fqdn +full_link: +short_description: The fully qualified domain name (FQDN) of a machine in the Viam platform. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/machine-id.md b/docs/reference/glossary_tmp/machine-id.md new file mode 100644 index 0000000000..1c7491a8b9 --- /dev/null +++ b/docs/reference/glossary_tmp/machine-id.md @@ -0,0 +1,8 @@ +--- +title: Machine ID +id: machine-id +full_link: +short_description: A unique identifier assigned to each machine in the Viam platform. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/machine.md b/docs/reference/glossary_tmp/machine.md new file mode 100644 index 0000000000..60cccfe150 --- /dev/null +++ b/docs/reference/glossary_tmp/machine.md @@ -0,0 +1,6 @@ +--- +title: Machine +id: machine +full_link: /fleet/machines/ +short_description: An organizational concept, consisting of a computer and the components and services it controls, or sometimes multiple computers working closely together. +--- diff --git a/docs/reference/glossary_tmp/ml.md b/docs/reference/glossary_tmp/ml.md new file mode 100644 index 0000000000..9bdaf475b4 --- /dev/null +++ b/docs/reference/glossary_tmp/ml.md @@ -0,0 +1,8 @@ +--- +title: ML +id: ml +full_link: +short_description: Machine learning, a field of artificial intelligence focused on building systems that learn from data. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/model-namespace-triplet.md b/docs/reference/glossary_tmp/model-namespace-triplet.md new file mode 100644 index 0000000000..8a6aa545fd --- /dev/null +++ b/docs/reference/glossary_tmp/model-namespace-triplet.md @@ -0,0 +1,5 @@ +--- +title: Model Namespace Triplet +id: model-namespace-triplet +short_description: namespace:module-name:name or rdk:builtin:name +--- diff --git a/docs/reference/glossary_tmp/model.md b/docs/reference/glossary_tmp/model.md new file mode 100644 index 0000000000..951ff8b8eb --- /dev/null +++ b/docs/reference/glossary_tmp/model.md @@ -0,0 +1,6 @@ +--- +title: Model +id: model +full_link: +short_description: A particular implementation of a resource. For example, UR5e is a model of the arm component API. +--- diff --git a/docs/reference/glossary_tmp/modular-resource.md b/docs/reference/glossary_tmp/modular-resource.md new file mode 100644 index 0000000000..6b17c829f1 --- /dev/null +++ b/docs/reference/glossary_tmp/modular-resource.md @@ -0,0 +1,5 @@ +--- +title: Modular Resource +id: modular-resource +short_description: A modular resource is a model of a component or service provided by a module. +--- diff --git a/docs/reference/glossary_tmp/module.md b/docs/reference/glossary_tmp/module.md new file mode 100644 index 0000000000..5ea6dc8494 --- /dev/null +++ b/docs/reference/glossary_tmp/module.md @@ -0,0 +1,6 @@ +--- +title: Module +id: module +full_link: +short_description: Modules are the code packages that provide functionality like drivers, integrations, and control logic to your machines. +--- diff --git a/docs/reference/glossary_tmp/mql.md b/docs/reference/glossary_tmp/mql.md new file mode 100644 index 0000000000..7c39e34e94 --- /dev/null +++ b/docs/reference/glossary_tmp/mql.md @@ -0,0 +1,6 @@ +--- +title: MQL +id: mql +full_link: +short_description: MQL is the MongoDB query language, similar to SQL but specific to the MongoDB document model. +--- diff --git a/docs/reference/glossary_tmp/organization.md b/docs/reference/glossary_tmp/organization.md new file mode 100644 index 0000000000..b2d1f674da --- /dev/null +++ b/docs/reference/glossary_tmp/organization.md @@ -0,0 +1,6 @@ +--- +title: Organization +id: organization +full_link: /reference/account/organize/ +short_description: An organization is a group of one or more locations that helps you organize your fleet and manage who has access to your fleet. +--- diff --git a/docs/reference/glossary_tmp/origin-frame.md b/docs/reference/glossary_tmp/origin-frame.md new file mode 100644 index 0000000000..bd29cf5cc8 --- /dev/null +++ b/docs/reference/glossary_tmp/origin-frame.md @@ -0,0 +1,6 @@ +--- +title: Origin frame +id: origin-frame +full_link: +short_description: The origin frame is the frame at the base of an arm or other component that has a complex kinematics chain. +--- diff --git a/docs/reference/glossary_tmp/package.md b/docs/reference/glossary_tmp/package.md new file mode 100644 index 0000000000..cc78d4a131 --- /dev/null +++ b/docs/reference/glossary_tmp/package.md @@ -0,0 +1,6 @@ +--- +title: Package +id: package +full_link: +short_description: An archive, module, ML model, SLAM Map, or other bundle of binary code. +--- diff --git a/docs/reference/glossary_tmp/part.md b/docs/reference/glossary_tmp/part.md new file mode 100644 index 0000000000..3be1b32931 --- /dev/null +++ b/docs/reference/glossary_tmp/part.md @@ -0,0 +1,6 @@ +--- +title: Part +id: part +full_link: /reference/architecture/parts/ +short_description: A single-board computer, desktop, laptop, or other computer running viam-server, the hardware components attached to it, and any services or other resources running on it. +--- diff --git a/docs/reference/glossary_tmp/pi.md b/docs/reference/glossary_tmp/pi.md new file mode 100644 index 0000000000..37ed77b2d0 --- /dev/null +++ b/docs/reference/glossary_tmp/pi.md @@ -0,0 +1,8 @@ +--- +title: Pi +id: pi +full_link: +short_description: Short for Raspberry Pi, a series of small single-board computers developed by the Raspberry Pi Foundation. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/pin-number.md b/docs/reference/glossary_tmp/pin-number.md new file mode 100644 index 0000000000..95de28c2b0 --- /dev/null +++ b/docs/reference/glossary_tmp/pin-number.md @@ -0,0 +1,6 @@ +--- +title: Pin Number +id: pin-number +full_link: +short_description: A pin number is the index of the pin on the board. Not the same as a pin's GPIO number. +--- diff --git a/docs/reference/glossary_tmp/protobuf.md b/docs/reference/glossary_tmp/protobuf.md new file mode 100644 index 0000000000..66c946c447 --- /dev/null +++ b/docs/reference/glossary_tmp/protobuf.md @@ -0,0 +1,6 @@ +--- +title: Protocol Buffers (Protobuf) +id: protobuf +full_link: +short_description: A free and open-source, language-neutral, cross-platform data format for serializing structured data. +--- diff --git a/docs/reference/glossary_tmp/rdk.md b/docs/reference/glossary_tmp/rdk.md new file mode 100644 index 0000000000..c8bc04b6bc --- /dev/null +++ b/docs/reference/glossary_tmp/rdk.md @@ -0,0 +1,6 @@ +--- +title: RDK (Robot Development Kit) +id: rdk +full_link: /reference/platform/viam-server/ +short_description: The official Viam-developed codebase that provides all functionality of an SDK and more. +--- diff --git a/docs/reference/glossary_tmp/remote-part.md b/docs/reference/glossary_tmp/remote-part.md new file mode 100644 index 0000000000..0a270c292a --- /dev/null +++ b/docs/reference/glossary_tmp/remote-part.md @@ -0,0 +1,7 @@ +--- +title: Remote part +id: remote-part +full_link: /architecture/parts/ +short_description: A machine part which is controlled by another machine part. +aka: +--- diff --git a/docs/reference/glossary_tmp/resource.md b/docs/reference/glossary_tmp/resource.md new file mode 100644 index 0000000000..bd0b859655 --- /dev/null +++ b/docs/reference/glossary_tmp/resource.md @@ -0,0 +1,6 @@ +--- +title: Resource +id: resource +full_link: +short_description: Resources are individual, addressable elements of a machine such as components or services. +--- diff --git a/docs/reference/glossary_tmp/sdk.md b/docs/reference/glossary_tmp/sdk.md new file mode 100644 index 0000000000..a8cbd8f9ad --- /dev/null +++ b/docs/reference/glossary_tmp/sdk.md @@ -0,0 +1,6 @@ +--- +title: SDK (Software Development Kit) +id: sdk +full_link: /reference/apis/ +short_description: Viam provides software development kits (SDKs) to help you write client applications and create support for custom component types. +--- diff --git a/docs/reference/glossary_tmp/service.md b/docs/reference/glossary_tmp/service.md new file mode 100644 index 0000000000..7234d55742 --- /dev/null +++ b/docs/reference/glossary_tmp/service.md @@ -0,0 +1,5 @@ +--- +title: Service +id: service +short_description: Built-in software packages for complex capabilities such as SLAM, Computer Vision, Motion Planning, and Data Collection. +--- diff --git a/docs/reference/glossary_tmp/setup.md b/docs/reference/glossary_tmp/setup.md new file mode 100644 index 0000000000..a06d1881e9 --- /dev/null +++ b/docs/reference/glossary_tmp/setup.md @@ -0,0 +1,6 @@ +--- +title: View setup instructions +id: setup +full_link: +short_description: To view setup instructions for a machine part, navigate to the CONFIGURE tab, find the part's card, click the "..." menu in the upper right corner of the card, and select "View setup instructions". +--- diff --git a/docs/reference/glossary_tmp/slam.md b/docs/reference/glossary_tmp/slam.md new file mode 100644 index 0000000000..9b219afb5c --- /dev/null +++ b/docs/reference/glossary_tmp/slam.md @@ -0,0 +1,6 @@ +--- +title: SLAM +id: slam +full_link: /reference/services/slam/ +short_description: Simultaneous Localization And Mapping (SLAM) algorithms use data from a machine's sensors to generate a map of the environment and determine the machine's position within it. +--- diff --git a/docs/reference/glossary_tmp/smart-machine.md b/docs/reference/glossary_tmp/smart-machine.md new file mode 100644 index 0000000000..c3a442b772 --- /dev/null +++ b/docs/reference/glossary_tmp/smart-machine.md @@ -0,0 +1,6 @@ +--- +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. +--- diff --git a/docs/reference/glossary_tmp/sql.md b/docs/reference/glossary_tmp/sql.md new file mode 100644 index 0000000000..a5aeb07e76 --- /dev/null +++ b/docs/reference/glossary_tmp/sql.md @@ -0,0 +1,6 @@ +--- +title: SQL +id: sql +full_link: +short_description: SQL (structured query language) is the widely-used, industry-standard query language popular with relational databases. +--- diff --git a/docs/reference/glossary_tmp/subtype.md b/docs/reference/glossary_tmp/subtype.md new file mode 100644 index 0000000000..6888600813 --- /dev/null +++ b/docs/reference/glossary_tmp/subtype.md @@ -0,0 +1,6 @@ +--- +title: Subtype +id: subtype +full_link: +short_description: A group of component or service models that share the same API. For example, arm is a subtype of component. +--- diff --git a/docs/reference/glossary_tmp/trigger.md b/docs/reference/glossary_tmp/trigger.md new file mode 100644 index 0000000000..a754e10e3f --- /dev/null +++ b/docs/reference/glossary_tmp/trigger.md @@ -0,0 +1,6 @@ +--- +title: Trigger +id: trigger +full_link: /reference/configuration/triggers/ +short_description: A mechanism that sends alerts by email or webhook when specific events occur in your machine or data. +--- diff --git a/docs/reference/glossary_tmp/type.md b/docs/reference/glossary_tmp/type.md new file mode 100644 index 0000000000..fae6954123 --- /dev/null +++ b/docs/reference/glossary_tmp/type.md @@ -0,0 +1,6 @@ +--- +title: Type +id: type +full_link: +short_description: Component and service are the built-in types of resource API the RDK provides. +--- diff --git a/docs/reference/glossary_tmp/viam-agent.md b/docs/reference/glossary_tmp/viam-agent.md new file mode 100644 index 0000000000..9ade548edd --- /dev/null +++ b/docs/reference/glossary_tmp/viam-agent.md @@ -0,0 +1,6 @@ +--- +title: Viam Agent +id: viam-agent +full_link: +short_description: The Viam provisioning application for deploying viam-server. +--- diff --git a/docs/reference/glossary_tmp/viam-micro-server.md b/docs/reference/glossary_tmp/viam-micro-server.md new file mode 100644 index 0000000000..5776a9cae7 --- /dev/null +++ b/docs/reference/glossary_tmp/viam-micro-server.md @@ -0,0 +1,6 @@ +--- +title: viam-micro-server +id: viam-micro-server +full_link: /reference/platform/viam-micro-server/ +short_description: The lightweight version of viam-server that can run on ESP32 devices. +--- diff --git a/docs/reference/glossary_tmp/viam-robot-api.md b/docs/reference/glossary_tmp/viam-robot-api.md new file mode 100644 index 0000000000..c7072a564b --- /dev/null +++ b/docs/reference/glossary_tmp/viam-robot-api.md @@ -0,0 +1,6 @@ +--- +title: Viam Robot API +id: viam-robot-api +full_link: +short_description: The specification for communication with resources. +--- diff --git a/docs/reference/glossary_tmp/viam-server.md b/docs/reference/glossary_tmp/viam-server.md new file mode 100644 index 0000000000..967b7591d7 --- /dev/null +++ b/docs/reference/glossary_tmp/viam-server.md @@ -0,0 +1,6 @@ +--- +title: viam-server +id: viam-server +full_link: /reference/platform/viam-server/ +short_description: The executable binary which runs on and provides functionality to machines. +--- diff --git a/docs/reference/glossary_tmp/vision-service.md b/docs/reference/glossary_tmp/vision-service.md new file mode 100644 index 0000000000..44c9eeed37 --- /dev/null +++ b/docs/reference/glossary_tmp/vision-service.md @@ -0,0 +1,8 @@ +--- +title: Vision service +id: vision-service +full_link: /reference/services/vision/ +short_description: A service that enables machines to interpret visual data from cameras using computer vision and machine learning. +aka: +type: "page" +--- diff --git a/docs/reference/glossary_tmp/web-sockets.md b/docs/reference/glossary_tmp/web-sockets.md new file mode 100644 index 0000000000..d43f9cd613 --- /dev/null +++ b/docs/reference/glossary_tmp/web-sockets.md @@ -0,0 +1,6 @@ +--- +title: Websockets +id: web-sockets +full_link: +short_description: A computer communications protocol that provides full-duplex communication channels over a single Transmission Control Protocol (TCP) connection. +--- diff --git a/docs/reference/glossary_tmp/webrtc.md b/docs/reference/glossary_tmp/webrtc.md new file mode 100644 index 0000000000..94ce30a7bf --- /dev/null +++ b/docs/reference/glossary_tmp/webrtc.md @@ -0,0 +1,6 @@ +--- +title: WebRTC +id: webrtc +full_link: +short_description: An open source project which provides applications with real-time communication (RTC) using application programming interfaces (API) allowing powerful voice and video integration. +--- diff --git a/docs/reference/glossary_tmp/world-frame.md b/docs/reference/glossary_tmp/world-frame.md new file mode 100644 index 0000000000..7d9065772b --- /dev/null +++ b/docs/reference/glossary_tmp/world-frame.md @@ -0,0 +1,7 @@ +--- +title: World frame +id: world-frame +full_link: /motion-planning/frame-system/ +short_description: The fixed, user-defined global coordinate system that is the reference point for all other coordinate frames in a robotic system. +aka: world frame, world +--- diff --git a/docs/reference/module-configuration.md b/docs/reference/module-configuration.md new file mode 100644 index 0000000000..088e6e117b --- /dev/null +++ b/docs/reference/module-configuration.md @@ -0,0 +1,9 @@ +--- +title: "Modular resource and module configuration" +linkTitle: "Module configuration" +weight: 30 +type: docs +icon: true +description: "Configure module versions and module environment variables." +date: "2025-11-11" +--- diff --git a/docs/reference/platform/_index.md b/docs/reference/platform/_index.md new file mode 100644 index 0000000000..8dc0f26300 --- /dev/null +++ b/docs/reference/platform/_index.md @@ -0,0 +1,8 @@ +--- +title: "Platform" +linkTitle: "Platform" +weight: 50 +type: "docs" +no_list: true +description: "Reference documentation for viam-server, viam-micro-server, and viam-agent." +--- diff --git a/docs/reference/platform/viam-agent/_index.md b/docs/reference/platform/viam-agent/_index.md new file mode 100644 index 0000000000..26926f7ef8 --- /dev/null +++ b/docs/reference/platform/viam-agent/_index.md @@ -0,0 +1,10 @@ +--- +title: "viam-agent" +linkTitle: "viam-agent" +weight: 20 +type: docs +description: "The viam-agent is a self-updating service manager that maintains the lifecycle for Viam's system services, among them viam-server and provisioning." +date: "2025-02-14" +# updated: "" # When the content was last entirely checked +# SMEs: James, Ale +--- diff --git a/docs/reference/platform/viam-agent/manage-viam-agent.md b/docs/reference/platform/viam-agent/manage-viam-agent.md new file mode 100644 index 0000000000..06f0070804 --- /dev/null +++ b/docs/reference/platform/viam-agent/manage-viam-agent.md @@ -0,0 +1,13 @@ +--- +title: "Manage viam-agent" +linkTitle: "Manage viam-agent" +weight: 110 +no_list: true +type: docs +draft: false +images: ["/installation/thumbnails/manage.png"] +imageAlt: "Manage viam-agent" +description: "Control and manage the viam-agent systemd service." +date: "2024-08-16" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/platform/viam-micro-server.md b/docs/reference/platform/viam-micro-server.md new file mode 100644 index 0000000000..6948e6bf9b --- /dev/null +++ b/docs/reference/platform/viam-micro-server.md @@ -0,0 +1,12 @@ +--- +title: "The Micro-RDK and viam-micro-server" +linkTitle: "viam-micro-server" +weight: 40 +type: docs +images: ["/installation/thumbnails/esp32-espressif.png"] +imageAlt: "E S P 32 - espressif" +description: "Set up the Espressif ESP32 for development with `viam-micro-server`." +date: "2024-09-03" +# updated: "" # When the content was last entirely checked +# SMEs: Nicolas M., Gautham V., Andrew M. +--- diff --git a/docs/reference/platform/viam-server/_index.md b/docs/reference/platform/viam-server/_index.md new file mode 100644 index 0000000000..1e1d2a9eba --- /dev/null +++ b/docs/reference/platform/viam-server/_index.md @@ -0,0 +1,10 @@ +--- +title: "viam-server" +linkTitle: "viam-server" +weight: 31 +type: "docs" +description: "viam-server is the open-source, on-machine portion of the Viam platform." +tags: ["server", "rdk"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/platform/viam-server/debug-endpoints.md b/docs/reference/platform/viam-server/debug-endpoints.md new file mode 100644 index 0000000000..44306b4092 --- /dev/null +++ b/docs/reference/platform/viam-server/debug-endpoints.md @@ -0,0 +1,8 @@ +--- +title: "Debug Endpoints" +linkTitle: "Debug Endpoints" +weight: 130 +type: "docs" +description: "Advanced debugging endpoints available in viam-server for troubleshooting and development." +date: "2025-05-19" +--- diff --git a/docs/reference/platform/viam-server/manage-viam-server.md b/docs/reference/platform/viam-server/manage-viam-server.md new file mode 100644 index 0000000000..0d75873dcf --- /dev/null +++ b/docs/reference/platform/viam-server/manage-viam-server.md @@ -0,0 +1,13 @@ +--- +title: "Manage viam-server" +linkTitle: "Manage viam-server" +weight: 120 +no_list: true +type: docs +draft: false +images: ["/installation/thumbnails/manage.png"] +imageAlt: "Manage viam-server" +description: "If you have manually installed viam-server, you can chose to run it as a system service or on the command line." +date: "2024-08-16" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/sdks/_index.md b/docs/reference/sdks/_index.md new file mode 100644 index 0000000000..619ed51773 --- /dev/null +++ b/docs/reference/sdks/_index.md @@ -0,0 +1,7 @@ +--- +title: "Write control code with Viam SDKs" +linkTitle: "SDKs" +weight: 10 +type: "docs" +description: "Write code to control your machine with Viam's Python, Go, TypeScript, Flutter, and C++ SDKs." +--- diff --git a/docs/reference/sdks/connectivity.md b/docs/reference/sdks/connectivity.md new file mode 100644 index 0000000000..7d5e220e9a --- /dev/null +++ b/docs/reference/sdks/connectivity.md @@ -0,0 +1,11 @@ +--- +title: "Client sessions and machine network connectivity" +linkTitle: "Network connectivity" +weight: 80 +type: "docs" +description: "When you connect to a machine, the machine automatically chooses the best connection over local LAN, WAN or the internet." +tags: + ["client", "sdk", "viam-server", "networking", "apis", "robot api", "session"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/sdks/cpp.md b/docs/reference/sdks/cpp.md new file mode 100644 index 0000000000..fe605fbe9c --- /dev/null +++ b/docs/reference/sdks/cpp.md @@ -0,0 +1,11 @@ +--- +title: "C++" +linkTitle: "C++" +weight: 40 +type: "docs" +layout: "empty" +icon: true +images: ["/logos/cpp.svg"] +canonical: "https://cpp.viam.dev/" +description: "C++." +--- diff --git a/docs/reference/sdks/docommand.md b/docs/reference/sdks/docommand.md new file mode 100644 index 0000000000..4cfbe153c8 --- /dev/null +++ b/docs/reference/sdks/docommand.md @@ -0,0 +1,10 @@ +--- +title: "Implement or use DoCommand" +linkTitle: "DoCommand" +weight: 67 +type: "docs" +description: "Implement DoCommand in your module or use it from Viam's SDKs." +tags: ["sdk", "extend"] +date: "2025-04-29" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/sdks/flutter.md b/docs/reference/sdks/flutter.md new file mode 100644 index 0000000000..83c22926ed --- /dev/null +++ b/docs/reference/sdks/flutter.md @@ -0,0 +1,11 @@ +--- +title: "Flutter" +linkTitle: "Flutter" +weight: 50 +type: "docs" +layout: "empty" +icon: true +images: ["/logos/flutter.svg"] +canonical: "https://flutter.viam.dev/" +description: "Flutter." +--- diff --git a/docs/reference/sdks/go.md b/docs/reference/sdks/go.md new file mode 100644 index 0000000000..4b737c7e25 --- /dev/null +++ b/docs/reference/sdks/go.md @@ -0,0 +1,11 @@ +--- +title: "Go" +linkTitle: "Go" +weight: 20 +type: "docs" +layout: "empty" +icon: true +images: ["/logos/golang.svg"] +canonical: "https://pkg.go.dev/go.viam.com/rdk" +description: "Go." +--- diff --git a/docs/reference/sdks/python/_index.md b/docs/reference/sdks/python/_index.md new file mode 100644 index 0000000000..7b809d1d71 --- /dev/null +++ b/docs/reference/sdks/python/_index.md @@ -0,0 +1,11 @@ +--- +title: "Python" +linkTitle: "Python" +weight: 10 +type: "docs" +layout: "empty" +icon: true +images: ["/logos/python.svg"] +canonical: "https://python.viam.dev/" +description: "Python." +--- diff --git a/docs/reference/sdks/python/python-venv.md b/docs/reference/sdks/python/python-venv.md new file mode 100644 index 0000000000..d2db5ca388 --- /dev/null +++ b/docs/reference/sdks/python/python-venv.md @@ -0,0 +1,12 @@ +--- +title: "Prepare your Python Virtual Environment" +linkTitle: "Virtualenv for Python SDK" +weight: 10 +type: "docs" +description: "Prepare your Python Virtual Environment to program machines with the Python SDK." +images: ["/services/icons/sdk.svg"] +tags: + ["client", "sdk", "application", "sdk", "fleet", "program", "python", "venv"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/sdks/typescript.md b/docs/reference/sdks/typescript.md new file mode 100644 index 0000000000..520766b189 --- /dev/null +++ b/docs/reference/sdks/typescript.md @@ -0,0 +1,11 @@ +--- +title: "TypeScript" +linkTitle: "TypeScript" +weight: 30 +type: "docs" +layout: "empty" +icon: true +images: ["/logos/typescript.svg"] +canonical: "https://ts.viam.dev/" +description: "TypeScript." +--- diff --git a/docs/reference/sdks/use-extra-params.md b/docs/reference/sdks/use-extra-params.md new file mode 100644 index 0000000000..788451b2da --- /dev/null +++ b/docs/reference/sdks/use-extra-params.md @@ -0,0 +1,11 @@ +--- +title: "Using extra parameters with Viam's SDKs" +linkTitle: "Extra params" +weight: 70 +type: "docs" +description: "Using the extra parameter on resource API methods with Viam's SDKs." +images: ["/services/icons/sdk.svg"] +tags: ["sdk", "extra", "extend"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/reference/services/_index.md b/docs/reference/services/_index.md new file mode 100644 index 0000000000..99b6fb167c --- /dev/null +++ b/docs/reference/services/_index.md @@ -0,0 +1,8 @@ +--- +title: "Services" +linkTitle: "Services" +weight: 30 +type: "docs" +no_list: true +description: "Services are built-in software packages that add high-level functionality to your machine." +--- diff --git a/docs/reference/services/base-rc/_index.md b/docs/reference/services/base-rc/_index.md new file mode 100644 index 0000000000..41271f0f87 --- /dev/null +++ b/docs/reference/services/base-rc/_index.md @@ -0,0 +1,14 @@ +--- +title: "Base Remote Control Service" +linkTitle: "Base Remote Control" +weight: 70 +type: "docs" +description: "The base remote control service allows you to remotely control a base with an input controller like a gamepad." +tags: ["base", "services", "rover", "input controller", "remote control"] +icon: true +images: ["/services/icons/base-rc.svg"] +no_service: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SME: Eric +--- diff --git a/docs/reference/services/discovery/_index.md b/docs/reference/services/discovery/_index.md new file mode 100644 index 0000000000..3e1da863b4 --- /dev/null +++ b/docs/reference/services/discovery/_index.md @@ -0,0 +1,16 @@ +--- +title: "Discovery Service" +linkTitle: "Discovery" +description: "Use a discovery service to discover available resources on a machine." +type: docs +weight: 50 +no_list: true +#icon: true +#images: ["/services/icons/discovery.svg"] +tags: ["discovery", "services"] +no_service: true +date: "2025-03-03" +# updated: "" # When the content was last entirely checked +# SMEs: John N. +modulescript: true +--- diff --git a/docs/reference/services/generic/_index.md b/docs/reference/services/generic/_index.md new file mode 100644 index 0000000000..391f9d4381 --- /dev/null +++ b/docs/reference/services/generic/_index.md @@ -0,0 +1,17 @@ +--- +title: "Generic Service" +linkTitle: "Generic Service" +childTitleEndOverwrite: "Generic Service" +weight: 500 +type: "docs" +description: "A service that does not fit any of the other APIs." +tags: ["generic", "services"] +icon: true +images: ["/icons/components/generic.svg"] +no_list: true +modulescript: true +hide_children: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: +--- diff --git a/docs/reference/services/generic/fake.md b/docs/reference/services/generic/fake.md new file mode 100644 index 0000000000..5f0a120e64 --- /dev/null +++ b/docs/reference/services/generic/fake.md @@ -0,0 +1,10 @@ +--- +title: "Configure a Fake Generic Service" +linkTitle: "fake" +weight: 10 +type: "docs" +description: "Configure a fake generic service using the generic service API." +service_description: "A model used for testing a generic service." +tags: ["generic", "services"] +toc_hide: true +--- diff --git a/docs/reference/services/slam/_index.md b/docs/reference/services/slam/_index.md new file mode 100644 index 0000000000..7e8d3a81dc --- /dev/null +++ b/docs/reference/services/slam/_index.md @@ -0,0 +1,14 @@ +--- +title: "SLAM Service" +linkTitle: "SLAM" +weight: 60 +type: "docs" +description: "Simultaneous localization and mapping (SLAM) allows your machine to create a map of its surroundings and find its location within that map." +tags: ["slam", "services"] +icon: true +images: ["/services/icons/slam.svg"] +no_list: true +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: John N. +--- diff --git a/docs/reference/services/slam/cartographer/_index.md b/docs/reference/services/slam/cartographer/_index.md new file mode 100644 index 0000000000..bd55c39779 --- /dev/null +++ b/docs/reference/services/slam/cartographer/_index.md @@ -0,0 +1,13 @@ +--- +title: "Cartographer Modular Resource" +linkTitle: "Cartographer" +weight: 70 +type: "docs" +description: "Configure a Simultaneous Localization And Mapping (SLAM) service with the Cartographer modular resource." +tags: ["slam", "services"] +icon: true +images: ["/services/icons/slam.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: John N. +--- diff --git a/docs/reference/services/slam/cloudslam/_index.md b/docs/reference/services/slam/cloudslam/_index.md new file mode 100644 index 0000000000..b010648741 --- /dev/null +++ b/docs/reference/services/slam/cloudslam/_index.md @@ -0,0 +1,13 @@ +--- +title: "CloudSLAM Wrapper Modular Resource" +linkTitle: "CloudSLAM" +weight: 70 +type: "docs" +description: "Configure a Simultaneous Localization And Mapping (SLAM) service that runs in the cloud using Viam." +tags: ["slam", "services"] +icon: true +images: ["/services/icons/slam.svg"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: John N. +--- diff --git a/docs/reference/services/slam/orbslamv3/_index.md b/docs/reference/services/slam/orbslamv3/_index.md new file mode 100644 index 0000000000..a0a8c7f22a --- /dev/null +++ b/docs/reference/services/slam/orbslamv3/_index.md @@ -0,0 +1,12 @@ +--- +title: "ORB-SLAM3 Integrated Library" +linkTitle: "ORB-SLAM3" +weight: 70 +type: "docs" +draft: true +description: "Configure a SLAM service with the ORB-SLAM3 library." +tags: ["slam", "services"] +date: "2022-01-01" +# updated: "" # When the content was last entirely checked +# SMEs: Kat, Jeremy +--- diff --git a/docs/reference/services/vision/_index.md b/docs/reference/services/vision/_index.md new file mode 100644 index 0000000000..396ac87ee3 --- /dev/null +++ b/docs/reference/services/vision/_index.md @@ -0,0 +1,8 @@ +--- +title: "Vision Service" +linkTitle: "Vision Service" +weight: 20 +type: "docs" +no_list: true +description: "The vision service enables your machine to use its on-board cameras to intelligently see and interpret the world around it." +--- diff --git a/docs/reference/services/vision/color_detector.md b/docs/reference/services/vision/color_detector.md new file mode 100644 index 0000000000..5cbfb4b1c7 --- /dev/null +++ b/docs/reference/services/vision/color_detector.md @@ -0,0 +1,11 @@ +--- +title: "Configure a color_detector" +linkTitle: "color_detector" +weight: 10 +type: "docs" +description: "A heuristic detector that draws boxes around objects according to their hue (does not detect black, gray, and white)." +service_description: "A heuristic detector that draws boxes around objects according to their hue (does not detect black, gray, and white)." +tags: ["vision", "computer vision", "CV", "services", "detection"] +images: ["/services/vision/dog-detector.png"] +# SMEs: Bijan, Khari +--- diff --git a/docs/reference/services/vision/detector_3d_segmenter.md b/docs/reference/services/vision/detector_3d_segmenter.md new file mode 100644 index 0000000000..4471ac051e --- /dev/null +++ b/docs/reference/services/vision/detector_3d_segmenter.md @@ -0,0 +1,11 @@ +--- +title: "Configure a detector_3d_segmenter" +linkTitle: "detector_3d_segmenter" +weight: 20 +type: "docs" +description: "This model takes 2D bounding boxes from an object detector and projects the pixels in the bounding box to points in 3D space." +service_description: "A segmenter that takes 2D bounding boxes from an object detector and projects the pixels in the bounding box to points in 3D space." +tags: ["vision", "computer vision", "CV", "services", "segmentation"] +# SMEs: Bijan, Khari +draft: true +--- diff --git a/docs/reference/services/vision/mlmodel.md b/docs/reference/services/vision/mlmodel.md new file mode 100644 index 0000000000..6726a19559 --- /dev/null +++ b/docs/reference/services/vision/mlmodel.md @@ -0,0 +1,11 @@ +--- +title: "Configure an mlmodel Detector or Classifier" +linkTitle: "mlmodel" +weight: 10 +type: "docs" +description: "A detector or classifier that uses an ML model available on the machine to draw bounding boxes around objects or return a class label." +service_description: "A detector or classifier that uses a model available on the machine’s hard drive to draw bounding boxes around objects or returns a class label and confidence score." +tags: ["vision", "computer vision", "CV", "services", "detection"] +images: ["/services/vision/dog-detector.png"] +# SMEs: Bijan, Khari +--- diff --git a/docs/train/_index.md b/docs/train/_index.md new file mode 100644 index 0000000000..d510b6e0ff --- /dev/null +++ b/docs/train/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Train ML Models" +title: "Train ML Models" +weight: 50 +layout: "docs" +type: "docs" +no_list: true +description: "Create datasets and train ML models from captured data." +--- diff --git a/docs/train/annotate-images.md b/docs/train/annotate-images.md new file mode 100644 index 0000000000..cdadafab30 --- /dev/null +++ b/docs/train/annotate-images.md @@ -0,0 +1,8 @@ +--- +linkTitle: "annotate images" +title: "annotate images" +weight: 10 +layout: "docs" +type: "docs" +description: "annotate images." +--- diff --git a/docs/train/automate-annotation.md b/docs/train/automate-annotation.md new file mode 100644 index 0000000000..ba4fc89918 --- /dev/null +++ b/docs/train/automate-annotation.md @@ -0,0 +1,8 @@ +--- +linkTitle: "automate annotation" +title: "automate annotation" +weight: 10 +layout: "docs" +type: "docs" +description: "automate annotation." +--- diff --git a/docs/train/create-a-dataset.md b/docs/train/create-a-dataset.md new file mode 100644 index 0000000000..1d8739b40a --- /dev/null +++ b/docs/train/create-a-dataset.md @@ -0,0 +1,8 @@ +--- +linkTitle: "create a dataset" +title: "create a dataset" +weight: 10 +layout: "docs" +type: "docs" +description: "create a dataset." +--- diff --git a/docs/train/custom-training-scripts.md b/docs/train/custom-training-scripts.md new file mode 100644 index 0000000000..8d2853a675 --- /dev/null +++ b/docs/train/custom-training-scripts.md @@ -0,0 +1,8 @@ +--- +linkTitle: "custom training scripts" +title: "custom training scripts" +weight: 10 +layout: "docs" +type: "docs" +description: "custom training scripts." +--- diff --git a/docs/train/train-a-model.md b/docs/train/train-a-model.md new file mode 100644 index 0000000000..e2dff25726 --- /dev/null +++ b/docs/train/train-a-model.md @@ -0,0 +1,8 @@ +--- +linkTitle: "train a model" +title: "train a model" +weight: 10 +layout: "docs" +type: "docs" +description: "train a model." +--- diff --git a/docs/try/_index.md b/docs/try/_index.md new file mode 100644 index 0000000000..2bf641118d --- /dev/null +++ b/docs/try/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Try" +title: "Try Viam" +weight: 20 +layout: "docs" +type: "docs" +no_list: true +description: "Hands-on guided tutorials to experience Viam end-to-end." +--- diff --git a/docs/try/first-project/_index.md b/docs/try/first-project/_index.md new file mode 100644 index 0000000000..524a72ae9c --- /dev/null +++ b/docs/try/first-project/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "First project" +title: "First project" +weight: 10 +layout: "docs" +type: "docs" +description: "First project." +--- diff --git a/docs/try/first-project/gazebo-setup.md b/docs/try/first-project/gazebo-setup.md new file mode 100644 index 0000000000..38b6a38e9e --- /dev/null +++ b/docs/try/first-project/gazebo-setup.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Gazebo Simulation Setup" +title: "Gazebo Simulation Setup" +weight: 100 +layout: "docs" +type: "docs" +description: "Set up the Gazebo simulation environment for the inspection tutorial." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-1.md b/docs/try/first-project/part-1.md new file mode 100644 index 0000000000..c612b276d6 --- /dev/null +++ b/docs/try/first-project/part-1.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 1: Vision Pipeline" +title: "Part 1: Vision Pipeline" +weight: 10 +layout: "docs" +type: "docs" +description: "Set up a camera, ML model, and vision service to detect defects." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-2.md b/docs/try/first-project/part-2.md new file mode 100644 index 0000000000..8dc2ddebc1 --- /dev/null +++ b/docs/try/first-project/part-2.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 2: Data Capture" +title: "Part 2: Data Capture" +weight: 20 +layout: "docs" +type: "docs" +description: "Configure automatic image capture and cloud sync for your inspection system." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-3.md b/docs/try/first-project/part-3.md new file mode 100644 index 0000000000..1579de9193 --- /dev/null +++ b/docs/try/first-project/part-3.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 3: Control Logic" +title: "Part 3: Control Logic" +weight: 30 +layout: "docs" +type: "docs" +description: "Write inspection logic that detects defective cans." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-4.md b/docs/try/first-project/part-4.md new file mode 100644 index 0000000000..bdb30f35cb --- /dev/null +++ b/docs/try/first-project/part-4.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 4: Deploy a Module" +title: "Part 4: Deploy a Module" +weight: 40 +layout: "docs" +type: "docs" +description: "Deploy your inspector module and configure queryable detection data capture." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-5.md b/docs/try/first-project/part-5.md new file mode 100644 index 0000000000..93b079c736 --- /dev/null +++ b/docs/try/first-project/part-5.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 5: Productize" +title: "Part 5: Productize" +weight: 50 +layout: "docs" +type: "docs" +description: "Build a monitoring dashboard for your inspection system using Viam's Teleop interface." +date: "2025-01-30" +--- diff --git a/docs/vision/_index.md b/docs/vision/_index.md new file mode 100644 index 0000000000..72395b2b3a --- /dev/null +++ b/docs/vision/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Computer Vision" +title: "Computer Vision" +weight: 55 +layout: "docs" +type: "docs" +no_list: true +description: "Add computer vision to your machine: deploy ML models, detect and classify objects, measure depth, and act or alert on results." +--- diff --git a/docs/vision/act-on-detections.md b/docs/vision/act-on-detections.md new file mode 100644 index 0000000000..a2eb02c06a --- /dev/null +++ b/docs/vision/act-on-detections.md @@ -0,0 +1,8 @@ +--- +linkTitle: "act on detections" +title: "act on detections" +weight: 10 +layout: "docs" +type: "docs" +description: "act on detections." +--- diff --git a/docs/vision/alert-on-detections.md b/docs/vision/alert-on-detections.md new file mode 100644 index 0000000000..c72d91469f --- /dev/null +++ b/docs/vision/alert-on-detections.md @@ -0,0 +1,8 @@ +--- +linkTitle: "alert on detections" +title: "alert on detections" +weight: 10 +layout: "docs" +type: "docs" +description: "alert on detections." +--- diff --git a/docs/vision/classify.md b/docs/vision/classify.md new file mode 100644 index 0000000000..31658a7f43 --- /dev/null +++ b/docs/vision/classify.md @@ -0,0 +1,8 @@ +--- +linkTitle: "classify" +title: "classify" +weight: 10 +layout: "docs" +type: "docs" +description: "classify." +--- diff --git a/docs/vision/configure.md b/docs/vision/configure.md new file mode 100644 index 0000000000..5970095410 --- /dev/null +++ b/docs/vision/configure.md @@ -0,0 +1,8 @@ +--- +linkTitle: "configure" +title: "configure" +weight: 10 +layout: "docs" +type: "docs" +description: "configure." +--- diff --git a/docs/vision/detect.md b/docs/vision/detect.md new file mode 100644 index 0000000000..5d0f6df874 --- /dev/null +++ b/docs/vision/detect.md @@ -0,0 +1,8 @@ +--- +linkTitle: "detect" +title: "detect" +weight: 10 +layout: "docs" +type: "docs" +description: "detect." +--- diff --git a/docs/vision/measure-depth.md b/docs/vision/measure-depth.md new file mode 100644 index 0000000000..883dd028e5 --- /dev/null +++ b/docs/vision/measure-depth.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Measure Depth" +title: "Measure Depth" +weight: 50 +layout: "docs" +type: "docs" +description: "Retrieve point clouds and depth images from a depth camera, read depth at specific pixels, and measure distance to detected objects." +date: "2025-01-30" +--- diff --git a/docs/vision/track.md b/docs/vision/track.md new file mode 100644 index 0000000000..6fc1c76474 --- /dev/null +++ b/docs/vision/track.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Track Objects" +title: "Track Objects Across Frames" +weight: 40 +layout: "docs" +type: "docs" +description: "Match detections across consecutive frames using IoU, assign stable track IDs, and count entries and exits." +date: "2025-01-30" +--- diff --git a/docs/what-is-viam/_index.md b/docs/what-is-viam/_index.md new file mode 100644 index 0000000000..42de7a11d8 --- /dev/null +++ b/docs/what-is-viam/_index.md @@ -0,0 +1,12 @@ +--- +linkTitle: "What is Viam?" +title: "What is Viam?" +weight: 10 +layout: "docs" +type: "docs" +no_list: true +images: ["/general/understand.png"] +imageAlt: "Viam platform overview" +description: "Viam is a software platform for building, deploying, and managing robotics applications." +date: "2025-01-30" +--- diff --git a/docs/what-is-viam/problems-viam-solves.md b/docs/what-is-viam/problems-viam-solves.md new file mode 100644 index 0000000000..eaf762a91f --- /dev/null +++ b/docs/what-is-viam/problems-viam-solves.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Problems Viam Solves" +title: "Problems Viam Solves" +weight: 20 +layout: "docs" +type: "docs" +description: "A guide to the challenges you'll face at each stage of robotics development and how Viam helps." +date: "2025-01-30" +--- diff --git a/docs/what-is-viam/what-is-viam.md b/docs/what-is-viam/what-is-viam.md new file mode 100644 index 0000000000..7bf2bd540e --- /dev/null +++ b/docs/what-is-viam/what-is-viam.md @@ -0,0 +1,11 @@ +--- +linkTitle: "What is Viam?" +title: "What is Viam?" +weight: 1 +layout: "docs" +type: "docs" +description: "Viam is a software platform for building, deploying, and managing robotics applications." +images: ["/general/understand.png"] +imageAlt: "Viam platform overview" +date: "2025-01-30" +--- diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index ecdf1b06a1..6e382a6855 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -74,17 +74,4 @@ -
-
    -
  • Overview
    • - {{ with .Site.GetPage "/" }} - {{- range .Pages -}} - {{- $activePath := or ($currentPage.IsDescendant .) (eq $currentPage .) -}} - {{- if not (eq .LinkTitle "Tutorials") -}} -
  • {{ .LinkTitle }}
    • - {{- end -}} - {{- end -}} - {{- end -}} -
-
diff --git a/layouts/partials/sidebar-tree.html b/layouts/partials/sidebar-tree.html index bf5c14999a..8e98bc545d 100644 --- a/layouts/partials/sidebar-tree.html +++ b/layouts/partials/sidebar-tree.html @@ -64,7 +64,7 @@ {{ else }} {{ if or ( or (not $toc_hide) ($activePath) ) $active }} -
  • +
  • {{ if (and $p.Site.Params.ui.sidebar_menu_foldable (ge $ulNr 1)) -}}