Skip to content

Viam Server for Microcontrollers

License

Notifications You must be signed in to change notification settings

viamrobotics/micro-rdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

724ff8a · Jan 29, 2025
Dec 6, 2024
Jan 29, 2025
Jan 29, 2025
Dec 6, 2024
Jan 10, 2025
Jan 23, 2025
Jan 28, 2025
Jan 23, 2025
Apr 2, 2024
Jan 27, 2025
Jan 27, 2025
Jan 15, 2025
Jan 23, 2025
Jan 28, 2025
Jun 26, 2023
Oct 24, 2024
Jan 28, 2025
Jan 28, 2025
Jan 23, 2025
Jan 10, 2023
Jan 15, 2025
Jan 23, 2025
Jan 23, 2025
Apr 30, 2024

Repository files navigation

Table of Contents

The Micro-RDK (Robot Development Kit for Microcontrollers)

Viam provides an open source robot architecture that provides robotics functionality via simple APIs.

The Micro-RDK is a lightweight version of Viam's RDK. Its goal is to be run on resource-limited embedded systems. The only microcontroller currently supported is the ESP32.

Website: viam.com

Documentation: docs.viam.com

Cloud App: app.viam.com

Contact

If you have a bug or an idea, please open an issue here.

(In)stability Notice

Warning This is a beta release of the Viam Micro-RDK. Stability is not guaranteed. Breaking changes are likely to occur, and occur often.

Getting Started

For instructions on how to install the Micro-RDK, see the Viam Installation Documentation.

For instructions on how to get started with Micro-RDK development tasks, such as module development or usage, please see the Development Setup Documentation.

For documentation on advanced development configuration, including working across multiple projects, sharing local changes, credentials management, build performance, and customizing ESP-IDF configuration, please see DEVELOPMENT.md in this repository.

Debugging

Viewing server logs

The following instructions should be used for viewing server logs from an esp32 in terminal. These logs should be copied and included when contacting Viam support.

Using espflash

To see server logs for an esp32, use the monitor command on espflash:

espflash monitor

Without espflash

In the event that cargo and/or espflash is not installed, the micro-rdk-installer also contains the monitor command and can be downloaded as an alternative. Here is an example using the x86_64-Linux version:

./micro-rdk-installer-amd64-linux monitor

License

Copyright 2022-2023 Viam Inc.

AGPLv3 - See LICENSE file