Update trigger sync page #3652
Update trigger sync page #3652
Conversation
viambot
added
the
safe to build
docs/how-tos/trigger-sync.md
Outdated
| @@ -28,7 +28,7 @@ You can use it as the basis of your own custom logic. | |||
|
|
|||
| {{% alert title="In this page" color="tip" %}} | |||
|
|
|||
| 1. [Use the `CreateShouldSyncReading` function to enable sync](#use-the-createshouldsyncreading-function-to-enable-sync) | |||
| 1. [Return `should_sync` as a reading from a sensor](#return-should_sync-as-a-reading-from-a-sensor) | |||
There was a problem hiding this comment.
If builtin data manager is configured with a sync sensor, data manager will only sync on the sync interval if the syncs sensor's Readings method returns a successful response and that response has a "should_sync" key
in it with a value of true.
Otherwise, a builtin data manager will not sync on the sync interval.
There was a problem hiding this comment.
I've adjusted the descriptions below a bit - what you commented on is really only a table of contents - so not really a place to explain this further.
There was a problem hiding this comment.
We can change the headers if you have a better suggestion?
Thanks for the code changes - that's a lot cleaner
Co-authored-by: nicksanford <[email protected]>
Why are these green lines in the docs? |
|
|
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3652 |
https://docs-test.viam.dev/3652/how-tos/trigger-sync/#return-should_sync-as-a-reading-from-a-sensor