Skip to content

Commit

Permalink
Merge pull request #20 from viam-modules/readme-inline-updates
Browse files Browse the repository at this point in the history
update readmes
  • Loading branch information
randhid authored Feb 5, 2025
2 parents 064b1ed + 9bcd440 commit d5276b3
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ On the new component panel, copy and paste the following attribute template into
"width_px": <int>,
"height_px": <int>,
"frame_rate": <int>,
"debug": <bool>
}
```

Expand All @@ -51,7 +50,7 @@ Edit the attributes as applicable and save your config.
In the **Control** tab of the [Viam app](https://app.viam.com/), you can now view the camera feed.
If you do not see anything, check the logs tab for errors.

### Attributes
#### Attributes

The following attributes are available for `viam:camera:csi` cameras:

Expand All @@ -61,7 +60,6 @@ The following attributes are available for `viam:camera:csi` cameras:
| `height_px` | int | Optional | Height of the image this camera captures in pixels. <br> Default: `1080` |
| `frame_rate` | int | Optional | The image capture frame rate this camera should use. <br> Default: `30` |
| `video_path` | string | Optional | The filepath to the input sensor of this camera on your board. If none is given, your robot will attempt to detect the video path automatically. <br> Default: `"0"` </br> |
| `debug` | boolean | Optional | Whether or not you want debug input from this camera in your robot's logs. <br> Default: `false` |

Once configured, check the [Logs tab](https://docs.viam.com/program/debug/) of your robot in the Viam app to make sure your camera has connected and no errors are being raised.

Expand Down
4 changes: 3 additions & 1 deletion meta-pi.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"models": [
{
"api": "rdk:component:camera",
"model": "viam:camera:csi-pi"
"model": "viam:camera:csi-pi",
"markdown_link": "README.md#configure-your-csi-camera",
"description" :"A module for the CSI camera"
}
],
"entrypoint": "./bin/viam-csi-latest-aarch64.AppImage"
Expand Down
4 changes: 3 additions & 1 deletion meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"models": [
{
"api": "rdk:component:camera",
"model": "viam:camera:csi"
"model": "viam:camera:csi",
"markdown_link": "README.md#configure-your-csi-camera",
"description" :"A module for the CSI camera"
}
],
"entrypoint": "./bin/viam-csi-latest-aarch64.AppImage"
Expand Down

0 comments on commit d5276b3

Please sign in to comment.