DOCS-1825: Document teleop page as how-to #3675
Conversation
sguequierre
commented
Nov 14, 2024
sguequierre
commented
- creates a simple how-to for teleop
- leaves the question of which widgets up to their machine but explores creating all 4 types of widgets
viambot
added
the
safe to build
| - A [movement sensor](/components/movement-sensor/) | ||
| - A [sensor](/components/sensor/) | ||
|
|
||
| See [configure a machine](/how-tos/configure/) for more information. |
There was a problem hiding this comment.
figure this covers device requirements and viam app requirements? lmk and I can add more but this isn't a super basic thing to do with viam so I figured a tiny bit of cross-linking was ok
| - A [movement sensor](/components/movement-sensor/) | ||
| - A [sensor](/components/sensor/) | ||
|
|
||
| See [configure a machine](/how-tos/configure/) for more information. |
|
|
||
| - If you have a movement sensor, select a **GPS map**, which allows you to map the location of a machine. | ||
| Enter the name of your movement sensor. | ||
| Toggle **Historic positions** to on to see how position has changed over time. |
There was a problem hiding this comment.
did you test this? Does this create a heatmap or how is this visualized?
There was a problem hiding this comment.
yes, it creates a line I believe from starting position to end. like this:
| Toggle **Historic positions** to on to see how position has changed over time. | ||
|
|
||
| - If you have a sensor, select **Stat** to view a single sensor value. | ||
| Enter the name of the sensor for **Sensor name** and enter the key for the value in **Path**, for example `time_unix`. |
There was a problem hiding this comment.
I think for these it would be good to add a tip for people trying to figure out how to get the path (go to machine's test panel and check the returned json object. should probably also include what to do if it's inside another object)
However, this should ideally be a tooltip in the app. Please file the appropriate ticket with a suggestion for copy.
There was a problem hiding this comment.
They are going to make it selectable from a dropdown so I think it's not worth filing that as it would quickly be deprecated, does that make sense? @npentrel
| Click **Add widget** and select the appropriate widget for your machine. | ||
| Repeat as many times as necessary. | ||
|
|
||
| - If you have a camera, select **Camera stream**, which allows you to view a camera stream. |
There was a problem hiding this comment.
I don't think these should be needed. The UI should be self explanatory from here, shouldn't it? If it isn't this is a place where we should work with Product to improve the UI instead. See notes below
There was a problem hiding this comment.
Do you mean to suggest removing all of these bullets? Just want to be sure. I agree the UI should be self explanatory
Co-authored-by: Naomi Pentrel <[email protected]>
Co-authored-by: Naomi Pentrel <[email protected]>
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3675 |
