Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add micro-RDK style guide suggestion #3861

Merged
merged 3 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/vale/styles/Viam/AvoidWithSubstitution.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ swap:
make sure: ensure
matrices: matrixes
meta-data: metadata
microRDK: Micro-RDK
name space: namespace
nameserver: name server
need to: must
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ swap:
Viam-server: viam-server
Viam server: viam-server
Viam-Server: viam-server
micro-RDK: Micro-RDK
Config Tab: CONFIG tab
Config tab: CONFIG tab
Vision service: vision service
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ For more information, see [Configure an esp32-camera](/operate/reference/compone

{{% changelog date="2024-08-26" color="changed" title="Micro-RDK now called viam-micro-server" %}}

The lightweight version of `viam-server` that is built from the micro-RDK is now referred to as `viam-micro-server`.
The lightweight version of `viam-server` that is built from the Micro-RDK is now referred to as `viam-micro-server`.
For more information, see [viam-micro-server](/operate/reference/viam-micro-server/).

{{% /changelog %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/glossary/viam-micro-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ short_description: The lightweight version of viam-server that can run on ESP32

The lightweight version of `viam-server`, built for microcontrollers.
`viam-micro-server` is a set of open-source utilities which run on your microcontroller and provides Viam functionality to your machine.
`viam-micro-server` is built from the micro-RDK.
`viam-micro-server` is built from the Micro-RDK.

For more information see [Architecture](/operate/reference/viam-micro-server/).
2 changes: 1 addition & 1 deletion docs/operate/get-started/other-hardware/micro-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The instructions below are for configuring a development environment in order to

## Required software

The [micro-RDK](https://github.com/viamrobotics/micro-rdk) (from which `viam-micro-server` is built) is written in Rust.
The [Micro-RDK](https://github.com/viamrobotics/micro-rdk) (from which `viam-micro-server` is built) is written in Rust.
To be able to develop for `viam-micro-server` on macOS and Linux systems, you must install the following software on your development machine:

1. Install dependencies:
Expand Down
2 changes: 1 addition & 1 deletion docs/operate/get-started/supported-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,4 @@ Modules for 64-bit architecture run alongside [`viam-server`](/operate/reference
When a module initializes, it registers its {{< glossary_tooltip term_id="model" text="model or models" >}} and associated [APIs](/dev/reference/apis/) with `viam-server`, making the new model available for use.
`viam-server` manages the [dependencies](/operate/reference/viam-server/#dependency-management), [start-up](/operate/reference/viam-server/#start-up), [reconfiguration](/operate/reference/viam-server/#reconfiguration), [data management](/data-ai/capture-data/capture-sync/), and [shutdown](/operate/reference/viam-server/#shutdown) behavior of your modular resource.

For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the micro-RDK and one or more modules onto your device.
For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the Micro-RDK and one or more modules onto your device.
4 changes: 2 additions & 2 deletions docs/operate/reference/components/camera/esp32-camera.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ 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"]
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"
aliases:
- /components/camera/esp32-camera/
# updated: "" # When the content was last entirely checked
# SMEs: Matt Perez, micro-RDK team
# SMEs: Matt Perez, Micro-RDK team
---

`esp32-camera` is the camera model that supports all cameras that work with Espressif's [esp32-camera drivers](https://github.com/espressif/esp32-camera) including:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
component_description: "A camera model for testing."
micrordk_component: true
toc_hide: true
# SMEs: Matt Perez, micro-RDK team
# SMEs: Matt Perez, Micro-RDK team
---

A `fake` camera is a camera model for testing.
Expand Down
4 changes: 2 additions & 2 deletions docs/operate/reference/viam-micro-server/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ date: "2024-09-03"
---

`viam-micro-server` is the lightweight version of [`viam-server`](/operate/reference/viam-server/) which can run on resource-limited embedded systems (ESP32) that cannot run the fully-featured `viam-server`.
`viam-micro-server` is built from the open-source [micro-RDK](https://github.com/viamrobotics/micro-rdk/).
`viam-micro-server` is built from the open-source [Micro-RDK](https://github.com/viamrobotics/micro-rdk/).

## Hardware requirements

{{% readfile "/static/include/micro-rdk-hardware.md" %}}

## Support

[Client API](/dev/reference/apis/) usage with the micro-RDK currently supports the following {{< glossary_tooltip term_id="resource" text="resources" >}}:
[Client API](/dev/reference/apis/) usage with the Micro-RDK currently supports the following {{< glossary_tooltip term_id="resource" text="resources" >}}:

{{< cards >}}
{{% relatedcard link="/dev/reference/apis/components/base/" %}}
Expand Down
Loading