diff --git a/docs/dev/tools/common-errors.md b/docs/dev/tools/common-errors.md index 42f0d32a6c..52ba66bdc5 100644 --- a/docs/dev/tools/common-errors.md +++ b/docs/dev/tools/common-errors.md @@ -213,6 +213,14 @@ resource build error: unknown resource type: API "rdk:component:camera" with mod 1. Check the logs for other errors. It may be that the instantiation of the model is failing, for other reasons such as the hardware being disconnected. +### Failed to connect to robot within time limit {#conn-time-out} + +**Full Error:** `failed to connect to machine within time limit. check network connection, whether the viam-server is running, and try again. see https://docs.viam.com/dev/tools/common-errors/#conn-time-out for troubleshooting steps` + +**Description:** This error occurs when the host fails to connect to the robot within the time limit. + +**Solution:** See [Network Troubleshooting](/dev/tools/common-errors/#network-troubleshooting) section. + ### Could not connect to machine part **Full Error:** `Could not connect to machine part: error updating resources: rpc error: code = ResourceExhausted desc = exceeded request limit 100 on resource viam.robot.v1.RobotService` @@ -232,7 +240,7 @@ To adjust the per-resource limit for modules, you can set the `VIAM_RESOURCE_REQ **Solution:** To adjust the initial app connection timeout, you can set the `VIAM_CONFIG_READ_TIMEOUT` [environment variable on your machine](/manage/reference/viam-agent/#environment-variables-for-viam-server) to a positive integer higher than the default, 15. -### exceeded request limit on resource +### exceeded request limit on resource {#req-limit-exceeded} **Full Error:** @@ -296,7 +304,22 @@ If not, look for other related errors in your logs. **Description:** This error indicates a networking or connection issue. -**Solution:** +**Solution:** See [Network Troubleshooting](/dev/tools/common-errors/#network-troubleshooting) section. + +### Unable to create PeerConnection with module + +**Full Warning:** `Unable to create PeerConnection with module. Ignoring.` + +**Description:** Indicates that while the gRPC connection to the module is working as expected, the connection to the module does not support efficient video streaming over WebRTC. +Only some Go-based camera modules support optimized video streaming over WebRTC. + +{{% hiddencontent %}} +You can use any Viam SDK to implement a camera module, but only Go-based modules can access optimized video streaming over WebRTC. +{{% /hiddencontent %}} + +**Solution:** This warning can be safely ignored. + +## Network Troubleshooting 1. Check networking: @@ -350,19 +373,6 @@ If not, look for other related errors in your logs. 1. If you have multiple tabs open with your machine's page, close all but one. Having too many connections can cause instability on some machines. -### Unable to create PeerConnection with module - -**Full Warning:** `Unable to create PeerConnection with module. Ignoring.` - -**Description:** Indicates that while the gRPC connection to the module is working as expected, the connection to the module does not support efficient video streaming over WebRTC. -Only some Go-based camera modules support optimized video streaming over WebRTC. - -{{% hiddencontent %}} -You can use any Viam SDK to implement a camera module, but only Go-based modules can access optimized video streaming over WebRTC. -{{% /hiddencontent %}} - -**Solution:** This warning can be safely ignored. - ## Known application and plugin conflicts ### macOS applications