-
Notifications
You must be signed in to change notification settings - Fork 12
/
wiseconnect3.xapi
2459 lines (2459 loc) · 114 KB
/
wiseconnect3.xapi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<api xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="api.xsd" device_id="7" device_name="wifi">
<types>
<type name="errorcode" datatype="uint16" length="2">
<description>
SL_STATUS_OK if successful. Error code otherwise.
</description>
</type>
<type datatype="uint16" name="uint16" length="2">
<description>
Unsigned 16-bit integer
</description>
</type>
<type datatype="uint32" name="uint32" length="4">
<description>
Unsigned 32-bit integer
</description>
</type>
<type datatype="uint8" name="uint8" length="1">
<description>
Unsigned 8-bit integer
</description>
</type>
<type datatype="uint8array" name="uint8array" length="1">
<description>
Variable length byte array. The first byte defines the length
of data that follows, 0 - 255 bytes.
</description>
</type>
<type datatype="uint16array" name="uint16array" length="2">
<description>
Variable length byte array. The first two bytes of uint16 type define the length of data that
follows, 0 - 65535 bytes.
</description>
</type>
<type name="byte_array" datatype="byte_array" length="0">
<description>
Fixed length byte array. The length of array must be specified with length attribute of
derived data type. Note that this is a base type and it shouldn't be used in type
value of param directly.
</description>
</type>
<type datatype="bd_addr" name="mac_address" length="6">
<description>
Bluetooth address
</description>
</type>
<type name="ipv4_address" datatype="uint32" length="4">
<description>
Description
</description>
</type>
<type name="ipv6_address" datatype="uuid_128" length="16">
<description>
Description
</description>
</type>
<type name="api_ssid" datatype="uint8array" length="32">
<description>
Description
</description>
</type>
<type name="bssid" datatype="uint8array" length="6">
<description>
Array representing the BSSID (MAC address) consisting of 6 bytes.
</description>
</type>
<type name="api_credential" datatype="uint8array" length="32">
<description>
Credential data object.
</description>
</type>
</types>
<overviewdoc title="Overview">
<section title="Wi-Fi API Payload">
The parameters of a xAPI command, response, or event are passed between the application and module in a
payload. For example, a parameter of uint32 type uses 4 bytes of the payload space. A byte array parameter
uses one byte to describe the length of the array. Data in the array is copied into the remaining free
payload space.
</section>
</overviewdoc>
<class name="system" index="0x00" title="System">
<description>
Commands and events in this class can be used to access and query the local device.
</description>
<event name="boot" index="0x00">
<description>
Indicates that the device has started and the radio is ready. This event carries the module build number.
</description>
<params>
<param name="major" type="uint16">
<description>
Major release version.
</description>
</param>
<param name="minor" type="uint16">
<description>
Minor release version.
</description>
</param>
<param name="patch" type="uint16">
<description>
Patch release number.
</description>
</param>
</params>
</event>
<event name="error" index="0x01">
<description>
Indicates that an error has occurred.
</description>
<params>
<param name="reason" type="errorcode">
<description>
Error code from module.
</description>
</param>
<param name="data" type="uint8array">
<description>
Data related to the error; this field can be empty.
</description>
</param>
</params>
</event>
<command name="hello" index="0x00">
<description>
Verifies whether the communication between the host and the device is functional.
</description>
<params/>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="echo" index="0x01">
<description>
Verifies whether the communication between the host and the device is functional by echoing the number sent from the host to the module.
</description>
<params>
<param name="number_in" type="uint32">
<description>
Number to be echoed.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
<param name="number_out" type="uint32">
<description>
Echoed number.
</description>
</param>
</returns>
</command>
<command name="reset" index="0x02" title="reset" no_return="true">
<description>
Soft resets device
</description>
<params/>
<returns/>
</command>
</class>
<class name="net_intf" index="0x11" title="Network Interface">
<description>
Commands and Events in this class performs essential operations for managing and controlling network interfaces. They handle initialization, configuration, starting, and stopping of these interfaces, ensuring efficient utilization within the system.
Note: Currently only access point interface is supported.
</description>
<enums name="interface" title="interface">
<description>
Enumeration of available network interface types.
</description>
<enum name="interface_client" value="0x08" title="Client Interface">
<description>
Wi-Fi Client Interface (not currently supported).
</description>
</enum>
<enum name="interface_ap" value="0x10" title="Access Point Interface">
<description>
Wi-Fi Access Point Interface. This is the only currently supported interface for network operations.
</description>
</enum>
<enum name="interface_ethernet" value="0x18" title="Ethernet Interface">
<description>
Ethernet Interface (not currently supported).
</description>
</enum>
<enum name="interface_thread" value="0x20" title="Thread Interface">
<description>
Thread Interface (not currently supported).
</description>
</enum>
<enum name="interface_bluetooth" value="0x28" title="Bluetooth Interface">
<description>
Bluetooth Interface (not currently supported).
</description>
</enum>
<enum name="interface_zwave" value="0x30" title="Z-Wave Interface">
<description>
Z-Wave Interface (not currently supported).
</description>
</enum>
</enums>
<enums name="profile_id" title="profile_id">
<description>
Enumeration of profile IDs for various network profiles.
</description>
<enum name="profile_id_default_wifi_ap_profile" value="0" title="Wi-Fi Access Point Default Profile">
<description>
Default profile for Wi-Fi Access Point configuration.
</description>
</enum>
</enums>
<command name="init" index="0x00">
<description>
Initializes the specified network interface, allocating the necessary resources for its operation. After initialization, the user will begin receiving callbacks related to network and Wi-Fi events. For the AP_INTERFACE, this function sets up the Wi-Fi driver, configures the network processor (NWP), and prepares the interface for use.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to be initialized. Currently only AP_INTERFACE is supported.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="deinit" index="0x01">
<description>
De-initializes the specified network interface, releasing any resources allocated during initialization. After this operation, the user will not receive callbacks related to network events. For the AP_INTERFACE, this function ensures proper shutdown of the Wi-Fi driver, performs a soft reset of the NWP, and releases allocated resources.
Note: Please ensure that sl_wifi_net_intf_init is called before using this API.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to be deinitialized. Currently only AP_INTERFACE is supported.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="up" index="0x02">
<description>
Brings the specified network interface up using the given profile ID, enabling the interface for operation.
By default, profile and credential configurations in sl_net_defaults.h are used by SDK.
The user can define their profile and credential configurations for an interface by calling APIs in network profile and network credential before calling sl_wifi_net_intf_up API.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to bring up.
</description>
</param>
<param name="profile_id" type="uint8" enum="net_intf_profile_id">
<description>
profile ID to use for configuring the network interface.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="down" index="0x03">
<description>
Brings the specified network interface down, disabling it and releasing its resources.
sl_wifi_net_intf_up should be called before this API to ensure the interface is active before attempting to bring it down.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to bring down.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="set_device_config" index="0x04">
<description>
Sets si91x device configuration of the device.
</description>
<params>
<param name="boot_option" type="uint8" enum="net_intf_boot_option">
<description>
Boot option, which specifies the type of firmware to be loaded for the si91x devices.
</description>
</param>
<param name="mac_address_octet_0" type="uint8">
<description>
First octet of the mac address.
</description>
</param>
<param name="mac_address_octet_1" type="uint8">
<description>
Second octet of the mac address.
</description>
</param>
<param name="mac_address_octet_2" type="uint8">
<description>
Third octet of the mac address.
</description>
</param>
<param name="mac_address_octet_3" type="uint8">
<description>
Fourth octet of the mac address.
</description>
</param>
<param name="mac_address_octet_4" type="uint8">
<description>
Fifth octet of the mac address.
</description>
</param>
<param name="mac_address_octet_5" type="uint8">
<description>
Sixth octet of the mac address.
</description>
</param>
<param name="band" type="uint8" enum="net_intf_band_mode">
<description>
si91x Wi-Fi band mode defines the supported frequency bands for the device. At present, only the 2.4 GHz band is supported.
</description>
</param>
<param name="region_code" type="uint8" enum="net_intf_region_code">
<description>
si91x region code, which defines the regional settings for the device. Note that Singapore is not currently supported.
</description>
</param>
<param name="tx_ratio_in_buffer_pool" type="uint8">
<description>
Specifies the ratio of the transmission (TX) buffer allocation in the buffer pool.
</description>
</param>
<param name="rx_ratio_in_buffer_pool" type="uint8">
<description>
Specifies the ratio of the reception (RX) buffer allocation in the buffer pool.
</description>
</param>
<param name="global_ratio_in_buffer_pool" type="uint8">
<description>
Specifies the ratio of the global buffer allocation in the buffer pool.
</description>
</param>
<param name="efuse_data_type" type="uint8">
<description>
Type of eFuse data need to be read from flash.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="get_init_status" index="0x06">
<description>
Gets device intialization status.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to be initialized. Currently only AP_INTERFACE is supported.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
<param name="is_init" type="uint8">
<description>
Gets device intialization status. 1 for initialized, 0 for not initialized.
</description>
</param>
</returns>
</command>
<command name="get_network_status" index="0x07">
<description>
Gets status of network interface.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to be initialized. Currently only AP_INTERFACE is supported.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
<param name="is_up" type="uint8">
<description>
Status of the network interface. A value of 1 means the network interface is up, and 0 means the network interface is down.
</description>
</param>
</returns>
</command>
<command name="get_device_config" index="0x08">
<description>
Gets si91x device configuration of the device.
</description>
<params/>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
<param name="boot_option" type="uint8" enum="net_intf_boot_option">
<description>
Specifies the current boot option for the si91x device, which determines the type of firmware to be loaded.
</description>
</param>
<param name="mac_address_octet_0" type="uint8">
<description>
The first octet of the device's MAC address.
</description>
</param>
<param name="mac_address_octet_1" type="uint8">
<description>
The second octet of the device's MAC address.
</description>
</param>
<param name="mac_address_octet_2" type="uint8">
<description>
The third octet of the device's MAC address.
</description>
</param>
<param name="mac_address_octet_3" type="uint8">
<description>
The fourth octet of the device's MAC address.
</description>
</param>
<param name="mac_address_octet_4" type="uint8">
<description>
The fifth octet of the device's MAC address.
</description>
</param>
<param name="mac_address_octet_5" type="uint8">
<description>
The sixth octet of the device's MAC address.
</description>
</param>
<param name="band" type="uint8" enum="net_intf_band_mode">
<description>
The current Wi-Fi band mode of the si91x device. This defines the supported frequency bands. Currently, only the 2.4 GHz band is supported.
</description>
</param>
<param name="region_code" type="uint8" enum="net_intf_region_code">
<description>
The regional code for the device.
</description>
</param>
<param name="tx_ratio_in_buffer_pool" type="uint8">
<description>
The ratio of the transmission (TX) buffer allocation in the buffer pool.
</description>
</param>
<param name="rx_ratio_in_buffer_pool" type="uint8">
<description>
The ratio of the reception (RX) buffer allocation in the buffer pool.
</description>
</param>
<param name="global_ratio_in_buffer_pool" type="uint8">
<description>
The ratio of the global buffer allocation in the buffer pool.
</description>
</param>
<param name="efuse_data_type" type="uint8">
<description>
The type of eFuse data to be read from the device's flash memory.
</description>
</param>
</returns>
</command>
<enums name="region_code" title="Region Code">
<enum name="region_code_default_region" value="0x00" title="Factory default region">
<description>
The default region setting applied when the device is initialized to factory settings.
</description>
</enum>
<enum name="region_code_us" value="0x01" title="United States">
<description>
The region code for the United States.
</description>
</enum>
<enum name="region_code_eu" value="0x02" title="European Union">
<description>
The region code for the European Union.
</description>
</enum>
<enum name="region_code_jp" value="0x03" title="Japan">
<description>
The region code for Japan.
</description>
</enum>
<enum name="region_code_world_domain" value="0x04" title="Worldwide domain">
<description>
The worldwide domain region code, which applies global regulatory settings. This setting is used for devices that are not restricted to a specific region and are intended for use across multiple countries.
</description>
</enum>
<enum name="region_code_kr" value="0x05" title="Korea">
<description>
The region code for Korea.
</description>
</enum>
<enum name="region_code_ch" value="0x07" title="China">
<description>
The region code for China.
</description>
</enum>
</enums>
<event name="network_up_completed" index="0x00">
<description>
Indicates that the network interface has successfully completed the network up procedure.
This event is triggered when the specified network interface is brought up and initialized,
or if there was an error during the process.
</description>
<params>
<param name="net_interface" type="uint8" enum="net_intf_interface">
<description>
Network interface to be initialized. Currently only AP_INTERFACE is supported.
</description>
</param>
<param name="is_completed" type="errorcode">
<description>
Status of the network interface. A value of 1 means the network interface is up, and 0 means the network interface is down.
</description>
</param>
</params>
</event>
<enums name="band_mode" title="band_mode">
<enum name="band_mode_2_4_ghz" value="0x00" title="Wi-Fi Band 2.4 GHz">
<description>
2.4 GHz Wi-Fi band.
</description>
</enum>
<enum name="band_mode_5_ghz" value="0x01" title="Wi-Fi Band 5 GHz">
<description>
5 GHz Wi-Fi band (currently not supported).
</description>
</enum>
<enum name="band_mode_dual_ghz" value="0x02" title="Wi-Fi Dual Band">
<description>
Both 2.4 GHz and 5 GHz Wi-Fi bands (currently not supported).
</description>
</enum>
</enums>
<enums name="boot_option" title="Boot Option">
<enum name="boot_option_load_nwp_fw" value="0x31" title="Load NWP Firmware">
<description>
Specifies the option to load the Network Processor (NWP) firmware during the boot process. This option is used to initialize the device's networking capabilities by loading the appropriate firmware.
</description>
</enum>
</enums>
<enums name="oper_mode" title="Operation Mode">
<description>
si91x operating mode
</description>
<enum name="oper_mode_client" value="0x00">
<description>
Wi-Fi personal client mode
</description>
</enum>
<enum name="oper_mode_enterprise_client" value="0x02">
<description>
Wi-Fi enterprise client mode
</description>
</enum>
<enum name="oper_mode_ap" value="0x06">
<description>
Wi-Fi access point mode
</description>
</enum>
<enum name="oper_mode_transceiver" value="0x07">
<description>
Wi-Fi transceiver mode
</description>
</enum>
<enum name="oper_mode_transmit_test" value="0x08">
<description>
Wi-Fi transmit test mode
</description>
</enum>
<enum name="oper_mode_concurrent" value="0x09">
<description>
Wi-Fi concurrent mode
</description>
</enum>
</enums>
<enums name="coex_mode" title="Coexistence mode">
<enum name="coex_mode_wlan_only" value="0x00" title="WLAN only mode">
<description>
Wireless local area network (WLAN) only mode
</description>
</enum>
<enum name="coex_mode_ble" value="0x0C" title="BLE mode">
<description>
Bluetooth Low Energy (BLE) only mode, used when power save mode is not needed.
</description>
</enum>
<enum name="coex_mode_wlan_ble" value="0x0D" title="WLAN and BLE mode">
<description>
WLAN and BLE mode
</description>
</enum>
</enums>
<command name="set_si91x_boot_config" index="0x05" title="Sets si91x boot configuration">
<description>
Sets si91x specific boot configuration of the device.
</description>
<params>
<param name="oper_mode" type="uint16" enum="net_intf_oper_mode">
<description>
The operational mode of the device. This defines how the device functions within the network (e.g., as an access point or station).
</description>
</param>
<param name="coex_mode" type="uint16" enum="net_intf_coex_mode">
<description>
The coexistence mode, which specifies how the device manages simultaneous use of multiple wireless technologies (e.g., Wi-Fi and Bluetooth).
</description>
</param>
<param name="feature_bit_map" type="uint32">
<description>
A 32-bit feature bit map that specifies the available features on the device. Each bit represents a different device feature.
</description>
</param>
<param name="tcp_ip_feature_bit_map" type="uint32">
<description>
A 32-bit bit map that indicates which TCP/IP features are enabled on the device.
</description>
</param>
<param name="custom_feature_bit_map" type="uint32">
<description>
A 32-bit custom feature bit map that represents additional features configured for the device beyond standard capabilities.
</description>
</param>
<param name="ext_custom_feature_bit_map" type="uint32">
<description>
An extended custom feature bit map providing even further customization options beyond the basic and custom features.
</description>
</param>
<param name="bt_feature_bit_map" type="uint32">
<description>
A 32-bit Bluetooth feature bit map that specifies which Bluetooth features are supported and enabled on the device.
</description>
</param>
<param name="ext_tcp_ip_feature_bit_map" type="uint32">
<description>
An extended TCP/IP feature bit map, indicating advanced TCP/IP features enabled on the device.
</description>
</param>
<param name="ble_feature_bit_map" type="uint32">
<description>
A 32-bit bit map that specifies which BLE features are supported on the device.
</description>
</param>
<param name="ble_ext_feature_bit_map" type="uint32">
<description>
An extended BLE feature bit map that allows additional customization of BLE functionality beyond the basic BLE features.
</description>
</param>
<param name="config_feature_bit_map" type="uint32">
<description>
A configuration feature bit map that represents various configuration settings for the device, including network and device-specific options.
</description>
</param>
</params>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
</returns>
</command>
<command name="get_si91x_boot_config" index="0x09" title="Gets si91x boot configuration">
<description>
Gets si91x specific boot configuration of the device.
</description>
<params/>
<returns>
<param name="result" type="errorcode">
<description>
Result of the command.
</description>
</param>
<param name="oper_mode" type="uint16" enum="net_intf_oper_mode">
<description>
The operational mode of the device, which defines how the device functions within the network (e.g., access point, station mode, etc.).
</description>
</param>
<param name="coex_mode" type="uint16" enum="net_intf_coex_mode">
<description>
The coexistence mode, which specifies how the device interacts with other wireless technologies (e.g., Bluetooth and Wi-Fi co-existence).
</description>
</param>
<param name="feature_bit_map" type="uint32">
<description>
The feature bit map that specifies the available features of the device.
</description>
</param>
<param name="tcp_ip_feature_bit_map" type="uint32">
<description>
The TCP/IP feature bit map, which indicates the specific TCP/IP features enabled on the device.
</description>
</param>
<param name="custom_feature_bit_map" type="uint32">
<description>
A custom feature bit map representing any additional custom features configured for the device.
</description>
</param>
<param name="ext_custom_feature_bit_map" type="uint32">
<description>
An extended custom feature bit map, providing further customization options beyond the basic custom feature set.
</description>
</param>
<param name="bt_feature_bit_map" type="uint32">
<description>
The Bluetooth feature bit map, specifying the Bluetooth features supported and enabled on the device.
</description>
</param>
<param name="ext_tcp_ip_feature_bit_map" type="uint32">
<description>
An extended TCP/IP feature bit map, representing additional TCP/IP features enabled on the device.
</description>
</param>
<param name="ble_feature_bit_map" type="uint32">
<description>
The BLE feature bit map, which indicates the BLE features enabled on the device.
</description>
</param>
<param name="ble_ext_feature_bit_map" type="uint32">
<description>
An extended BLE feature bit map.
</description>
</param>
<param name="config_feature_bit_map" type="uint32">
<description>
The configuration feature bit map that represents the device's configuration features, including network and device-specific settings.
</description>
</param>
</returns>
</command>
</class>
<class name="net_profile" index="0x12" title="Network Profile">
<description>
Commands and events in this class are described by "profiles" that contain all the information needed to configure a particular interface. Each type of network interface has a unique profile structure to optimally store the relevant information. For example, a Wi-Fi client interface requires an SSID, a security mode, and a passphrase for a security-enabled access point.
</description>
<enums name="security_type" title="Wi-Fi Security Types">
<description>
Enumeration for various Wi-Fi security types.
</description>
<enum name="security_type_open" value="0x00" title="Wi-Fi Open Security">
<description>
Wi-Fi Open security type.
</description>
</enum>
<enum name="security_type_wpa" value="0x01" title="Wi-Fi WPA Security">
<description>
Wi-Fi WPA security type.
</description>
</enum>
<enum name="security_type_wpa2" value="0x02" title="Wi-Fi WPA2 Security">
<description>
Wi-Fi WPA2 security type.
</description>
</enum>
<enum name="security_type_wep" value="0x03" title="Wi-Fi WEP Security">
<description>
Wi-Fi WEP security type.
</description>
</enum>
<enum name="security_type_wpa_enterprise" value="0x04" title="Wi-Fi WPA Enterprise Security">
<description>
Wi-Fi WPA enterprise security type.
</description>
</enum>
<enum name="security_type_wpa2_enterprise" value="0x05" title="Wi-Fi WPA2 Enterprise Security">
<description>
Wi-Fi WPA2 enterprise security type.
</description>
</enum>
<enum name="security_type_wpa_wpa2_mixed" value="0x06" title="Wi-Fi WPA/WPA2 Mixed Security">
<description>
Wi-Fi WPA/WPA2 mixed security type that supports both WPA and WPA2.
</description>
</enum>
<enum name="security_type_wpa3" value="0x07" title="Wi-Fi WPA3 Security">
<description>
Wi-Fi WPA3 security type.
</description>
</enum>
<enum name="security_type_wpa3_transition" value="0x08" title="Wi-Fi WPA3 Transition Security">
<description>
Wi-Fi WPA3 Transition security type (not currently supported in AP mode).
</description>
</enum>
<enum name="security_type_wpa3_enterprise" value="0x09" title="Wi-Fi WPA3 Enterprise Security">
<description>
Wi-Fi WPA3 enterprise security type.
</description>
</enum>
<enum name="security_type_wpa3_transition_enterprise" value="0x0A" title="Wi-Fi WPA3 Transition Enterprise Security">
<description>
Wi-Fi WPA3 Transition enterprise security type.
</description>
</enum>
<enum name="security_type_security_unknown" value="0xFFFF" title="Wi-Fi Unknown Security">
<description>
Wi-Fi Unknown Security type.
</description>
</enum>
</enums>
<enums name="encryption_type" title="Wi-Fi Encryption Types">
<description>
Enumeration for various Wi-Fi encryption types.
</description>
<enum name="encryption_type_default" value="0x00" title="Default Wi-Fi Encryption">
<description>
Default Wi-Fi encryption.
</description>
</enum>
<enum name="encryption_type_no" value="0x01" title="No Wi-Fi Encryption">
<description>
Wi-Fi with no Encryption (not currently supported in STA mode).
</description>
</enum>
<enum name="encryption_type_wep" value="0x02" title="WEP Wi-Fi Encryption">
<description>
Wi-Fi with WEP Encryption (not currently supported in STA mode).
</description>
</enum>
<enum name="encryption_type_tkip" value="0x03" title="TKIP Wi-Fi Encryption">
<description>
Wi-Fi with TKIP Encryption (not currently supported in STA mode).
</description>
</enum>
<enum name="encryption_type_ccmp" value="0x04" title="CCMP Wi-Fi Encryption">
<description>
Wi-Fi with CCMP Encryption.
</description>
</enum>
<enum name="encryption_type_eap_tls" value="0x05" title="Enterprise TLS Wi-Fi Encryption">
<description>
Wi-Fi with Enterprise TLS Encryption.
</description>
</enum>
<enum name="encryption_type_eap_ttls" value="0x06" title="Enterprise TTLS Wi-Fi Encryption">
<description>
Wi-Fi with Enterprise TTLS Encryption.
</description>
</enum>
<enum name="encryption_type_eap_fast" value="0x07" title="Enterprise FAST Wi-Fi Encryption">
<description>
Wi-Fi with Enterprise FAST Encryption.
</description>
</enum>
<enum name="encryption_type_peap_mschapv2" value="0x08" title="Enterprise PEAP Wi-Fi Encryption">
<description>
Wi-Fi with Enterprise PEAP Encryption.
</description>
</enum>
<enum name="encryption_type_eap_leap" value="0x09" title="Enterprise LEAP Wi-Fi Encryption">
<description>
Wi-Fi with Enterprise LEAP Encryption.
</description>
</enum>
</enums>
<enums name="rate_protocol" title="Wi-Fi Rate Protocols">
<description>
Enumeration for different Wi-Fi rate protocols.
</description>
<enum name="rate_protocol_b_only" value="0x00" title="802.11b Only">
<description>
802.11b rates only.
</description>
</enum>
<enum name="rate_protocol_g_only" value="0x01" title="802.11g Only">
<description>
802.11g rates only.
</description>
</enum>
<enum name="rate_protocol_n_only" value="0x02" title="802.11n Only">
<description>
802.11n rates only.
</description>
</enum>
<enum name="rate_protocol_ac_only" value="0x03" title="802.11ac Only">
<description>
802.11ac rates only (not currently supported).
</description>
</enum>
<enum name="rate_protocol_ax_only" value="0x04" title="802.11ax Only">
<description>
802.11ax rates only.
</description>
</enum>
<enum name="rate_protocol_auto" value="0x05" title="Automatic Rate Selection">
<description>
Automatic rate selection.
</description>
</enum>
</enums>
<enums name="ap_option" title="Wi-Fi Access Point Flags">
<enum name="ap_option_enable_hidden_ssid" value="0x01" title="Hidden SSID">
<description>
Hide the SSID of the Access Point.
</description>
</enum>
<enum name="ap_option_disable_hidden_ssid" value="0x00" title="Hidden SSID">
<description>
Display the SSID of the Access Point.
</description>
</enum>
</enums>
<enums name="credential_id" title="Network Credential IDs">
<enum name="credential_id_invalid" value="0x00" title="Invalid Credential ID">
<description>
Invalid Credential ID.
</description>
</enum>
<enum name="credential_id_default_wifi_client" value="0x01" title="Wi-Fi Client Credential ID">
<description>
Default Wi-Fi Client Credential ID. By default, uses default_wifi_client_credential from sl_net_default_values.h, which can be overridden using sl_net_set_credential.
</description>
</enum>
<enum name="credential_id_default_wifi_ap" value="0x02" title="Wi-Fi Access Point Credential ID">
<description>
Default Wi-Fi Access Point Credential ID. By default, uses default_wifi_ap_credential from sl_net_default_values.h, which can be overridden using sl_net_set_credential.
</description>
</enum>
<enum name="credential_id_wifi_eap_client" value="0x03" title="Wi-Fi EAP Client Credential ID">
<description>
Wi-Fi EAP Client Credential ID.
</description>
</enum>
<enum name="credential_id_wifi_eap_server" value="0x04" title="Wi-Fi EAP Server Credential ID">
<description>
Wi-Fi EAP Server Credential ID.
</description>
</enum>
<enum name="credential_id_user" value="0x05" title="User Credential ID">
<description>
User Credential ID.
</description>
</enum>
<enum name="credential_id_tls_client" value="0x100" title="TLS Client Credential ID">
<description>
TLS Client Credential ID.
</description>
</enum>
<enum name="credential_id_tls_server" value="0x200" title="TLS Server Credential ID">
<description>
TLS Server Credential ID.
</description>
</enum>
<enum name="credential_id_mqtt_server" value="0x300" title="MQTT Server Credential ID">
<description>
MQTT Server Credential ID.
</description>
</enum>
<enum name="credential_id_mqtt_client" value="0x400" title="MQTT Client Credential ID">
<description>
MQTT Client Credential ID.
</description>