xref: /aosp_15_r20/external/openthread/tests/toranj/ncp/test-001-get-set.py (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1#!/usr/bin/env python3
2#
3#  Copyright (c) 2018, The OpenThread Authors.
4#  All rights reserved.
5#
6#  Redistribution and use in source and binary forms, with or without
7#  modification, are permitted provided that the following conditions are met:
8#  1. Redistributions of source code must retain the above copyright
9#     notice, this list of conditions and the following disclaimer.
10#  2. Redistributions in binary form must reproduce the above copyright
11#     notice, this list of conditions and the following disclaimer in the
12#     documentation and/or other materials provided with the distribution.
13#  3. Neither the name of the copyright holder nor the
14#     names of its contributors may be used to endorse or promote products
15#     derived from this software without specific prior written permission.
16#
17#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27#  POSSIBILITY OF SUCH DAMAGE.
28
29from wpan import verify
30import wpan
31
32# -----------------------------------------------------------------------------------------------------------------------
33# Test description: simple wpanctl get and set commands
34
35test_name = __file__[:-3] if __file__.endswith('.py') else __file__
36print('-' * 120)
37print('Starting \'{}\''.format(test_name))
38
39# -----------------------------------------------------------------------------------------------------------------------
40# Creating `wpan.Nodes` instances
41
42node = wpan.Node()
43
44# -----------------------------------------------------------------------------------------------------------------------
45# Init all nodes
46
47wpan.Node.init_all_nodes()
48
49# -----------------------------------------------------------------------------------------------------------------------
50# Test implementation
51
52verify(node.get(wpan.WPAN_STATE) == wpan.STATE_OFFLINE)
53
54# set some of properties and check and verify that the value is indeed
55# changed...
56
57node.set(wpan.WPAN_NAME, 'test-network')
58verify(node.get(wpan.WPAN_NAME) == '"test-network"')
59
60node.set(wpan.WPAN_NAME, 'a')
61verify(node.get(wpan.WPAN_NAME) == '"a"')
62
63node.set(wpan.WPAN_PANID, '0xABBA')
64verify(node.get(wpan.WPAN_PANID) == '0xABBA')
65
66node.set(wpan.WPAN_XPANID, '1020031510006016', binary_data=True)
67verify(node.get(wpan.WPAN_XPANID) == '0x1020031510006016')
68
69node.set(wpan.WPAN_KEY, '0123456789abcdeffecdba9876543210', binary_data=True)
70verify(node.get(wpan.WPAN_KEY) == '[0123456789ABCDEFFECDBA9876543210]')
71
72node.set(wpan.WPAN_MAC_ALLOWLIST_ENABLED, '1')
73verify(node.get(wpan.WPAN_MAC_ALLOWLIST_ENABLED) == 'true')
74
75node.set(wpan.WPAN_MAC_ALLOWLIST_ENABLED, '0')
76verify(node.get(wpan.WPAN_MAC_ALLOWLIST_ENABLED) == 'false')
77
78node.set(wpan.WPAN_MAC_ALLOWLIST_ENABLED, 'true')
79verify(node.get(wpan.WPAN_MAC_ALLOWLIST_ENABLED) == 'true')
80
81node.set(wpan.WPAN_THREAD_ROUTER_UPGRADE_THRESHOLD, '100')
82verify(int(node.get(wpan.WPAN_THREAD_ROUTER_UPGRADE_THRESHOLD), 0) == 100)
83
84node.set(wpan.WPAN_THREAD_ROUTER_DOWNGRADE_THRESHOLD, '40')
85verify(int(node.get(wpan.WPAN_THREAD_ROUTER_DOWNGRADE_THRESHOLD), 0) == 40)
86
87# Ensure `get` is successful with all gettable properties
88
89all_gettable_props = [
90    wpan.WPAN_STATE,
91    wpan.WPAN_NAME,
92    wpan.WPAN_PANID,
93    wpan.WPAN_XPANID,
94    wpan.WPAN_KEY,
95    wpan.WPAN_CHANNEL,
96    wpan.WPAN_HW_ADDRESS,
97    wpan.WPAN_EXT_ADDRESS,
98    wpan.WPAN_POLL_INTERVAL,
99    wpan.WPAN_NODE_TYPE,
100    wpan.WPAN_ROLE,
101    wpan.WPAN_PARTITION_ID,
102    wpan.WPAN_NCP_VERSION,
103    wpan.WPAN_NCP_MCU_POWER_STATE,
104    wpan.WPAN_NETWORK_PASSTHRU_PORT,
105    wpan.WPAN_IP6_LINK_LOCAL_ADDRESS,
106    wpan.WPAN_IP6_MESH_LOCAL_ADDRESS,
107    wpan.WPAN_IP6_MESH_LOCAL_PREFIX,
108    wpan.WPAN_IP6_ALL_ADDRESSES,
109    wpan.WPAN_IP6_MULTICAST_ADDRESSES,
110    wpan.WPAN_THREAD_RLOC16,
111    wpan.WPAN_THREAD_ROUTER_ID,
112    wpan.WPAN_THREAD_NETWORK_DATA,
113    wpan.WPAN_THREAD_CHILD_TABLE,
114    wpan.WPAN_THREAD_CHILD_TABLE_ASVALMAP,
115    wpan.WPAN_THREAD_CHILD_TABLE_ADDRESSES,
116    wpan.WPAN_THREAD_NEIGHBOR_TABLE,
117    wpan.WPAN_THREAD_NEIGHBOR_TABLE_ASVALMAP,
118    wpan.WPAN_THREAD_NEIGHBOR_TABLE_ERR_RATES,
119    wpan.WPAN_THREAD_ROUTER_TABLE,
120    wpan.WPAN_THREAD_ROUTER_TABLE_ASVALMAP,
121    wpan.WPAN_THREAD_CHILD_TIMEOUT,
122    wpan.WPAN_THREAD_NETWORK_DATA_VERSION,
123    wpan.WPAN_THREAD_STABLE_NETWORK_DATA,
124    wpan.WPAN_THREAD_STABLE_NETWORK_DATA_VERSION,
125    wpan.WPAN_THREAD_DEVICE_MODE,
126    wpan.WPAN_THREAD_OFF_MESH_ROUTES,
127    wpan.WPAN_THREAD_ON_MESH_PREFIXES,
128    wpan.WPAN_THREAD_ROUTER_ROLE_ENABLED,
129    wpan.WPAN_THREAD_CONFIG_FILTER_RLOC_ADDRESSES,
130    wpan.WPAN_THREAD_ROUTER_UPGRADE_THRESHOLD,
131    wpan.WPAN_THREAD_ROUTER_DOWNGRADE_THRESHOLD,
132    wpan.WPAN_THREAD_ACTIVE_DATASET,
133    wpan.WPAN_THREAD_ACTIVE_DATASET_ASVALMAP,
134    wpan.WPAN_THREAD_PENDING_DATASET,
135    wpan.WPAN_THREAD_PENDING_DATASET_ASVALMAP,
136    wpan.WPAN_OT_LOG_LEVEL,
137    wpan.WPAN_OT_STEERING_DATA_ADDRESS,
138    wpan.WPAN_OT_STEERING_DATA_SET_WHEN_JOINABLE,
139    wpan.WPAN_OT_MSG_BUFFER_COUNTERS,
140    wpan.WPAN_OT_MSG_BUFFER_COUNTERS_AS_STRING,
141    wpan.WPAN_NCP_COUNTER_ALL_MAC,
142    wpan.WPAN_NCP_COUNTER_ALL_MAC_ASVALMAP,
143    wpan.WPAN_MAC_ALLOWLIST_ENABLED,
144    wpan.WPAN_MAC_ALLOWLIST_ENTRIES,
145    wpan.WPAN_MAC_ALLOWLIST_ENTRIES_ASVALMAP,
146    wpan.WPAN_MAC_DENYLIST_ENABLED,
147    wpan.WPAN_MAC_DENYLIST_ENTRIES,
148    wpan.WPAN_MAC_DENYLIST_ENTRIES_ASVALMAP,
149    wpan.WPAN_JAM_DETECTION_STATUS,
150    wpan.WPAN_JAM_DETECTION_ENABLE,
151    wpan.WPAN_JAM_DETECTION_RSSI_THRESHOLD,
152    wpan.WPAN_JAM_DETECTION_WINDOW,
153    wpan.WPAN_JAM_DETECTION_BUSY_PERIOD,
154    wpan.WPAN_JAM_DETECTION_DEBUG_HISTORY_BITMAP,
155    wpan.WPAN_CHANNEL_MONITOR_SAMPLE_INTERVAL,
156    wpan.WPAN_CHANNEL_MONITOR_RSSI_THRESHOLD,
157    wpan.WPAN_CHANNEL_MONITOR_SAMPLE_WINDOW,
158    wpan.WPAN_CHANNEL_MONITOR_SAMPLE_COUNT,
159    wpan.WPAN_CHANNEL_MONITOR_CHANNEL_QUALITY,
160    wpan.WPAN_CHANNEL_MONITOR_CHANNEL_QUALITY_ASVALMAP,
161    wpan.WPAN_CHANNEL_MANAGER_NEW_CHANNEL,
162    wpan.WPAN_CHANNEL_MANAGER_DELAY,
163    wpan.WPAN_CHANNEL_MANAGER_CHANNEL_SELECT,
164    wpan.WPAN_CHANNEL_MANAGER_AUTO_SELECT_ENABLED,
165    wpan.WPAN_CHANNEL_MANAGER_AUTO_SELECT_INTERVAL,
166    wpan.WPAN_CHANNEL_MANAGER_SUPPORTED_CHANNEL_MASK,
167    wpan.WPAN_CHANNEL_MANAGER_FAVORED_CHANNEL_MASK,
168    wpan.WPAN_THREAD_LEADER_ADDRESS,
169    wpan.WPAN_THREAD_LEADER_ROUTER_ID,
170    wpan.WPAN_THREAD_LEADER_WEIGHT,
171    wpan.WPAN_THREAD_LEADER_LOCAL_WEIGHT,
172    wpan.WPAN_THREAD_LEADER_NETWORK_DATA,
173    wpan.WPAN_THREAD_STABLE_LEADER_NETWORK_DATA,
174]
175
176# note: Partition Id only takes effect after forming one Thread network.
177node.set(wpan.WPAN_PARTITION_ID, '12345678')
178
179node.form('get-set')
180
181# verify that Partition Id property is indeed changed.
182verify(int(node.get(wpan.WPAN_PARTITION_ID), 0) == 12345678)
183
184for prop in all_gettable_props:
185    node.get(prop)
186
187# -----------------------------------------------------------------------------------------------------------------------
188# Test finished
189
190wpan.Node.finalize_all_nodes()
191
192print('\'{}\' passed.'.format(test_name))
193