1 /*
2  *  Copyright (c) 2019, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *   This file includes the abstraction for the platform OTNS utilities.
33  *
34  *   OTNS is an OpenThread Network Simulator that simulates Thread networks using OpenThread simulation instances and
35  *   provides visualization and management of those simulated networks.
36  *   Refer to https://github.com/openthread/ot-ns for more information about OTNS.
37  */
38 
39 #ifndef OPENTHREAD_PLATFORM_OTNS_H_
40 #define OPENTHREAD_PLATFORM_OTNS_H_
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /**
47  * @addtogroup plat-otns
48  *
49  * @brief
50  *   This module includes the platform abstraction for OTNS.
51  *
52  * @{
53  *
54  */
55 
56 /**
57  * This function exports status information to OTNS.
58  *
59  * The status information is represented by a null-terminated string with format recognizable by OTNS.
60  * Each call to `otPlatOtnsStatus` can send multiple statuses, separated by ';', e.x. "parid=577fbc37;lrid=5".
61  * Each status contains key and value separated by '='.
62  * Status value can be further separated into multiple fields using ',',
63  * e.x. "ping_request=fdde:ad00:beef:0:459e:d7b4:b65e:5480,4,112000".
64  *
65  * New statuses should follow these conventions.
66  *
67  * Currently, OTNS only supports virtual time simulation.
68  *
69  * @param[in]  aStatus  The status string.
70  *
71  */
72 void otPlatOtnsStatus(const char *aStatus);
73 
74 /**
75  * @}
76  *
77  */
78 
79 #ifdef __cplusplus
80 } // extern "C"
81 #endif
82 
83 #endif // OPENTHREAD_PLATFORM_OTNS_H_
84