DOCS-1499: Document dual-gps-rtk model of movement sensor
#2594
Conversation
sguequierre
commented
Feb 27, 2024
sguequierre
commented
- Adds new model
viambot
added
the
safe to build
|
Overall readability score: 55.58 (🔴 -0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
| --- | ||
|
|
||
| The `dual-gps-rtk` model of movement sensor calculates compass heading from two gps movement sensors. | ||
| In addition to [`CompassHeading()`](/components/movement-sensor/#getcompassheading), this model provides data for [`GetPosition()`](/components/movement-sensor/#getposition). |
There was a problem hiding this comment.
| In addition to [`CompassHeading()`](/components/movement-sensor/#getcompassheading), this model provides data for [`GetPosition()`](/components/movement-sensor/#getposition). | |
| In addition to [`CompassHeading()`](/components/movement-sensor/#getcompassheading), this model provides data for [`Position()`](/components/movement-sensor/#getposition). |
Either use Get as a prepend for both or don't. The go APIs follow the go style of not prefixing Get to the API function names, the other SDKs do.
There was a problem hiding this comment.
Sounds good-- will use Get to match docs I think
| <!-- prettier-ignore --> | ||
| | Name | Type | Inclusion | Description | | ||
| | ---- | ---- | --------- | ----------- | | ||
| | `first_gps` | int | **Required** | The name you have configured for the first movement sensor you want to combine the measurements from. Must be a `GPS` model. | |
There was a problem hiding this comment.
Technically we're only checking if the movement sensor is position reporting in the code, but I doubt this model will be useful for non-GPS position reporting sensors such as wheeled odometry, SLAM algorithms or optical trackers.
There was a problem hiding this comment.
Should I specify position reporting then, or leave as is?
Co-authored-by: randhid <[email protected]>
There was a problem hiding this comment.
This image is rendering with a bit of a blur, but it's not intense at all.
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2594 |
