Skip to content
Draft

Draft #4535

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 21 additions & 51 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,68 +27,38 @@ aliases:
- "/platform/"
---

<div class="max-page">
<div class="hero-container">
<div class="hero-text">
<h1>Viam Documentation</h1>
<p>
Viam integrates with hardware and software on <b>any device</b> in the physical world. Once you <a href="/operate/get-started/setup/">set up your machines</a>, you can use Viam SDKs to program your devices and connected hardware. Everything is managed in the cloud and you can add use machine learning, data management, and much more for your projects.
</p>
<div class="cards max-page">
<div class="front-card-container">
<div class="hover-card primary">
<a href="/operate/get-started/setup/" class="noanchor">
<div>
<p>Get started</p>
</div>
</a>
</div>
<div class="cta secondary">
<a href="/dev/" class="noanchor"><div>
<p>APIs & CLI →</p></div>
</a>
</div>
</div>
</div>
</div>
<img src="docs-hero-image.png" alt="App illustration" class="hero">
</div>
</div>
<br>

<!-- Need to use upside down logic because using Subsequent-sibling combinator -->
<div class="max-page gray-container">
<h2 id="platform">The Viam platform
<h2 id="platform">Viam Documentation
<div class="copied" id="copied-platform" aria-hidden="true">
<div class="copied-notification" id="copied-platform-text"></div>
</div>
</h2>
<p> Viam allows you to control and program any sensor, actuator or other hardware that is connected to a device. The Viam platform offers builtin capabilities to capture data from devices to the cloud, to build and deploy machine learning models, to alert on problems, and much more. With the connection to the cloud, you can configure, control, and manage your devices from anywhere.</p>
<p> Viam is a software platform for devices that interact with the physical world.</p>
<br>
<div class="imgcontcenter">
<div class="img-overlay-wrap aligncenter">
<img src="platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
<img src="platform/platform-build-all.svg" alt="Platform diagram with connect elements highlighted" class="aligncenter overlay-platform" id="build-platform" style="width:800px;height:auto" loading="lazy" >
<img src="platform/platform-data-all.svg" alt="Platform diagram with apps element highlighted" class="aligncenter overlay-platform" id="data-platform" style="width:800px;height:auto" loading="lazy" >
<img src="platform/platform-fleet-all.svg" alt="Platform diagram with motion elements highlighted" class="aligncenter overlay-platform" id="fleet-platform" style="width:800px;height:auto" loading="lazy" >
</div>
</div>

<br>
- [**`viam-server` →**](/operate/reference/viam-server/)

<div class="three-cards hoveraction">
The open-source server that runs on machines to manage hardware and software.

