Skip to content

Commit e260850

Browse files
Damian-Nordicrlubos
authored andcommitted
doc: update OpenThread RPC doc
1. Update the list of supported functions. 2. Update API documentation section to mention API additions. Signed-off-by: Damian Krolik <[email protected]>
1 parent 63ffbb9 commit e260850

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

doc/nrf/libraries/networking/ot_rpc.rst

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,25 @@ OpenThread RPC currently supports the serialization of the following OpenThread
151151
* :c:func:`otSrpClientDisableAutoStartMode`
152152
* :c:func:`otSrpClientEnableAutoHostAddress`
153153
* :c:func:`otSrpClientEnableAutoStartMode`
154+
* :c:func:`otSrpClientGetHostInfo`
155+
* :c:func:`otSrpClientGetKeyLeaseInterval`
156+
* :c:func:`otSrpClientGetLeaseInterval`
157+
* :c:func:`otSrpClientGetServerAddress`
158+
* :c:func:`otSrpClientGetServices`
159+
* :c:func:`otSrpClientGetTtl`
160+
* :c:func:`otSrpClientIsAutoStartModeEnabled`
161+
* :c:func:`otSrpClientIsRunning`
162+
* :c:func:`otSrpClientItemStateToString`
154163
* :c:func:`otSrpClientRemoveHostAndServices`
155164
* :c:func:`otSrpClientRemoveService`
156165
* :c:func:`otSrpClientSetCallback`
166+
* :c:func:`otSrpClientSetHostAddresses`
157167
* :c:func:`otSrpClientSetHostName`
158168
* :c:func:`otSrpClientSetKeyLeaseInterval`
159169
* :c:func:`otSrpClientSetLeaseInterval`
160170
* :c:func:`otSrpClientSetTtl`
171+
* :c:func:`otSrpClientStart`
172+
* :c:func:`otSrpClientStop`
161173
* :c:func:`otThreadDiscover`
162174
* :c:func:`otThreadErrorToString`
163175
* :c:func:`otThreadGetDeviceRole`
@@ -170,20 +182,21 @@ OpenThread RPC currently supports the serialization of the following OpenThread
170182
* :c:func:`otThreadGetNetworkName`
171183
* :c:func:`otThreadGetNextDiagnosticTlv`
172184
* :c:func:`otThreadGetPartitionId`
173-
* :c:func:`otThreadGetVendorName`
174185
* :c:func:`otThreadGetVendorModel`
186+
* :c:func:`otThreadGetVendorName`
175187
* :c:func:`otThreadGetVendorSwVersion`
176188
* :c:func:`otThreadGetVersion`
177189
* :c:func:`otThreadSendDiagnosticGet`
178190
* :c:func:`otThreadSendDiagnosticReset`
179191
* :c:func:`otThreadSetEnabled`
180192
* :c:func:`otThreadSetLinkMode`
181-
* :c:func:`otThreadSetVendorName`
182193
* :c:func:`otThreadSetVendorModel`
194+
* :c:func:`otThreadSetVendorName`
183195
* :c:func:`otThreadSetVendorSwVersion`
184196
* :c:func:`otUdpBind`
185197
* :c:func:`otUdpClose`
186198
* :c:func:`otUdpConnect`
199+
* :c:func:`otUdpIsOpen`
187200
* :c:func:`otUdpNewMessage`
188201
* :c:func:`otUdpOpen`
189202
* :c:func:`otUdpSend`
@@ -203,5 +216,12 @@ The libraries have the following dependencies:
203216
API documentation
204217
*****************
205218

206-
This library does not define a new OpenThread API.
219+
This library is an implementation of the existing OpenThread C API.
207220
Please refer to `OpenThread Reference`_ for the OpenThread C API documentation.
221+
222+
In addition, the library also implements some API additions.
223+
224+
| Header file: :file:`include/net/ot_rpc.h`
225+
| Source files: :file:`subsys/net/openthread/rpc`
226+
227+
.. doxygengroup:: ot_rpc

0 commit comments

Comments
 (0)