Skip to content

Commit a922525

Browse files
DOCS-4171: Add troubleshooting for error when webrtc, mDNS, and gRPC fail (#4742)
1 parent ce8a938 commit a922525

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

docs/dev/tools/common-errors.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,14 @@ resource build error: unknown resource type: API "rdk:component:camera" with mod
213213
1. Check the logs for other errors.
214214
It may be that the instantiation of the model is failing, for other reasons such as the hardware being disconnected.
215215
216+
### Failed to connect to robot within time limit {#conn-time-out}
217+
218+
**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`
219+
220+
**Description:** This error occurs when the host fails to connect to the robot within the time limit.
221+
222+
**Solution:** See [Network Troubleshooting](/dev/tools/common-errors/#network-troubleshooting) section.
223+
216224
### Could not connect to machine part
217225
218226
**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
232240
233241
**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.
234242
235-
### exceeded request limit on resource
243+
### exceeded request limit on resource {#req-limit-exceeded}
236244
237245
**Full Error:**
238246
@@ -296,7 +304,22 @@ If not, look for other related errors in your logs.
296304
297305
**Description:** This error indicates a networking or connection issue.
298306
299-
**Solution:**
307+
**Solution:** See [Network Troubleshooting](/dev/tools/common-errors/#network-troubleshooting) section.
308+
309+
### Unable to create PeerConnection with module
310+
311+
**Full Warning:** `Unable to create PeerConnection with module. Ignoring.`
312+
313+
**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.
314+
Only some Go-based camera modules support optimized video streaming over WebRTC.
315+
316+
{{% hiddencontent %}}
317+
You can use any Viam SDK to implement a camera module, but only Go-based modules can access optimized video streaming over WebRTC.
318+
{{% /hiddencontent %}}
319+
320+
**Solution:** This warning can be safely ignored.
321+
322+
## Network Troubleshooting
300323
301324
1. Check networking:
302325
@@ -350,19 +373,6 @@ If not, look for other related errors in your logs.
350373
1. If you have multiple tabs open with your machine's page, close all but one.
351374
Having too many connections can cause instability on some machines.
352375

353-
### Unable to create PeerConnection with module
354-
355-
**Full Warning:** `Unable to create PeerConnection with module. Ignoring.`
356-
357-
**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.
358-
Only some Go-based camera modules support optimized video streaming over WebRTC.
359-
360-
{{% hiddencontent %}}
361-
You can use any Viam SDK to implement a camera module, but only Go-based modules can access optimized video streaming over WebRTC.
362-
{{% /hiddencontent %}}
363-
364-
**Solution:** This warning can be safely ignored.
365-
366376
## Known application and plugin conflicts
367377

368378
### macOS applications

0 commit comments

Comments
 (0)