espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-07-28 14:47:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] add documentation for CLI dataset updater command (#9905)

Browse Source
This commit is contained in:
Abtin Keshavarzian
2024-03-11 11:29:21 -07:00
committed by GitHub
parent 518a849495
commit 2b4b2cfe63
2 changed files with 169 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cli/cli_dataset.cpp
+45
View File
@@ -1154,10 +1154,46 @@ template <> otError Dataset::Process<Cmd("updater")>(Arg aArgs[])
{
otError error = OT_ERROR_NONE;
/**
* @cli dataset updater
* @code
* dataset updater
* Enabled
* Done
* @endcode
* @par api_copy
* #otDatasetUpdaterIsUpdateOngoing
*/
if (aArgs[0].IsEmpty())
{
OutputEnabledDisabledStatus(otDatasetUpdaterIsUpdateOngoing(GetInstancePtr()));
}
/**
* @cli dataset updater start
* @code
* channel
* 19
* Done
* dataset clear
* Done
* dataset channel 15
* Done
* dataset
* Channel: 15
* Done
* dataset updater start
* Done
* dataset updater
* Enabled
* Done
* Dataset update complete: OK
* channel
* 15
* Done
* @endcode
* @par api_copy
* #otDatasetUpdaterRequestUpdate
*/
else if (aArgs[0] == "start")
{
otOperationalDataset dataset;
@@ -1166,6 +1202,15 @@ template <> otError Dataset::Process<Cmd("updater")>(Arg aArgs[])
SuccessOrExit(
error = otDatasetUpdaterRequestUpdate(GetInstancePtr(), &dataset, &Dataset::HandleDatasetUpdater, this));
}
/**
* @cli dataset updater cancel
* @code
* @dataset updater cancel
* Done
* @endcode
* @par api_copy
* #otDatasetUpdaterCancelUpdate
*/
else if (aArgs[0] == "cancel")
{
otDatasetUpdaterCancelUpdate(GetInstancePtr());