<div class="col hover-card build-platform">
<div><span><h3>Build & integrate</h3><p>To get started, install Viam on any device and integrate your hardware. Then you can control your device and any attached physical hardware securely from anywhere in the world.</p></span><p><a href="operate/">Learn more</a></p></div>
</div>
- [**Viam →**](https://app.viam.com/robots)

<div class="col hover-card data-platform">
<div><span><h3>Work with Data and AI</h3><p>Viam's data and AI capabilities enable you to capture and sync or upload data, build a dataset, train and deploy ML models, and run inference with computer vision. Then, you can act or alert on inferences.</p></span><p><a href="data-ai/">Learn more</a></p></div>
</div>
The cloud app for configuration and management.

<div class="col hover-card fleet-platform">
<div><span><h3>Deploy, manage, and troubleshoot</h3><p>Viam’s fleet management tooling allows you to remotely deploy and manage software on any fleet of devices. You can monitor all connected devices and troubleshoot any issues - from anywhere.</p></span><p><a href="manage/">Learn more</a></p></div>
</div>
- [**Architectural Overview →**](/operate/reference/architecture/)

How a machine is structured, including on-device and cloud communications.

- [**Building machines →**](/operate/)

Mix and match from existing software resources or make your own.

- [**Data management & AI →**](/data-ai/)

Manage data from your devices and use it with machine learning.

- [**Fleet Management →**](/manage/)

Remotely deploy and manage software on any fleet of devices.

</div>
</div>
64 changes: 19 additions & 45 deletions docs/data-ai/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
linkTitle: "AI and Data"
title: "Work with Data and AI"
title: "AI and Data"
weight: 250
layout: "docs"
type: "docs"
Expand All @@ -12,54 +12,28 @@ notoc: true
description: "Sync and store sensor data, images, and any other binary or timeseries data. Then use ML and AI to turn your data into insights and action."
---

Viam's data and AI capabilities enable you to capture and sync or upload data, build a dataset, train and deploy ML models, and run inference with computer vision.
Then, you can act or alert on inferences.
You can also monitor your machines through teleop, power your application logic, or analyze historical data trends.
<div class="max-page gray-container">
<p> Manage data from your devices and use it with machine learning.</p>
<br>

<div class="img-overlay-wrap aligncenter">
<img src="../platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto">
<img src="../platform/platform-data-capture.svg" alt="Platform diagram with data capture elements highlighted" class="aligncenter overlay" id="data-platform-capture" style="width:800px;height:auto" loading="lazy" >
<img src="../platform/platform-data-work.svg" alt="Platform diagram with data usage elements highlighted" class="aligncenter overlay" id="data-platform-work" style="width:800px;height:auto" loading="lazy" >
<img src="../platform/platform-data-ai.svg" alt="Platform diagram with AI elements highlighted" class="aligncenter overlay" id="data-platform-ai" style="width:800px;height:auto" loading="lazy" >
</div>
- [**Data Management →**](/data-ai/capture-data/capture-sync/)

<div class="hoveraction">
Capture and sync data from devices.

{{< how-to-expand "Capture data" "4" "BEGINNER-FRIENDLY" "" "data-platform-capture" >}}
{{< cards >}}
{{% card link="/data-ai/capture-data/capture-sync/" noimage="true" %}}
{{% card link="/data-ai/capture-data/filter-before-sync/" noimage="true" %}}
{{% card link="/data-ai/capture-data/conditional-sync/" noimage="true" %}}
{{% card link="/data-ai/capture-data/lorawan/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
- [**Machine Learning →**](/data-ai/train/train-tflite/)

{{< how-to-expand "Work with data" "4" "BEGINNER-FRIENDLY" "" "data-platform-work" >}}
{{< cards >}}
{{% card link="/data-ai/data/query/" noimage="true" %}}
{{% card link="/data-ai/data/visualize/" noimage="true" %}}
{{% card link="/data-ai/data/advanced/alert-data/" noimage="true" %}}
{{% card link="/data-ai/data/export/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
Build a dataset to train machine learning models for your machines.

{{< how-to-expand "Train an ML model" "5" "INTERMEDIATE" "" "data-platform-ai" >}}
{{< cards >}}
{{% card link="/data-ai/train/create-dataset/" noimage="true" %}}
{{% card link="/data-ai/train/capture-annotate-images/" noimage="true" %}}
{{% card link="/data-ai/train/train-tflite/" noimage="true" %}}
{{% card link="/data-ai/train/train/" noimage="true" %}}
{{% card link="/data-ai/train/upload-external-data/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
- [**Computer Vision →**](/data-ai/ai/run-inference/)

{{< how-to-expand "Infer with ML models" "4" "INTERMEDIATE" "" "data-platform-ai" >}}
{{< cards >}}
{{% card link="/data-ai/ai/deploy/" noimage="true" %}}
{{% card link="/data-ai/ai/run-inference/" noimage="true" %}}
{{% card link="/data-ai/ai/alert/" noimage="true" %}}
{{% card link="/data-ai/ai/act/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
Allow machines to interpret their environments.

</div>
- [**Query data →**](/data-ai/data/query/)

Graph or query data from all your devices.

- [**LoRaWAN networks →**](/data-ai/capture-data/lorawan/)

Collect LoRaWAN sensor data with Viam.

</div>
22 changes: 22 additions & 0 deletions docs/dev/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,28 @@ aliases:
- /internals/
---

<div class="max-page gray-container">
<p> Remotely deploy and manage software on any fleet of devices - from anywhere.</p>
<br>

- [**CLI →**](/dev/tools/cli/)

Manage your machines resources from the command line.

- [**Tutorials →**](LINK)

Build small projects while learning new skills.

- [**APIs →**](LINK)

Every Viam resource exposes an API described through protocol buffers.

- [**SDKs →**](/dev/reference/sdks/)

Control your machines with Go, Python, TypeScript, Flutter, C++, and more..

</div>

<div class="max-page">
<div class="hero-container-small">
<div class="hero-text">
Expand Down
61 changes: 21 additions & 40 deletions docs/manage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,51 +17,32 @@ aliases:
- /product-overviews/fleet-management/
---

Viam's fleet management tooling allows you to remotely deploy and manage software on any fleet of devices. You can monitor all connected devices and troubleshoot any issues - from anywhere.
<div class="max-page gray-container">
<p> Remotely deploy and manage software on any fleet of devices - from anywhere.</p>
<br>

<div class="img-overlay-wrap aligncenter">
<img src="../platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
<img src="../platform/platform-fleet-team.svg" alt="Platform diagram with team management elements highlighted" id="fleet-platform-team" class="aligncenter overlay" style="width:800px;height:auto" loading="lazy">
<img src="../platform/platform-fleet-management.svg" alt="Platform diagram with deploy and manage elements highlighted" class="aligncenter overlay" id="fleet-platform-management" style="width:800px;height:auto" loading="lazy" >
<img src="../platform/platform-fleet-monitor.svg" alt="Platform diagram with monitoring elements highlighted" class="aligncenter overlay" id="fleet-platform-monitor" style="width:800px;height:auto" loading="lazy" >
</div>
- [**Fleet Management →**](/manage/fleet/reuse-configuration/)

Set up all your machines with shared configuration fragments.

- [**Provisioning →**](/manage/fleet/provision/setup/)

Set up machines with a pre-defined configuration as they come online.

- [**Monitoring →**](/manage/troubleshoot/monitor/)

Remotely monitor and operate all your machines.

- [**Access Control →**](manage/manage/access/)

<div class="hoveraction">
Collaborate with others on your machines.

{{< how-to-expand "Deploy a fleet of machines" "4" "INTERMEDIATE" "" "fleet-platform-management">}}
{{< cards >}}
{{% card link="/manage/fleet/reuse-configuration/" noimage="true" %}}
{{% card link="/manage/fleet/system-settings/" noimage="true" %}}
{{% card link="/manage/fleet/provision/setup/" noimage="true" %}}
{{% card link="manage/fleet/provision/end-user-setup/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
- [**Maintenance and Updates →**](/manage/software/update-software/)

{{< how-to-expand "Deploy code and manage software on machines" "2" "INTERMEDIATE" "fleet-platform-management" >}}
{{< cards >}}
{{% card link="/manage/software/control-logic/" noimage="true" %}}
{{% card link="/manage/software/deploy-software/" noimage="true" %}}
{{% card link="/manage/software/update-software/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
Roll out software updates to your machines in a few clicks.

{{< how-to-expand "Manage access for organizations" "4" "INTERMEDIATE" "" "fleet-platform-team" >}}
{{< cards >}}
{{% card link="/manage/manage/access/" noimage="true" %}}
{{% card link="/manage/manage/rbac/" noimage="true" %}}
{{% card link="/manage/manage/oauth/" noimage="true" %}}
{{% card link="/manage/manage/white-labelled-billing/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
- [**OS settings & Networking →**](/manage/fleet/system-settings/)

{{< how-to-expand "Remotely monitor and troubleshoot" "5" "INTERMEDIATE" "" "fleet-platform-monitor" >}}
{{< cards >}}
{{% card link="/manage/troubleshoot/monitor/" noimage="true" %}}
{{% card link="/manage/troubleshoot/alert/" noimage="true" %}}
{{% card link="/manage/troubleshoot/teleoperate/custom-interface" customTitle="Teleoperate with custom interface" noimage="true" %}}
{{% card link="/manage/troubleshoot/teleoperate/default-interface" customTitle="Teleoperate with default interface" noimage="true" %}}
{{% card link="/manage/troubleshoot/troubleshoot/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
Configure networks and package updates for the host operating system.

</div>
67 changes: 30 additions & 37 deletions docs/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,36 @@ aliases:
- /build/
---

To get started, install Viam on any device and integrate your hardware. Then you can control your device and any attached physical hardware securely from anywhere in the world.

<!-- Need to use upside down logic because using Subsequent-sibling combinator -->
<div class="img-overlay-wrap aligncenter">
<img src="../platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
<img src="../platform/platform-build-connect.svg" alt="Platform diagram with connect elements highlighted" class="aligncenter overlay" id="build-platform-connect" style="width:800px;height:auto" loading="lazy" >
<img src="../platform/platform-build-apps.svg" alt="Platform diagram with apps element highlighted" class="aligncenter overlay" id="build-platform-apps" style="width:800px;height:auto" loading="lazy" >
<img src="../platform/platform-build-motion.svg" alt="Platform diagram with motion elements highlighted" class="aligncenter overlay" id="build-platform-motion" style="width:800px;height:auto" loading="lazy" >
</div>
<div class="max-page gray-container">
<p> Control your device and any attached physical hardware from anywhere in the world.</p>
<br>

- [**Installation →**](/operate/get-started/setup/)

Install Viam on any device.

- [**Registry →**](/operate/get-started/supported-hardware/)

An online hub of resources you can use on your machines..

- [**Modules →**](/operate/get-started/other-hardware/create-module/)

Create modules to support your specialized hardware and software.

- [**Viam applications →**](/operate/control/viam-applications/)

Deploy web applications to provide an interface for your machines.

- [**SDKs →**](/dev/reference/sdks/)

Control your machines with Go, Python, TypeScript, Flutter, C++, and more.

- [**Motion planning →**](/operate/mobility/motion-concepts/)

Use built-in motion planning software to move arms, bases, etc.

- [**Micro-RDK →**](/operate/reference/viam-micro-server/)

<div class="hoveraction">

{{< how-to-expand "Connect devices" "4" "BEGINNER-FRIENDLY" "" "build-platform-connect" >}}
{{< cards >}}
{{% card link="/operate/get-started/basics/" noimage="true" %}}
{{% card link="/operate/get-started/setup/" noimage="true" %}}
{{% card link="/operate/get-started/supported-hardware/" noimage="true" %}}
{{% card link="/operate/get-started/other-hardware/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}

{{< how-to-expand "Build apps" "4" "BEGINNER-FRIENDLY" "" "build-platform-apps" >}}
{{< cards >}}
{{% card link="/operate/control/viam-applications/" noimage="true" %}}
{{% card link="/operate/control/web-app/" noimage="true" %}}
{{% card link="/operate/control/mobile-app/" noimage="true" %}}
{{% card link="/operate/control/headless-app/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}

{{< how-to-expand "Intelligent actuation and motion planning" "4" "INTERMEDIATE" "" "build-platform-motion" >}}
{{< cards >}}
{{% card link="/operate/mobility/motion-concepts/" noimage="true" %}}
{{% card link="/operate/mobility/move-arm/" noimage="true" %}}
{{% card link="/operate/mobility/move-base/" noimage="true" %}}
{{% card link="/operate/mobility/move-gantry/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
The lightweight version of `viam-server` for microcontrollers.

</div>
Loading