DOCS-4189: Improve camera troubleshooting (#4479)

Author: npentrel

docs/dev/tools/common-errors.md

@@ -119,7 +119,7 @@ sudo apt install jackd qjackctl libpulse-dev pulseaudio
 
 This error can be safely ignored if you do not intend to use audio on your machine.
 
-## Common errors using the web UI
+## Common errors between `viam-server` and Viam
 
 ### Failed to connect; retrying
 
@@ -143,6 +143,21 @@ When a machine is disconnected, it will continue to run with its locally-cached
     grep 'viam-server' /var/log/syslog | tail -50
     ```
 
+### Error: error connecting to peer, error not connected
+
+**Full Error:** `error connecting to peer   error not connected`
+
+**Description:** This error indicates a networking or connection issue.
+
+**Solution:**
+
+1. Verify your machine's internet connection is stable and working properly.
+1. Ensure your machine is using the correct machine cloud credentials.
+   You can obtain your machine cloud credentials from the machine's status in the part status dropdown to the right of your machine’s name on the top of the page.
+1. If you are using API keys to connect, ensure you are using the correct credentials for the machine.
+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.
+
 ### Error: cannot parse config: JSON: cannot unmarshal string into Go struct
 
 **Full Error:** `Error: cannot parse config: JSON: cannot unmarshal string into Go struct field Component.components.frame of type float64.`
@@ -171,20 +186,32 @@ In **JSON** mode, it will resemble the following:
 
 **Full Error:**
 
+Generalized example::
+
+```sh {class="command-line" data-prompt="$" data-output="1-10"}
+resource build error: unknown resource type: API "<API-TRIPLET>" with model "<MODEL-TRIPLET>" not registered
+```
+
+Camera example:
+
 ```sh {class="command-line" data-prompt="$" data-output="1-10"}
-error rdk.resource_manager.rdk:<RESOURCE-IDENTIFIER>   resource/graph_node.go:297   resource build error: unknown resource type: API "<API-TRIPLET>" with model "<MODEL-TRIPLET>" not registered   resource <RESOURCE-IDENTIFIER>  model <MODEL-TRIPLET>
+resource build error: unknown resource type: API "rdk:component:camera" with model "viam:orbbec:astra2" not registered.
 ```
 
 **Description:** This error occurs when your configuration requests a model with an associated API and the combination of model name and API triplet is not registered with viam-server.
 
 **Solution:**
 
-- **Module Installation**: For registry-provided models, ensure that your machine's configuration includes the module.
-- **Model Triplet Verification**: Check for typos in the model triplet.
-  It must exactly match the model registered with `viam-server`.
-  For registry-provided models, you can find the correct model triplet (for example `viam:camera:csi-pi`) in the **Components & services** section of the registry page.
-- **API Compatibility**: Ensure the selected model supports the requested API. You can find the requested APIs next to each model entry in the **Components & services** section of the registry page.
-- **API Triplet Verification**: Check for typos in the API triplet (for example `rdk:component:camera`).
+1. If you are using a registry-provided models, ensure that your machine's configuration includes the module that provides the model.
+   On your machine page, find the module and navigate to it's module page in the registry.
+   You can find the correct model triplet (for example `viam:camera:csi-pi`) in the **Components & services** section of the registry page.
+1. Check for typos in the model triplet.
+   It must exactly match the model registered with `viam-server`.
+1. Ensure the model supports the requested API.
+   You can find the requested APIs next to each model entry in the **Components & services** section of the registry page.
+1. Check for typos in the API triplet (for example `rdk:component:camera`).
+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.
 
 ### Accidental deletion of machines, locations, organizations, or accounts
 

docs/operate/reference/components/arm/_index.md

@@ -78,8 +78,9 @@ The frame system allows the motion service to calculate where any component of y
 If your arm is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your arm model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the arm there.
+1. Review your arm model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the arm there.
+1. Disconnect and reconnect your arm.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/button/_index.md

@@ -52,8 +52,9 @@ The [button API](/dev/reference/apis/components/button/) supports the following
 If your button is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your button model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the button there.
+1. Review your button model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the button there.
+1. Disconnect and reconnect your button.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/camera/_index.md

@@ -67,9 +67,9 @@ The [camera API](/dev/reference/apis/components/camera/) supports the following
 If your camera is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-
-2. Review your camera model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the camera there.
+1. Review your camera model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the camera there.
+1. Disconnect and reconnect your camera.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/component/_index.md

@@ -76,8 +76,9 @@ _Use an included snippet so you can add it to <file>/program/apis/</file>._
 If your COMPONENT is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your COMPONENT model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the COMPONENT there.
+1. Review your COMPONENT model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the COMPONENT there.
+1. Disconnect and reconnect your COMPONENT.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/gantry/_index.md

@@ -68,8 +68,9 @@ The [gantry API](/dev/reference/apis/components/gantry/) supports the following
 If your gantry is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your gantry model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the gamtry there.
+1. Review your gantry model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the gamtry there.
+1. Disconnect and reconnect your gantry.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/generic/_index.md

@@ -83,8 +83,8 @@ The [generic API](/dev/reference/apis/components/generic/) supports the followin
 If your generic component is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your generic component model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the generic component there.
+1. Review your generic component model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the generic component there.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/gripper/_index.md

@@ -59,8 +59,9 @@ The [gripper API](/dev/reference/apis/components/gripper/) supports the followin
 If your gripper is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your gripper model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the gripper there.
+1. Review your gripper model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the gripper there.
+1. Disconnect and reconnect your gripper.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/input-controller/_index.md

@@ -67,8 +67,9 @@ The [input controller API](/dev/reference/apis/components/input-controller/) sup
 If your input controller is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your input controller model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the input controller there.
+1. Review your input controller model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the input controller there.
+1. Disconnect and reconnect your input controller.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
 

docs/operate/reference/components/movement-sensor/_index.md

@@ -73,8 +73,9 @@ You can run `GetProperties` on your sensor for a list of its supported methods.
 If your movement sensor is not working as expected, follow these steps:
 
 1. Check your machine logs on the **LOGS** tab to check for errors.
-2. Review your movement sensor model's documentation to ensure you have configured all required attributes.
-3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the movement sensor there.
+1. Review your movement sensor model's documentation to ensure you have configured all required attributes.
+1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the movement sensor there.
+1. Disconnect and reconnect your movement sensor.
 
 If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.