README
¶
API
Protobuf definitions for Viam's public-facing API.
Contributing
Development
make setup- Setup your development environmentmake all- Clean and build the Go and web generated librariesmake dist/buf- Build the Go and web generated libraries without cleaningmake clean- Clean tool cache
Submitting PRs for Protobuf Changes
Please only edit .proto files. The generated interfaces build in CI.
To build protos for a PR:
- add the
ready-for-protoslabel - adding the label will compile your protos, and commit the compiled changes to your PR branch from the github-actions bot
- the bot commit will also add a
protos-compiledlabel which is checked to merge. subsequent manual commits remove this label
- the bot commit will also add a
- when you're ready to merge, remove the
ready-for-protoslabel; that will trigger lint and merge checks - in order to merge, the last commit to your PR must be a bot commit. (this is enforced through labeling)
Other guidelines:
- Do not make breaking changes to APIs if it can be avoided.
- Always use semantic version tags (not hashes) when importing this into other projects, such as RDK.
- For example, use
go get go.viam.com/api@v0.1.180NOTgo get go.viam.com/api@037415e - Add a new (semantic version compatible) tag when needed for this.
- Do NOT duplicate, move, or remove version tags.
- For example, use
License
Copyright 2023 Viam Inc.
Apache 2.0 - See LICENSE file
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
agent/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
build/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
cloudslam/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
data/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
dataset/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
datasync/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
mltraining/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
model/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
packages/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
common
|
|
|
component
|
|
|
arm/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
audioinput/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
base/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
board/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
camera/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
encoder/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
gantry/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
generic/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
gripper/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
inputcontroller/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
motor/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
movementsensor/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
posetracker/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
powersensor
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
powersensor/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
sensor/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
servo/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
testecho/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
module
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
provisioning
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
robot
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
service
|
|
|
datamanager/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
generic/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
mlmodel/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
motion/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
navigation/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
sensors/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
shell/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
slam/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
vision/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
stream
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
tagger
|
|
Click to show internal directories.
Click to hide internal directories.