Main Page
Introduction
NXP NCP host sample application provides reference code of communication between NCP host and NCP device over NCP TLV protocol. NCP host could connect to redfinch NCP device through multiple HW interfaces. Developers can refer to NCP APIs for Wi-Fi, Bluetooth LE and 15.4 to implement their own sample application which runs on their host platform.
Note: Default NCP host MCU platform: RT1060 EVKB. NCP device supported two kinds redfinch boards: RD-RW612-BGA: UART/SPI/USB/SDIO, FRDM-RW612: UART/SPI/USB.
Abbreviations and acronyms
| Abbreviations | Description |
| ACS | auto channel selection |
| AD | advertising data |
| AES | advanced encryption standard |
| AP | access point |
| ARP | address resolution protocol |
| BAS | battery service |
| BIG | broadcast isochronous group |
| BSS | basic service set |
| BSSID | basic service set ID |
| CCC | client characteristic configuration |
| CCK | complementary code keying |
| CSI | channel state information |
| CSIS | coordinated set identification service |
| CW | continuous wave |
| DHCP | dynamic host configuration protocol |
| DPP | device provisioning protocol |
| DTIM | delivery traffic indication map |
| DNS | domain name system |
| EAP | extensible authentication protocol |
| EATT | enhanced attribute protocol |
| EAP-TLS | extensible authentication protocol transport layer security |
| EAP-TTLS | extensible authentication protocol tunneled transport layer security |
| EIR | extended inquiry response |
| EU | encrypt unit |
| FCS | frame check sequence |
| FT | fast BSS transition |
| GAP | generic access profile |
| GATT | generic attribute profile |
| GI | guard interval |
| HE | 802.11ax high efficiency |
| HRC | health rate client |
| HT | 802.11n high throughput |
| HTC | health thermometer client |
| HTS | health thermometer service |
| ICMP | internet control message protocol |
| L2CAP | logical link control and adaptation layer protocol |
| MBO | multi band operation |
| MDNS | multicast DNS |
| MEF | memory efficient filtering |
| MFPC | management frame protection capable |
| MFPR | management frame protection required |
| MITM | man in the middle |
| MTU | max transmission unit |
| NAK | net access key |
| NF | noise floor |
| OCE | optimized connectivity experience |
| OFDM | orthogonal frequency division multiplexing |
| OMI | operating mode indication |
| OWE | opportunistic wireless encryption |
| OOB | out of band |
| OT | openthread |
| PBC | push button configuration |
| PHY | physical |
| PIN | personal identification number |
| PMF | protected management frame |
| PPE | physical layer (PHY) packet extension |
| PS | power save |
| PSK | pre-shared key |
| PSM | protocol/service multiplexer |
| PTR | pointer records |
| PWE | Password Element |
| QoS | quality of service |
| RSI | Resolvable Set Identifier |
| RSSI | received signal strength indicator |
| SAD | software antenna diversity |
| SAE | simultaneous authentication of equals |
| SIFS | short interframe space |
| SNR | signal noise ratio |
| SRV | service records |
| SSID | service set ID |
| STBC | space time block code |
| TBTT | target beacon transmission time |
| TWT | target wake time |
| UAPSD | unscheduled automatic power save delivery |
| UUID | universally unique identifier |
| URI | uniform resource identifier |
| VHT | 802.11ac very high throughput |
| WEP | wired equivalent privacy |
| WLCMGR | Wi-Fi command manager |
| WPA | Wi-Fi protected access |
| WPA2 | Wi-Fi protected access 2 |
| WPA3 | Wi-Fi protected access 3 |
| WPS | Wi-Fi protected setup |
| WMM | Wi-Fi multimedia |
| WNM | wireless network management |
| WOWLAN | wake on wireless LAN |
File Index
File List
Here is a list of all documented files with brief descriptions:
bas.h (Battery Service Profile definitions )
hr.h (Health Rate Profile definitions )
ht.h (Health Thermometer Profile definitions )
ncp_cmd_ble.h (NCP Bluetooth LE command and structure definitions )
ncp_cmd_wifi.h (NCP Wi-Fi command/response definitions )
ncp_host_command_ble.h (NCP Bluetooth LE host command interfaces )
ncp_host_command_wifi.h (NCP host command interfaces )
otopcode.h (This file provides interface to get Open Thread commands corresponding opcode )
service.h (Bluetooth service definitions )
Data Structure Documentation
_ACSBand_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint16_t acs_band
Detailed Description
This structure is used for ACS (auto channel selection) band configuration.
Field Documentation
TypeHeader_t _ACSBand_ParamSet_t::header
Header type and size information.
uint16_t _ACSBand_ParamSet_t::acs_band
Band configuration for ACS. Valid when set channel to zero.
0: 2GHz,
1: 5GHz.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_BSSID_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
char bssid [IEEEtypes_MAC_ADDRESS_SIZE]
Detailed Description
This structure is used for BSSID configuration.
Field Documentation
TypeHeader_t _BSSID_ParamSet_t::header
Header type and size information.
char _BSSID_ParamSet_t::bssid[IEEEtypes_MAC_ADDRESS_SIZE]
BSSID (basic service set identifier).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_BSSRole_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t role
Detailed Description
This structure is used for BSS role configuration.
Field Documentation
TypeHeader_t _BSSRole_ParamSet_t::header
Header type and size information.
uint8_t _BSSRole_ParamSet_t::role
Network BSS role,
0: STA,
1: UAP.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_CAPA_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t capa
Detailed Description
This structure is used for Wi-Fi capabilities configuration.
Field Documentation
TypeHeader_t _CAPA_ParamSet_t::header
Header type and size information.
uint8_t _CAPA_ParamSet_t::capa
Wi-Fi capabilities bitmap, such as 802.11n, 802.11ac, 802.11ax and legacy.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_Channel_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t channel
Detailed Description
This structure is used for channel configuration.
Field Documentation
TypeHeader_t _Channel_ParamSet_t::header
Header type and size information.
uint8_t _Channel_ParamSet_t::channel
Network channel
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_DTIM_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t dtim_period
Detailed Description
This structure is used for DTIM (delivery traffic indication message) period configuration.
Field Documentation
TypeHeader_t _DTIM_ParamSet_t::header
Header type and size information.
uint8_t _DTIM_ParamSet_t::dtim_period
DTIM (delivery traffic indication message) period.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_EAP_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
char anonymous_identity [IDENTITY_MAX_LENGTH]
char client_key_passwd [PASSWORD_MAX_LENGTH]
Detailed Description
This structure is used for EAP (extensible authentication protocol) information configuration.
Field Documentation
TypeHeader_t _EAP_ParamSet_t::header
Header type and size information.
char _EAP_ParamSet_t::anonymous_identity[IDENTITY_MAX_LENGTH]
Anonymous identity string for EAP
char _EAP_ParamSet_t::client_key_passwd[PASSWORD_MAX_LENGTH]
Client key password string
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_HE_CAP_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t ext_id
uint8_t he_mac_cap [6]
uint8_t he_phy_cap [11]
uint8_t he_txrx_mcs_support [4]
uint8_t val [28]
Detailed Description
This structure is used for HE (802.11ax high efficient) capability configuration.
Field Documentation
TypeHeader_t _HE_CAP_ParamSet_t::header
Header type and size information.
uint8_t _HE_CAP_ParamSet_t::ext_id
Element ID extension.
uint8_t _HE_CAP_ParamSet_t::he_mac_cap[6]
HE MAC capabilities information. The bit values of this bit field are defined in the 802.11ax core specification.
uint8_t _HE_CAP_ParamSet_t::he_phy_cap[11]
HE physical capabilities information.The bit values of this bit field are defined in the 802.11ax core specification.
uint8_t _HE_CAP_ParamSet_t::he_txrx_mcs_support[4]
HE TX/RX MCS support for 80MHz. The bit values of this bit field are defined in the 802.11ax core specification.
uint8_t _HE_CAP_ParamSet_t::val[28]
Including he_txrx_mcs_support for 160 and 80+80 MHz, and PPE Thresholds. The bit values of this bit field are defined in the 802.11ax core specification.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_IEEE_BTWT_ParamSet_t Struct Reference
Data Fields
uint16_t request_type
uint16_t target_wake_time
uint8_t nominal_min_wake_duration
uint16_t wake_interval_mantissa
uint16_t twt_info
Detailed Description
This structure is used for IEEE BTWT (broadcast target wake time) configuration.
Field Documentation
uint16_t _IEEE_BTWT_ParamSet_t::request_type
Request type, bit0: request,
bit1-bit3: setup_cmd,
bit4: trigger,
bit5: last broadcast parameter set,
bit6: flow type,
bit7-bit9: btwt_recommendation,
bit10-bit14: wake interval exponent,
bit15: reserved.
uint16_t _IEEE_BTWT_ParamSet_t::target_wake_time
Wake up time agreed by the device and host.
uint8_t _IEEE_BTWT_ParamSet_t::nominal_min_wake_duration
Nominal minimum TWT wake duration.
uint16_t _IEEE_BTWT_ParamSet_t::wake_interval_mantissa
TWT wake interval mantissa.
uint16_t _IEEE_BTWT_ParamSet_t::twt_info
Bit0-bit2: reserved
bit3-bit7: btwt_id
bit8-bit15: btwt_persistence.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_IP_ADDR_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t addr_type
union {
uint32_t ip_v4
uint32_t ip_v6 [4]
} ip
Detailed Description
This structure is used for IP address configuration.
Field Documentation
TypeHeader_t _IP_ADDR_ParamSet_t::header
Header type and size information.
uint8_t _IP_ADDR_ParamSet_t::addr_type
IP address type.
1: ADDR_TYPE_DHCP, use DHCP (dynamic host configuration protocol) to obtain the IP address.
0: ADDR_TYPE_STATIC, use a static IP address.
union { … } _IP_ADDR_ParamSet_t::ip
IPv4/IPv6 address.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_IP_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t is_autoip
uint32_t address
uint32_t gateway
uint32_t netmask
uint32_t dns1
uint32_t dns2
Detailed Description
This structure is used for network IP configuration.
Field Documentation
TypeHeader_t _IP_ParamSet_t::header
Header type and size information.
uint8_t _IP_ParamSet_t::is_autoip
Auto IP flag,
0: not auto IP,
1: auto IP.
uint32_t _IP_ParamSet_t::address
Network IP address.
uint32_t _IP_ParamSet_t::gateway
Gateway.
uint32_t _IP_ParamSet_t::netmask
Netmask.
uint32_t _IP_ParamSet_t::dns1
System’s primary DNS (domain name system) server.
uint32_t _IP_ParamSet_t::dns2
System’s secondary DNS server.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_MBO_NONPREFER_CH_SUPP Struct Reference
Data Fields
char mbo_nonprefer_ch_params [32]
Detailed Description
This structure is used for MBO non prefer channel configuration.
Field Documentation
char _MBO_NONPREFER_CH_SUPP::mbo_nonprefer_ch_params[32]
MBO non prefer channel parameters.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_ADD_SERVICE_RP Struct Reference
Data Fields
uint16_t attr_handle
Detailed Description
This structure contains the command response of the Bluetooth LE add service command.
Field Documentation
uint16_t _NCP_ADD_SERVICE_RP::attr_handle
service attribute handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_ATTR_VALUE_CHANGED_EV Struct Reference
Data Fields
uint16_t handle
uint16_t data_length
uint8_t data [MAX_ATTRIBUTE_VALUE_LEN]
Detailed Description
This structure contains the value of the Bluetooth LE GATT attribute value changed event which notifies the changed attributes to the client.
Field Documentation
uint16_t _NCP_ATTR_VALUE_CHANGED_EV::handle
attribute handle
uint16_t _NCP_ATTR_VALUE_CHANGED_EV::data_length
attribute data length
uint8_t _NCP_ATTR_VALUE_CHANGED_EV::data[MAX_ATTRIBUTE_VALUE_LEN]
attribute data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_ncp_ble_low_power_mode_cfg Struct Reference
Data Fields
uint8_t power_mode
uint16_t timeout
Detailed Description
This structure contains the configuration values of the narrowband controller low power mode.
Field Documentation
uint8_t _ncp_ble_low_power_mode_cfg::power_mode
Set narrowband controller power mode.
auto sleep disable : 0x02
auto sleep enable : 0x03
uint16_t _ncp_ble_low_power_mode_cfg::timeout
sleep timeout value (the timebase is us)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_ncp_ble_set_bd_address_cfg Struct Reference
Data Fields
uint8_t paramater_id
uint8_t bd_addr_len
uint8_t bd_address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set device address command.
Field Documentation
uint8_t _ncp_ble_set_bd_address_cfg::paramater_id
Vendor command parameter id.
The id of Bluetooth LE Vendor set board address is 0xFE
uint8_t _ncp_ble_set_bd_address_cfg::bd_addr_len
Bluetooth LE Device address length
The length of Bluetooth LE Device address is 0x06
uint8_t _ncp_ble_set_bd_address_cfg::bd_address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE Device address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CCC_CFG_CHANGED_EV Struct Reference
Data Fields
uint16_t ccc_value
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the value of the Bluetooth LE client characteristic configuration changed event which indicates whether the characteristic notification or indication is enabled or disabled to the client.
Field Documentation
uint16_t _NCP_CCC_CFG_CHANGED_EV::ccc_value
client characteristic configuration changed value
uint8_t _NCP_CCC_CFG_CHANGED_EV::uuid_length
UUID length
uint8_t _NCP_CCC_CFG_CHANGED_EV::uuid[SERVER_MAX_UUID_LEN]
UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CFG_SUBSCRIBE_CMD Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t enable
uint16_t ccc_handle
Detailed Description
This structure is used for NCP Bluetooth LE subscribe service.
Field Documentation
uint8_t _NCP_CFG_SUBSCRIBE_CMD::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CFG_SUBSCRIBE_CMD::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t _NCP_CFG_SUBSCRIBE_CMD::enable
subscribe value
0: disallow to subscribe
1: allow to subscribe
uint16_t _NCP_CFG_SUBSCRIBE_CMD::ccc_handle
ccc (client characteristic configuration) handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_11AX_CFG Struct Reference
Data Fields
uint8_t band
HE_CAP_ParamSet_t he_cap_tlv
Detailed Description
This structure is used for band type and HE (802.11ax high efficient) capability configuration.
Field Documentation
uint8_t _NCP_CMD_11AX_CFG::band
Band,
0: 2.4GHz,
2: 5GHz,
3: 2.4GHz and 5GHz.
HE_CAP_ParamSet_t _NCP_CMD_11AX_CFG::he_cap_tlv
HE (802.11ax high efficient) capability.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_11D_ENABLE Struct Reference
Data Fields
uint32_t role
uint32_t state
Detailed Description
This structure is used for 802.11d flag configuration.
Field Documentation
uint32_t _NCP_CMD_11D_ENABLE::role
Role type,
0: STA,
1: UAP.
uint32_t _NCP_CMD_11D_ENABLE::state
State type,
0: disable 802.11d,
1: enable 802.11d.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_11K_CFG Struct Reference
Data Fields
int enable
Detailed Description
This structure is used for enable/disable 802.11k flag configuration.
Field Documentation
int _NCP_CMD_11K_CFG::enable
Enable/disable 802.11k flag,
0: disable,
1: enable.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_ANTENNA_CFG Struct Reference
Data Fields
uint8_t action
uint32_t antenna_mode
uint16_t evaluate_time
uint8_t evaluate_mode
uint16_t current_antenna
Detailed Description
This structure is used for antenna configuration.
Field Documentation
uint8_t _NCP_CMD_ANTENNA_CFG::action
Action type,
0: get,
1: set
uint32_t _NCP_CMD_ANTENNA_CFG::antenna_mode
Antenna mode,
0: 1ANT,
1: 2ANT,
15: ANT diversity.
uint16_t _NCP_CMD_ANTENNA_CFG::evaluate_time
SAD (software antenna diversity) evaluate time interval (unit: milliseconds), default value is 6000ms.
uint8_t _NCP_CMD_ANTENNA_CFG::evaluate_mode
Evaluate mode is used to specify two out of three antennas for SAD, with valid values of 0, 1, 2 and 255.
0: ant 1 and ant 2,
1: ant 2 and ant 3,
2: ant 1 and ant 3,
255: indicates that no antenna is specified.
uint16_t _NCP_CMD_ANTENNA_CFG::current_antenna
Current antenna configuration.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_BTWT_CFG Struct Reference
Data Fields
uint16_t action
uint16_t sub_id
uint8_t nominal_wake
uint8_t max_sta_support
uint16_t twt_mantissa
uint16_t twt_offset
uint8_t twt_exponent
uint8_t sp_gap
Detailed Description
This structure is used for BTWT configuration. The AP manages BTWT working mechanism: the AP announces the TWT time period of the current round in each beacon frame. In some cases, the AP also announces TWT time period in other management frames. For example association frames, reassociation frames, and/or probe response frames. The endpoint must apply to the AP to add a group before the endpoint can run broadcast TWT. The STA adds the group and follows the latest TWT time period. When TWT time period is reached, the STA wakes up and starts exchanging information.
Field Documentation
uint16_t _NCP_CMD_BTWT_CFG::action
Action, only support 1: set.
uint16_t _NCP_CMD_BTWT_CFG::sub_id
Subcommand ID, the subcommand ID of BTWT is 0x125.
uint8_t _NCP_CMD_BTWT_CFG::nominal_wake
Nominal minimum TWT wake duration.
uint8_t _NCP_CMD_BTWT_CFG::max_sta_support
Maximum number of STAs supported.
uint16_t _NCP_CMD_BTWT_CFG::twt_mantissa
TWT wake interval mantissa, range: [0 - (2^16-1)].
uint16_t _NCP_CMD_BTWT_CFG::twt_offset
TWT wake interval offset.
uint8_t _NCP_CMD_BTWT_CFG::twt_exponent
TWT wake interval exponent.
uint8_t _NCP_CMD_BTWT_CFG::sp_gap
Service period gap.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_CLIENT_CNT Struct Reference
Data Fields
uint16_t max_sta_count
uint8_t set_status
uint8_t support_count
Detailed Description
This structure is used for maximum number of STA configuration for UAP.
Field Documentation
uint16_t _NCP_CMD_CLIENT_CNT::max_sta_count
Maximum number of STAs set in the command.
uint8_t _NCP_CMD_CLIENT_CNT::set_status
Set status.
0: success,
1: fail.
uint8_t _NCP_CMD_CLIENT_CNT::support_count
Maximum number of STAs supported by the device side.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_CONN_PARA_UPDATE Struct Reference
Data Fields
uint8_t type
uint8_t addr [NCP_BLE_ADDR_LENGTH]
uint16_t interval_min
uint16_t interval_max
uint16_t latency
uint16_t timeout
Detailed Description
This structure is used for NCP Bluetooth LE update connection parameters.
Field Documentation
uint8_t _NCP_CMD_CONN_PARA_UPDATE::type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_CONN_PARA_UPDATE::addr[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_CMD_CONN_PARA_UPDATE::interval_min
connection minimal interval
Minimum value for the connection interval. Must be less than or equal to maximum connection interval
uint16_t _NCP_CMD_CONN_PARA_UPDATE::interval_max
connection maximum interval
Maximum value for the connection interval. Must be greater than or equal to minimum connection interval
uint16_t _NCP_CMD_CONN_PARA_UPDATE::latency
connection latency
Maximum peripheral latency for the connection in number of subrated connection events
uint16_t _NCP_CMD_CONN_PARA_UPDATE::timeout
connection timeout
Supervision timeout for the Bluetooth LE link
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_CONN_PARA_UPDATE_EV Struct Reference
Data Fields
uint8_t type
uint8_t addr [NCP_BLE_ADDR_LENGTH]
uint16_t interval
uint16_t latency
uint16_t timeout
Detailed Description
This structure contains the value of the Bluetooth LE connection update complete event which indicate the connection update procedure has completed.
Field Documentation
uint8_t _NCP_CMD_CONN_PARA_UPDATE_EV::type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_CONN_PARA_UPDATE_EV::addr[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_CMD_CONN_PARA_UPDATE_EV::interval
connection interval
uint16_t _NCP_CMD_CONN_PARA_UPDATE_EV::latency
connection latency
Maximum peripheral latency for the connection in number of subrated connection events
uint16_t _NCP_CMD_CONN_PARA_UPDATE_EV::timeout
connection timeout
Supervision timeout for the Bluetooth LE link
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_CONNECT Struct Reference
Data Fields
uint8_t type
uint8_t addr [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure is used for NCP Bluetooth LE create connection.
Field Documentation
uint8_t _NCP_CMD_CONNECT::type
remote address type
uint8_t _NCP_CMD_CONNECT::addr[NCP_BLE_ADDR_LENGTH]
remote address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_CONNECT_STAT Struct Reference
Data Fields
uint8_t ps_mode
uint8_t uap_conn_stat
uint8_t sta_conn_stat
Detailed Description
This structure is used for Wi-Fi connection status configuration.
Field Documentation
uint8_t _NCP_CMD_CONNECT_STAT::ps_mode
PS (power save) mode.
0: active mode,
1: IEEE power save mode,
2: deep sleep power save mode,
3: IEEE power save and deep sleep mode,
4: WNM (wireless network management) power save mode,
5: WNM power save and deep sleep mode.
uint8_t _NCP_CMD_CONNECT_STAT::uap_conn_stat
UAP connection status.
uint8_t _NCP_CMD_CONNECT_STAT::sta_conn_stat
STA connection status.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_CSI Struct Reference
Data Fields
wlan_csi_config_params_t csi_para
Detailed Description
This structure is used for CSI configuration.
Field Documentation
wlan_csi_config_params_t _NCP_CMD_CSI::csi_para
CSI (channel state information) configuration.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_DATA_LEN_UPDATE_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t tx_max_len
uint16_t tx_max_time
uint16_t rx_max_len
uint16_t rx_max_time
Detailed Description
This structure contains the value of the Bluetooth LE data length change event which notifies the Host of a change to either the maximum LL Data PDU Payload length or the maximum transmission time of packets containing LL Data PDUs in either direction.
Field Documentation
uint8_t _NCP_CMD_DATA_LEN_UPDATE_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_DATA_LEN_UPDATE_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_CMD_DATA_LEN_UPDATE_EV::tx_max_len
Maximum data length of TX connection
uint16_t _NCP_CMD_DATA_LEN_UPDATE_EV::tx_max_time
Maximum time of TX connection
uint16_t _NCP_CMD_DATA_LEN_UPDATE_EV::rx_max_len
Maximum length of RX connection
uint16_t _NCP_CMD_DATA_LEN_UPDATE_EV::rx_max_time
Maximum time of RX connection
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_DATE_TIME Struct Reference
Data Fields
uint32_t action
wlan_date_time_t date_time
Detailed Description
This structure is used for date and time configuration.
Field Documentation
uint32_t _NCP_CMD_DATE_TIME::action
Action type,
0: get,
1: set.
wlan_date_time_t _NCP_CMD_DATE_TIME::date_time
Date and time structure.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_DEEP_SLEEP_PS Struct Reference
Data Fields
int enable
Detailed Description
This structure is used for deep sleep power save mode flag configuration.
Field Documentation
int _NCP_CMD_DEEP_SLEEP_PS::enable
Enable deep sleep power save mode flag,
0: disable,
1: enable.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_ED_MAC Struct Reference
Data Fields
uint8_t action
uint16_t ed_ctrl_2g
uint16_t ed_offset_2g
uint16_t ed_ctrl_5g
uint16_t ed_offset_5g
Detailed Description
This structure is used for EDMAC (energy detect media access control) mode configuration.
Field Documentation
uint8_t _NCP_CMD_ED_MAC::action
Action,
0: get,
1: set.
uint16_t _NCP_CMD_ED_MAC::ed_ctrl_2g
Enable/disable EU (Encrypt unit) adaptivity for 2.4GHz band.
uint16_t _NCP_CMD_ED_MAC::ed_offset_2g
Energy detect threshold for 2.4GHz band.
uint16_t _NCP_CMD_ED_MAC::ed_ctrl_5g
Enable/disable EU adaptivity for 5GHz band.
uint16_t _NCP_CMD_ED_MAC::ed_offset_5g
Energy detect threshold for 5GHz band.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_ENCRYPTION Struct Reference
Data Fields
uint8_t type
uint8_t addr [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure is used for NCP Bluetooth LE encryption.
Field Documentation
uint8_t _NCP_CMD_ENCRYPTION::type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_ENCRYPTION::addr[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_EU_CRYPRTO Struct Reference
Data Fields
uint8_t enc
Detailed Description
This structure is used for EU (encryption unit) crypto configuration.
Field Documentation
uint8_t _NCP_CMD_EU_CRYPRTO::enc
0: decrypt,
1: encrypt.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_FW_VERSION Struct Reference
Data Fields
char driver_ver_str [MLAN_MAX_DRIVER_VER_STR_LEN]
char fw_ver_str [MLAN_MAX_VER_STR_LEN]
Detailed Description
This structure is used to store Wi-Fi driver and firmware version.
Field Documentation
char _NCP_CMD_FW_VERSION::driver_ver_str[MLAN_MAX_DRIVER_VER_STR_LEN]
Driver version string.
char _NCP_CMD_FW_VERSION::fw_ver_str[MLAN_MAX_VER_STR_LEN]
Firmware version string.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_GET_CURRENT_NETWORK Struct Reference
Data Fields
NCP_WLAN_NETWORK sta_network
Detailed Description
This structure is used for store the information about the current network.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_GET_MAC_ADDRESS Struct Reference
Data Fields
uint8_t uap_mac [MLAN_MAC_ADDR_LENGTH]
uint8_t sta_mac [MLAN_MAC_ADDR_LENGTH]
Detailed Description
This structure is used for MAC address configuration.
Field Documentation
uint8_t _NCP_CMD_GET_MAC_ADDRESS::uap_mac[MLAN_MAC_ADDR_LENGTH]
MAC address of UAP.
uint8_t _NCP_CMD_GET_MAC_ADDRESS::sta_mac[MLAN_MAC_ADDR_LENGTH]
MAC address of STA.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_CONNECT_CFG Struct Reference
Data Fields
int opened_handle
char host [1]
Detailed Description
This structure is used for HTTP connect configuration.
Field Documentation
int _NCP_CMD_HTTP_CONNECT_CFG::opened_handle
Created HTTP handle.
char _NCP_CMD_HTTP_CONNECT_CFG::host[1]
HTTP host, the maximum string length is 512.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_DISCONNECT_CFG Struct Reference
Data Fields
uint32_t handle
Detailed Description
This structure is used for HTTP disconnect configuration.
Field Documentation
uint32_t _NCP_CMD_HTTP_DISCONNECT_CFG::handle
Socket handle index number.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_RECV_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t recv_size
uint32_t timeout
char recv_data [1]
Detailed Description
This structure is used for HTTP receive data configuration.
Field Documentation
uint32_t _NCP_CMD_HTTP_RECV_CFG::handle
Socket handle index number.
uint32_t _NCP_CMD_HTTP_RECV_CFG::recv_size
Size of HTTP received data
uint32_t _NCP_CMD_HTTP_RECV_CFG::timeout
HTTP receive data wait time
char _NCP_CMD_HTTP_RECV_CFG::recv_data[1]
Received data buffer.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_REQ_CFG Struct Reference
Data Fields
uint32_t handle
char method [HTTP_PARA_LEN]
char uri [HTTP_URI_LEN]
uint32_t req_size
char req_data [1]
Detailed Description
This structure is used for HTTP request configuration.
Field Documentation
uint32_t _NCP_CMD_HTTP_REQ_CFG::handle
Socket handle index number.
char _NCP_CMD_HTTP_REQ_CFG::method[HTTP_PARA_LEN]
Support method is get/delete/put/options. The max length is 16.
char _NCP_CMD_HTTP_REQ_CFG::uri[HTTP_URI_LEN]
HTTP URL, the string max length is 512
uint32_t _NCP_CMD_HTTP_REQ_CFG::req_size
Size of the request data.
char _NCP_CMD_HTTP_REQ_CFG::req_data[1]
Request data.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_REQ_RESP_CFG Struct Reference
Data Fields
uint32_t header_size
char recv_header [1]
Detailed Description
This structure is used for HTTP request response configuration.
Field Documentation
uint32_t _NCP_CMD_HTTP_REQ_RESP_CFG::header_size
Received header size
char _NCP_CMD_HTTP_REQ_RESP_CFG::recv_header[1]
Received header
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_SETH_CFG Struct Reference
Data Fields
char name [SETH_NAME_LENGTH]
char value [SETH_VALUE_LENGTH]
Detailed Description
This structure is used for HTTP header configuration.
Field Documentation
char _NCP_CMD_HTTP_SETH_CFG::name[SETH_NAME_LENGTH]
HTTP header segment name.
char _NCP_CMD_HTTP_SETH_CFG::value[SETH_VALUE_LENGTH]
HTTP header segment value.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_UNSETH_CFG Struct Reference
Data Fields
char name [SETH_NAME_LENGTH]
Detailed Description
This structure is used for unset HTTP header segment name configuration.
Field Documentation
char _NCP_CMD_HTTP_UNSETH_CFG::name[SETH_NAME_LENGTH]
HTTP header segment name.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_HTTP_UPG_CFG Struct Reference
Data Fields
uint32_t handle
char uri [HTTP_URI_LEN]
char protocol [HTTP_PARA_LEN]
Detailed Description
This structure is used for HTTP upgrade configuration.
Field Documentation
uint32_t _NCP_CMD_HTTP_UPG_CFG::handle
Socket handle index number.
char _NCP_CMD_HTTP_UPG_CFG::uri[HTTP_URI_LEN]
Web socket URI
char _NCP_CMD_HTTP_UPG_CFG::protocol[HTTP_PARA_LEN]
Protocol
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_IEEE_PS Struct Reference
Data Fields
int enable
Detailed Description
This structure is used for IEEE power save mode configuration.
Field Documentation
int _NCP_CMD_IEEE_PS::enable
Enable IEEE power save mode flag,
0: disable,
1: enable.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_MAC_ADDRESS Struct Reference
Data Fields
uint8_t mac_addr [MLAN_MAC_ADDR_LENGTH]
Detailed Description
This structure is used for MAC address configuration.
Field Documentation
uint8_t _NCP_CMD_MAC_ADDRESS::mac_addr[MLAN_MAC_ADDR_LENGTH]
MAC address.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_MBO_ENABLE Struct Reference
Data Fields
int enable
Detailed Description
This structure is used for MBO (multi band operation) flag configuration.
Field Documentation
int _NCP_CMD_MBO_ENABLE::enable
Enable/disable MBO flag,
0: disable,
1: enable.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_MBO_SET_CELL_CAPA Struct Reference
Data Fields
uint8_t cell_capa
Detailed Description
This structure is used for MBO cellular data capabilities configuration.
Field Documentation
uint8_t _NCP_CMD_MBO_SET_CELL_CAPA::cell_capa
MBO cellular data capabilities,
1: cellular data connection available,
2: cellular data connection not available,
3: not cellular capable (default value).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_MBO_SET_OCE Struct Reference
Data Fields
uint8_t oce
Detailed Description
This structure is used for MBO OCE (optimized connectivity experience) configuration.
Field Documentation
uint8_t _NCP_CMD_MBO_SET_OCE::oce
Enable OCE features,
1: Enable OCE in non-AP STA mode,
2: Enable OCE in STA-CFON mode.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_MDNS_QUERY Struct Reference
Data Fields
uint8_t qtype
union {
QUERY_PTR_CFG ptr_cfg
QUERY_A_CFG a_cfg
} Q
Detailed Description
This structure is used to store MDNS query results.
Field Documentation
uint8_t _NCP_CMD_MDNS_QUERY::qtype
Query type, PTR (pointer records), SRV (service records), A (Ipv4), AAAA (IPv6).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_MEM_STAT Struct Reference
Data Fields
uint32_t free_heap_size
uint32_t minimum_ever_free_heap_size
Detailed Description
This structure is used for memory status configuration.
Field Documentation
uint32_t _NCP_CMD_MEM_STAT::free_heap_size
Size of free heap.
uint32_t _NCP_CMD_MEM_STAT::minimum_ever_free_heap_size
Minimum size of ever free heap.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NEIGHBOR_REQ Struct Reference
Data Fields
SSID_ParamSet_t ssid_tlv
Detailed Description
This structure is used for neighbor request.
Field Documentation
SSID_ParamSet_t _NCP_CMD_NEIGHBOR_REQ::ssid_tlv
SSID parameter set.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NET_MONITOR Struct Reference
Data Fields
NCP_WLAN_NET_MONITOR_PARA monitor_para
Detailed Description
This structure is used for network monitor configuration.
Field Documentation
NCP_WLAN_NET_MONITOR_PARA _NCP_CMD_NET_MONITOR::monitor_para
Monitor configuration.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_ADD Struct Reference
Data Fields
char name [WLAN_NETWORK_NAME_MAX_LENGTH]
uint32_t tlv_buf_len
uint8_t tlv_buf [1]
Detailed Description
This structure is used to store the information about the network to be added.
Field Documentation
char _NCP_CMD_NETWORK_ADD::name[WLAN_NETWORK_NAME_MAX_LENGTH]
Network name string
uint32_t _NCP_CMD_NETWORK_ADD::tlv_buf_len
Length of TLVs sent in command starting at TLV buffer
uint8_t _NCP_CMD_NETWORK_ADD::tlv_buf[1]
Payload of “wlan-add” command, includes:
SSID TLV, SSID_ParamSet_t
BSSID TLV, BSSID_ParamSet_t
BSS role TLV, BSSRole_ParamSet_t
Channel TLV, Channel_ParamSet_t
ACS band TLV, ACSBand_ParamSet_t
IP address TLV, IP_ParamSet_t
Security TLV, Security_ParamSet_t
DTIM period TLV, DTIM_ParamSet_t
CAPA TLV, CAPA_ParamSet_t
PMF TLV, PMF_ParamSet_t
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_ADDRESS Struct Reference
Data Fields
uint8_t sta_conn_stat
NCP_WLAN_NETWORK sta_network
Detailed Description
This structure is used for STA network address configuration.
Field Documentation
uint8_t _NCP_CMD_NETWORK_ADDRESS::sta_conn_stat
Station connection status
NCP_WLAN_NETWORK _NCP_CMD_NETWORK_ADDRESS::sta_network
Network information for the station
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_INFO Struct Reference
Data Fields
uint8_t uap_conn_stat
uint8_t sta_conn_stat
NCP_WLAN_NETWORK uap_network
NCP_WLAN_NETWORK sta_network
Detailed Description
This structure is used for network information configuration.
Field Documentation
uint8_t _NCP_CMD_NETWORK_INFO::uap_conn_stat
UAP connection status
uint8_t _NCP_CMD_NETWORK_INFO::sta_conn_stat
Station connection status
NCP_WLAN_NETWORK _NCP_CMD_NETWORK_INFO::uap_network
Network information for the UAP
NCP_WLAN_NETWORK _NCP_CMD_NETWORK_INFO::sta_network
Network information for the station
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_LIST Struct Reference
Data Fields
uint8_t count
NCP_WLAN_NETWORK net_list [NCP_WLAN_KNOWN_NETWORKS]
Detailed Description
This structure is used for network list configuration.
Field Documentation
uint8_t _NCP_CMD_NETWORK_LIST::count
Network number
NCP_WLAN_NETWORK _NCP_CMD_NETWORK_LIST::net_list[NCP_WLAN_KNOWN_NETWORKS]
Network information list.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_REMOVE Struct Reference
Data Fields
char name [WLAN_NETWORK_NAME_MAX_LENGTH+1]
int8_t remove_state
Detailed Description
This structure is used to store the information about the network to be removed.
Field Documentation
char _NCP_CMD_NETWORK_REMOVE::name[WLAN_NETWORK_NAME_MAX_LENGTH+1]
Name of the network to remove.
int8_t _NCP_CMD_NETWORK_REMOVE::remove_state
Remove status, WM_SUCCESS means removed successfully, otherwise removed failed
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_START Struct Reference
Data Fields
char name [WLAN_NETWORK_NAME_MAX_LENGTH]
char ssid [IEEEtypes_SSID_SIZE+1]
Detailed Description
This structure is used to store the information about the UAP to be started.
Field Documentation
char _NCP_CMD_NETWORK_START::name[WLAN_NETWORK_NAME_MAX_LENGTH]
Network name string.
char _NCP_CMD_NETWORK_START::ssid[IEEEtypes_SSID_SIZE+1]
SSID (service set identifier).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_NETWORK_UAP_STA_LIST Struct Reference
Data Fields
uint16_t sta_count
wifi_sta_info_t info [MAX_NUM_CLIENTS]
Detailed Description
This structure is used to store a collection of STAs information, those are connected to the UAP.
Field Documentation
uint16_t _NCP_CMD_NETWORK_UAP_STA_LIST::sta_count
Number of STAs connected to the UAP.
wifi_sta_info_t _NCP_CMD_NETWORK_UAP_STA_LIST::info[MAX_NUM_CLIENTS]
Information on the STAs connected to the UAP.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_PHY_UPDATE_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t tx_phy
uint8_t rx_phy
Detailed Description
This structure contains the value of the Bluetooth LE PHY update complete event which indicate that the controller has changed the transmitter PHY or receiver PHY in use.
Field Documentation
uint8_t _NCP_CMD_PHY_UPDATE_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_PHY_UPDATE_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t _NCP_CMD_PHY_UPDATE_EV::tx_phy
TX physical
1: 1M PHY
2: 2M PHY
4: Coded PHY
uint8_t _NCP_CMD_PHY_UPDATE_EV::rx_phy
RX physical
1: 1M PHY
2: 2M PHY
4: Coded PHY
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_POWERMGMT_MEF Struct Reference
Data Fields
int type
uint8_t action
Detailed Description
This structure is used for power management MEF (memory efficient filtering) configuration.
Field Documentation
int _NCP_CMD_POWERMGMT_MEF::type
Type,
0: delete,
1: ping,
2: ARP (address resolution protocol).
3: multicast,
4: Ipv6 NS.
uint8_t _NCP_CMD_POWERMGMT_MEF::action
Action,
0: discard and do not wake up the host,
1: discard and wake up the host,
3: allow and wake up the host.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_POWERMGMT_QOSINFO Struct Reference
Data Fields
uint8_t qos_info
uint8_t action
Detailed Description
This structure is used for QOS (quality of service) operation configuration.
Field Documentation
uint8_t _NCP_CMD_POWERMGMT_QOSINFO::qos_info
QOS information.
uint8_t _NCP_CMD_POWERMGMT_QOSINFO::action
Action,
0: get,
1: set.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_POWERMGMT_SLEEP_PERIOD Struct Reference
Data Fields
uint32_t period
uint8_t action
Detailed Description
This structure is used for power management sleep period configuration.
Field Documentation
uint32_t _NCP_CMD_POWERMGMT_SLEEP_PERIOD::period
Power management sleep period
uint8_t _NCP_CMD_POWERMGMT_SLEEP_PERIOD::action
Action,
0: get,
1: set.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_POWERMGMT_SUSPEND Struct Reference
Data Fields
int mode
Detailed Description
This structure is used for suspend mode of power management.
Field Documentation
int _NCP_CMD_POWERMGMT_SUSPEND::mode
Suspend mode,
1: PM1,
2: PM2,
3: PM3.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_POWERMGMT_UAPSD Struct Reference
Data Fields
int enable
Detailed Description
This structure is use for UAPSD (unscheduled automatic power save delivery) flag configuration.
Field Documentation
int _NCP_CMD_POWERMGMT_UAPSD::enable
Enable flag,
0: disable UAPSD,
1: enable UAPSD.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_POWERMGMT_WOWLAN_CFG Struct Reference
Data Fields
uint8_t is_mef
uint8_t wake_up_conds
Detailed Description
This structure is used for WOWLAN (wake on wireless LAN) power management configuration.
Field Documentation
uint8_t _NCP_CMD_POWERMGMT_WOWLAN_CFG::is_mef
Type,
0x0: WOWLAN
0x1: MEF.
uint8_t _NCP_CMD_POWERMGMT_WOWLAN_CFG::wake_up_conds
Wakeup condition bitmap, value for default WOWLAN (wake on wireless LAN) conditions only.
bit 0: WAKE_ON_ALL_BROADCAST,
bit 1: WAKE_ON_UNICAST,
bit 2: WAKE_ON_MAC_EVENT,
bit 3: WAKE_ON_MULTICAST,
bit 4: WAKE_ON_ARP_BROADCAST,
bit 6: WAKE_ON_MGMT_FRAME,
all bit 0 discard and not wakeup host.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_REGION_CODE Struct Reference
Data Fields
uint32_t action
uint32_t region_code
Detailed Description
This structure is used for region code configuration.
Field Documentation
uint32_t _NCP_CMD_REGION_CODE::action
Action,
0: get,
1: set.
uint32_t _NCP_CMD_REGION_CODE::region_code
Region code,
0x00:”WW” World Wide,
0x10:”US” US FCC,
0x20:”CA” IC Canada,
0x10:”SG” Singapore,
0x30:”EU” ETSI,
0x30:”AU” Australia,
0x30:”KR” Republic Of Korea,
0x32:”FR” France,
0xFF:”JP” Japan,
0x50:”CN” China.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_REGISTER_ACCESS Struct Reference
Data Fields
uint8_t action
uint8_t type
uint32_t offset
uint32_t value
Detailed Description
This structure is used for register access configuration.
Field Documentation
uint8_t _NCP_CMD_REGISTER_ACCESS::action
Action,
0: get,
1: set.
uint8_t _NCP_CMD_REGISTER_ACCESS::type
1: MAC,
2: BBP,
3: RF,
4: CAU
uint32_t _NCP_CMD_REGISTER_ACCESS::offset
Offset of register.
uint32_t _NCP_CMD_REGISTER_ACCESS::value
Value of register.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_BAND Struct Reference
Data Fields
uint8_t band
Detailed Description
This structure is used for RF band configuration.
Field Documentation
uint8_t _NCP_CMD_RF_BAND::band
Band mode,
0: 2.4GHz,
1: 5GHz.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_BANDWIDTH Struct Reference
Data Fields
uint8_t bandwidth
Detailed Description
This structure is used for RF bandwidth configuration.
Field Documentation
uint8_t _NCP_CMD_RF_BANDWIDTH::bandwidth
Bandwidth,
0: 20MHz;
1: 40MHz;
4: 80MHz.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_CHANNEL Struct Reference
Data Fields
uint8_t channel
Detailed Description
This structure is used for RF channel number configuration.
Field Documentation
uint8_t _NCP_CMD_RF_CHANNEL::channel
2.4GHz channel numbers or 5GHz channel numbers.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_PER Struct Reference
Data Fields
uint32_t rx_tot_pkt_count
uint32_t rx_mcast_bcast_count
uint32_t rx_pkt_fcs_error
Detailed Description
This structure is used for RF per command configuration.
Field Documentation
uint32_t _NCP_CMD_RF_PER::rx_tot_pkt_count
Sum of RX packet count.
uint32_t _NCP_CMD_RF_PER::rx_mcast_bcast_count
Sum of RX multicast/broadcast packet count.
uint32_t _NCP_CMD_RF_PER::rx_pkt_fcs_error
Sum of RX packets with FCS (frame check sequence) error count.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_RADIO_MODE Struct Reference
Data Fields
uint8_t radio_mode
Detailed Description
This structure is used for RF radio mode configuration.
Field Documentation
uint8_t _NCP_CMD_RF_RADIO_MODE::radio_mode
Radio mode,
0: set radio in power down mode,
3: sets radio in 5GHz band, 1X1 mode(path A),
11: sets radio in 2.4GHz band, 1X1 mode(path A).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_RX_ANTENNA Struct Reference
Data Fields
uint8_t ant
Detailed Description
This structure is used for RF RX antenna configuration.
Field Documentation
uint8_t _NCP_CMD_RF_RX_ANTENNA::ant
Antenna type,
1: main antenna,
2: aux antenna.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_TX_ANTENNA Struct Reference
Data Fields
uint8_t ant
Detailed Description
This structure is used for RF TX antenna configuration.
Field Documentation
uint8_t _NCP_CMD_RF_TX_ANTENNA::ant
Antenna type,
1: main antenna,
2: aux antenna.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_TX_CONT_MODE Struct Reference
Data Fields
uint32_t enable_tx
uint32_t cw_mode
uint32_t payload_pattern
uint32_t cs_mode
uint32_t act_sub_ch
uint32_t tx_rate
Detailed Description
This structure is used for RF TX continuous configuration.
Field Documentation
uint32_t _NCP_CMD_RF_TX_CONT_MODE::enable_tx
Enable TX flag,
0: disable TX,
1: enable TX.
uint32_t _NCP_CMD_RF_TX_CONT_MODE::cw_mode
Enable CW (continuous wave) mode flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_CONT_MODE::payload_pattern
Payload pattern, 0 to 0xFFFFFFF (enter hexadecimal value).
uint32_t _NCP_CMD_RF_TX_CONT_MODE::cs_mode
Enable CS mode flag, applicable only when continuous wave is disabled,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_CONT_MODE::act_sub_ch
Active sub channel,
0: low,
1: upper,
3: both.
uint32_t _NCP_CMD_RF_TX_CONT_MODE::tx_rate
Transmit data rate, rate index corresponding to legacy/HT (802.11n high throughput)/VHT (802.11ac very high throughput) rates.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_TX_FRAME Struct Reference
Data Fields
uint32_t enable
uint32_t data_rate
uint32_t frame_pattern
uint32_t frame_length
uint32_t adjust_burst_sifs
uint32_t burst_sifs_in_us
uint32_t short_preamble
uint32_t act_sub_ch
uint32_t short_gi
uint32_t adv_coding
uint32_t tx_bf
uint32_t gf_mode
uint32_t stbc
uint8_t bssid [MLAN_MAC_ADDR_LENGTH]
Detailed Description
This structure is used for RF TX frame configuration.
Field Documentation
uint32_t _NCP_CMD_RF_TX_FRAME::enable
Enable flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::data_rate
Transmit data rate, rate index corresponding to legacy/HT/VHT rates.
uint32_t _NCP_CMD_RF_TX_FRAME::frame_pattern
Payload pattern, (0 to 0xFFFFFFFF) (Enter hexadecimal value)
uint32_t _NCP_CMD_RF_TX_FRAME::frame_length
Payload length, (1 to 0x400) (Enter hexadecimal value)
uint32_t _NCP_CMD_RF_TX_FRAME::adjust_burst_sifs
Adjust burst SIFS3 gap enable flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::burst_sifs_in_us
Burst SIFS (short interframe space) in us (0 to 255us)
uint32_t _NCP_CMD_RF_TX_FRAME::short_preamble
Enable short preamble flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::act_sub_ch
Enable active sub channel flag,
0: low,
1: upper,
3: both.
uint32_t _NCP_CMD_RF_TX_FRAME::short_gi
Enable short GI (guard interval) flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::adv_coding
Enable advanced coding flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::tx_bf
Enable beamforming flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::gf_mode
Enable green field mode flag,
0: disable,
1: enable.
uint32_t _NCP_CMD_RF_TX_FRAME::stbc
Enable STBC (space time block coding) flag,
0: disable,
1: enable.
uint8_t _NCP_CMD_RF_TX_FRAME::bssid[MLAN_MAC_ADDR_LENGTH]
BSSID string.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RF_TX_POWER Struct Reference
Data Fields
uint8_t power
uint8_t mod
uint8_t path_id
Detailed Description
This structure is used for RF TX power configuration.
Field Documentation
uint8_t _NCP_CMD_RF_TX_POWER::power
Power value: 0~24 dBm.
uint8_t _NCP_CMD_RF_TX_POWER::mod
Modulation mode,
0: CCK (complementary code keying),
1: OFDM (orthogonal frequency division multiplexing),
2: MCS.
uint8_t _NCP_CMD_RF_TX_POWER::path_id
Path ID,
0: path A,
1: path B,
2: path A+B.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_ROAMING Struct Reference
Data Fields
uint32_t enable
uint8_t rssi_threshold
Detailed Description
This structure is used for roaming configuration.
Field Documentation
uint32_t _NCP_CMD_ROAMING::enable
STA roaming enable flag,
1: enable roaming,
0: disable roaming.
uint8_t _NCP_CMD_ROAMING::rssi_threshold
When the RSSI of the AP currently connected to the STA is lower than this threshold, the STA begins to scan the environment to find APs with better signals for roaming.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_RSSI Struct Reference
Data Fields
NCP_WLAN_RSSI_INFO_T rssi_info
Detailed Description
This structure is used for RSSI configuration.
Field Documentation
NCP_WLAN_RSSI_INFO_T _NCP_CMD_RSSI::rssi_info
RSSI information.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SCAN_NETWORK_INFO Struct Reference
Data Fields
uint32_t res_cnt
NCP_WLAN_SCAN_RESULT res [CONFIG_MAX_AP_ENTRIES]
Detailed Description
This structure is used to store the information of all scanned APs.
Field Documentation
uint32_t _NCP_CMD_SCAN_NETWORK_INFO::res_cnt
Number of scanned APs.
NCP_WLAN_SCAN_RESULT _NCP_CMD_SCAN_NETWORK_INFO::res[CONFIG_MAX_AP_ENTRIES]
Information of each scanned AP.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SCAN_START Struct Reference
Data Fields
uint8_t type
Detailed Description
This structure is used for NCP Bluetooth LE start scanning.
Field Documentation
uint8_t _NCP_CMD_SCAN_START::type
scan start
0: active scan
1: passive scan
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SERVICE_ADD Struct Reference
Data Fields
uint32_t tlv_buf_len
uint8_t tlv_buf [1]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE add service command.
Field Documentation
uint32_t _NCP_CMD_SERVICE_ADD::tlv_buf_len
the buffer length of TLV (type length value)
uint8_t _NCP_CMD_SERVICE_ADD::tlv_buf[1]
add service TLV, gatt_add_service_cmd_t
add characteristic TLV, gatt_add_characteristic_cmd_t
add descriptor TLV, gatt_add_descriptor_cmd_t
add include service TLV, gatt_add_included_service_cmd_t (to be added in the future)
start host service TLV, gatt_start_service_cmd_t
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SERVICE_DISC Struct Reference
Data Fields
uint32_t tlv_buf_len
uint8_t tlv_buf [1]
Detailed Description
This structure contains the configuration values of the Bluetooth LE service discovery data.
Field Documentation
uint32_t _NCP_CMD_SERVICE_DISC::tlv_buf_len
the buffer length of TLV (type length value)
uint8_t _NCP_CMD_SERVICE_DISC::tlv_buf[1]
discovery primary service TLV, gatt_disc_prim_uuid_cmd_t
discovery characteristic TLV, gatt_disc_chrc_uuid_cmd_t
discovery descriptor TLV, gatt_disc_desc_uuid_cmd_t
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_ADDR Struct Reference
Data Fields
uint8_t addr [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure is used for NCP Bluetooth LE set device address.
Field Documentation
uint8_t _NCP_CMD_SET_ADDR::addr[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_ADV_DATA Struct Reference
Data Fields
uint8_t adv_length
uint8_t adv_data []
Detailed Description
This structure is used for NCP Bluetooth LE set advertising data.
Field Documentation
uint8_t _NCP_CMD_SET_ADV_DATA::adv_length
advertising data length
uint8_t _NCP_CMD_SET_ADV_DATA::adv_data[]
advertising data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_DATA_LEN Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t time_flag
uint16_t tx_max_len
uint16_t tx_max_time
Detailed Description
This structure is used for NCP Bluetooth LE set data length.
Field Documentation
uint8_t _NCP_CMD_SET_DATA_LEN::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_SET_DATA_LEN::address[NCP_BLE_ADDR_LENGTH]
remote address
uint8_t _NCP_CMD_SET_DATA_LEN::time_flag
time flag
uint16_t _NCP_CMD_SET_DATA_LEN::tx_max_len
max transmit data length
uint16_t _NCP_CMD_SET_DATA_LEN::tx_max_time
max transmit time
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_NAME Struct Reference
Data Fields
uint8_t name [33]
Detailed Description
This structure is used for NCP Bluetooth LE set device name.
Field Documentation
uint8_t _NCP_CMD_SET_NAME::name[33]
device name
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_PHY Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t options
uint8_t pref_tx_phy
uint8_t pref_rx_phy
Detailed Description
This structure is used for NCP Bluetooth LE set PHY.
Field Documentation
uint8_t _NCP_CMD_SET_PHY::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_CMD_SET_PHY::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_CMD_SET_PHY::options
Connection PHY options
0: BT_CONN_LE_PHY_OPT_NONE (Convenience value when no options are specified)
bit0: BT_CONN_LE_PHY_OPT_CODED_S2 (LE Coded using S=2 coding preferred when transmitting)
bit1: BT_CONN_LE_PHY_OPT_CODED_S8 (LE Coded using S=8 coding preferred when transmitting)
uint8_t _NCP_CMD_SET_PHY::pref_tx_phy
Bitmask of preferred transmit PHYs
0: BT_GAP_LE_PHY_NONE (Convenience macro for when no PHY is set)
bit0: BT_GAP_LE_PHY_1M (LE 1M PHY)
bit1: BT_GAP_LE_PHY_2M (LE 2M PHY)
bit2: BT_GAP_LE_PHY_CODED (LE Coded PHY)
uint8_t _NCP_CMD_SET_PHY::pref_rx_phy
Bitmask of preferred receive PHYs
0: BT_GAP_LE_PHY_NONE (Convenience macro for when no PHY is set)
bit0: BT_GAP_LE_PHY_1M (LE 1M PHY)
bit1: BT_GAP_LE_PHY_2M (LE 2M PHY)
bit2: BT_GAP_LE_PHY_CODED (LE Coded PHY)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_POWER_MODE Struct Reference
Data Fields
uint8_t mode
Detailed Description
This structure is used for NCP Bluetooth LE set power mode.
Field Documentation
uint8_t _NCP_CMD_SET_POWER_MODE::mode
Set narrowband controller power mode.
auto sleep disable : 0x02
auto sleep enable : 0x03
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SET_SCAN_PARAM Struct Reference
Data Fields
uint32_t options
uint16_t interval
uint16_t window
Detailed Description
This structure is used for NCP Bluetooth LE set scan parameter.
Field Documentation
uint32_t _NCP_CMD_SET_SCAN_PARAM::options
bit-field of scanning options.
uint16_t _NCP_CMD_SET_SCAN_PARAM::interval
scan interval (N * 0.625 ms)
uint16_t _NCP_CMD_SET_SCAN_PARAM::window
scan window (N * 0.625 ms)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_SOCKET_ACCEPT_CFG Struct Reference
Data Fields
uint32_t handle
int accepted_handle
Detailed Description
This structure is used for socket accept configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_ACCEPT_CFG::handle
Socket handle index number.
int _NCP_CMD_SOCKET_ACCEPT_CFG::accepted_handle
Accept socket handle.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_BIND_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t port
char ip_addr [IP_ADDR_LEN]
Detailed Description
This structure is used for socket bind configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_BIND_CFG::handle
Socket handle index number.
uint32_t _NCP_CMD_SOCKET_BIND_CFG::port
socket port number to be bound.
char _NCP_CMD_SOCKET_BIND_CFG::ip_addr[IP_ADDR_LEN]
IP address to be bound.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_CLOSE_CFG Struct Reference
Data Fields
uint32_t handle
Detailed Description
This structure is used for socket closing configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_CLOSE_CFG::handle
Socket handle index number.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_CON_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t port
char ip_addr [IP_ADDR_LEN]
Detailed Description
This structure is used for socket connect configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_CON_CFG::handle
Socket handle index number
uint32_t _NCP_CMD_SOCKET_CON_CFG::port
Port number
char _NCP_CMD_SOCKET_CON_CFG::ip_addr[IP_ADDR_LEN]
IP address
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_LISTEN_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t number
Detailed Description
This structure is used for socket listening configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_LISTEN_CFG::handle
Socket handle index number
uint32_t _NCP_CMD_SOCKET_LISTEN_CFG::number
Maximum number of sockets to listen to
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_OPEN_CFG Struct Reference
Data Fields
char socket_type [HTTP_PARA_LEN]
char domain_type [HTTP_PARA_LEN]
char protocol [HTTP_PARA_LEN]
uint32_t opened_handle
Detailed Description
This structure is used for socket open configuration.
Field Documentation
char _NCP_CMD_SOCKET_OPEN_CFG::socket_type[HTTP_PARA_LEN]
Socket type: raw/UDP/TCP
char _NCP_CMD_SOCKET_OPEN_CFG::domain_type[HTTP_PARA_LEN]
Domain type
char _NCP_CMD_SOCKET_OPEN_CFG::protocol[HTTP_PARA_LEN]
Protocol.
uint32_t _NCP_CMD_SOCKET_OPEN_CFG::opened_handle
Handle to open.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_RECEIVE_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t recv_size
uint32_t timeout
char recv_data [1]
Detailed Description
This structure is used for socket receive configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_RECEIVE_CFG::handle
Peer socket handle.
uint32_t _NCP_CMD_SOCKET_RECEIVE_CFG::recv_size
Received buffer size, the buffer max length is 4072.
uint32_t _NCP_CMD_SOCKET_RECEIVE_CFG::timeout
Wait time.
char _NCP_CMD_SOCKET_RECEIVE_CFG::recv_data[1]
Received data.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_RECVFROM_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t recv_size
uint32_t timeout
char peer_ip [IP_ADDR_LEN]
uint32_t peer_port
char recv_data [1]
Detailed Description
This structure is used for socket recvfrom configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_RECVFROM_CFG::handle
Peer socket handle.
uint32_t _NCP_CMD_SOCKET_RECVFROM_CFG::recv_size
Size of received buffer, the buffer maximum length is 4072.
uint32_t _NCP_CMD_SOCKET_RECVFROM_CFG::timeout
Wait time.
char _NCP_CMD_SOCKET_RECVFROM_CFG::peer_ip[IP_ADDR_LEN]
Peer IP address.
uint32_t _NCP_CMD_SOCKET_RECVFROM_CFG::peer_port
Peer port number.
char _NCP_CMD_SOCKET_RECVFROM_CFG::recv_data[1]
Received data.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_SEND_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t size
char send_data [1]
Detailed Description
This structure is used for socket send configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_SEND_CFG::handle
Socket handle index number.
uint32_t _NCP_CMD_SOCKET_SEND_CFG::size
Size of send data.
char _NCP_CMD_SOCKET_SEND_CFG::send_data[1]
Data buffer to send.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_SOCKET_SENDTO_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t size
char ip_addr [IP_ADDR_LEN]
uint32_t port
char send_data [1]
Detailed Description
This structure is used for socket sendto configuration.
Field Documentation
uint32_t _NCP_CMD_SOCKET_SENDTO_CFG::handle
Socket handle index number.
uint32_t _NCP_CMD_SOCKET_SENDTO_CFG::size
Send data size.
char _NCP_CMD_SOCKET_SENDTO_CFG::ip_addr[IP_ADDR_LEN]
Peer device IP address, the max length is 16.
uint32_t _NCP_CMD_SOCKET_SENDTO_CFG::port
Peer port number
char _NCP_CMD_SOCKET_SENDTO_CFG::send_data[1]
Data buffer to send.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_START_SERVICE Struct Reference
Data Fields
uint8_t form_host
uint8_t svc_id
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE start service command.
Field Documentation
uint8_t _NCP_CMD_START_SERVICE::form_host
host status
uint8_t _NCP_CMD_START_SERVICE::svc_id
service ID
hts
hrs
htc
hrc
bas
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_CMD_TEMPERATURE Struct Reference
Data Fields
uint32_t temp
Detailed Description
This structure is used to store temperature of the device.
Field Documentation
uint32_t _NCP_CMD_TEMPERATURE::temp
Temperature (celsius) value.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_TWT_REPORT Struct Reference
Data Fields
uint8_t type
uint8_t length
uint8_t reserve [2]
IEEE_BTWT_ParamSet_t info [6]
Detailed Description
This structure is used for TWT report.
Field Documentation
uint8_t _NCP_CMD_TWT_REPORT::type
TWT report type, 0: BTWT id.
uint8_t _NCP_CMD_TWT_REPORT::length
TWT report length of value in data.
uint8_t _NCP_CMD_TWT_REPORT::reserve[2]
Reserved fields.
IEEE_BTWT_ParamSet_t _NCP_CMD_TWT_REPORT::info[6]
TWT report payload for FW response to fill, 4 * 9bytes.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_TWT_SETUP Struct Reference
Data Fields
uint8_t implicit
uint8_t announced
uint8_t trigger_enabled
uint8_t twt_info_disabled
uint8_t negotiation_type
uint8_t twt_wakeup_duration
uint8_t flow_identifier
uint8_t hard_constraint
uint8_t twt_exponent
uint16_t twt_mantissa
uint8_t twt_request
Detailed Description
This structure is used for TWT configuration.
Field Documentation
uint8_t _NCP_CMD_TWT_SETUP::implicit
Implicit enable flag,
0: TWT session is explicit,
1: session is implicit.
uint8_t _NCP_CMD_TWT_SETUP::announced
Announced enable flag,
0: unannounced,
1: announced TWT.
uint8_t _NCP_CMD_TWT_SETUP::trigger_enabled
Trigger enable flag,
0: Non-Trigger enabled,
1: trigger enabled TWT.
uint8_t _NCP_CMD_TWT_SETUP::twt_info_disabled
TWT information disable flag,
0: TWT info enabled,
1: TWT info disabled.
uint8_t _NCP_CMD_TWT_SETUP::negotiation_type
Negotiation type,
0: individual TWT,
3: broadcast TWT.
uint8_t _NCP_CMD_TWT_SETUP::twt_wakeup_duration
TWT wakeup duration, time after which the TWT requesting STA can transition to doze state.
uint8_t _NCP_CMD_TWT_SETUP::flow_identifier
Flow identifier. range: [0-7].
uint8_t _NCP_CMD_TWT_SETUP::hard_constraint
Hard constraint,
0: FW can tweak the TWT setup parameters if it is rejected by AP.
1: Firmware should not tweak any parameters.
uint8_t _NCP_CMD_TWT_SETUP::twt_exponent
TWT exponent, range: [0-63].
uint16_t _NCP_CMD_TWT_SETUP::twt_mantissa
TWT wake interval mantissa, range: [0-(2^16-1)].
uint8_t _NCP_CMD_TWT_SETUP::twt_request
TWT request type,
0: REQUEST_TWT,
1: SUGGEST_TWT.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_TWT_TEARDOWN Struct Reference
Data Fields
uint8_t flow_identifier
uint8_t negotiation_type
uint8_t teardown_all_twt
Detailed Description
This structure is used for TWT teardown configuration.
Field Documentation
uint8_t _NCP_CMD_TWT_TEARDOWN::flow_identifier
TWT flow identifier, range from 0 to 7.
uint8_t _NCP_CMD_TWT_TEARDOWN::negotiation_type
Negotiation type.
0: Future individual TWT service period start time,
1: Next wake TBTT (target beacon transmission time).
uint8_t _NCP_CMD_TWT_TEARDOWN::teardown_all_twt
Tear down all TWT enable flag.
1: To teardown all TWT,
0: none to do.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_UAP_PROV_SET_UAPCFG Struct Reference
Data Fields
uint32_t security_type
char ssid [WLAN_NETWORK_NAME_MAX_LENGTH+1]
char uapPass [NCP_WLAN_PASSWORD_MAX_LENGTH+1]
Detailed Description
This structure is used for provisioning UAP configuration.
Field Documentation
uint32_t _NCP_CMD_UAP_PROV_SET_UAPCFG::security_type
Security type, detail value refer to enum wlan_security_type.
char _NCP_CMD_UAP_PROV_SET_UAPCFG::ssid[WLAN_NETWORK_NAME_MAX_LENGTH+1]
SSID string.
char _NCP_CMD_UAP_PROV_SET_UAPCFG::uapPass[NCP_WLAN_PASSWORD_MAX_LENGTH+1]
Password string.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_WEBSOCKET_RECV_CFG Struct Reference
Data Fields
uint32_t handle
uint32_t recv_size
uint32_t timeout
uint32_t fin
char recv_data [1]
Detailed Description
This structure is used for web socket receive configuration.
Field Documentation
uint32_t _NCP_CMD_WEBSOCKET_RECV_CFG::handle
Web socket handle.
uint32_t _NCP_CMD_WEBSOCKET_RECV_CFG::recv_size
Size of received data, the maximum length is 4068.
uint32_t _NCP_CMD_WEBSOCKET_RECV_CFG::timeout
Wait time, timeout if no data is received from the peer device within a period of time.
uint32_t _NCP_CMD_WEBSOCKET_RECV_CFG::fin
FIN flag is used to terminate the TCP connection, If the value is 1, the TCP connection is disconnected.
char _NCP_CMD_WEBSOCKET_RECV_CFG::recv_data[1]
Data buffer used to store the packets received from the web socket.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_WEBSOCKET_SEND_CFG Struct Reference
Data Fields
uint32_t handle
char type [HTTP_PARA_LEN]
uint32_t size
char send_data [1]
Detailed Description
This structure is used for web socket send configuration.
Field Documentation
uint32_t _NCP_CMD_WEBSOCKET_SEND_CFG::handle
Socket handle index number
char _NCP_CMD_WEBSOCKET_SEND_CFG::type[HTTP_PARA_LEN]
Data type.
uint32_t _NCP_CMD_WEBSOCKET_SEND_CFG::size
Size of send data.
char _NCP_CMD_WEBSOCKET_SEND_CFG::send_data[1]
Data to be send.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_WLAN_CONN Struct Reference
Data Fields
char name [WLAN_NETWORK_NAME_MAX_LENGTH]
uint32_t ip
char ssid [IEEEtypes_SSID_SIZE+1]
Detailed Description
This structure is used for Wi-Fi connection configuration.
Field Documentation
char _NCP_CMD_WLAN_CONN::name[WLAN_NETWORK_NAME_MAX_LENGTH]
Wi-Fi network profile name.
uint32_t _NCP_CMD_WLAN_CONN::ip
IP address of STA after the connection is successful.
char _NCP_CMD_WLAN_CONN::ssid[IEEEtypes_SSID_SIZE+1]
SSID of the connected Wi-Fi network.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_WPS_GEN_PIN Struct Reference
Data Fields
uint32_t pin
Detailed Description
This structure is used for generated pin code configuration.
Field Documentation
uint32_t _NCP_CMD_WPS_GEN_PIN::pin
WPS (Wi-Fi protected setup) pin code.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_CMD_WPS_PIN Struct Reference
Data Fields
uint32_t pin
Detailed Description
This structure is used for pin code configuration.
Field Documentation
uint32_t _NCP_CMD_WPS_PIN::pin
Pin code of WPS (Wi-Fi protected setup).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_DEVICE_ADV_REPORT_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
int8_t rssi
uint8_t flags
uint16_t eir_data_len
uint8_t eir_data []
Detailed Description
This structure contains the value of the Bluetooth LE advertising report event which indicates one or more Bluetooth devices have responded to an active scan or have broadcast advertisements that were received during a passive scan.
Field Documentation
uint8_t _NCP_DEVICE_ADV_REPORT_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_DEVICE_ADV_REPORT_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
int8_t _NCP_DEVICE_ADV_REPORT_EV::rssi
advertising packet RSSI
uint8_t _NCP_DEVICE_ADV_REPORT_EV::flags
Bluetooth LE device found flag
0x01: GAP_DEVICE_FOUND_FLAG_RSSI
0x02: GAP_DEVICE_FOUND_FLAG_AD
0x04: GAP_DEVICE_FOUND_FLAG_SD
uint16_t _NCP_DEVICE_ADV_REPORT_EV::eir_data_len
EIR data length
uint8_t _NCP_DEVICE_ADV_REPORT_EV::eir_data[]
EIR data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DEVICE_CONNECTED_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t interval
uint16_t latency
uint16_t timeout
Detailed Description
This structure contains the value of the Bluetooth LE connection complete event which indicates a new connection has been created.
Field Documentation
uint8_t _NCP_DEVICE_CONNECTED_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_DEVICE_CONNECTED_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_DEVICE_CONNECTED_EV::interval
connection interval
uint16_t _NCP_DEVICE_CONNECTED_EV::latency
connection latency
Maximum peripheral latency for the connection in number of subrated connection events
uint16_t _NCP_DEVICE_CONNECTED_EV::timeout
connection timeout
Supervision timeout for the Bluetooth LE link
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DEVICE_DISCONNECTED_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the value of the Bluetooth LE disconnection complete event which indicates a connection is terminated.
Field Documentation
uint8_t _NCP_DEVICE_DISCONNECTED_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_DEVICE_DISCONNECTED_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DISC_ALL_DESC_RP Struct Reference
Data Fields
uint8_t descriptors_count
GATT_DESCRIPTOR_T descriptors [MAX_SUPPORT_SERVICE]
Detailed Description
This structure is returned as an output from the Bluetooth LE discover descriptors command.
Field Documentation
uint8_t _NCP_DISC_ALL_DESC_RP::descriptors_count
descriptors count
GATT_DESCRIPTOR_T _NCP_DISC_ALL_DESC_RP::descriptors[MAX_SUPPORT_SERVICE]
descriptors information
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DISC_CHRC_RP Struct Reference
Data Fields
uint8_t characteristics_count
GATT_CHARACTERISTIC_T characteristics [MAX_SUPPORT_SERVICE]
Detailed Description
This structure is returned as an output from the Bluetooth LE discover characteristics command.
Field Documentation
uint8_t _NCP_DISC_CHRC_RP::characteristics_count
characteristic count
GATT_CHARACTERISTIC_T _NCP_DISC_CHRC_RP::characteristics[MAX_SUPPORT_SERVICE]
characteristic information
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DISC_CHRC_UUID_CMD Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure is used for NCP Bluetooth LE discover characteristic UUID.
Field Documentation
uint8_t _NCP_DISC_CHRC_UUID_CMD::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_DISC_CHRC_UUID_CMD::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_DISC_CHRC_UUID_CMD::start_handle
attribute start handle
uint16_t _NCP_DISC_CHRC_UUID_CMD::end_handle
attribute end handle
uint8_t _NCP_DISC_CHRC_UUID_CMD::uuid_length
UUID length
uint8_t _NCP_DISC_CHRC_UUID_CMD::uuid[SERVER_MAX_UUID_LEN]
UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DISC_PRIM_RP Struct Reference
Data Fields
uint8_t services_count
GATT_SERVICE_T services [MAX_SUPPORT_SERVICE]
Detailed Description
This structure is returned as an output from the Bluetooth LE discover primary service command.
Field Documentation
uint8_t _NCP_DISC_PRIM_RP::services_count
service count
GATT_SERVICE_T _NCP_DISC_PRIM_RP::services[MAX_SUPPORT_SERVICE]
service information
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_DISC_PRIM_UUID_CMD Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure is used for NCP Bluetooth LE discover primary service UUID.
Field Documentation
uint8_t _NCP_DISC_PRIM_UUID_CMD::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_DISC_PRIM_UUID_CMD::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t _NCP_DISC_PRIM_UUID_CMD::uuid_length
UUID length
uint8_t _NCP_DISC_PRIM_UUID_CMD::uuid[SERVER_MAX_UUID_LEN]
UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_EVT_CSI_DATA Struct Reference
Data Fields
uint16_t Len
uint16_t CSI_Sign
uint32_t CSI_HeaderID
uint16_t PKT_info
uint16_t FCF
uint64_t TSF
uint8_t Dst_MAC [IEEEtypes_MAC_ADDRESS_SIZE]
uint8_t Src_MAC [IEEEtypes_MAC_ADDRESS_SIZE]
uint8_t Rx_RSSI_A
uint8_t Rx_RSSI_B
uint8_t Rx_NF_A
uint8_t Rx_NF_B
uint8_t Rx_SINR
uint8_t channel
uint16_t chip_id
uint32_t rsvd
uint32_t CSI_Data_Length
uint8_t CSI_Data [0]
Detailed Description
This structure is used for CSI (channel state information) data configuration.
Field Documentation
uint16_t _NCP_EVT_CSI_DATA::Len
Length in dwords, including header.
uint16_t _NCP_EVT_CSI_DATA::CSI_Sign
CSI (channel state information) signature. 0xABCD fixed.
uint32_t _NCP_EVT_CSI_DATA::CSI_HeaderID
User defined header ID.
uint16_t _NCP_EVT_CSI_DATA::PKT_info
Packet info field.
uint16_t _NCP_EVT_CSI_DATA::FCF
Frame control field for the received packet.
uint64_t _NCP_EVT_CSI_DATA::TSF
Timestamp when packet received
uint8_t _NCP_EVT_CSI_DATA::Dst_MAC[IEEEtypes_MAC_ADDRESS_SIZE]
Destination MAC address of received packet.
uint8_t _NCP_EVT_CSI_DATA::Src_MAC[IEEEtypes_MAC_ADDRESS_SIZE]
Source MAC address of received packet.
uint8_t _NCP_EVT_CSI_DATA::Rx_RSSI_A
RX RSSI for antenna A.
uint8_t _NCP_EVT_CSI_DATA::Rx_RSSI_B
RX RSSI for antenna B.
uint8_t _NCP_EVT_CSI_DATA::Rx_NF_A
Noise floor for antenna A.
uint8_t _NCP_EVT_CSI_DATA::Rx_NF_B
Noise floor for antenna B.
uint8_t _NCP_EVT_CSI_DATA::Rx_SINR
RX signal strength above noise floor.
uint8_t _NCP_EVT_CSI_DATA::channel
Channel.
uint16_t _NCP_EVT_CSI_DATA::chip_id
User defined chip ID.
uint32_t _NCP_EVT_CSI_DATA::rsvd
Reserved.
uint32_t _NCP_EVT_CSI_DATA::CSI_Data_Length
CSI data length in DWORDs.
uint8_t _NCP_EVT_CSI_DATA::CSI_Data[0]
Start of CSI data.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_EVT_MDNS_RESOLVE Struct Reference
Data Fields
uint8_t ip_type
union {
uint32_t ip6_addr [4]
uint32_t ip4_addr
} u_addr
Detailed Description
This structure is for MDNS domain event.
Field Documentation
uint8_t _NCP_EVT_MDNS_RESOLVE::ip_type
IP type,
0: IPv4,
1: IPv6.
union { … } _NCP_EVT_MDNS_RESOLVE::u_addr
IPv4/IPv6 address.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_EVT_MDNS_RESULT Struct Reference
Data Fields
uint32_t ttl
uint32_t tlv_buf_len
uint8_t tlv_buf [1]
Detailed Description
This structure is used to store MDNS query results.
Field Documentation
uint32_t _NCP_EVT_MDNS_RESULT::ttl
Time to live.
uint32_t _NCP_EVT_MDNS_RESULT::tlv_buf_len
Length of TLVs sent in command starting at buffer.
uint8_t _NCP_EVT_MDNS_RESULT::tlv_buf[1]
Payload buffer of MDNS (multicast DNS) query command.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_GATT_READ_CMD Struct Reference
Data Fields
uint8_t type
uint8_t addr [NCP_BLE_ADDR_LENGTH]
uint16_t handle
Detailed Description
This structure is used for NCP Bluetooth LE read attribute value.
Field Documentation
uint8_t _NCP_GATT_READ_CMD::type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_GATT_READ_CMD::addr[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_GATT_READ_CMD::handle
Attribute handle to read with Characteristic Value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_IDENTITY_RESOLVED_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t identity_address_type
uint8_t identity_address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the value of the Bluetooth LE identity resolved event which indicates that the remote host Identity Address has been resolved.
Field Documentation
uint8_t _NCP_IDENTITY_RESOLVED_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_IDENTITY_RESOLVED_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t _NCP_IDENTITY_RESOLVED_EV::identity_address_type
Bluetooth LE identity address type
2: public identity address
3: random identity address
uint8_t _NCP_IDENTITY_RESOLVED_EV::identity_address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE identity address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_CONNECT_CMD Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
uint8_t sec
uint8_t sec_flag
Detailed Description
This structure is used for NCP Bluetooth LE L2CAP connection.
Field Documentation
uint8_t _NCP_L2CAP_CONNECT_CMD::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_L2CAP_CONNECT_CMD::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_L2CAP_CONNECT_CMD::psm
PSM (Protocol/Service Multiplexer) value
uint8_t _NCP_L2CAP_CONNECT_CMD::sec
connection security level
0x01: No encryption and no authentication
0x02: Encryption and no authentication (no MITM)
0x03: Encryption and authentication (MITM)
uint8_t _NCP_L2CAP_CONNECT_CMD::sec_flag
Option to use customized security level or to use system default security level
0: to use system default security level
1: to use customized security level
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_CONNECT_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
Detailed Description
This structure contains the value of the Bluetooth LE L2CAP (Logical Link Control and Adaptation Layer Protocol) connection complete event which indicates an L2CAP connection is established.
Field Documentation
uint8_t _NCP_L2CAP_CONNECT_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_L2CAP_CONNECT_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_L2CAP_CONNECT_EV::psm
PSM (Protocol/Service Multiplexer) value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_DISCONNECT_CMD Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure is used for NCP Bluetooth LE L2CAP disconnection.
Field Documentation
uint8_t _NCP_L2CAP_DISCONNECT_CMD::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_L2CAP_DISCONNECT_CMD::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_DISCONNECT_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
Detailed Description
This structure contains the value of the Bluetooth LE L2CAP (Logical Link Control and Adaptation Layer Protocol) disconnection complete event which indicates an L2CAP connection is terminated.
Field Documentation
uint8_t _NCP_L2CAP_DISCONNECT_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_L2CAP_DISCONNECT_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_L2CAP_DISCONNECT_EV::psm
PSM (Protocol/Service Multiplexer) value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_METRICS_CMD Struct Reference
Data Fields
bool metrics_flag
Detailed Description
This structure is used for NCP Bluetooth LE L2CAP set metrics.
Field Documentation
bool _NCP_L2CAP_METRICS_CMD::metrics_flag
option to enable calculating metrics of l2cap rate
0: disable calculating metrics of l2cap rate
1: enable calculating metrics of l2cap rate
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_RECEIVE_CMD Struct Reference
Data Fields
uint32_t l2cap_recv_delay_ms
Detailed Description
This structure is used for NCP Bluetooth LE L2CAP receive data.
Field Documentation
uint32_t _NCP_L2CAP_RECEIVE_CMD::l2cap_recv_delay_ms
receive delay time in millisecond
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_RECEIVE_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
uint8_t len
uint8_t data [256]
Detailed Description
This structure contains the value of the Bluetooth LE L2CAP (Logical Link Control and Adaptation Layer Protocol) receive packet event which notifies the receive data over L2CAP channel to the client.
Field Documentation
uint8_t _NCP_L2CAP_RECEIVE_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_L2CAP_RECEIVE_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_L2CAP_RECEIVE_EV::psm
PSM (Protocol/Service Multiplexer) value
uint8_t _NCP_L2CAP_RECEIVE_EV::len
receive data length
uint8_t _NCP_L2CAP_RECEIVE_EV::data[256]
receive data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_REGISTER_CMD Struct Reference
Data Fields
uint16_t psm
uint8_t sec_level
uint8_t sec_flag
uint8_t policy
uint8_t policy_flag
Detailed Description
This structure is used for NCP Bluetooth LE L2CAP register PSM (Protocol/Service Multiplexer).
Field Documentation
uint16_t _NCP_L2CAP_REGISTER_CMD::psm
PSM (Protocol/Service Multiplexer) value
uint8_t _NCP_L2CAP_REGISTER_CMD::sec_level
connection security level
0x01: No encryption and no authentication
0x02: Encryption and no authentication (no MITM)
0x03: Encryption and authentication (MITM)
uint8_t _NCP_L2CAP_REGISTER_CMD::sec_flag
Option to use custom security level or to use system default security level
0: to use system default security level
1: to use customized security level
uint8_t _NCP_L2CAP_REGISTER_CMD::policy
allowlist
uint8_t _NCP_L2CAP_REGISTER_CMD::policy_flag
option to use allowlist
0: not use allowlist
1: use allowlist
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_L2CAP_SEND_CMD Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t times
Detailed Description
This structure is used for NCP Bluetooth LE L2CAP send data.
Field Documentation
uint8_t _NCP_L2CAP_SEND_CMD::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_L2CAP_SEND_CMD::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t _NCP_L2CAP_SEND_CMD::times
the number of times a loop is sent
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_NCS_INFO_RP Struct Reference
Data Fields
char ssid [32]
uint8_t ssid_len
char pswd [65]
uint8_t pswd_len
char secu [10]
uint8_t secu_len
Detailed Description
This structure is returned as an output from the Bluetooth LE commission service command.
Field Documentation
char _NCP_NCS_INFO_RP::ssid[32]
ssid value
uint8_t _NCP_NCS_INFO_RP::ssid_len
ssid length
char _NCP_NCS_INFO_RP::pswd[65]
password value
uint8_t _NCP_NCS_INFO_RP::pswd_len
password length
char _NCP_NCS_INFO_RP::secu[10]
security value
uint8_t _NCP_NCS_INFO_RP::secu_len
security length
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_NOTIFICATION_EV Struct Reference
Data Fields
uint8_t svc_id
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t type
uint16_t handle
uint16_t data_length
uint8_t data [MAX_ATTRIBUTE_VALUE_LEN]
Detailed Description
This structure contains the value of the Bluetooth LE GATT notification event which notifies characteristic values to the client.
Field Documentation
uint8_t _NCP_NOTIFICATION_EV::svc_id
service id
uint8_t _NCP_NOTIFICATION_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_NOTIFICATION_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t _NCP_NOTIFICATION_EV::type
notification type
uint16_t _NCP_NOTIFICATION_EV::handle
notification handle
uint16_t _NCP_NOTIFICATION_EV::data_length
notification data length
uint8_t _NCP_NOTIFICATION_EV::data[MAX_ATTRIBUTE_VALUE_LEN]
notification data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_PASSKEY_DISPLAY_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint32_t passkey
Detailed Description
This structure contains the value of the Bluetooth LE user passkey notification event which is used to provide a passkey for the Host to display to the user.
Field Documentation
uint8_t _NCP_PASSKEY_DISPLAY_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_PASSKEY_DISPLAY_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint32_t _NCP_PASSKEY_DISPLAY_EV::passkey
device passkey number
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_REGISTER_SERVICE Struct Reference
Data Fields
uint8_t svc_length
uint8_t service [MAX_SUPPORT_SERVICE]
Detailed Description
This structure is used for NCP Bluetooth LE register service.
Field Documentation
uint8_t _NCP_REGISTER_SERVICE::svc_length
service length
uint8_t _NCP_REGISTER_SERVICE::service[MAX_SUPPORT_SERVICE]
service id
1: Peripheral_HTS
2: Peripheral_HRS
3: BAS
4: Central_HTS
5: Central_HRS
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_SEC_LEVEL_CHANGED_EV Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t sec_level
Detailed Description
This structure contains the value of the Bluetooth LE security level changed event which is sent when the connection security level has changed.
Field Documentation
uint8_t _NCP_SEC_LEVEL_CHANGED_EV::address_type
Bluetooth LE address type
0: public
1: random
uint8_t _NCP_SEC_LEVEL_CHANGED_EV::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t _NCP_SEC_LEVEL_CHANGED_EV::sec_level
connection security level
0x01: No encryption and no authentication
0x02: Encryption and no authentication (no MITM)
0x03: Encryption and authentication (MITM)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_SET_VALUE_CMD Struct Reference
Data Fields
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
uint16_t len
uint8_t value [512]
Detailed Description
This structure is used for NCP Bluetooth LE set attribute value.
Field Documentation
uint8_t _NCP_SET_VALUE_CMD::uuid_length
UUID length
uint8_t _NCP_SET_VALUE_CMD::uuid[SERVER_MAX_UUID_LEN]
UUID value
uint16_t _NCP_SET_VALUE_CMD::len
data length
uint8_t _NCP_SET_VALUE_CMD::value[512]
data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_START_ADV_RP Struct Reference
Data Fields
uint32_t adv_setting
Detailed Description
This structure contains the command response values of the Bluetooth LE start advertising command.
Field Documentation
uint32_t _NCP_START_ADV_RP::adv_setting
device current setting
bit0: GAP_SETTINGS_POWERED
bit1: GAP_SETTINGS_CONNECTABLE
bit2: GAP_SETTINGS_FAST_CONNECTABLE
bit3: GAP_SETTINGS_DISCOVERABLE
bit4: GAP_SETTINGS_BONDABLE
bit5: GAP_SETTINGS_LINK_SEC_3
bit6: GAP_SETTINGS_SSP
bit7: GAP_SETTINGS_BREDR
bit8: GAP_SETTINGS_HS
bit9: GAP_SETTINGS_LE
bit10: GAP_SETTINGS_ADVERTISING
bit11: GAP_SETTINGS_SC
bit12: GAP_SETTINGS_DEBUG_KEYS
bit13: GAP_SETTINGS_PRIVACY
bit14: GAP_SETTINGS_CONTROLLER_CONFIG
bit15: GAP_SETTINGS_STATIC_ADDRESS
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_NCP_SUBSCRIPTION_EV Struct Reference
Data Fields
uint8_t svc_id
uint8_t status
Detailed Description
This structure contains the value of the Bluetooth LE subscription event which indicates the service characteristics are subscribed
Field Documentation
uint8_t _NCP_SUBSCRIPTION_EV::svc_id
service id
uint8_t _NCP_SUBSCRIPTION_EV::status
subscription status
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_ncp_wlan_ipv4_config Struct Reference
Data Fields
uint32_t addr_type: 2
uint32_t address
uint32_t gw
uint32_t netmask
uint32_t dns1
uint32_t dns2
Detailed Description
This structure is used for IPv4 configuration.
Field Documentation
uint32_t _ncp_wlan_ipv4_config::addr_type
Set to ADDR_TYPE_DHCP to use DHCP to obtain the IP address or ADDR_TYPE_STATIC to use a static IP. In case of static IP address ip, gateway, netmask and dns members must be specified. When using DHCP, the IP, gateway, netmask and DNS are overwritten by the values obtained from the DHCP server. They should be zeroed out if not used.
uint32_t _ncp_wlan_ipv4_config::address
IP address in network order of the system.
uint32_t _ncp_wlan_ipv4_config::gw
Default gateway in network order of the system.
uint32_t _ncp_wlan_ipv4_config::netmask
Subnet mask in network order of the system.
uint32_t _ncp_wlan_ipv4_config::dns1
Primary dns server in network order of the system.
uint32_t _ncp_wlan_ipv4_config::dns2
Secondary DNS server in network order of the system.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_ncp_wlan_ipv6_config Struct Reference
Data Fields
unsigned address [MLAN_IPV6_ADDR_LEN]
unsigned char addr_type_str [IPV6_MAX_ADDR_TYPE_STR_LEN]
unsigned char addr_state_str [IPV6_MAX_ADDR_STATE_STR_LEN]
Detailed Description
This structure is used for IPv6 configuration.
Field Documentation
unsigned _ncp_wlan_ipv6_config::address[MLAN_IPV6_ADDR_LEN]
System’s IPv6 address in network order.
unsigned char _ncp_wlan_ipv6_config::addr_type_str[IPV6_MAX_ADDR_TYPE_STR_LEN]
Address type string: linklocal, site-local or global.
unsigned char _ncp_wlan_ipv6_config::addr_state_str[IPV6_MAX_ADDR_STATE_STR_LEN]
State string of IPv6 address (Tentative, Preferred, etc).
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_WLAN_NET_MONITOR_PARA Struct Reference
Data Fields
uint16_t action
uint16_t monitor_activity
uint16_t filter_flags
uint8_t radio_type
uint8_t chan_number
uint8_t filter_num
uint8_t mac_addr [MAX_MONIT_MAC_FILTER_NUM][MLAN_MAC_ADDR_LENGTH]
Detailed Description
This structure is used for network monitor configuration.
Field Documentation
uint16_t _NCP_WLAN_NET_MONITOR_PARA::action
Action,
add: add mac addr as filter element
delete: delete mac addr
clear: clear mac addr
dump: dump monitor parameter.
uint16_t _NCP_WLAN_NET_MONITOR_PARA::monitor_activity
Monitor activity enable flag, 1 enable, other disable.
uint16_t _NCP_WLAN_NET_MONITOR_PARA::filter_flags
network monitor filter flag.
uint8_t _NCP_WLAN_NET_MONITOR_PARA::radio_type
Channel scan parameter: radio type.
uint8_t _NCP_WLAN_NET_MONITOR_PARA::chan_number
Channel to monitor.
uint8_t _NCP_WLAN_NET_MONITOR_PARA::filter_num
mac num of filter.
uint8_t _NCP_WLAN_NET_MONITOR_PARA::mac_addr[MAX_MONIT_MAC_FILTER_NUM][MLAN_MAC_ADDR_LENGTH]
Source address of the packet to receive.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_ncp_wlan_network Struct Reference
Data Fields
char name [WLAN_NETWORK_NAME_MAX_LENGTH+1]
char ssid [IEEEtypes_SSID_SIZE+1]
char bssid [IEEEtypes_MAC_ADDRESS_SIZE]
unsigned int channel
uint16_t acs_band
short rssi_threshold
uint8_t type
uint8_t role
uint8_t security_type
uint8_t enable_11ax: 1
uint8_t enable_11ac: 1
uint8_t enable_11n: 1
NCP_WLAN_IPV6_CONFIG ipv6 [CONFIG_MAX_IPV6_ADDRESSES]
NCP_WLAN_IPV4_CONFIG ipv4
uint8_t is_sta_ipv4_connected
char identity [IDENTITY_MAX_LENGTH]
unsigned ssid_specific: 1
unsigned bssid_specific: 1
unsigned channel_specific: 1
unsigned security_specific: 1
unsigned wps_specific: 1
uint16_t beacon_period
uint8_t dtim_period
uint8_t wlan_capa
Detailed Description
This structure is used to store a Wi-Fi network profile.
Field Documentation
char _ncp_wlan_network::name[WLAN_NETWORK_NAME_MAX_LENGTH+1]
Name of this network profile.
char _ncp_wlan_network::ssid[IEEEtypes_SSID_SIZE+1]
Network SSID, represented as a C string of up to 32 characters in length. If this profile is used in the UAP mode, this field is used as the SSID of the network. If this profile is used in the station mode, this field is used to identify the network. Set the first byte of the SSID to NULL (a 0-length string) to use only the BSSID to find the network.
char _ncp_wlan_network::bssid[IEEEtypes_MAC_ADDRESS_SIZE]
Network BSSID, represented as a 6-byte array. If this profile is used in the UAP mode, this field is ignored. If this profile is used in the station mode, this field is used to identify the network. Set all 6 bytes to 0 to use any BSSID, in which case only the SSID will be used to find the network.
unsigned int _ncp_wlan_network::channel
Channel for this network. If this profile is used in UAP mode, this field specifies the channel to start the UAP interface on. Set this to 0 for auto channel selection. If this profile is used in the station mode, this constrains the channel on which the network to connect should be present. Set this to 0 to allow the network to be found on any channel.
uint16_t _ncp_wlan_network::acs_band
If set channel to 0, enable auto channel select.
short _ncp_wlan_network::rssi_threshold
Rssi threshold is used to scan with RSSI filter.
uint8_t _ncp_wlan_network::type
BSS type.
uint8_t _ncp_wlan_network::role
Network role type, set this to specify what type of Wi-Fi network mode to use. This can either be WLAN_BSS_ROLE_STA for use in the station mode, or it can be WLAN_BSS_ROLE_UAP for use in the UAP mode.
uint8_t _ncp_wlan_network::security_type
Network’s security type. Use specified by enum wlan_security_type.
uint8_t _ncp_wlan_network::enable_11ax
Enable 802.11ax flag,
1: enable;
0: disable.
uint8_t _ncp_wlan_network::enable_11ac
Enable 802.11ac flag,
1: enable;
0: disable.
uint8_t _ncp_wlan_network::enable_11n
Enable 802.11n flag,
1: enable;
0: disable.
NCP_WLAN_IPV6_CONFIG _ncp_wlan_network::ipv6[CONFIG_MAX_IPV6_ADDRESSES]
Configuration of network is IPv6 address.
NCP_WLAN_IPV4_CONFIG _ncp_wlan_network::ipv4
Configuration of network is IPv4 address.
uint8_t _ncp_wlan_network::is_sta_ipv4_connected
STA connected AP with IPV4 flag, TRUE means STA is connected to AP, FALSE means STA is disconnected to AP.
char _ncp_wlan_network::identity[IDENTITY_MAX_LENGTH]
Identity string.
unsigned _ncp_wlan_network::ssid_specific
If set to 1, the ssid field contains the specific SSID for this network.
unsigned _ncp_wlan_network::bssid_specific
If set to 1, the BSSID (basic service set ID) field contains the specific BSSID for this network.
unsigned _ncp_wlan_network::channel_specific
If set to 1, the channel field contains the specific channel for this network.
unsigned _ncp_wlan_network::security_specific
Set to 0, any security that matches is used.
unsigned _ncp_wlan_network::wps_specific
This indicates this network is used as an internal network for WPS.
uint16_t _ncp_wlan_network::beacon_period
Beacon period of associated BSS (basic service set).
uint8_t _ncp_wlan_network::dtim_period
DTIM period of associated BSS.
uint8_t _ncp_wlan_network::wlan_capa
Wi-Fi network capability.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCP_WLAN_RSSI_INFO_T Struct Reference
Data Fields
int16_t data_rssi_last
int16_t data_nf_last
int16_t data_rssi_avg
int16_t data_nf_avg
int16_t bcn_snr_last
int16_t bcn_snr_avg
int16_t data_snr_last
int16_t data_snr_avg
int16_t bcn_rssi_last
int16_t bcn_nf_last
int16_t bcn_rssi_avg
int16_t bcn_nf_avg
Detailed Description
This structure is used for RSSI (received signal strength indicator) information configuration.
Field Documentation
int16_t _NCP_WLAN_RSSI_INFO_T::data_rssi_last
Value of last RSSI.
int16_t _NCP_WLAN_RSSI_INFO_T::data_nf_last
Value of last NF (noise floor).
int16_t _NCP_WLAN_RSSI_INFO_T::data_rssi_avg
Average value of RSSI.
int16_t _NCP_WLAN_RSSI_INFO_T::data_nf_avg
Average value of NF (noise floor).
int16_t _NCP_WLAN_RSSI_INFO_T::bcn_snr_last
SNR (signal noise ratio) of last beacon.
int16_t _NCP_WLAN_RSSI_INFO_T::bcn_snr_avg
Average SNR (signal noise ratio) of beacon.
int16_t _NCP_WLAN_RSSI_INFO_T::data_snr_last
SNR (signal noise ratio) of last data.
int16_t _NCP_WLAN_RSSI_INFO_T::data_snr_avg
Average SNR (signal noise ratio) of data.
int16_t _NCP_WLAN_RSSI_INFO_T::bcn_rssi_last
RSSI of last beacon.
int16_t _NCP_WLAN_RSSI_INFO_T::bcn_nf_last
NF (noise floor) of last beacon.
int16_t _NCP_WLAN_RSSI_INFO_T::bcn_rssi_avg
Average RSSI of beacon.
int16_t _NCP_WLAN_RSSI_INFO_T::bcn_nf_avg
Average NF of beacon.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_ncp_wlan_scan_result Struct Reference
Data Fields
char ssid [IEEEtypes_SSID_SIZE+1]
unsigned int ssid_len
char bssid [IEEEtypes_MAC_ADDRESS_SIZE]
unsigned int channel
unsigned dot11n: 1
unsigned dot11ac: 1
unsigned dot11ax: 1
unsigned wmm: 1
unsigned wps: 1
unsigned int wps_session
unsigned wpa2_entp: 1
unsigned wep: 1
unsigned wpa: 1
unsigned wpa2: 1
unsigned wpa2_sha256: 1
unsigned wpa3_sae: 1
unsigned char rssi
char trans_ssid [IEEEtypes_SSID_SIZE+1]
unsigned int trans_ssid_len
char trans_bssid [IEEEtypes_MAC_ADDRESS_SIZE]
uint16_t beacon_period
uint8_t dtim_period
uint8_t ap_mfpc
uint8_t ap_mfpr
bool neighbor_report_supported
bool bss_transition_supported
Detailed Description
This structure is used to store the information of one scanned AP
Field Documentation
char _ncp_wlan_scan_result::ssid[IEEEtypes_SSID_SIZE+1]
Network SSID (service set ID) , represented as a NULL-terminated C string of 0 to 32 characters. If the network has a hidden SSID, this will be the empty string.
unsigned int _ncp_wlan_scan_result::ssid_len
SSID length.
char _ncp_wlan_scan_result::bssid[IEEEtypes_MAC_ADDRESS_SIZE]
Network BSSID (basic servivce set ID), represented as a 6-byte array.
unsigned int _ncp_wlan_scan_result::channel
Network channel.
unsigned _ncp_wlan_scan_result::dot11n
Network supports 802.11n. This is set to 0 if the network does not support 802.11n or if the system does not have 802.11n support enabled.
unsigned _ncp_wlan_scan_result::dot11ac
Network supports 802.11ac. This is set to 0 if the network does not support 802.11ac or if the system does not have 802.11ac support enabled.
unsigned _ncp_wlan_scan_result::dot11ax
Network supports 802.11ax. This is set to 0 if the network does not support 802.11ax or if the system does not have 802.11ax support enabled.
unsigned _ncp_wlan_scan_result::wps
Network supports WPS (Wi-Fi protected setup). This is set to 0 if the network does not support WPS or if the system does not have WPS support enabled.
unsigned int _ncp_wlan_scan_result::wps_session
WPS type PBC (push button configuration)/PIN
unsigned _ncp_wlan_scan_result::wpa2_entp
WPA2 enterprise security
unsigned _ncp_wlan_scan_result::wep
Network uses WEP security.
unsigned _ncp_wlan_scan_result::wpa
Network uses WPA security.
unsigned _ncp_wlan_scan_result::wpa2
Network uses WPA2 security.
unsigned _ncp_wlan_scan_result::wpa2_sha256
The network uses WPA2 SHA256 security
unsigned _ncp_wlan_scan_result::wpa3_sae
Network uses WPA3 SAE (simultaneous authentication of equals) security.
unsigned char _ncp_wlan_scan_result::rssi
Signal strength of the beacon.
char _ncp_wlan_scan_result::trans_ssid[IEEEtypes_SSID_SIZE+1]
Network SSID (service set ID), represented as a NULL-terminated C string of 0 to 32 characters. If the network has a hidden SSID, this will be the empty string.
unsigned int _ncp_wlan_scan_result::trans_ssid_len
SSID length
char _ncp_wlan_scan_result::trans_bssid[IEEEtypes_MAC_ADDRESS_SIZE]
Network BSSID (basic service set ID), represented as a 6-byte array.
uint16_t _ncp_wlan_scan_result::beacon_period
Beacon period.
uint8_t _ncp_wlan_scan_result::dtim_period
DTIM (delivery traffic indication map) period.
uint8_t _ncp_wlan_scan_result::ap_mfpc
MFPC (Management Frame Protection Capable) bit of AP (Access Point)
uint8_t _ncp_wlan_scan_result::ap_mfpr
MFPR (Management Frame Protection Required) bit of AP (Access Point)
bool _ncp_wlan_scan_result::neighbor_report_supported
Neighbor report support
bool _ncp_wlan_scan_result::bss_transition_supported
bss transition support
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCPCmd_DS_COMMAND Struct Reference
Data Fields
NCP_COMMAND header
union {
NCP_CMD_SCAN_NETWORK_INFO scan_network_info
NCP_CMD_FW_VERSION fw_version
NCP_CMD_MAC_ADDRESS mac_addr
NCP_CMD_GET_MAC_ADDRESS get_mac_addr
NCP_CMD_CONNECT_STAT conn_stat
NCP_CMD_NETWORK_INFO network_info
NCP_CMD_NETWORK_ADDRESS network_address
NCP_CMD_NET_MONITOR monitor_cfg
NCP_CMD_NETWORK_ADD network_add
NCP_CMD_NETWORK_START network_start
NCP_CMD_NETWORK_UAP_STA_LIST uap_sta_list
NCP_CMD_CSI csi_cfg
NCP_CMD_11K_CFG wlan_11k_cfg
NCP_CMD_NEIGHBOR_REQ neighbor_req
NCP_CMD_MBO_ENABLE wlan_mbo_enable
NCP_CMD_MBO_NONPREFER_CH mbo_nonprefer_ch
NCP_CMD_MBO_SET_CELL_CAPA wlan_mbo_set_cell_capa
NCP_CMD_MBO_SET_OCE wlan_mbo_set_oce
NCP_CMD_RSSI signal_rssi
NCP_CMD_ROAMING roaming_cfg
NCP_CMD_CLIENT_CNT max_client_count
NCP_CMD_ANTENNA_CFG antenna_cfg
NCP_CMD_WPS_GEN_PIN wps_gen_pin_info
NCP_CMD_WPS_PIN wps_pin_cfg
NCP_CMD_11AX_CFG_INFO he_cfg
NCP_CMD_BTWT_CFG_INFO btwt_cfg
NCP_CMD_TWT_SETUP_CFG twt_setup
NCP_CMD_TWT_TEARDOWN_CFG twt_teardown
NCP_CMD_11D_ENABLE_CFG wlan_11d_cfg
NCP_CMD_SOCKET_OPEN_CFG wlan_socket_open
NCP_CMD_SOCKET_CON_CFG wlan_socket_con
NCP_CMD_SOCKET_BIND_CFG wlan_socket_bind
NCP_CMD_SOCKET_CLOSE_CFG wlan_socket_close
NCP_CMD_SOCKET_LISTEN_CFG wlan_socket_listen
NCP_CMD_SOCKET_ACCEPT_CFG wlan_socket_accept
NCP_CMD_SOCKET_SEND_CFG wlan_socket_send
NCP_CMD_SOCKET_SENDTO_CFG wlan_socket_sendto
NCP_CMD_SOCKET_RECEIVE_CFG wlan_socket_receive
NCP_CMD_SOCKET_RECVFROM_CFG wlan_socket_recvfrom
NCP_CMD_HTTP_CON_CFG wlan_http_connect
NCP_CMD_UAP_PROV_SET_UAPCFG prov_set_uapcfg
NCP_CMD_HTTP_DISCON_CFG wlan_http_disconnect
NCP_CMD_HTTP_SETH_CFG wlan_http_seth
NCP_CMD_HTTP_UNSETH_CFG wlan_http_unseth
NCP_CMD_HTTP_REQ_CFG wlan_http_req
NCP_CMD_HTTP_REQ_RESP_CFG wlan_http_req_resp
NCP_CMD_HTTP_RECV_CFG wlan_http_recv
NCP_CMD_HTTP_UPG_CFG wlan_http_upg
NCP_CMD_WEBSOCKET_SEND_CFG wlan_websocket_send
NCP_CMD_WEBSOCKET_RECV_CFG wlan_websocket_recv
NCP_CMD_POWERMGMT_MEF mef_config
NCP_CMD_DEEP_SLEEP_PS wlan_deep_sleep_ps
NCP_CMD_IEEE_PS wlan_ieee_ps
NCP_CMD_POWERMGMT_UAPSD uapsd_cfg
NCP_CMD_POWERMGMT_QOSINFO qosinfo_cfg
NCP_CMD_POWERMGMT_SLEEP_PERIOD sleep_period_cfg
NCP_CMD_POWERMGMT_WOWLAN_CFG wowlan_config
NCP_CMD_POWERMGMT_SUSPEND suspend_config
WLAN_RESET_data reset_config
NCP_CMD_TWT_REPORT twt_report
NCP_CMD_REGION_CODE_CFG region_cfg
NCP_CMD_ED_MAC ed_mac_mode
NCP_CMD_RF_TX_ANTENNA rf_tx_antenna
NCP_CMD_RF_RX_ANTENNA rf_rx_antenna
NCP_CMD_RF_BAND rf_band
NCP_CMD_RF_BANDWIDTH rf_bandwidth
NCP_CMD_RF_CHANNEL rf_channel
NCP_CMD_RF_RADIO_MODE rf_radio_mode
NCP_CMD_RF_TX_POWER rf_tx_power
NCP_CMD_RF_TX_CONT_MODE rf_tx_cont_mode
NCP_CMD_RF_TX_FRAME rf_tx_frame
NCP_CMD_RF_PER rf_per
NCP_CMD_EU_CRYPRTO eu_crypto
NCP_CMD_REGISTER_ACCESS register_access
NCP_CMD_MEM_STAT mem_stat
NCP_CMD_DATE_TIME_CFG date_time
NCP_CMD_TEMPERATURE temperature
NCP_CMD_WLAN_CONN wlan_connect
NCP_CMD_MDNS_QUERY mdns_query
NCP_EVT_MDNS_RESULT mdns_result
NCP_EVT_MDNS_RESOLVE mdns_resolve
NCP_EVT_CSI_DATA csi_data
NCP_CMD_NETWORK_LIST network_list
NCP_CMD_NETWORK_REMOVE network_remove
NCP_CMD_GET_CURRENT_NETWORK current_network
} params
Detailed Description
NCP command structure.
Field Documentation
NCP_COMMAND _NCPCmd_DS_COMMAND::header
Command header.
NCP_CMD_SCAN_NETWORK_INFO _NCPCmd_DS_COMMAND::scan_network_info
Scan result.
NCP_CMD_FW_VERSION _NCPCmd_DS_COMMAND::fw_version
Driver and firmware version
NCP_CMD_MAC_ADDRESS _NCPCmd_DS_COMMAND::mac_addr
MAC address
NCP_CMD_GET_MAC_ADDRESS _NCPCmd_DS_COMMAND::get_mac_addr
Get MAC address
NCP_CMD_CONNECT_STAT _NCPCmd_DS_COMMAND::conn_stat
wlan connection state
NCP_CMD_NETWORK_INFO _NCPCmd_DS_COMMAND::network_info
wlan network info
NCP_CMD_NETWORK_ADDRESS _NCPCmd_DS_COMMAND::network_address
wlan network address
NCP_CMD_NETWORK_ADD _NCPCmd_DS_COMMAND::network_add
wlan add network
NCP_CMD_NETWORK_START _NCPCmd_DS_COMMAND::network_start
wlan start network
NCP_CMD_NETWORK_UAP_STA_LIST _NCPCmd_DS_COMMAND::uap_sta_list
wlan UAP station list
NCP_CMD_CSI _NCPCmd_DS_COMMAND::csi_cfg
CSI configuration
NCP_CMD_11K_CFG _NCPCmd_DS_COMMAND::wlan_11k_cfg
802.11k enable configuration
NCP_CMD_NEIGHBOR_REQ _NCPCmd_DS_COMMAND::neighbor_req
neighbor report request
NCP_CMD_MBO_ENABLE _NCPCmd_DS_COMMAND::wlan_mbo_enable
MBO enable configure
NCP_CMD_MBO_NONPREFER_CH _NCPCmd_DS_COMMAND::mbo_nonprefer_ch
NCP MBO non prefer channel structure
NCP_CMD_MBO_SET_CELL_CAPA _NCPCmd_DS_COMMAND::wlan_mbo_set_cell_capa
MBO cell capacity
NCP_CMD_MBO_SET_OCE _NCPCmd_DS_COMMAND::wlan_mbo_set_oce
NCP MBO set OCE
NCP_CMD_RSSI _NCPCmd_DS_COMMAND::signal_rssi
RSSI information
NCP_CMD_ROAMING _NCPCmd_DS_COMMAND::roaming_cfg
Roaming configurations
NCP_CMD_CLIENT_CNT _NCPCmd_DS_COMMAND::max_client_count
MAX client count
NCP_CMD_ANTENNA_CFG _NCPCmd_DS_COMMAND::antenna_cfg
Antenna config
NCP_CMD_WPS_GEN_PIN _NCPCmd_DS_COMMAND::wps_gen_pin_info
Generated WPS pin code
NCP_CMD_WPS_PIN _NCPCmd_DS_COMMAND::wps_pin_cfg
wps pin code
NCP_CMD_11AX_CFG_INFO _NCPCmd_DS_COMMAND::he_cfg
802.11ax configure information
NCP_CMD_BTWT_CFG_INFO _NCPCmd_DS_COMMAND::btwt_cfg
TWT broadcast configuration information
NCP_CMD_TWT_SETUP_CFG _NCPCmd_DS_COMMAND::twt_setup
TWT setup configuration
NCP_CMD_TWT_TEARDOWN_CFG _NCPCmd_DS_COMMAND::twt_teardown
TWT teardown configuration
NCP_CMD_11D_ENABLE_CFG _NCPCmd_DS_COMMAND::wlan_11d_cfg
802.11d enable configuration
NCP_CMD_SOCKET_OPEN_CFG _NCPCmd_DS_COMMAND::wlan_socket_open
socket open configuration
NCP_CMD_SOCKET_CON_CFG _NCPCmd_DS_COMMAND::wlan_socket_con
socket connect configuration
NCP_CMD_SOCKET_BIND_CFG _NCPCmd_DS_COMMAND::wlan_socket_bind
socket bind configuration
NCP_CMD_SOCKET_CLOSE_CFG _NCPCmd_DS_COMMAND::wlan_socket_close
socket close configuration
NCP_CMD_SOCKET_LISTEN_CFG _NCPCmd_DS_COMMAND::wlan_socket_listen
socket listen configuration
NCP_CMD_SOCKET_ACCEPT_CFG _NCPCmd_DS_COMMAND::wlan_socket_accept
socket accept configuration
NCP_CMD_SOCKET_SEND_CFG _NCPCmd_DS_COMMAND::wlan_socket_send
socket send configuration
NCP_CMD_SOCKET_SENDTO_CFG _NCPCmd_DS_COMMAND::wlan_socket_sendto
socket sendto configuration
NCP_CMD_SOCKET_RECEIVE_CFG _NCPCmd_DS_COMMAND::wlan_socket_receive
socket receive configuration
NCP_CMD_SOCKET_RECVFROM_CFG _NCPCmd_DS_COMMAND::wlan_socket_recvfrom
socket recvfrom configuration
NCP_CMD_HTTP_CON_CFG _NCPCmd_DS_COMMAND::wlan_http_connect
http connect configuration
NCP_CMD_UAP_PROV_SET_UAPCFG _NCPCmd_DS_COMMAND::prov_set_uapcfg
provisioning UAP configuration
NCP_CMD_HTTP_DISCON_CFG _NCPCmd_DS_COMMAND::wlan_http_disconnect
http disconnect configuration
NCP_CMD_HTTP_SETH_CFG _NCPCmd_DS_COMMAND::wlan_http_seth
http seth.
NCP_CMD_HTTP_UNSETH_CFG _NCPCmd_DS_COMMAND::wlan_http_unseth
http unseth.
NCP_CMD_HTTP_REQ_CFG _NCPCmd_DS_COMMAND::wlan_http_req
http request.
NCP_CMD_HTTP_REQ_RESP_CFG _NCPCmd_DS_COMMAND::wlan_http_req_resp
http request response
NCP_CMD_HTTP_RECV_CFG _NCPCmd_DS_COMMAND::wlan_http_recv
http receive configuration.
NCP_CMD_HTTP_UPG_CFG _NCPCmd_DS_COMMAND::wlan_http_upg
Http upgrade
NCP_CMD_WEBSOCKET_SEND_CFG _NCPCmd_DS_COMMAND::wlan_websocket_send
NCP web socket send configuration.
NCP_CMD_WEBSOCKET_RECV_CFG _NCPCmd_DS_COMMAND::wlan_websocket_recv
NCP web socket receive configuration.
NCP_CMD_POWERMGMT_MEF _NCPCmd_DS_COMMAND::mef_config
MEF configurations.
NCP_CMD_DEEP_SLEEP_PS _NCPCmd_DS_COMMAND::wlan_deep_sleep_ps
Wi-Fi deep sleep power save mode.
NCP_CMD_IEEE_PS _NCPCmd_DS_COMMAND::wlan_ieee_ps
Wi-Fi IEEE power save mode configure.
NCP_CMD_POWERMGMT_UAPSD _NCPCmd_DS_COMMAND::uapsd_cfg
NCP enable/disable UAPSD configuration
NCP_CMD_POWERMGMT_QOSINFO _NCPCmd_DS_COMMAND::qosinfo_cfg
NCP set/get WMM QoS configuration
NCP_CMD_POWERMGMT_SLEEP_PERIOD _NCPCmd_DS_COMMAND::sleep_period_cfg
NCP set/get sleep period
NCP_CMD_POWERMGMT_WOWLAN_CFG _NCPCmd_DS_COMMAND::wowlan_config
Wakeup configuration.
NCP_CMD_POWERMGMT_SUSPEND _NCPCmd_DS_COMMAND::suspend_config
Enter suspend configuration.
WLAN_RESET_data _NCPCmd_DS_COMMAND::reset_config
Wi-Fi reset config.
NCP_CMD_TWT_REPORT _NCPCmd_DS_COMMAND::twt_report
TWT report.
NCP_CMD_REGION_CODE_CFG _NCPCmd_DS_COMMAND::region_cfg
Region code configuration structure.
NCP_CMD_ED_MAC _NCPCmd_DS_COMMAND::ed_mac_mode
Regulatory commands.
NCP_CMD_RF_TX_ANTENNA _NCPCmd_DS_COMMAND::rf_tx_antenna
NCP RF TX antenna.
NCP_CMD_RF_RX_ANTENNA _NCPCmd_DS_COMMAND::rf_rx_antenna
NCP RF RX antenna.
NCP_CMD_RF_BAND _NCPCmd_DS_COMMAND::rf_band
NCP RF band.
NCP_CMD_RF_BANDWIDTH _NCPCmd_DS_COMMAND::rf_bandwidth
NCP RF bandwidth.
NCP_CMD_RF_CHANNEL _NCPCmd_DS_COMMAND::rf_channel
NCP RF channel.
NCP_CMD_RF_RADIO_MODE _NCPCmd_DS_COMMAND::rf_radio_mode
NCP RF radio mode.
NCP_CMD_RF_TX_POWER _NCPCmd_DS_COMMAND::rf_tx_power
NCP RF TX power.
NCP_CMD_RF_TX_CONT_MODE _NCPCmd_DS_COMMAND::rf_tx_cont_mode
NCP RF TX cont mode.
NCP_CMD_RF_TX_FRAME _NCPCmd_DS_COMMAND::rf_tx_frame
NCP RF TX frame.
NCP_CMD_RF_PER _NCPCmd_DS_COMMAND::rf_per
NCP RF per.
NCP_CMD_EU_CRYPRTO _NCPCmd_DS_COMMAND::eu_crypto
NCP EU (encrypt unit) cryprto.
NCP_CMD_REGISTER_ACCESS _NCPCmd_DS_COMMAND::register_access
Debug commands.
NCP_CMD_MEM_STAT _NCPCmd_DS_COMMAND::mem_stat
Memory commands.
NCP_CMD_DATE_TIME_CFG _NCPCmd_DS_COMMAND::date_time
Data time.
NCP_CMD_TEMPERATURE _NCPCmd_DS_COMMAND::temperature
Chip temperature.
NCP_CMD_WLAN_CONN _NCPCmd_DS_COMMAND::wlan_connect
Wi-Fi connect.
NCP_CMD_MDNS_QUERY _NCPCmd_DS_COMMAND::mdns_query
MDNS query.
NCP_EVT_MDNS_RESULT _NCPCmd_DS_COMMAND::mdns_result
MDNS result.
NCP_EVT_MDNS_RESOLVE _NCPCmd_DS_COMMAND::mdns_resolve
MDNS resolve.
NCP_EVT_CSI_DATA _NCPCmd_DS_COMMAND::csi_data
CSI data.
NCP_CMD_NETWORK_LIST _NCPCmd_DS_COMMAND::network_list
Added network list.
NCP_CMD_NETWORK_REMOVE _NCPCmd_DS_COMMAND::network_remove
Network to remove.
NCP_CMD_GET_CURRENT_NETWORK _NCPCmd_DS_COMMAND::current_network
Get current network
union { … } _NCPCmd_DS_COMMAND::params
Command body.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_NCPCmd_DS_COMMAND_BLE Struct Reference
Data Fields
NCP_COMMAND header
union {
NCP_CMD_SET_ADV_DATA set_adv_data
NCP_CMD_SET_SCAN_PARAM set_scan_parameter
NCP_CMD_SCAN_START scan_start
NCP_CMD_CONNECT connect
NCP_CMD_SET_DATA_LEN set_data_len
NCP_CMD_SET_PHY set_phy
NCP_CMD_CONN_PARA_UPDATE conn_param_update
NCP_CMD_ENCRYPTION conn_encryption
NCP_CMD_SET_POWER_MODE set_pw_mode
NCP_CMD_SET_ADDR set_dev_addr
NCP_GATT_READ_CMD gatt_read_char
NCP_CMD_SET_NAME set_dev_name
NCP_CMD_SERVICE_ADD host_svc_add
NCP_CMD_START_SERVICE host_start_svc
NCP_REGISTER_SERVICE register_service
NCP_SET_VALUE_CMD gatt_set_value
NCP_DISC_PRIM_UUID_CMD discover_prim
NCP_DISC_CHRC_UUID_CMD discover_chrc
NCP_CFG_SUBSCRIBE_CMD cfg_subscribe
NCP_L2CAP_CONNECT_CMD l2cap_connect
NCP_L2CAP_DISCONNECT_CMD l2cap_disconnect
NCP_L2CAP_SEND_CMD l2cap_send
NCP_L2CAP_REGISTER_CMD l2cap_register
NCP_L2CAP_METRICS_CMD l2cap_metrics
NCP_L2CAP_RECEIVE_CMD l2cap_receive
NCP_DEVICE_ADV_REPORT_EV adv_reported
NCP_DEVICE_CONNECTED_EV device_connected
NCP_DEVICE_DISCONNECTED_EV device_disconnected
NCP_PASSKEY_DISPLAY_EV passkey_display
NCP_IDENTITY_RESOLVED_EV identity_resolved
NCP_CMD_CONN_PARA_UPDATE_EV conn_param_update_ev
NCP_CMD_PHY_UPDATE_EV phy_updated_ev
NCP_CMD_DATA_LEN_UPDATE_EV data_len_updated_ev
NCP_SEC_LEVEL_CHANGED_EV sec_level_changed
NCP_NOTIFICATION_EV gatt_notification
NCP_ATTR_VALUE_CHANGED_EV attr_value_changed
NCP_CCC_CFG_CHANGED_EV gatt_ccc_cfg_changed_ev
NCP_SUBSCRIPTION_EV gatt_subscription_ev
NCP_DISC_PRIM_EV gatt_disc_prim_ev
NCP_DISC_CHRC_EV gatt_disc_chrc_ev
NCP_DISC_ALL_DESC_EV gatt_disc_desc_ev
NCP_L2CAP_CONNECT_EV l2cap_connect_ev
NCP_L2CAP_DISCONNECT_EV l2cap_disconnect_ev
NCP_L2CAP_RECEIVE_EV l2cap_receive_ev
NCP_START_ADV_RP start_adv_rp
NCP_ADD_SERVICE_RP add_service_rp
NCP_DISC_PRIM_RP discover_prim_rp
NCP_DISC_CHRC_RP discover_chrc_rp
NCP_DISC_ALL_DESC_RP discover_desc_rp
NCP_NCS_INFO_RP ncs_info_rp
} params
Detailed Description
This structure contains the configuration value which is used as an input to the Bluetooth LE TLV command.
Field Documentation
NCP_COMMAND _NCPCmd_DS_COMMAND_BLE::header
Command Header : Command
NCP_CMD_SET_ADV_DATA _NCPCmd_DS_COMMAND_BLE::set_adv_data
Set NCP Bluetooth LE advertising data
NCP_CMD_SET_SCAN_PARAM _NCPCmd_DS_COMMAND_BLE::set_scan_parameter
Set NCP Bluetooth LE scan parameter
NCP_CMD_SCAN_START _NCPCmd_DS_COMMAND_BLE::scan_start
NCP Bluetooth LE start scanning
NCP_CMD_CONNECT _NCPCmd_DS_COMMAND_BLE::connect
NCP Bluetooth LE connect/disconnect
NCP_CMD_SET_DATA_LEN _NCPCmd_DS_COMMAND_BLE::set_data_len
Set NCP Bluetooth LE data len
NCP_CMD_SET_PHY _NCPCmd_DS_COMMAND_BLE::set_phy
Set NCP Bluetooth LE set Bluetooth PHY
NCP_CMD_CONN_PARA_UPDATE _NCPCmd_DS_COMMAND_BLE::conn_param_update
NCP Bluetooth LE update connection parameters
NCP_CMD_ENCRYPTION _NCPCmd_DS_COMMAND_BLE::conn_encryption
NCP Bluetooth LE connect encryption
NCP_CMD_SET_POWER_MODE _NCPCmd_DS_COMMAND_BLE::set_pw_mode
NCP Bluetooth LE set power mode
NCP_CMD_SET_ADDR _NCPCmd_DS_COMMAND_BLE::set_dev_addr
NCP Bluetooth LE set device address
NCP_GATT_READ_CMD _NCPCmd_DS_COMMAND_BLE::gatt_read_char
NCP Bluetooth LE read characteristic
NCP_CMD_SET_NAME _NCPCmd_DS_COMMAND_BLE::set_dev_name
NCP Bluetooth LE set device name
NCP_CMD_SERVICE_ADD _NCPCmd_DS_COMMAND_BLE::host_svc_add
NCP Bluetooth LE gatt add host service
NCP_CMD_START_SERVICE _NCPCmd_DS_COMMAND_BLE::host_start_svc
NCP Bluetooth LE start service at host side
NCP_REGISTER_SERVICE _NCPCmd_DS_COMMAND_BLE::register_service
NCP Bluetooth LE gatt register service
NCP_SET_VALUE_CMD _NCPCmd_DS_COMMAND_BLE::gatt_set_value
NCP Bluetooth LE gatt set characteristic/descriptor service
NCP_DISC_PRIM_UUID_CMD _NCPCmd_DS_COMMAND_BLE::discover_prim
NCP Bluetooth LE gatt discover primary Service
NCP_DISC_CHRC_UUID_CMD _NCPCmd_DS_COMMAND_BLE::discover_chrc
NCP Bluetooth LE gatt discover characteristics
NCP_CFG_SUBSCRIBE_CMD _NCPCmd_DS_COMMAND_BLE::cfg_subscribe
NCP Bluetooth LE gatt configure service to indicate characteristic value to client
NCP_L2CAP_CONNECT_CMD _NCPCmd_DS_COMMAND_BLE::l2cap_connect
NCP Bluetooth LE l2cap connect
NCP_L2CAP_DISCONNECT_CMD _NCPCmd_DS_COMMAND_BLE::l2cap_disconnect
NCP Bluetooth LE l2cap disconnect
NCP_L2CAP_SEND_CMD _NCPCmd_DS_COMMAND_BLE::l2cap_send
NCP Bluetooth LE l2cap send
NCP_L2CAP_REGISTER_CMD _NCPCmd_DS_COMMAND_BLE::l2cap_register
NCP Bluetooth LE l2cap register
NCP_L2CAP_METRICS_CMD _NCPCmd_DS_COMMAND_BLE::l2cap_metrics
NCP Bluetooth LE l2cap metrics
NCP_L2CAP_RECEIVE_CMD _NCPCmd_DS_COMMAND_BLE::l2cap_receive
NCP Bluetooth LE l2cap receive
NCP_DEVICE_ADV_REPORT_EV _NCPCmd_DS_COMMAND_BLE::adv_reported
NCP Bluetooth LE advertising reported event
NCP_DEVICE_CONNECTED_EV _NCPCmd_DS_COMMAND_BLE::device_connected
NCP Bluetooth LE connected event
NCP_DEVICE_DISCONNECTED_EV _NCPCmd_DS_COMMAND_BLE::device_disconnected
NCP Bluetooth LE disconnected event
NCP_PASSKEY_DISPLAY_EV _NCPCmd_DS_COMMAND_BLE::passkey_display
NCP Bluetooth LE passkey display event
NCP_IDENTITY_RESOLVED_EV _NCPCmd_DS_COMMAND_BLE::identity_resolved
NCP Bluetooth LE remote identity address resolved event
NCP_CMD_CONN_PARA_UPDATE_EV _NCPCmd_DS_COMMAND_BLE::conn_param_update_ev
NCP Bluetooth LE connection update event
NCP_CMD_PHY_UPDATE_EV _NCPCmd_DS_COMMAND_BLE::phy_updated_ev
NCP Bluetooth LE phy update event
NCP_CMD_DATA_LEN_UPDATE_EV _NCPCmd_DS_COMMAND_BLE::data_len_updated_ev
NCP Bluetooth LE data length update event
NCP_SEC_LEVEL_CHANGED_EV _NCPCmd_DS_COMMAND_BLE::sec_level_changed
NCP Bluetooth LE security level changed event
NCP_NOTIFICATION_EV _NCPCmd_DS_COMMAND_BLE::gatt_notification
NCP Bluetooth LE gatt notification receive event
NCP_ATTR_VALUE_CHANGED_EV _NCPCmd_DS_COMMAND_BLE::attr_value_changed
NCP Bluetooth LE gatt attribute value changed event
NCP_CCC_CFG_CHANGED_EV _NCPCmd_DS_COMMAND_BLE::gatt_ccc_cfg_changed_ev
NCP Bluetooth LE gatt client characteristic configuration changed event
NCP_SUBSCRIPTION_EV _NCPCmd_DS_COMMAND_BLE::gatt_subscription_ev
NCP Bluetooth LE gatt client subscription event
NCP_DISC_PRIM_EV _NCPCmd_DS_COMMAND_BLE::gatt_disc_prim_ev
NCP Bluetooth LE gatt discover primary service event
NCP_DISC_CHRC_EV _NCPCmd_DS_COMMAND_BLE::gatt_disc_chrc_ev
NCP Bluetooth LE gatt discover characteristic event
NCP_DISC_ALL_DESC_EV _NCPCmd_DS_COMMAND_BLE::gatt_disc_desc_ev
NCP Bluetooth LE gatt discover description event
NCP_L2CAP_CONNECT_EV _NCPCmd_DS_COMMAND_BLE::l2cap_connect_ev
NCP Bluetooth LE l2cap connect event
NCP_L2CAP_DISCONNECT_EV _NCPCmd_DS_COMMAND_BLE::l2cap_disconnect_ev
NCP Bluetooth LE l2cap disconnect event
NCP_L2CAP_RECEIVE_EV _NCPCmd_DS_COMMAND_BLE::l2cap_receive_ev
NCP Bluetooth LE l2cap receive event
NCP_START_ADV_RP _NCPCmd_DS_COMMAND_BLE::start_adv_rp
NCP Bluetooth LE start advertising response
NCP_ADD_SERVICE_RP _NCPCmd_DS_COMMAND_BLE::add_service_rp
NCP Bluetooth LE gatt add service attribute response
NCP_DISC_PRIM_RP _NCPCmd_DS_COMMAND_BLE::discover_prim_rp
NCP Bluetooth LE gatt discover primary service response
NCP_DISC_CHRC_RP _NCPCmd_DS_COMMAND_BLE::discover_chrc_rp
NCP Bluetooth LE gatt discover characteristics response
NCP_DISC_ALL_DESC_RP _NCPCmd_DS_COMMAND_BLE::discover_desc_rp
NCP Bluetooth LE gatt discover descriptors response
NCP_NCS_INFO_RP _NCPCmd_DS_COMMAND_BLE::ncs_info_rp
NCP Bluetooth LE commissioning ssid/password receive response
union { … } _NCPCmd_DS_COMMAND_BLE::params
Command Body
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
_ping_msg_t Struct Reference
Data Fields
uint16_t size
uint32_t count
uint32_t timeout
uint32_t handle
char ip_addr [IP_ADDR_LEN]
uint32_t port
Detailed Description
This structure is used for the ping command configuration.
Field Documentation
uint16_t _ping_msg_t::size
Packet size.
uint32_t _ping_msg_t::count
Packet count.
uint32_t _ping_msg_t::timeout
Timeout in seconds.
uint32_t _ping_msg_t::handle
Socket handle index number.
char _ping_msg_t::ip_addr[IP_ADDR_LEN]
Peer IP address.
uint32_t _ping_msg_t::port
Peer port number.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
_ping_res Struct Reference
Data Fields
int seq_no
int echo_resp
uint32_t time
uint32_t recvd
int ttl
char ip_addr [IP_ADDR_LEN]
uint16_t size
Detailed Description
This structure is used for ping command response message.
Field Documentation
int _ping_res::seq_no
Sequence number.
int _ping_res::echo_resp
Echo response.
uint32_t _ping_res::time
Time interval.
uint32_t _ping_res::recvd
Count of received packet.
int _ping_res::ttl
Time to live
char _ping_res::ip_addr[IP_ADDR_LEN]
IP address of the peer device.
uint16_t _ping_res::size
Packet size.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
_PMF_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t mfpc
uint8_t mfpr
Detailed Description
This structure is used for PMF (protected management frame) configuration.
Field Documentation
TypeHeader_t _PMF_ParamSet_t::header
Header type and size information.
uint8_t _PMF_ParamSet_t::mfpc
MFPC (management frame protection capable) flag,
1: enable,
0: disable.
uint8_t _PMF_ParamSet_t::mfpr
MFPR (management frame protection required) flag,
1: enable,
0: disable.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_PTR_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
char instance_name [NCP_MDNS_LABEL_MAX_LEN+1]
char service_type [NCP_MDNS_LABEL_MAX_LEN+1]
char proto [8]
Detailed Description
This structure is used for pointer records configuration.
Field Documentation
TypeHeader_t _PTR_ParamSet_t::header
Header type and size information.
char _PTR_ParamSet_t::instance_name[NCP_MDNS_LABEL_MAX_LEN+1]
Instance name, used to distinguish between different service instances of the same type.
char _PTR_ParamSet_t::service_type[NCP_MDNS_LABEL_MAX_LEN+1]
The type of service and the transport protocol are identified, for example, _http._tcp indicates an HTTP service that uses the TCP protocol.
char _PTR_ParamSet_t::proto[8]
The protocol type of service, for example, the TCP/UDP protocol.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_Pwe_Derivation_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t pwe_derivation
Detailed Description
This structure is used for PWE (password element) derivation configuration.
Field Documentation
TypeHeader_t _Pwe_Derivation_ParamSet_t::header
Header type and size information.
uint8_t _Pwe_Derivation_ParamSet_t::pwe_derivation
sae_pwe - SAE mechanism for PWE derivation.
0: hunting-and-pecking loop only,
1: hash-to-element only,
2: both hunting-and-pecking loop and hash-to-element enabled.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_QUERY_A_CFG Struct Reference
Data Fields
char name [NCP_MDNS_LABEL_MAX_LEN+1]
Detailed Description
This structure is used for domain name configuration.
Field Documentation
char _QUERY_A_CFG::name[NCP_MDNS_LABEL_MAX_LEN+1]
Domain name, like “wifi-http.local”.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_QUERY_PTR_CFG Struct Reference
Data Fields
char service [NCP_MDNS_LABEL_MAX_LEN+1]
uint16_t proto
Detailed Description
This structure is used for service protocol configuration.
Field Documentation
char _QUERY_PTR_CFG::service[NCP_MDNS_LABEL_MAX_LEN+1]
Type of service, like “http”.
uint16_t _QUERY_PTR_CFG::proto
Protocol type,
0: UDP,
1: TCP.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_Security_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t type
uint8_t password_len
char password [1]
Detailed Description
This structure is used for security password configuration.
Field Documentation
TypeHeader_t _Security_ParamSet_t::header
Header type and size information.
uint8_t _Security_ParamSet_t::type
Wi-Fi security type.
uint8_t _Security_ParamSet_t::password_len
Wi-Fi security password length.
char _Security_ParamSet_t::password[1]
Wi-Fi security password string.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_SRV_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
char host_name [NCP_MDNS_LABEL_MAX_LEN+1]
uint16_t port
char target [NCP_MDNS_LABEL_MAX_LEN+1]
Detailed Description
This structure is used for service records configuration.
Field Documentation
TypeHeader_t _SRV_ParamSet_t::header
Header type and size information.
char _SRV_ParamSet_t::host_name[NCP_MDNS_LABEL_MAX_LEN+1]
Host name.
uint16_t _SRV_ParamSet_t::port
Service port.
char _SRV_ParamSet_t::target[NCP_MDNS_LABEL_MAX_LEN+1]
Target name.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_SSID_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
char ssid [IEEEtypes_SSID_SIZE+1]
Detailed Description
This structure is used for SSID configuration.
Field Documentation
TypeHeader_t _SSID_ParamSet_t::header
Header type and size information.
char _SSID_ParamSet_t::ssid[IEEEtypes_SSID_SIZE+1]
SSID (service set identifier)
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_Transition_Disable_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t transition_disable
Detailed Description
This structure is used for transition disable flag configuration.
Field Documentation
TypeHeader_t _Transition_Disable_ParamSet_t::header
Header type and size information.
uint8_t _Transition_Disable_ParamSet_t::transition_disable
Transition disable flag.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_TXT_ParamSet_t Struct Reference
Data Fields
TypeHeader_t header
uint8_t txt_len
char txt [NCP_MDNS_LABEL_MAX_LEN+1]
Detailed Description
This structure is used for txt resource configuration.
Field Documentation
TypeHeader_t _TXT_ParamSet_t::header
Header type and size information.
uint8_t _TXT_ParamSet_t::txt_len
txt value length.
char _TXT_ParamSet_t::txt[NCP_MDNS_LABEL_MAX_LEN+1]
txt string.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
_wifi_csi_config_params_t Struct Reference
Data Fields
uint8_t bss_type
uint16_t csi_enable
uint32_t head_id
uint32_t tail_id
uint8_t csi_filter_cnt
uint8_t chip_id
uint8_t band_config
uint8_t channel
uint8_t csi_monitor_enable
uint8_t ra4us
wifi_csi_filter_t csi_filter [CSI_FILTER_MAX]
Detailed Description
This structure is used for Wi-Fi CSI configuration.
Field Documentation
uint8_t _wifi_csi_config_params_t::bss_type
BSS type,
0: STA;
1: UAP.
uint16_t _wifi_csi_config_params_t::csi_enable
CSI enable flag,
1: enable,
2: disable.
uint32_t _wifi_csi_config_params_t::head_id
Header ID
uint32_t _wifi_csi_config_params_t::tail_id
Tail ID
uint8_t _wifi_csi_config_params_t::csi_filter_cnt
Number of CSI filters
uint8_t _wifi_csi_config_params_t::chip_id
Chip ID
uint8_t _wifi_csi_config_params_t::band_config
band config
uint8_t _wifi_csi_config_params_t::channel
Channel num
uint8_t _wifi_csi_config_params_t::csi_monitor_enable
Enable getting CSI data on special channel
uint8_t _wifi_csi_config_params_t::ra4us
CSI data received in cfg channel with mac addr filter, not only RA is us or other.
wifi_csi_filter_t _wifi_csi_config_params_t::csi_filter[CSI_FILTER_MAX]
CSI filters.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
_wifi_csi_filter_t Struct Reference
Data Fields
uint8_t mac_addr [MLAN_MAC_ADDR_LENGTH]
uint8_t pkt_type
uint8_t subtype
uint8_t flags
Detailed Description
This structure is used for Wi-Fi CSI (channel state information) filter configuration.
Field Documentation
uint8_t _wifi_csi_filter_t::mac_addr[MLAN_MAC_ADDR_LENGTH]
Source address of the packet to receive.
uint8_t _wifi_csi_filter_t::pkt_type
Packet type of the interested CSI.
uint8_t _wifi_csi_filter_t::subtype
Packet subtype of the interested CSI.
uint8_t _wifi_csi_filter_t::flags
Other filter flags
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
_wlan_date_time_t Struct Reference
Data Fields
uint32_t action
uint16_t year
uint8_t month
uint8_t day
uint8_t hour
uint8_t minute
uint8_t second
Detailed Description
This structure is used for date and time configuration.
Field Documentation
uint32_t _wlan_date_time_t::action
Action type,
0: get,
1: set.
uint16_t _wlan_date_time_t::year
Year: range from 1970 to 2099.
uint8_t _wlan_date_time_t::month
Month: range from 1 to 12.
uint8_t _wlan_date_time_t::day
Day: range from 1 to 31 (depending on month).
uint8_t _wlan_date_time_t::hour
Hour: range from 0 to 23.
uint8_t _wlan_date_time_t::minute
Minute: range from 0 to 59.
uint8_t _wlan_date_time_t::second
Minute: range from 0 to 59.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
adv_data_t Struct Reference
Data Fields
uint8_t data_len
uint8_t type
const uint8_t * data
Detailed Description
NCP Bluetooth LE adv data type structure
Field Documentation
uint8_t adv_data_t::data_len
adv data length
uint8_t adv_data_t::type
adv data type
const uint8_t* adv_data_t::data
adv data
The documentation for this struct was generated from the following file:
service.h
gap_bond_lost_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the value of the Bluetooth LE lost bond event which indicates the signature check has failed and the client need pair again to reestablish the bond.
Field Documentation
uint8_t gap_bond_lost_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_bond_lost_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_bond_pairing_failed_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t reason
Detailed Description
This structure contains the value of Bluetooth LE pairing failed event which the secure pairing process has failed.
Field Documentation
uint8_t gap_bond_pairing_failed_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_bond_pairing_failed_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gap_bond_pairing_failed_ev::reason
pairing failed reason
0: Security procedure successful
1: Authentication failed
2: PIN or encryption key is missing
3: OOB data is not available
4: The requested security level could not be reached
5: Pairing is not supported
6: Pairing is not allowed
7: Invalid parameters
8: Distributed Key Rejected
9: Pairing failed but the exact reason could not be specified
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_conn_param_update_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t interval_min
uint16_t interval_max
uint16_t latency
uint16_t timeout
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE update connection command.
Field Documentation
uint8_t gap_conn_param_update_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_conn_param_update_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gap_conn_param_update_cmd::interval_min
connection minimal interval
Minimum value for the connection interval. Must be less than or equal to maximum connection interval
uint16_t gap_conn_param_update_cmd::interval_max
connection maximum interval
Maximum value for the connection interval. Must be greater than or equal to minimum connection interval
uint16_t gap_conn_param_update_cmd::latency
connection latency
Maximum peripheral latency for the connection in number of subrated connection events
uint16_t gap_conn_param_update_cmd::timeout
connection timeout
Supervision timeout for the Bluetooth LE link
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_conn_param_update_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t interval
uint16_t latency
uint16_t timeout
Detailed Description
This structure contains the value of the Bluetooth LE connection update complete event which indicate the connection update procedure has completed.
Field Documentation
uint8_t gap_conn_param_update_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_conn_param_update_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gap_conn_param_update_ev::interval
connection interval
uint16_t gap_conn_param_update_ev::latency
connection latency
Maximum peripheral latency for the connection in number of subrated connection events
uint16_t gap_conn_param_update_ev::timeout
connection timeout
Supervision timeout for the Bluetooth LE link
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_connect_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE connect command.
Field Documentation
uint8_t gap_connect_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_connect_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_data_len_updated_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t tx_max_len
uint16_t tx_max_time
uint16_t rx_max_len
uint16_t rx_max_time
Detailed Description
This structure contains the value of the Bluetooth LE data length change event which notifies the Host of a change to either the maximum LL Data PDU Payload length or the maximum transmission time of packets containing LL Data PDUs in either direction.
Field Documentation
uint8_t gap_data_len_updated_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_data_len_updated_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gap_data_len_updated_ev::tx_max_len
Maximum data length of TX connection
uint16_t gap_data_len_updated_ev::tx_max_time
Maximum time of TX connection
uint16_t gap_data_len_updated_ev::rx_max_len
Maximum length of RX connection
uint16_t gap_data_len_updated_ev::rx_max_time
Maximum time of RX connection
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_device_connected_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t interval
uint16_t latency
uint16_t timeout
Detailed Description
This structure contains the value of the Bluetooth LE connection complete event which indicates a new connection has been created.
Field Documentation
uint8_t gap_device_connected_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_device_connected_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gap_device_connected_ev::interval
connection interval
uint16_t gap_device_connected_ev::latency
connection latency
Maximum peripheral latency for the connection in number of subrated connection events
uint16_t gap_device_connected_ev::timeout
connection timeout
Supervision timeout for the Bluetooth LE link
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_device_disconnected_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the value of the Bluetooth LE disconnection complete event which indicates a connection is terminated.
Field Documentation
uint8_t gap_device_disconnected_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_device_disconnected_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_device_found_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
int8_t rssi
uint8_t flags
uint16_t eir_data_len
uint8_t eir_data []
Detailed Description
This structure contains the value of the Bluetooth LE advertising report event which indicates one or more Bluetooth devices have responded to an active scan or have broadcast advertisements that were received during a passive scan.
Field Documentation
uint8_t gap_device_found_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_device_found_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
int8_t gap_device_found_ev::rssi
scan rssi
uint8_t gap_device_found_ev::flags
Bluetooth LE device found flag
0x01: GAP_DEVICE_FOUND_FLAG_RSSI
0x02: GAP_DEVICE_FOUND_FLAG_AD
0x04: GAP_DEVICE_FOUND_FLAG_SD
uint16_t gap_device_found_ev::eir_data_len
scan data length
uint8_t gap_device_found_ev::eir_data[]
scan data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_disconnect_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE disconnect command.
Field Documentation
uint8_t gap_disconnect_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_disconnect_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_identity_resolved_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t identity_address_type
uint8_t identity_address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the value of the Bluetooth LE identity resolved event which indicates that the remote host Identity Address has been resolved.
Field Documentation
uint8_t gap_identity_resolved_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_identity_resolved_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gap_identity_resolved_ev::identity_address_type
Bluetooth LE identity address type
2: public identity address
3: random identity address
uint8_t gap_identity_resolved_ev::identity_address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE identity address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_pair_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE pair command.
Field Documentation
uint8_t gap_pair_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_pair_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_passkey_display_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint32_t passkey
Detailed Description
This structure contains the value of the Bluetooth LE user passkey notification event which is used to provide a passkey for the Host to display to the user.
Field Documentation
uint8_t gap_passkey_display_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_passkey_display_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint32_t gap_passkey_display_ev::passkey
device passkey number
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_phy_updated_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t tx_phy
uint8_t rx_phy
Detailed Description
This structure contains the value of the Bluetooth LE PHY update complete event which indicate that the controller has changed the transmitter PHY or receiver PHY in use.
Field Documentation
uint8_t gap_phy_updated_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_phy_updated_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gap_phy_updated_ev::tx_phy
Bluetooth TX PHY
1: 1M PHY
2: 2M PHY
4: Coded PHY
uint8_t gap_phy_updated_ev::rx_phy
Bluetooth RX PHY
1: 1M PHY
2: 2M PHY
4: Coded PHY
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_sec_level_changed_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t sec_level
Detailed Description
This structure contains the value of the Bluetooth LE security level changed event which is sent when the connection security level has changed.
Field Documentation
uint8_t gap_sec_level_changed_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_sec_level_changed_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gap_sec_level_changed_ev::sec_level
connection security level
0x01: No encryption and no authentication
0x02: Encryption and no authentication (no MITM)
0x03: Encryption and authentication (MITM)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_set_adv_data_cmd Struct Reference
Data Fields
uint8_t adv_data_len
uint8_t data [31]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set advertising data command.
Field Documentation
uint8_t gap_set_adv_data_cmd::adv_data_len
advertising data length
uint8_t gap_set_adv_data_cmd::data[31]
Advertising data to set
advertising data follows the format:
struct bt_data {
U8 len;
U8 type;
const U8 *data;
}
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_set_data_len_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t time_flag
uint16_t tx_max_len
uint16_t tx_max_time
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set advertising data length command.
Field Documentation
uint8_t gap_set_data_len_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_set_data_len_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gap_set_data_len_cmd::time_flag
option to use tx_max_time or to use system calculate maximum TX transmit time
0: use system maximum TX transmit time
1: use customized maximum TX transmit time
uint16_t gap_set_data_len_cmd::tx_max_len
Maximum data length to transmit
uint16_t gap_set_data_len_cmd::tx_max_time
Maximum TX transmit time
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_set_filter_list Struct Reference
Data Fields
uint8_t cnt
le_addr_t addr
Detailed Description
This structure contains the configuration values of Bluetooth LE filter list.
Field Documentation
uint8_t gap_set_filter_list::cnt
The number of filter addresses to set
le_addr_t gap_set_filter_list::addr
list of filter addresses
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_set_phy_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t options
uint8_t pref_tx_phy
uint8_t pref_rx_phy
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set PHY command.
Field Documentation
uint8_t gap_set_phy_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_set_phy_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gap_set_phy_cmd::options
Connection PHY options
0: BT_CONN_LE_PHY_OPT_NONE (Convenience value when no options are specified)
bit0: BT_CONN_LE_PHY_OPT_CODED_S2 (LE Coded using S=2 coding preferred when transmitting)
bit1: BT_CONN_LE_PHY_OPT_CODED_S8 (LE Coded using S=8 coding preferred when transmitting)
uint8_t gap_set_phy_cmd::pref_tx_phy
Bitmask of preferred transmit PHYs
0: BT_GAP_LE_PHY_NONE (Convenience macro for when no PHY is set)
bit0: BT_GAP_LE_PHY_1M (LE 1M PHY)
bit1: BT_GAP_LE_PHY_2M (LE 2M PHY)
bit2: BT_GAP_LE_PHY_CODED (LE Coded PHY)
uint8_t gap_set_phy_cmd::pref_rx_phy
Bitmask of preferred receive PHYs
0: BT_GAP_LE_PHY_NONE (Convenience macro for when no PHY is set)
bit0: BT_GAP_LE_PHY_1M (LE 1M PHY)
bit1: BT_GAP_LE_PHY_2M (LE 2M PHY)
bit2: BT_GAP_LE_PHY_CODED (LE Coded PHY)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_set_scan_param_cmd Struct Reference
Data Fields
uint32_t options
uint16_t interval
uint16_t window
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set scan parameter command.
Field Documentation
uint32_t gap_set_scan_param_cmd::options
Bit-field of scanning options.
uint16_t gap_set_scan_param_cmd::interval
Scan interval (N * 0.625 ms)
uint16_t gap_set_scan_param_cmd::window
Scan window (N * 0.625 ms)
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_start_advertising_cmd Struct Reference
Data Fields
uint8_t adv_data_len
uint8_t scan_rsp_len
uint8_t adv_sr_data []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE advertising command.
Field Documentation
uint8_t gap_start_advertising_cmd::adv_data_len
advertising data length
uint8_t gap_start_advertising_cmd::scan_rsp_len
scan response length
uint8_t gap_start_advertising_cmd::adv_sr_data[]
advertising/scan response data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_start_advertising_rp Struct Reference
Data Fields
uint32_t current_settings
Detailed Description
This structure contains the command response values of the Bluetooth LE start advertising command.
Field Documentation
uint32_t gap_start_advertising_rp::current_settings
device current setting
bit0: GAP_SETTINGS_POWERED
bit1: GAP_SETTINGS_CONNECTABLE
bit2: GAP_SETTINGS_FAST_CONNECTABLE
bit3: GAP_SETTINGS_DISCOVERABLE
bit4: GAP_SETTINGS_BONDABLE
bit5: GAP_SETTINGS_LINK_SEC_3
bit6: GAP_SETTINGS_SSP
bit7: GAP_SETTINGS_BREDR
bit8: GAP_SETTINGS_HS
bit9: GAP_SETTINGS_LE
bit10: GAP_SETTINGS_ADVERTISING
bit11: GAP_SETTINGS_SC
bit12: GAP_SETTINGS_DEBUG_KEYS
bit13: GAP_SETTINGS_PRIVACY
bit14: GAP_SETTINGS_CONTROLLER_CONFIG
bit15: GAP_SETTINGS_STATIC_ADDRESS
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_start_discovery_cmd Struct Reference
Data Fields
uint8_t flags
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE start discovery command.
Field Documentation
uint8_t gap_start_discovery_cmd::flags
discovery setting
0x01: discovery le
0x02: discovery bredr
0x04: limit discovery
0x08: active scan
0x10: observe
0x20: discovery own address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_stop_advertising_rp Struct Reference
Data Fields
uint32_t current_settings
Detailed Description
This structure contains the command response values of the Bluetooth LE stop advertising command.
Field Documentation
uint32_t gap_stop_advertising_rp::current_settings
device current setting
bit0: GAP_SETTINGS_POWERED
bit1: GAP_SETTINGS_CONNECTABLE
bit2: GAP_SETTINGS_FAST_CONNECTABLE
bit3: GAP_SETTINGS_DISCOVERABLE
bit4: GAP_SETTINGS_BONDABLE
bit5: GAP_SETTINGS_LINK_SEC_3
bit6: GAP_SETTINGS_SSP
bit7: GAP_SETTINGS_BREDR
bit8: GAP_SETTINGS_HS
bit9: GAP_SETTINGS_LE
bit10: GAP_SETTINGS_ADVERTISING
bit11: GAP_SETTINGS_SC
bit12: GAP_SETTINGS_DEBUG_KEYS
bit13: GAP_SETTINGS_PRIVACY
bit14: GAP_SETTINGS_CONTROLLER_CONFIG
bit15: GAP_SETTINGS_STATIC_ADDRESS
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gap_unpair_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE unpair command.
Field Documentation
uint8_t gap_unpair_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gap_unpair_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_characteristic_cmd Struct Reference
Data Fields
TypeHeader_t header
uint16_t svc_id
uint8_t properties
uint16_t permissions
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE add characteristic command.
Field Documentation
TypeHeader_t gatt_add_characteristic_cmd::header
Header of the type tlv
uint16_t gatt_add_characteristic_cmd::svc_id
service id
uint8_t gatt_add_characteristic_cmd::properties
characteristic properties
uint16_t gatt_add_characteristic_cmd::permissions
characteristic permission
uint8_t gatt_add_characteristic_cmd::uuid_length
characteristic length
uint8_t gatt_add_characteristic_cmd::uuid[SERVER_MAX_UUID_LEN]
characteristic UUID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_characteristic_rp Struct Reference
Data Fields
uint16_t char_id
Detailed Description
This structure is returned as an output from the Bluetooth LE add characteristic command.
Field Documentation
uint16_t gatt_add_characteristic_rp::char_id
characteristic ID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_descriptor_cmd Struct Reference
Data Fields
TypeHeader_t header
uint16_t char_id
uint16_t permissions
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE add descriptor command.
Field Documentation
TypeHeader_t gatt_add_descriptor_cmd::header
Header of the type tlv
uint16_t gatt_add_descriptor_cmd::char_id
characteristic id
uint16_t gatt_add_descriptor_cmd::permissions
descriptor permission
uint8_t gatt_add_descriptor_cmd::uuid_length
descriptor length
uint8_t gatt_add_descriptor_cmd::uuid[SERVER_MAX_UUID_LEN]
descriptor UUID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_descriptor_rp Struct Reference
Data Fields
uint16_t desc_id
Detailed Description
This structure is returned as an output from the Bluetooth LE add descriptor command.
Field Documentation
uint16_t gatt_add_descriptor_rp::desc_id
descriptor id
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_included_service_cmd Struct Reference
Data Fields
TypeHeader_t header
uint16_t svc_id
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE add include service command.
Field Documentation
TypeHeader_t gatt_add_included_service_cmd::header
Header of the type tlv
uint16_t gatt_add_included_service_cmd::svc_id
service UUID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_included_service_rp Struct Reference
Data Fields
uint16_t included_service_id
Detailed Description
This structure is returned as an output from the Bluetooth LE add include service command.
Field Documentation
uint16_t gatt_add_included_service_rp::included_service_id
include service ID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_service_cmd Struct Reference
Data Fields
TypeHeader_t header
uint8_t type
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE add service command.
Field Documentation
TypeHeader_t gatt_add_service_cmd::header
Header of the type tlv
uint8_t gatt_add_service_cmd::type
Bluetooth LE service type
0: primary service
1: secondary service
uint8_t gatt_add_service_cmd::uuid_length
service UUID length
0x02: UUID type 16-bit
0x10: UUID type 128-bit
uint8_t gatt_add_service_cmd::uuid[SERVER_MAX_UUID_LEN]
service UUID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_add_service_rp Struct Reference
Data Fields
uint16_t svc_id
Detailed Description
This structure is returned as an output from the Bluetooth LE add service command.
Field Documentation
uint16_t gatt_add_service_rp::svc_id
attribute handle of added new service
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_attr Struct Reference
Data Fields
uint16_t handle
uint8_t permission
uint8_t type_length
uint8_t type []
Detailed Description
This structure contains the configuration values of the Bluetooth LE attributes.
Field Documentation
uint16_t gatt_attr::handle
attribute handle
uint8_t gatt_attr::permission
attribute permission
uint8_t gatt_attr::type_length
attribute type length
uint8_t gatt_attr::type[]
attribute type list
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_attr_value_changed_ev Struct Reference
Data Fields
uint16_t handle
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the value of the Bluetooth LE GATT attribute value changed event which notifies the changed attributes to the client.
Field Documentation
uint16_t gatt_attr_value_changed_ev::handle
attribute handle
uint16_t gatt_attr_value_changed_ev::data_length
attribute data length
uint8_t gatt_attr_value_changed_ev::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_ccc_cfg_changed_ev Struct Reference
Data Fields
uint16_t ccc_value
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the value of the Bluetooth LE client characteristic configuration changed event which indicates whether the characteristic notification or indication is enabled or disabled to the client.
Field Documentation
uint16_t gatt_ccc_cfg_changed_ev::ccc_value
ccc (client characteristic configuration) value
uint8_t gatt_ccc_cfg_changed_ev::uuid_length
UUID length
uint8_t gatt_ccc_cfg_changed_ev::uuid[SERVER_MAX_UUID_LEN]
UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_cfg_notify_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t enable
uint16_t ccc_handle
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE notify command.
Field Documentation
uint8_t gatt_cfg_notify_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_cfg_notify_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gatt_cfg_notify_cmd::enable
enable characteristic notification
0: disable
1: enable
uint16_t gatt_cfg_notify_cmd::ccc_handle
characteristic configure change handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_cfg_notify_mult_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t cnt
uint16_t attr_id []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE notify multiple service command.
Field Documentation
uint8_t gatt_cfg_notify_mult_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_cfg_notify_mult_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_cfg_notify_mult_cmd::cnt
attribute number
uint16_t gatt_cfg_notify_mult_cmd::attr_id[]
attribute id list
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_change_db_cmd Struct Reference
Data Fields
uint16_t start_handle
uint8_t visibility
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE change DB (data base) command.
Field Documentation
uint16_t gatt_change_db_cmd::start_handle
start handle UUID
uint8_t gatt_change_db_cmd::visibility
visibility setting
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_char_value Struct Reference
Data Fields
uint16_t handle
uint8_t data_len
uint8_t data [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE characteristics.
Field Documentation
uint16_t gatt_char_value::handle
characteristic handle
uint8_t gatt_char_value::data_len
characteristic data length
uint8_t gatt_char_value::data[SERVER_MAX_UUID_LEN]
characteristic data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
GATT_CHARACTERISTIC Struct Reference
Data Fields
uint16_t characteristic_handle
uint16_t value_handle
uint8_t properties
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE characteristic data.
Field Documentation
uint16_t GATT_CHARACTERISTIC::characteristic_handle
characteristic handle
uint16_t GATT_CHARACTERISTIC::value_handle
characteristic value handle
uint8_t GATT_CHARACTERISTIC::properties
characteristic properties handle
uint8_t GATT_CHARACTERISTIC::uuid_length
characteristic UUID length
uint8_t GATT_CHARACTERISTIC::uuid[SERVER_MAX_UUID_LEN]
characteristic UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_characteristic Struct Reference
Data Fields
uint16_t characteristic_handle
uint16_t value_handle
uint8_t properties
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE characteristic data.
Field Documentation
uint16_t gatt_characteristic::characteristic_handle
characteristic handle
uint16_t gatt_characteristic::value_handle
value handle
uint8_t gatt_characteristic::properties
characteristic properties
uint8_t gatt_characteristic::uuid_length
characteristic UUID length
uint8_t gatt_characteristic::uuid[SERVER_MAX_UUID_LEN]
characteristic UUIDs
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_descriptor Struct Reference
Data Fields
uint16_t descriptor_handle
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE descriptor data.
Field Documentation
uint16_t gatt_descriptor::descriptor_handle
descriptor handle
uint8_t gatt_descriptor::uuid_length
descriptor UUID length
uint8_t gatt_descriptor::uuid[SERVER_MAX_UUID_LEN]
descriptor UUID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
GATT_DESCRIPTOR Struct Reference
Data Fields
uint16_t descriptor_handle
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE descriptor data.
Field Documentation
uint16_t GATT_DESCRIPTOR::descriptor_handle
descriptor handle
uint8_t GATT_DESCRIPTOR::uuid_length
descriptor UUID length
uint8_t GATT_DESCRIPTOR::uuid[SERVER_MAX_UUID_LEN]
descriptor UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_all_chrc_cmd Struct Reference
Data Fields
TypeHeader_t header
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE discovery characteristic command.
Field Documentation
TypeHeader_t gatt_disc_all_chrc_cmd::header
Header of the type tlv
uint8_t gatt_disc_all_chrc_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_disc_all_chrc_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_disc_all_chrc_cmd::start_handle
characteristic start handle
uint16_t gatt_disc_all_chrc_cmd::end_handle
characteristic end handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_all_desc_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE discovery descriptor command.
Field Documentation
uint8_t gatt_disc_all_desc_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_disc_all_desc_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_disc_all_desc_cmd::start_handle
descriptor start handle
uint16_t gatt_disc_all_desc_cmd::end_handle
descriptor end handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_all_desc_rp Struct Reference
Data Fields
uint8_t descriptors_count
gatt_descriptor_t descriptors []
Detailed Description
This structure is returned as an output from the Bluetooth LE discovery descriptor command.
Field Documentation
uint8_t gatt_disc_all_desc_rp::descriptors_count
The number of discovered descriptors
gatt_descriptor_t gatt_disc_all_desc_rp::descriptors[]
discovered descriptors
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_all_prim_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE discovery primary service command.
Field Documentation
uint8_t gatt_disc_all_prim_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_disc_all_prim_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_all_prim_rp Struct Reference
Data Fields
uint8_t services_count
gatt_service_t services []
Detailed Description
This structure is returned as an output from the Bluetooth LE discovery primary service command.
Field Documentation
uint8_t gatt_disc_all_prim_rp::services_count
discovered service number
gatt_service_t gatt_disc_all_prim_rp::services[]
discovered service
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_chrc_rp Struct Reference
Data Fields
uint8_t characteristics_count
gatt_characteristic_t characteristics []
Detailed Description
This structure is returned as an output from the Bluetooth LE discovery characteristic command.
Field Documentation
uint8_t gatt_disc_chrc_rp::characteristics_count
discovered characteristic number
gatt_characteristic_t gatt_disc_chrc_rp::characteristics[]
discovered characteristic
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_chrc_uuid_cmd Struct Reference
Data Fields
TypeHeader_t header
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
uint8_t uuid_length
uint8_t uuid []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE discovery characteristic UUID command.
Field Documentation
TypeHeader_t gatt_disc_chrc_uuid_cmd::header
Header of the type tlv
uint8_t gatt_disc_chrc_uuid_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_disc_chrc_uuid_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_disc_chrc_uuid_cmd::start_handle
characteristic start handle
uint16_t gatt_disc_chrc_uuid_cmd::end_handle
characteristic end handle
uint8_t gatt_disc_chrc_uuid_cmd::uuid_length
characteristic UUID length
uint8_t gatt_disc_chrc_uuid_cmd::uuid[]
characteristic UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_desc_uuid_cmd Struct Reference
Data Fields
TypeHeader_t header
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
uint8_t uuid_length
uint8_t uuid []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE discovery descriptor UUID command.
Field Documentation
TypeHeader_t gatt_disc_desc_uuid_cmd::header
Header of the type tlv
uint8_t gatt_disc_desc_uuid_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_disc_desc_uuid_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_disc_desc_uuid_cmd::start_handle
descriptor start handle
uint16_t gatt_disc_desc_uuid_cmd::end_handle
descriptor end handle
uint8_t gatt_disc_desc_uuid_cmd::uuid_length
descriptor UUID length
uint8_t gatt_disc_desc_uuid_cmd::uuid[]
descriptor UUID values
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_prim_rp Struct Reference
Data Fields
uint8_t services_count
gatt_service_t services []
Detailed Description
This structure is returned as an output from the Bluetooth LE discovery primary UUID command.
Field Documentation
uint8_t gatt_disc_prim_rp::services_count
The number of discovered services
gatt_service_t gatt_disc_prim_rp::services[]
discovered services
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_disc_prim_uuid_cmd Struct Reference
Data Fields
TypeHeader_t header
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t uuid_length
uint8_t uuid []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE discovery primary UUID command.
Field Documentation
TypeHeader_t gatt_disc_prim_uuid_cmd::header
Header of the type tlv
uint8_t gatt_disc_prim_uuid_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_disc_prim_uuid_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gatt_disc_prim_uuid_cmd::uuid_length
UUID length
uint8_t gatt_disc_prim_uuid_cmd::uuid[]
UUID value list
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_eatt_connect_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t num_channels
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE gatt eatt connect command.
Field Documentation
uint8_t gatt_eatt_connect_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_eatt_connect_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gatt_eatt_connect_cmd::num_channels
channel number
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_exchange_mtu_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE exchange maximum transmission unit command.
Field Documentation
uint8_t gatt_exchange_mtu_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_exchange_mtu_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_find_included_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE find included service command.
Field Documentation
uint8_t gatt_find_included_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_find_included_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_find_included_cmd::start_handle
service start handle
uint16_t gatt_find_included_cmd::end_handle
service end handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_find_included_rp Struct Reference
Data Fields
uint8_t services_count
gatt_included_t included []
Detailed Description
This structure is returned as an output from the Bluetooth LE find included service command.
Field Documentation
uint8_t gatt_find_included_rp::services_count
The number of discovered services
gatt_included_t gatt_find_included_rp::included[]
discovered included service
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_get_attribute_value_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE get attribute value command.
Field Documentation
uint8_t gatt_get_attribute_value_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_get_attribute_value_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_get_attribute_value_cmd::handle
attribute handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_get_attribute_value_rp Struct Reference
Data Fields
uint8_t att_response
uint16_t value_length
uint8_t value []
Detailed Description
This structure is returned as an output from the Bluetooth LE get attribute value command.
Field Documentation
uint8_t gatt_get_attribute_value_rp::att_response
attribute response
uint16_t gatt_get_attribute_value_rp::value_length
attribute value length
uint8_t gatt_get_attribute_value_rp::value[]
attribute value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_get_attributes_cmd Struct Reference
Data Fields
uint16_t start_handle
uint16_t end_handle
uint8_t type_length
uint8_t type []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE get attributes command.
Field Documentation
uint16_t gatt_get_attributes_cmd::start_handle
attribute start handle
uint16_t gatt_get_attributes_cmd::end_handle
attribute end handle
uint8_t gatt_get_attributes_cmd::type_length
attribute type length
uint8_t gatt_get_attributes_cmd::type[]
attribute type
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_get_attributes_rp Struct Reference
Data Fields
uint8_t attrs_count
uint8_t attrs []
Detailed Description
This structure is returned as an output from the Bluetooth LE get attributes command.
Field Documentation
uint8_t gatt_get_attributes_rp::attrs_count
attribute count number
uint8_t gatt_get_attributes_rp::attrs[]
attribute list
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_included Struct Reference
Data Fields
uint16_t included_handle
struct gatt_service service
Detailed Description
This structure contains the configuration values of the Bluetooth LE service data.
Field Documentation
uint16_t gatt_included::included_handle
service include UUID
struct gatt_service gatt_included::service
service handle
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_ncp_ble_add_service_cmd Struct Reference
Data Fields
uint8_t svc_length
uint8_t svc []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE add service command.
Field Documentation
uint8_t gatt_ncp_ble_add_service_cmd::svc_length
service length
uint8_t gatt_ncp_ble_add_service_cmd::svc[]
service add list
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_ncp_ble_add_service_rp Struct Reference
Data Fields
uint8_t svc_length
uint8_t status []
Detailed Description
This structure contains the command response values of the Bluetooth LE add service command.
Field Documentation
uint8_t gatt_ncp_ble_add_service_rp::svc_length
service length
uint8_t gatt_ncp_ble_add_service_rp::status[]
service status
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_ncp_ble_svc_subscription_ev Struct Reference
Data Fields
uint8_t svc_id
uint8_t status
Detailed Description
This structure contains the value of the Bluetooth LE subscription event which indicates the service characteristics are subscribed.
Field Documentation
uint8_t gatt_ncp_ble_svc_subscription_ev::svc_id
service id
uint8_t gatt_ncp_ble_svc_subscription_ev::status
subscription status
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_notification_ev Struct Reference
Data Fields
uint8_t svc_id
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t type
uint16_t handle
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the value of the Bluetooth LE GATT notification event which notifies characteristic values to the client.
Field Documentation
uint8_t gatt_notification_ev::svc_id
service id
uint8_t gatt_notification_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_notification_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gatt_notification_ev::type
attribute type
uint16_t gatt_notification_ev::handle
attribute handle UUID
uint16_t gatt_notification_ev::data_length
attribute data length
uint8_t gatt_notification_ev::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE read attribute command.
Field Documentation
uint8_t gatt_read_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_read_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_read_cmd::handle
handle UUID
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_long_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
uint16_t offset
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE read long attribute command.
Field Documentation
uint8_t gatt_read_long_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_read_long_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_read_long_cmd::handle
handle UUID
uint16_t gatt_read_long_cmd::offset
handle UUID offset
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_long_rp Struct Reference
Data Fields
uint8_t att_response
uint16_t data_length
uint8_t data []
Detailed Description
This structure is returned as an output from the Bluetooth LE read long attribute command.
Field Documentation
uint8_t gatt_read_long_rp::att_response
attribute response
uint16_t gatt_read_long_rp::data_length
data length
uint8_t gatt_read_long_rp::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_multiple_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint8_t handles_count
uint16_t handles []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE read multiple attributes command.
Field Documentation
uint8_t gatt_read_multiple_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_read_multiple_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint8_t gatt_read_multiple_cmd::handles_count
handle UUID number
uint16_t gatt_read_multiple_cmd::handles[]
handle UUID list
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_multiple_rp Struct Reference
Data Fields
uint8_t att_response
uint16_t data_length
uint8_t data []
Detailed Description
This structure is returned as an output from the Bluetooth LE read multiple atrributes command.
Field Documentation
uint8_t gatt_read_multiple_rp::att_response
attribute response
uint16_t gatt_read_multiple_rp::data_length
attribute data length
uint8_t gatt_read_multiple_rp::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_rp Struct Reference
Data Fields
uint8_t att_response
uint16_t data_length
uint8_t data []
Detailed Description
This structure is returned as an output from the Bluetooth LE read attribute command.
Field Documentation
uint8_t gatt_read_rp::att_response
attribute response
uint16_t gatt_read_rp::data_length
data length
uint8_t gatt_read_rp::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_uuid_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t start_handle
uint16_t end_handle
uint8_t uuid_length
uint8_t uuid []
Detailed Description
This structure is returned as an output from the Bluetooth LE read UUID command.
Field Documentation
uint8_t gatt_read_uuid_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_read_uuid_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_read_uuid_cmd::start_handle
UUID start handle
uint16_t gatt_read_uuid_cmd::end_handle
UUID end handle
uint8_t gatt_read_uuid_cmd::uuid_length
UUID length
uint8_t gatt_read_uuid_cmd::uuid[]
UUID data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_read_uuid_rp Struct Reference
Data Fields
uint8_t att_response
uint8_t values_count
gatt_char_value_t values [SERVER_MAX_ATTRIBUTES]
Detailed Description
This structure is returned as an output from the Bluetooth LE read UUID command.
Field Documentation
uint8_t gatt_read_uuid_rp::att_response
attribute response
uint8_t gatt_read_uuid_rp::values_count
attribute value number
gatt_char_value_t gatt_read_uuid_rp::values[SERVER_MAX_ATTRIBUTES]
characteristic value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_reliable_write_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
uint16_t offset
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE write reliable attribute command.
Field Documentation
uint8_t gatt_reliable_write_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_reliable_write_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_reliable_write_cmd::handle
handle UUID
uint16_t gatt_reliable_write_cmd::offset
handle offset
uint16_t gatt_reliable_write_cmd::data_length
attribute data length
uint8_t gatt_reliable_write_cmd::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_reliable_write_rp Struct Reference
Data Fields
uint8_t att_response
Detailed Description
This structure is returned as an output from the Bluetooth LE write reliable attribute command.
Field Documentation
uint8_t gatt_reliable_write_rp::att_response
attribute response
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_service Struct Reference
Data Fields
uint16_t start_handle
uint16_t end_handle
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE service characteristic data.
Field Documentation
uint16_t gatt_service::start_handle
service start UUID
uint16_t gatt_service::end_handle
service end UUID
uint8_t gatt_service::uuid_length
UUID length
uint8_t gatt_service::uuid[SERVER_MAX_UUID_LEN]
UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
GATT_SERVICE Struct Reference
Data Fields
uint16_t start_handle
uint16_t end_handle
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
This structure contains the configuration values of the Bluetooth LE service data.
Field Documentation
uint16_t GATT_SERVICE::start_handle
service start handle
uint16_t GATT_SERVICE::end_handle
service end handle
uint8_t GATT_SERVICE::uuid_length
service UUID length
uint8_t GATT_SERVICE::uuid[SERVER_MAX_UUID_LEN]
service UUID value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_set_enc_key_size_cmd Struct Reference
Data Fields
uint16_t attr_id
uint8_t key_size
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set encryption key size command.
Field Documentation
uint16_t gatt_set_enc_key_size_cmd::attr_id
attribute id
uint8_t gatt_set_enc_key_size_cmd::key_size
encryption key size
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_set_value_cmd Struct Reference
Data Fields
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
uint16_t len
uint8_t value [512]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE set value command.
Field Documentation
uint8_t gatt_set_value_cmd::uuid_length
characteristic UUID length
uint8_t gatt_set_value_cmd::uuid[SERVER_MAX_UUID_LEN]
characteristic UUID
uint16_t gatt_set_value_cmd::len
value length
uint8_t gatt_set_value_cmd::value[512]
characteristic value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_signed_write_without_rsp_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE signed write without response command.
Field Documentation
uint8_t gatt_signed_write_without_rsp_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_signed_write_without_rsp_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_signed_write_without_rsp_cmd::handle
handle UUID
uint16_t gatt_signed_write_without_rsp_cmd::data_length
attribute data length
uint8_t gatt_signed_write_without_rsp_cmd::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_start_server_rp Struct Reference
Data Fields
uint16_t db_attr_off
uint8_t db_attr_cnt
Detailed Description
This structure is returned as an output from the Bluetooth LE start server command.
Field Documentation
uint16_t gatt_start_server_rp::db_attr_off
database attribute offset
uint8_t gatt_start_server_rp::db_attr_cnt
database attribute count
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_start_service_cmd Struct Reference
Data Fields
TypeHeader_t header
uint8_t started
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE start service command.
Field Documentation
TypeHeader_t gatt_start_service_cmd::header
Header of the type tlv
uint8_t gatt_start_service_cmd::started
service started status
0: unstart
1: start
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_write_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE write attribute command.
Field Documentation
uint8_t gatt_write_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_write_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_write_cmd::handle
handle UUID
uint16_t gatt_write_cmd::data_length
attribute data length
uint8_t gatt_write_cmd::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_write_long_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
uint16_t offset
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE write long attribute command.
Field Documentation
uint8_t gatt_write_long_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_write_long_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_write_long_cmd::handle
handle UUID
uint16_t gatt_write_long_cmd::offset
handle offset
uint16_t gatt_write_long_cmd::data_length
attribute data length
uint8_t gatt_write_long_cmd::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_write_long_rp Struct Reference
Data Fields
uint8_t att_response
Detailed Description
This structure is returned as an output from the Bluetooth LE write long attribute command.
Field Documentation
uint8_t gatt_write_long_rp::att_response
attribute response
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_write_rp Struct Reference
Data Fields
uint8_t att_response
Detailed Description
This structure is returned as an output from the Bluetooth LE write attribute command.
Field Documentation
uint8_t gatt_write_rp::att_response
attribute response
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
gatt_write_without_rsp_cmd Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t handle
uint16_t data_length
uint8_t data []
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE write without response command.
Field Documentation
uint8_t gatt_write_without_rsp_cmd::address_type
Bluetooth LE address type
0: public
1: random
uint8_t gatt_write_without_rsp_cmd::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t gatt_write_without_rsp_cmd::handle
handle UUID
uint16_t gatt_write_without_rsp_cmd::data_length
attribute data length
uint8_t gatt_write_without_rsp_cmd::data[]
attribute data
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
host_gatt_attr Struct Reference
Data Fields
uint8_t type
uint8_t properties
uint16_t permissions
uint8_t uuid_length
uint8_t uuid [SERVER_MAX_UUID_LEN]
Detailed Description
NCP Bluetooth LE host gatt attribute type structure
Field Documentation
uint8_t host_gatt_attr::type
NCP Bluetooth LE TLV type
uint8_t host_gatt_attr::properties
attribute properties
uint16_t host_gatt_attr::permissions
attribute permissions
uint8_t host_gatt_attr::uuid_length
service uuid length
uint8_t host_gatt_attr::uuid[SERVER_MAX_UUID_LEN]
service uuid
The documentation for this struct was generated from the following file:
service.h
hr_measurement Struct Reference
Data Fields
uint8_t sensor
uint8_t rate
Detailed Description
Heart Rate format
Field Documentation
uint8_t hr_measurement::sensor
sensor id
uint8_t hr_measurement::rate
heart rate
The documentation for this struct was generated from the following file:
ht.h
icmp_echo_hdr Struct Reference
Data Fields
uint8_t type
uint8_t code
uint16_t chksum
uint16_t id
uint16_t seqno
Detailed Description
This structure is used for ICMP (internet control message protocol) echo header configuration.
Field Documentation
uint8_t icmp_echo_hdr::type
Indicates the type of ICMP packet.
uint8_t icmp_echo_hdr::code
Identifies the code of the corresponding ICMP packet. Together with the Type field, it identifies the detailed type of an ICMP packet.
uint16_t icmp_echo_hdr::chksum
This checksum checksums the entire ICMP datagram, including the data portion of the ICMP packet, to check whether there is an error in the transmission of the packet.
uint16_t icmp_echo_hdr::id
This field is used to identify the ICMP process, but is only applicable to echoing requests and replies to ICMP packets, and has a value of 0 for ICMP packets whose destinations are unreachable and ICMP packets that have timed out.
uint16_t icmp_echo_hdr::seqno
Packet sequence number, which is used to mark the order of ICMP packets.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
ip_hdr Struct Reference
Data Fields
uint8_t _v_hl
uint8_t _tos
uint16_t _len
uint16_t _id
uint16_t _offset
uint8_t _ttl
uint8_t _proto
uint16_t _chksum
in_addr_t src
in_addr_t dest
Detailed Description
This structure is used for IP header configuration.
Field Documentation
uint8_t ip_hdr::_v_hl
Version / header length
uint8_t ip_hdr::_tos
Type of service.
uint16_t ip_hdr::_len
Total length.
uint16_t ip_hdr::_id
Identification.
uint16_t ip_hdr::_offset
Fragment offset field
uint8_t ip_hdr::_ttl
Time to live.
uint8_t ip_hdr::_proto
Protocol type.
uint16_t ip_hdr::_chksum
Checksum.
in_addr_t ip_hdr::src
Source IP address.
in_addr_t ip_hdr::dest
Destination IP address.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
iperf_msg_t Struct Reference
Data Fields
int16_t status [2]
uint32_t count
uint32_t timeout
uint32_t handle
uint32_t port
uint16_t per_size
char ip_addr [IP_ADDR_LEN]
iperf_set_t iperf_set
Detailed Description
This structure is used for iperf message configuration.
Field Documentation
int16_t iperf_msg_t::status[2]
Iperf status.
status[0] is for TX,
status[1] is for RX.
uint32_t iperf_msg_t::count
Count of iperf package.
uint32_t iperf_msg_t::timeout
Timeout period.
uint32_t iperf_msg_t::handle
Socket handle index number.
uint32_t iperf_msg_t::port
Peer port number.
uint16_t iperf_msg_t::per_size
Size of per UDP package.
char iperf_msg_t::ip_addr[IP_ADDR_LEN]
IP address.
iperf_set_t iperf_msg_t::iperf_set
Iperf configuration.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
iperf_set_t Struct Reference
Data Fields
uint32_t iperf_type
uint32_t iperf_count
uint32_t iperf_udp_rate
uint32_t iperf_udp_time
Detailed Description
This structure is used for iperf configuration.
Field Documentation
uint32_t iperf_set_t::iperf_type
Iperf type,
0: TCP TX,
1: TCP RX,
2: UDP TX,
3: UDP RX.
uint32_t iperf_set_t::iperf_count
Iperf package count.
uint32_t iperf_set_t::iperf_udp_rate
UDP rate.
uint32_t iperf_set_t::iperf_udp_time
UDP time.
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
l2cap_connect_cmd_tag Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
uint8_t sec
uint8_t sec_flag
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE L2CAP connection command.
Field Documentation
uint8_t l2cap_connect_cmd_tag::address_type
Bluetooth LE address type
0: public
1: random
uint8_t l2cap_connect_cmd_tag::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t l2cap_connect_cmd_tag::psm
Protocol/Service Multiplexer
uint8_t l2cap_connect_cmd_tag::sec
connection security level
0x01: No encryption and no authentication
0x02: Encryption and no authentication (no MITM)
0x03: Encryption and authentication (MITM)
uint8_t l2cap_connect_cmd_tag::sec_flag
Option to use custom security level or to use system default security level
0: to use system default security level
1: to use customized security level
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_connect_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
Detailed Description
This structure contains the value of the Bluetooth LE L2CAP (Logical Link Control and Adaptation Layer Protocol) connection complete event which indicates an L2CAP connection is established.
Field Documentation
uint8_t l2cap_connect_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t l2cap_connect_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t l2cap_connect_ev::psm
PSM (Protocol/Service Multiplexer) value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_connect_rp_tag Struct Reference
Data Fields
uint8_t num
uint8_t chan_id []
Detailed Description
This structure is returned as an output of the Bluetooth LE L2CAP connection command.
Field Documentation
uint8_t l2cap_connect_rp_tag::num
receive packet number
uint8_t l2cap_connect_rp_tag::chan_id[]
receive channel id
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_disconnect_cmd_tag Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE L2CAP disconnection command.
Field Documentation
uint8_t l2cap_disconnect_cmd_tag::address_type
Bluetooth LE address type
0: public
1: random
uint8_t l2cap_disconnect_cmd_tag::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_disconnect_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
Detailed Description
This structure contains the value of the Bluetooth LE L2CAP (Logical Link Control and Adaptation Layer Protocol) disconnection complete event which indicates an L2CAP connection is terminated.
Field Documentation
uint8_t l2cap_disconnect_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t l2cap_disconnect_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t l2cap_disconnect_ev::psm
PSM (Protocol/Service Multiplexer) value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_metrics_cmd_tag Struct Reference
Data Fields
bool metrics_flag
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE l2cap metrics command.
Field Documentation
bool l2cap_metrics_cmd_tag::metrics_flag
option to enable calculating metrics of l2cap rate
0: disable calculating metrics of l2cap rate
1: enable calculating metrics of l2cap rate
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_receive_ev Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t psm
uint8_t len
uint8_t data [256]
Detailed Description
This structure contains the value of the Bluetooth LE L2CAP (Logical Link Control and Adaptation Layer Protocol) receive packet event which notifies the receive data over L2CAP channel to the client.
Field Documentation
uint8_t l2cap_receive_ev::address_type
Bluetooth LE address type
0: public
1: random
uint8_t l2cap_receive_ev::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t l2cap_receive_ev::psm
PSM (Protocol/Service Multiplexer) value
uint8_t l2cap_receive_ev::len
receive data length
uint8_t l2cap_receive_ev::data[256]
receive data value
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_recv_cmd_tag Struct Reference
Data Fields
uint32_t l2cap_recv_delay_ms
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE l2cap receive command.
Field Documentation
uint32_t l2cap_recv_cmd_tag::l2cap_recv_delay_ms
receive delay time in millisecond
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_register_psm_cmd_tag Struct Reference
Data Fields
uint16_t psm
uint8_t sec_level
uint8_t sec_flag
uint8_t policy
uint8_t policy_flag
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE l2cap register PSM (Protocol/Service Multiplexer) command.
Field Documentation
uint16_t l2cap_register_psm_cmd_tag::psm
protocol service multiplexor
uint8_t l2cap_register_psm_cmd_tag::sec_level
connection security level
0x01: No encryption and no authentication
0x02: Encryption and no authentication (no MITM)
0x03: Encryption and authentication (MITM)
uint8_t l2cap_register_psm_cmd_tag::sec_flag
Option to use custom security level or to use system default security level
0: use system default security level
1: use customized security level
uint8_t l2cap_register_psm_cmd_tag::policy
allowlist
uint8_t l2cap_register_psm_cmd_tag::policy_flag
option to use allowlist
0: do not use allowlist
1: use allowlist
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
l2cap_send_data_cmd_tag Struct Reference
Data Fields
uint8_t address_type
uint8_t address [NCP_BLE_ADDR_LENGTH]
uint16_t times
Detailed Description
This structure contains the configuration values that are used as input to the Bluetooth LE L2CAP send data command.
Field Documentation
uint8_t l2cap_send_data_cmd_tag::address_type
Bluetooth LE address type
0: public
1: random
uint8_t l2cap_send_data_cmd_tag::address[NCP_BLE_ADDR_LENGTH]
Bluetooth LE address
uint16_t l2cap_send_data_cmd_tag::times
the number of times a loop is sent
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
le_addr_t Struct Reference
Data Fields
uint8_t type
uint8_t address [NCP_BLE_ADDR_LENGTH]
Detailed Description
This structure contains the configuration values of Bluetooth LE address type.
Field Documentation
uint8_t le_addr_t::type
Types of Bluetooth LE device addresses:
Public Address : 0x00
Random Address : 0x01
Public Identity Address : 0x02
Random Identity Address : 0x03
uint8_t le_addr_t::address[NCP_BLE_ADDR_LENGTH]
Bluetooth device Address
The documentation for this struct was generated from the following file:
ncp_cmd_ble.h
temp_measurement Struct Reference
Data Fields
uint8_t flags
uint8_t temperature [4]
uint8_t type
Detailed Description
Temperature measurement format
Field Documentation
uint8_t temp_measurement::flags
temperature type flag
0: Fahrenheit
1: Celsius
uint8_t temp_measurement::temperature[4]
temperature
uint8_t temp_measurement::type
Possible temperature sensor locations
0: hts_no_temp_type
1: hts_armpit
2: hts_body
3: hts_ear
4: hts_finger
5: hts_gastroInt
6: hts_mouth
7: hts_rectum
8: hts_toe
9: hts_tympanum
The documentation for this struct was generated from the following file:
ht.h
wifi_sta_info_t Struct Reference
Data Fields
uint8_t mac [MLAN_MAC_ADDR_LENGTH]
uint8_t power_mgmt_status
char rssi
Detailed Description
This structure is used for station configuration.
Field Documentation
uint8_t wifi_sta_info_t::mac[MLAN_MAC_ADDR_LENGTH]
MAC address buffer.
uint8_t wifi_sta_info_t::power_mgmt_status
Power management status,
0: active (not in power save),
1: in power save status.
char wifi_sta_info_t::rssi
Value of RSSI: dBm
The documentation for this struct was generated from the following file:
ncp_host_command_wifi.h
WLAN_RESET_ParaSet Struct Reference
Data Fields
uint8_t option
Detailed Description
This structure is used for Wi-Fi reset option.
Field Documentation
uint8_t WLAN_RESET_ParaSet::option
Wi-Fi reset option, there are 3 modes,
0: disable Wi-Fi;
1: enable Wi-Fi;
2: reset Wi-Fi.
The documentation for this struct was generated from the following file:
ncp_cmd_wifi.h
File Documentation
bas.h File Reference
Battery Service Profile definitions.
Function Documentation
void bas_init (void )
Init BAS Service
void peripheral_bas_event_put (osa_event_flags_t flag)
Count binary semaphore to wait for BAS write characteristic response event
Parameters
| in | flag | flag to wait |
Returns
void
void peripheral_bas_start (void )
Start peripheral BAS Service
void peripheral_bas_indicate (uint8_t value)
Indicate BAS characteristic value change event
Parameters
| in | value | bas value |
Returns
void
Macro Documentation
#define BAS_EVENT_WRITE_CHRA_RSP 0x01
BAS write characteristic response event ID
#define UUID_BAS 0x180f
Battery Service UUID value
#define UUID_BAS_BATTERY_LEVEL 0x2a19
BAS Characteristic Battery Level UUID value
hr.h File Reference
Health Rate Profile definitions.
Function Documentation
void central_hrc_start (void )
Start Central HRC Service
void hrc_init (void )
Init HRC Service
void hrs_init (void )
Init HRS Service
void peripheral_hrs_event_put (osa_event_flags_t flag)
Count binary semaphore to wait for HRS write characteristic response event
Parameters
| in | flag | flag to wait |
Returns
void.
void peripheral_hrs_start (void )
Start Peripheral HRS Service
void peripheral_hrs_indicate (uint8_t value)
Indicate HRS characteristic value change event
Parameters
| in | value | hrs value |
Returns
void
Macro Documentation
#define HRC_EVENT_DEVICE_FOUND 0x01
HRC device found event ID
#define HRC_EVENT_CONNECTED 0x02
HRC connected event ID
#define HRC_EVENT_GET_PRIMARY_SERVICE 0x03
HRC get primary service event ID
#define HRC_EVENT_GET_CHARACTERISTICS 0x04
HRC get characteristic event ID
#define HRC_EVENT_GET_CCC 0x05
HRC get characteristic configuration changed event ID
#define HRS_EVENT_WRITE_CHRA_RSP 0x01
HRC write characteristic response event ID
#define UUID_HRS 0x180d
Heart Rate Service UUID value
#define UUID_HRS_MEASUREMENT 0x2a37
HRS Characteristic Measurement Interval UUID value
#define UUID_HRS_BODY_SENSOR 0x2a38
HRS Characteristic Body Sensor Location
#define UUID_HRS_CONTROL_POINT 0x2a39
HRS Characteristic Control Point UUID value
ht.h File Reference
Health Thermometer Profile definitions.
Function Documentation
void central_htc_start (void )
Start central HTC (Health Thermometer) service
void htc_init (void )
Init HTC Service
void hts_init (void )
Init HTS Service
void peripheral_hts_event_put (osa_event_flags_t flag)
Count binary semaphore to wait for HTS write characteristic response event
Parameters
| in | flag | flag to wait |
Returns
void
void peripheral_hts_start (void )
Start Peripheral HTS Service
void peripheral_hts_indicate (uint8_t value)
Indicate HTS characteristic value change event
Parameters
| in | value | hts value |
Returns
void
Macro Documentation
#define HTC_EVENT_DEVICE_FOUND 0x01
HTC device found event ID
#define HTC_EVENT_CONNECTED 0x02
HTC connected event ID
#define HTC_EVENT_GET_PRIMARY_SERVICE 0x03
HTC get primary service event ID
#define HTC_EVENT_GET_CHARACTERISTICS 0x04
HTC get characteristic ID
#define HTC_EVENT_GET_CCC 0x05
HTC get characteristic configuration changed event ID
#define HTS_EVENT_WRITE_CHRA_RSP 0x01
HTC write characteristic response event ID
#define UUID_GATT_PRIMARY 0x2800
GATT Primary Service UUID
#define UUID_HTS 0x1809
Health Thermometer Service UUID
#define UUID_HTS_MEASUREMENT 0x2a1c
HTS Characteristic Measurement Value UUID
#define UUID_GATT_CCC 0x2902
GATT Client Characteristic Configuration UUID
#define BT_GATT_CCC_NOTIFY 0x0001
Client Characteristic Configuration Values Client Characteristic Configuration Notification.
If set, changes to Characteristic Value are notified.
#define BT_GATT_CCC_INDICATE 0x0002
Client Characteristic Configuration Indication.
If set, changes to Characteristic Value are indicated.
#define hts_unit_celsius_c 0x00U
HTS flag values
ncp_cmd_ble.h File Reference
NCP Bluetooth LE command and structure definitions.
Macro Documentation
#define NCP_CMD_BLE_CORE 0x00000000
NCP Bluetooth LE subclass type NCP Bluetooth LE subclass type for core command
#define NCP_CMD_BLE_GAP 0x00100000
NCP Bluetooth LE subclass type for gap command
#define NCP_CMD_BLE_GATT 0x00200000
NCP Bluetooth LE subclass type for gatt command
#define NCP_CMD_BLE_L2CAP 0x00300000
NCP Bluetooth LE subclass type for l2cap command
#define NCP_CMD_BLE_POWERMGMT 0x00400000
NCP Bluetooth LE subclass type for power management command
#define NCP_CMD_BLE_VENDOR 0x00500000
NCP Bluetooth LE subclass type for vendor command
#define NCP_CMD_BLE_OTHER 0x00600000
NCP Bluetooth LE subclass type for other command
#define NCP_CMD_BLE_EVENT 0x00f00000
NCP Bluetooth LE subclass type for event
#define NCP_BLE_MTU 1024
The max size of the NCP Bluetooth LE max transmission unit
#define NCP_CMD_BLE_INVALID_CMD (NCP_CMD_BLE | NCP_CMD_BLE_CORE | NCP_MSG_TYPE_CMD | 0x0000000a)
NCP Command/Response definitions Bluetooth LE invalid command ID
#define NCP_RSP_BLE_CORE_SUPPORT_CMD (NCP_CMD_BLE | NCP_CMD_BLE_CORE | NCP_MSG_TYPE_RESP | 0x00000001)
Bluetooth LE Core support command response ID
#define NCP_CMD_BLE_GAP_SET_DATA_LEN (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x00000020)
Bluetooth LE GAP set data length command ID
#define NCP_RSP_BLE_GAP_SET_DATA_LEN (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x00000020)
Bluetooth LE GAP set data length command response ID
#define NCP_CMD_BLE_GAP_SET_PHY (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000001f)
Bluetooth LE GAP set phy command ID
#define NCP_RSP_BLE_GAP_SET_PHY (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000001f)
Bluetooth LE GAP set phy command response ID
#define NCP_CMD_BLE_GAP_SET_ADV_DATA (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000001e)
Bluetooth LE GAP set advertising data command ID
#define NCP_RSP_BLE_GAP_SET_ADV_DATA (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000001e)
Bluetooth LE GAP set advertising data command response ID
#define NCP_CMD_BLE_GAP_SET_SCAN_PARAM (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000001d)
Bluetooth LE GAP set scan parameter command ID
#define NCP_RSP_BLE_GAP_SET_SCAN_PARAM (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000001d)
Bluetooth LE GAP set scan parameter command response ID
#define NCP_CMD_BLE_GAP_START_ADV (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000000a)
Bluetooth LE GAP start advertising command ID
#define NCP_RSP_BLE_GAP_START_ADV (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000000a)
Bluetooth LE GAP start advertising command response ID
#define NCP_CMD_BLE_GAP_STOP_ADV (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000000b)
Bluetooth LE GAP stop advertising command ID
#define NCP_RSP_BLE_GAP_STOP_ADV (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000000b)
Bluetooth LE GAP stop advertising command response ID
#define NCP_CMD_BLE_GAP_START_SCAN (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000000c)
Bluetooth LE GAP start scan command ID
#define NCP_RSP_BLE_GAP_START_SCAN (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000000c)
Bluetooth LE GAP start scan command response ID
#define NCP_CMD_BLE_GAP_STOP_SCAN (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000000d)
Bluetooth LE GAP stop scan command ID
#define NCP_RSP_BLE_GAP_STOP_SCAN (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000000d)
Bluetooth LE GAP start scan command response ID
#define NCP_CMD_BLE_GAP_CONNECT (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000000e)
Bluetooth LE GAP connect command ID
#define NCP_RSP_BLE_GAP_CONNECT (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000000e)
Bluetooth LE GAP connect command response ID
#define NCP_CMD_BLE_GAP_DISCONNECT (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000000f)
Bluetooth LE GAP disconnect command ID
#define NCP_RSP_BLE_GAP_DISCONNECT (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000000f)
Bluetooth LE GAP connect command response ID
#define NCP_CMD_BLE_GAP_CONN_PARAM_UPDATE (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x00000016)
Bluetooth LE GAP connection parameter update command ID
#define NCP_RSP_BLE_GAP_CONN_PARAM_UPDATE (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x00000016)
Bluetooth LE GAP connection parameter update command response ID
#define NCP_CMD_BLE_GAP_SET_FILTER_LIST (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x0000001c)
Bluetooth LE GAP set filter list command ID
#define NCP_RSP_BLE_GAP_SET_FILTER_LIST (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x0000001c)
Bluetooth LE GAP set filter list command response ID
#define NCP_CMD_BLE_GAP_PAIR (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_CMD | 0x00000011)
Bluetooth LE GAP pair command ID
#define NCP_RSP_BLE_GAP_PAIR (NCP_CMD_BLE | NCP_CMD_BLE_GAP | NCP_MSG_TYPE_RESP | 0x00000011)
Bluetooth LE GAP pair command response ID
#define NCP_CMD_BLE_HOST_SERVICE_ADD (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | 0x00000002)
Bluetooth LE gatt add host service attribute command ID
#define NCP_RSP_BLE_HOST_SERVICE_ADD (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | 0x00000002)
Bluetooth LE gatt add host service attribute command response ID
#define NCP_CMD_BLE_HOST_SERVICE_DISC (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | 0x00000003)
Bluetooth LE gatt discovery primary service/characteristic/descriptor command ID
#define NCP_RSP_BLE_HOST_SERVICE_DISC (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | 0x00000003)
Bluetooth LE gatt discovery primary service/characteristic/descriptor command response ID
#define NCP_CMD_BLE_GATT_SET_VALUE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | 0x00000006)
Bluetooth LE gatt set characteristic/descriptor value command ID
#define NCP_RSP_BLE_GATT_SET_VALUE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | 0x00000006)
Bluetooth LE gatt set characteristic/descriptor value command response ID
#define NCP_CMD_BLE_GATT_START_SERVICE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | 0x00000007)
Bluetooth LE gatt start service command ID
#define NCP_RSP_BLE_GATT_START_SERVICE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | 0x00000007)
Bluetooth LE gatt start service command response ID
#define NCP_CMD_BLE_GATT_DISC_PRIM (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | GATT_DISC_PRIM_UUID)
Bluetooth LE gatt discovery primary service command ID
#define NCP_RSP_BLE_GATT_DISC_PRIM (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | GATT_DISC_PRIM_UUID)
Bluetooth LE gatt discovery primary service command response ID
#define NCP_CMD_BLE_GATT_DISC_CHRC (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | GATT_DISC_CHRC_UUID)
Bluetooth LE gatt discovery characteristic command ID
#define NCP_RSP_BLE_GATT_DISC_CHRC (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | GATT_DISC_CHRC_UUID)
Bluetooth LE gatt discovery characteristic command response ID
#define NCP_CMD_BLE_GATT_READ (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | 0x00000011)
Bluetooth LE gatt read characteristic/descriptor command ID
#define NCP_RSP_BLE_GATT_READ (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | 0x00000011)
Bluetooth LE gatt read characteristic/descriptor command response ID
#define NCP_CMD_BLE_GATT_CFG_NOTIFY (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | GATT_CFG_NOTIFY)
Bluetooth LE gatt config service notify characteristic value command ID
#define NCP_RSP_BLE_GATT_CFG_NOTIFY (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | GATT_CFG_NOTIFY)
Bluetooth LE gatt config service notify characteristic value command response ID
#define NCP_CMD_BLE_GATT_CFG_INDICATE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | GATT_CFG_INDICATE)
Bluetooth LE gatt config service indicate characteristic value command ID
#define NCP_RSP_BLE_GATT_CFG_INDICATE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | GATT_CFG_INDICATE)
Bluetooth LE gatt config service indicate characteristic value command response ID
#define NCP_CMD_BLE_GATT_WRITE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | GATT_WRITE)
Bluetooth LE gatt write characteristic/descriptor command ID
#define NCP_RSP_BLE_GATT_WRITE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | GATT_WRITE)
Bluetooth LE gatt write characteristic/descriptor command response ID
#define NCP_CMD_BLE_GATT_REGISTER_SERVICE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | 0x00000020)
Bluetooth LE gatt register service command ID
#define NCP_RSP_BLE_GATT_REGISTER_SERVICE (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | 0x00000020)
Bluetooth LE gatt register service command response ID
#define NCP_CMD_BLE_GATT_DESC_CHRC (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_CMD | GATT_DISC_DESC_UUID)
Bluetooth LE gatt discovery descriptor command ID
#define NCP_RSP_BLE_GATT_DESC_CHRC (NCP_CMD_BLE | NCP_CMD_BLE_GATT | NCP_MSG_TYPE_RESP | GATT_DISC_DESC_UUID)
Bluetooth LE gatt discovery descriptor command response ID
#define NCP_CMD_BLE_L2CAP_CONNECT (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_CMD | 0x00000002)
Bluetooth LE l2cap connect command ID
#define NCP_RSP_BLE_L2CAP_CONNECT (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_RESP | 0x00000002)
Bluetooth LE l2cap connect command response ID
#define NCP_CMD_BLE_L2CAP_DISCONNECT (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_CMD | 0x00000003)
Bluetooth LE l2cap disconnect command ID
#define NCP_RSP_BLE_L2CAP_DISCONNECT (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_RESP | 0x00000003)
Bluetooth LE l2cap disconnect command response ID
#define NCP_CMD_BLE_L2CAP_SEND (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_CMD | 0x00000004)
Bluetooth LE l2cap send command ID
#define NCP_RSP_BLE_L2CAP_SEND (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_RESP | 0x00000004)
Bluetooth LE l2cap send command response ID
#define NCP_CMD_BLE_L2CAP_REGISTER (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_CMD | 0x0000000a)
Bluetooth LE l2cap register command ID
#define NCP_RSP_BLE_L2CAP_REGISTER (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_RESP | 0x0000000a)
Bluetooth LE l2cap register command response ID
#define NCP_CMD_BLE_L2CAP_METRICS (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_CMD | 0x0000000b)
Bluetooth LE l2cap metrics command ID
#define NCP_RSP_BLE_L2CAP_METRICS (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_RESP | 0x0000000b)
Bluetooth LE l2cap metrics command response ID
#define NCP_CMD_BLE_L2CAP_RECEIVE (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_CMD | 0x0000000c)
Bluetooth LE l2cap receive command ID
#define NCP_RSP_BLE_L2CAP_RECEIVE (NCP_CMD_BLE | NCP_CMD_BLE_L2CAP | NCP_MSG_TYPE_RESP | 0x0000000c)
Bluetooth LE l2cap receive command response ID
#define NCP_CMD_BLE_VENDOR_POWER_MODE (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_CMD | 0x00000001)
Bluetooth LE Vendor enable/disable power mode command ID
#define NCP_RSP_BLE_VENDOR_POWER_MODE (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_RESP | 0x00000001)
Bluetooth LE Vendor enable/disable power mode command response ID
#define NCP_CMD_BLE_VENDOR_SET_UART_BR (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_CMD | 0x00000002)
Bluetooth LE Vendor set uart baud rate command ID
#define NCP_RSP_BLE_VENDOR_SET_UART_BR (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_RESP | 0x00000002)
Bluetooth LE Vendor set uart baud rate command response ID
#define NCP_CMD_BLE_VENDOR_SET_DEVICE_ADDR (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_CMD | 0x00000003)
Bluetooth LE Vendor set uart device address command ID
#define NCP_RSP_BLE_VENDOR_SET_DEVICE_ADDR (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_RESP | 0x00000003)
Bluetooth LE Vendor set uart device address command response ID
#define NCP_CMD_BLE_VENDOR_SET_DEVICE_NAME (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_CMD | 0x00000004)
Bluetooth LE Vendor set device name command ID
#define NCP_RSP_BLE_VENDOR_SET_DEVICE_NAME (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_RESP | 0x00000004)
Bluetooth LE Vendor set device name command response ID
#define NCP_CMD_BLE_VENDOR_CFG_MULTI_ADV (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_CMD | 0x00000005)
Bluetooth LE Vendor config multi-advertising command ID
#define NCP_RSP_BLE_VENDOR_CFG_MULTI_ADV (NCP_CMD_BLE | NCP_CMD_BLE_VENDOR | NCP_MSG_TYPE_RESP | 0x00000005)
Bluetooth LE Vendor config multi-advertising command response ID
#define NCP_EVENT_IUT_READY (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | CORE_EV_IUT_READY)
Bluetooth LE device ready event
#define NCP_EVENT_ADV_REPORT (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_DEVICE_FOUND)
Bluetooth LE advertising report event
#define NCP_EVENT_DEVICE_CONNECTED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_DEVICE_CONNECTED)
Bluetooth LE connection complete event
#define NCP_EVENT_DEVICE_DISCONNECT (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_DEVICE_DISCONNECTED)
Bluetooth LE disconnection complete event
#define NCP_EVENT_PASSKEY_DISPLAY (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_PASSKEY_DISPLAY)
Bluetooth LE passkey display event
#define NCP_EVENT_IDENTITY_RESOLVED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_IDENTITY_RESOLVED)
Bluetooth LE remote identity address resolved event
#define NCP_EVENT_CONN_PARAM_UPDATE (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_CONN_PARAM_UPDATE)
Bluetooth LE connection parameter update event
#define NCP_EVENT_SEC_LEVEL_CHANGED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_SEC_LEVEL_CHANGED)
Bluetooth LE security level changed event
#define NCP_EVENT_PAIRING_FAILED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_PAIRING_FAILED)
Bluetooth LE paring failed event
#define NCP_EVENT_BOND_LOST (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_BOND_LOST)
Bluetooth LE bond lost event
#define NCP_EVENT_PHY_UPDATED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_PHY_UPDATED)
Bluetooth LE phy update event
#define NCP_EVENT_DATA_LEN_UPDATED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GAP_EV_DATA_LEN_UPDATED)
Bluetooth LE data length update event
#define NCP_EVENT_GATT_NOTIFICATION (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GATT_EV_NOTIFICATION | 0x200)
Bluetooth LE gatt notification received event
#define NCP_EVENT_ATTR_VALUE_CHANGED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GATT_EV_ATTR_VALUE_CHANGED | 0x200)
Bluetooth LE gatt attribute value changed event
#define NCP_EVENT_GATT_CCC_CFG_CHANGED (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GATT_EV_CCC_CFG_CHANGED | 0x200)
Bluetooth LE gatt client characteristic configuration changed event
#define NCP_EVENT_GATT_SUBSCRIPTION (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | GATT_EV_SUBSCRIPTION | 0x200)
Bluetooth LE gatt client subscription event
#define NCP_EVENT_GATT_DISC_PRIM (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | 0x19 | 0x200)
Bluetooth LE gatt discover primary service event
#define NCP_EVENT_GATT_DISC_CHRC (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | 0x20 | 0x200)
Bluetooth LE gatt discover characteristic event
#define NCP_EVENT_GATT_DISC_DESC (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | 0x21 | 0x200)
Bluetooth LE gatt discover descriptor event
#define NCP_EVENT_L2CAP_CONNECT (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | L2CAP_EV_CONNECT | 0x300)
Bluetooth LE l2cap connect event
#define NCP_EVENT_L2CAP_DISCONNECT (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | L2CAP_EV_DISCONNECT | 0x300)
Bluetooth LE l2cap disconnect event
#define NCP_EVENT_L2CAP_RECEIVE (NCP_CMD_BLE | NCP_CMD_BLE_EVENT | NCP_MSG_TYPE_EVENT | L2CAP_EV_RECEIVE | 0x300)
Bluetooth LE l2cap receive event
#define NCP_CMD_GATT_ADD_SERVICE_TLV 0x0001
NCP Bluetooth LE TLV type NCP GATT add service tlv type
#define NCP_CMD_GATT_ADD_CHRC_TLV 0x0002
NCP GATT add characteristic tlv type
#define NCP_CMD_GATT_ADD_DESC_TLV 0x0003
NCP GATT add descriptor tlv type
#define NCP_CMD_GATT_START_SVC_TLV 0x0004
NCP GATT start service tlv type
#define NCP_CMD_GATT_DISC_PRIM_TLV 0x0005
NCP GATT discover primary service tlv type
#define NCP_CMD_GATT_DISC_CHRC_TLV 0x0006
NCP GATT discover characteristic tlv type
#define NCP_CMD_GATT_DISC_DESC_TLV 0x0007
NCP GATT discover descriptor tlv type
#define BT_UUID_SIZE_16 2
Size in octets of a 16-bit UUID
#define BT_UUID_SIZE_128 16
Size in octets of a 128-bit UUID
#define BT_HCI_VD_SET_BD_ADDRESS BT_OP(BT_OGF_VS, 0x0022)
Bluetooth LE Vendor set board address hci opcode
#define BT_HCI_VD_LOW_POWER_MODE BT_OP(BT_OGF_VS, 0x0023)
NCP Bluetooth LE low power mode opcode
#define BT_HCI_VD_MULTI_ADV_CMD BT_OP(BT_OGF_VS, 0x0154)
NCP Bluetooth LE multi advertising opcode
#define CORE_RESET_BOARD 0x06
NCP Bluetooth LE Core reset board command ID
#define GAP_READ_SUPPORTED_COMMANDS 0x01
NCP Bluetooth LE GAP read support command ID
#define GAP_READ_CONTROLLER_INDEX_LIST 0x02
NCP Bluetooth LE GAP read controller index list command ID
#define GAP_SETTINGS_POWERED 0
NCP Bluetooth LE GAP set power ID
#define GAP_SETTINGS_CONNECTABLE 1
NCP Bluetooth LE GAP connect ID
#define GAP_SETTINGS_FAST_CONNECTABLE 2
NCP Bluetooth LE GAP fast connect ID
#define GAP_SETTINGS_DISCOVERABLE 3
NCP Bluetooth LE GAP discover ID
#define GAP_SETTINGS_BONDABLE 4
NCP Bluetooth LE GAP bond ID
#define GAP_SETTINGS_LINK_SEC_3 5
NCP Bluetooth LE GAP set security ID
#define GAP_SETTINGS_SSP 6
NCP Bluetooth LE GAP set SSP ID
#define GAP_SETTINGS_BREDR 7
NCP Bluetooth LE GAP set bredr ID
#define GAP_SETTINGS_HS 8
NCP Bluetooth LE GAP set hs ID
#define GAP_SETTINGS_LE 9
NCP Bluetooth LE GAP set le ID
#define GAP_SETTINGS_ADVERTISING 10
NCP Bluetooth LE GAP set advertising ID
#define GAP_SETTINGS_SC 11
NCP Bluetooth LE GAP set SC ID
#define GAP_SETTINGS_DEBUG_KEYS 12
NCP Bluetooth LE GAP set debug key ID
#define GAP_SETTINGS_PRIVACY 13
NCP Bluetooth LE GAP set privacy ID
#define GAP_SETTINGS_CONTROLLER_CONFIG 14
NCP Bluetooth LE GAP set controller config ID
#define GAP_SETTINGS_STATIC_ADDRESS 15
NCP Bluetooth LE GAP set static address ID
#define GAP_NON_DISCOVERABLE 0x00
NCP Bluetooth LE GAP non discoverable ID
#define GAP_GENERAL_DISCOVERABLE 0x01
NCP Bluetooth LE GAP general discoverable ID
#define GAP_LIMITED_DISCOVERABLE 0x02
NCP Bluetooth LE GAP limit discoverable ID
#define GAP_SET_DISCOVERABLE 0x08
NCP Bluetooth LE GAP discoverable ID
#define GAP_SET_BONDABLE 0x09
NCP Bluetooth LE GAP set bondable ID
#define GAP_START_ADVERTISING 0x0a
NCP Bluetooth LE GAP set advertising ID
#define GAP_STOP_ADVERTISING 0x0b
NCP Bluetooth LE GAP stop advertising ID
#define GAP_DISCOVERY_FLAG_LE 0x01
NCP Bluetooth LE GAP discovery le ID
#define GAP_DISCOVERY_FLAG_BREDR 0x02
NCP Bluetooth LE GAP discovery bredr ID
#define GAP_DISCOVERY_FLAG_LIMITED 0x04
NCP Bluetooth LE GAP discovery limited ID
#define GAP_DISCOVERY_FLAG_LE_ACTIVE_SCAN 0x08
NCP Bluetooth LE GAP active scan ID
#define GAP_DISCOVERY_FLAG_LE_OBSERVE 0x10
NCP Bluetooth LE GAP observe ID
#define GAP_DISCOVERY_FLAG_OWN_ID_ADDR 0x20
NCP Bluetooth LE GAP discovery own address ID
#define GAP_START_DISCOVERY 0x0c
NCP Bluetooth LE GAP start discovery ID
#define GAP_STOP_DISCOVERY 0x0d
NCP Bluetooth LE GAP stop discovery ID
#define GAP_CONNECT 0x0e
NCP Bluetooth LE GAP connect ID
#define GAP_DISCONNECT 0x0f
NCP Bluetooth LE GAP disconnect ID
#define GAP_IO_CAP_DISPLAY_ONLY 0
NCP Bluetooth LE GAP IO capability display only ID
#define GAP_IO_CAP_DISPLAY_YESNO 1
NCP Bluetooth LE GAP IO capability display option ID
#define GAP_IO_CAP_KEYBOARD_ONLY 2
NCP Bluetooth LE GAP IO capability keyboard only ID
#define GAP_IO_CAP_NO_INPUT_OUTPUT 3
NCP Bluetooth LE GAP IO capability no input ouput ID
#define GAP_IO_CAP_KEYBOARD_DISPLAY 4
NCP Bluetooth LE GAP IO capability keyboard&display ID
#define GAP_SET_IO_CAP 0x10
NCP Bluetooth LE GAP IO capability ID
#define GAP_PAIR 0x11
NCP Bluetooth LE GAP pair ID
#define GAP_UNPAIR 0x12
NCP Bluetooth LE GAP unpair ID
#define GAP_PASSKEY_ENTRY 0x13
NCP Bluetooth LE GAP passkey entry ID
#define GAP_PASSKEY_CONFIRM 0x14
NCP Bluetooth LE GAP passkey confirm ID
#define GAP_START_DIRECTED_ADV_HD BIT(0)
NCP Bluetooth LE start directed advertising hd
#define GAP_START_DIRECTED_ADV_OWN_ID BIT(1)
NCP Bluetooth LE start directed advertising own id
#define GAP_START_DIRECTED_ADV_PEER_RPA BIT(2)
NCP Bluetooth LE start directed advertising peer rpa
#define GAP_START_DIRECTED_ADV 0x15
NCP Bluetooth LE start directed advertising ID
#define GAP_CONN_PARAM_UPDATE 0x16
NCP Bluetooth LE GAP connection parameter update ID
#define GAP_PAIRING_CONSENT 0x17
NCP Bluetooth LE GAP pairing consent ID
#define GAP_OOB_LEGACY_SET_DATA 0x18
NCP Bluetooth LE oob legacy set data ID
#define GAP_OOB_SC_GET_LOCAL_DATA 0x19
NCP Bluetooth LE oob security get local data ID
#define GAP_OOB_SC_SET_REMOTE_DATA 0x1a
NCP Bluetooth LE oob security set remote data ID
#define GAP_SET_MITM 0x1b
NCP Bluetooth LE GAP set mitm ID
#define GAP_SET_FILTER_LIST 0x1c
NCP Bluetooth LE GAP set filter list ID
#define GAP_SET_SCAN_PARAMETER 0x1d
NCP Bluetooth LE GAP set scan parameter ID
#define GAP_SET_ADV_DATA 0x1e
NCP Bluetooth LE GAP set advertising data ID
#define GAP_EV_NEW_SETTINGS 0x80
NCP Bluetooth LE new setting event ID
#define GAP_DEVICE_FOUND_FLAG_RSSI 0x01
NCP Bluetooth LE device found flag
#define GAP_EV_DEVICE_FOUND 0x81
NCP Bluetooth LE device found event ID
#define GAP_EV_DEVICE_CONNECTED 0x82
NCP Bluetooth LE device connected event ID
#define GAP_EV_DEVICE_DISCONNECTED 0x83
NCP Bluetooth LE device disconnected event ID
#define GAP_EV_PASSKEY_DISPLAY 0x84
NCP Bluetooth LE passkey display event ID
#define GAP_EV_PASSKEY_ENTRY_REQ 0x85
NCP Bluetooth LE passkey entry request event ID
#define GAP_EV_PASSKEY_CONFIRM_REQ 0x86
NCP Bluetooth LE passkey confirm request event ID
#define GAP_EV_IDENTITY_RESOLVED 0x87
NCP Bluetooth LE identity resolved event ID
#define GAP_EV_CONN_PARAM_UPDATE 0x88
NCP Bluetooth LE connection parameter update event ID
#define GAP_SEC_LEVEL_UNAUTH_ENC 0x01
NCP Bluetooth LE GAP security level
#define GAP_EV_SEC_LEVEL_CHANGED 0x89
NCP Bluetooth LE security level changed event ID
#define GAP_EV_PAIRING_CONSENT_REQ 0x8a
NCP Bluetooth LE pairing consent request event ID
#define GAP_EV_BOND_LOST 0x8b
NCP Bluetooth LE bonding lost event ID
#define GAP_EV_PAIRING_FAILED 0x8c
NCP Bluetooth LE pairing failed event ID
#define GAP_EV_PHY_UPDATED 0x91
NCP Bluetooth LE phy update event ID
#define GAP_EV_DATA_LEN_UPDATED 0x92
NCP Bluetooth LE data length update event ID
#define L2CAP_READ_SUPPORTED_COMMANDS 0x01
NCP Bluetooth LE l2cap read support command ID
#define L2CAP_CONNECT_OPT_ECFC 0x01
NCP Bluetooth LE opt
#define L2CAP_CONNECT 0x02
NCP Bluetooth LE l2cap connection ID
#define L2CAP_DISCONNECT 0x03
NCP Bluetooth LE l2cap disconnect ID
#define L2CAP_SEND_DATA 0x04
NCP Bluetooth LE l2cap send data ID
#define L2CAP_TRANSPORT_BREDR 0x00
NCP Bluetooth LE l2cap transport type
#define L2CAP_CONNECTION_RESPONSE_SUCCESS 0x00
NCP Bluetooth LE l2cap connection response type
#define L2CAP_LISTEN 0x05
NCP Bluetooth LE l2cap listen ID
#define L2CAP_ACCEPT_CONNECTION 0x06
NCP Bluetooth LE l2cap accept connection ID
#define L2CAP_RECONFIGURE 0x07
NCP Bluetooth LE l2cap reconfigure ID
#define L2CAP_CREDITS 0x08
NCP Bluetooth LE l2cap credit ID
#define L2CAP_DISCONNECT_EATT_CHANS 0x09
NCP Bluetooth LE l2cap disconnect eatt (Enhanced ATT Bearers support) channel ID
#define L2CAP_REGISTER_PSM 0x0a
NCP Bluetooth LE l2cap register PSM (Protocol/Service Multiplexer) ID
#define L2CAP_METRICS 0x0b
NCP Bluetooth LE l2cap metrics ID
#define L2CAP_RECV 0x0c
NCP Bluetooth LE l2cap receive ID
#define L2CAP_EV_CONNECTION_REQ 0x80
NCP Bluetooth LE connection request event ID
#define L2CAP_EV_CONNECTED 0x81
NCP Bluetooth LE l2cap connect event ID
#define L2CAP_EV_DISCONNECTED 0x82
NCP Bluetooth LE l2cap disconnect event ID
#define L2CAP_EV_DATA_RECEIVED 0x83
NCP Bluetooth LE l2cap data receive event ID
#define L2CAP_EV_RECONFIGURED 0x84
NCP Bluetooth LE l2cap reconfigure event ID
#define SERVER_MAX_SERVICES 10
gatt server context
#define GATT_READ_SUPPORTED_COMMANDS 0x01
NCP Bluetooth LE gatt read support command ID
#define GATT_SERVICE_PRIMARY 0x00
NCP Bluetooth LE service type NCP Bluetooth LE primary service type
#define GATT_SERVICE_SECONDARY 0x01
NCP Bluetooth LE secondary service type
#define GATT_ADD_SERVICE 0x02
NCP Bluetooth LE gatt add service ID
#define GATT_ADD_CHARACTERISTIC 0x03
NCP Bluetooth LE gatt add characteristic ID
#define GATT_ADD_DESCRIPTOR 0x04
NCP Bluetooth LE gatt add descriptor ID
#define GATT_ADD_INCLUDED_SERVICE 0x05
NCP Bluetooth LE gatt add include service ID
#define GATT_SET_VALUE 0x06
NCP Bluetooth LE gatt set value ID
#define GATT_START_SERVER 0x07
NCP Bluetooth LE gatt start server ID
#define GATT_RESET_SERVER 0x08
NCP Bluetooth LE gatt reset server ID
#define GATT_SET_ENC_KEY_SIZE 0x09
NCP Bluetooth LE gatt set encryption key size ID
#define GATT_EXCHANGE_MTU 0x0a
NCP Bluetooth LE exchange maximum transmission unit ID
#define GATT_DISC_ALL_PRIM 0x0b
NCP Bluetooth LE discovery primary service ID
#define GATT_DISC_PRIM_UUID 0x0c
NCP Bluetooth LE discovery primary UUID ID
#define GATT_FIND_INCLUDED 0x0d
NCP Bluetooth LE gatt find included ID
#define GATT_DISC_ALL_CHRC 0x0e
NCP Bluetooth LE gatt discovery characteristic ID
#define GATT_DISC_CHRC_UUID 0x0f
NCP Bluetooth LE gatt discovery characteristic UUID ID
#define GATT_DISC_ALL_DESC 0x10
NCP Bluetooth LE gatt discovery descriptor ID
#define GATT_DISC_DESC_UUID 0x21
NCP Bluetooth LE gatt discovery descriptor UUID ID
#define GATT_READ 0x11
NCP Bluetooth LE gatt read ID
#define GATT_READ_UUID 0x12
NCP Bluetooth LE gatt read UUID ID
#define GATT_READ_LONG 0x13
NCP Bluetooth LE gatt read long ID
#define GATT_READ_MULTIPLE 0x14
NCP Bluetooth LE gatt read multiple ID
#define GATT_WRITE_WITHOUT_RSP 0x15
NCP Bluetooth LE gatt write without response ID
#define GATT_SIGNED_WRITE_WITHOUT_RSP 0x16
NCP Bluetooth LE gatt signed write without response ID
#define GATT_WRITE 0x17
NCP Bluetooth LE gatt write ID
#define GATT_WRITE_LONG 0x18
NCP Bluetooth LE gatt write long ID
#define GATT_RELIABLE_WRITE 0x19
NCP Bluetooth LE gatt write reliable ID
#define GATT_CFG_NOTIFY 0x1a
NCP Bluetooth LE gatt config
#define GATT_GET_ATTRIBUTES 0x1c
NCP Bluetooth LE gatt get attribute ID
#define GATT_GET_ATTRIBUTE_VALUE 0x1d
NCP Bluetooth LE gatt get attribute value ID
#define GATT_CHANGE_DB 0x1e
NCP Bluetooth LE gatt change DB ID
#define GATT_EATT_CONNECT 0x1f
NCP Bluetooth LE gatt eatt connect ID
#define GATT_READ_MULTIPLE_VAR 0x20
NCP Bluetooth LE gatt read multiple variable ID
#define GATT_NOTIFY_MULTIPLE 0x21
NCP Bluetooth LE gatt notify multiple ID
#define GATT_NCP_BLE_ADD_SERVICE 0x22
NCP Bluetooth LE add service ID
#define GATT_EV_NOTIFICATION 0x80
NCP Bluetooth LE gatt notification event
#define GATT_EV_ATTR_VALUE_CHANGED 0x81
NCP Bluetooth LE gatt attribute value change event
#define GATT_EV_CCC_CFG_CHANGED 0x82
NCP Bluetooth LE gatt client characteristic configuration declaration event ID
#define GATT_EV_SUBSCRIPTION 0x85
NCP Bluetooth LE gatt subscription event ID
#define L2CAP_EV_CONNECT 0x81
NCP Bluetooth LE l2cap connect event ID
#define L2CAP_EV_DISCONNECT 0x82
NCP Bluetooth LE l2cap disconnect event ID
#define L2CAP_EV_RECEIVE 0x83
NCP Bluetooth LE l2cap receive event ID
#define MAX_ATTRIBUTE_VALUE_LEN 256
The maximum length of the attribute to notify
ncp_cmd_wifi.h File Reference
NCP Wi-Fi command/response definitions.
Macro Documentation
#define NCP_CMD_WLAN_STA 0x00000000
NCP Wi-Fi subclass types subclass type for Wi-Fi station commands, such as scan, connect, version, set mac and so on.
#define NCP_CMD_WLAN_BASIC 0x00100000
subclass type for basic command such as reset, reset UAP provisioning and start UAP provisioning.
#define NCP_CMD_WLAN_REGULATORY 0x00200000
subclass type for regulatory commands, such as set RF TX, RX antenna mode and RF band.
#define NCP_CMD_WLAN_POWERMGMT 0x00300000
subclass type for power management commands, such as enable/disable deep sleep power save mode.
#define NCP_CMD_WLAN_DEBUG 0x00400000
subclass type for debug commands.
#define NCP_CMD_WLAN_OTHER 0x00500000
subclass type for TWT (Target wake-up time), 802.11ax and region code commands.
#define NCP_CMD_WLAN_MEMORY 0x00600000
subclass type for memory commands.
#define NCP_CMD_WLAN_NETWORK 0x00700000
subclass type for network commands, such as add, start, stop and remove network command.
#define NCP_CMD_WLAN_SOCKET 0x00900000
subclass type for socket command, such as socket open, connect, close and send.
#define NCP_CMD_WLAN_UAP 0x00a00000
subclass type for UAP commands
#define NCP_CMD_WLAN_HTTP 0x00b00000
subclass type for http commands
#define NCP_CMD_WLAN_ASYNC_EVENT 0x00f00000
subclass type for async events.
#define NCP_WLAN_PASSWORD_MAX_LENGTH 255
Maximum length of password string
#define IEEEtypes_MAC_ADDRESS_SIZE 6
MAC address length.
#define MLAN_MAX_DRIVER_VER_STR_LEN 16
Maximum length of Wi-Fi driver version string.
#define MLAN_IPV6_ADDR_LEN 4
System’s IPv6 address.
#define IPV6_MAX_ADDR_TYPE_STR_LEN 16
Maximum length of IPV6 address type string.
#define IPV6_MAX_ADDR_STATE_STR_LEN 32
Maximum address state string of IPv6 address.
#define NCP_WLAN_KNOWN_NETWORKS 5
Maximum size of the network list
#define NCP_MDNS_LABEL_MAX_LEN 63
MDNS label maximum length
#define NCP_CMD_WLAN_STA_SCAN (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-scan */
Wi-Fi STA scan command ID
#define NCP_RSP_WLAN_STA_SCAN (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi STA scan command response ID
#define NCP_CMD_WLAN_STA_CONNECT (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-connect */
Wi-Fi STA connect command ID
#define NCP_RSP_WLAN_STA_CONNECT (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP |0x00000002)
Wi-Fi STA connect command response ID
#define NCP_CMD_WLAN_STA_DISCONNECT (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-disconnect */
Wi-Fi STA disconnect command ID
#define NCP_RSP_WLAN_STA_DISCONNECT (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi STA disconnect command response ID
#define NCP_CMD_WLAN_STA_VERSION (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-version */
Wi-Fi STA version command ID
#define NCP_RSP_WLAN_STA_VERSION (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi STA version command response ID
#define NCP_CMD_WLAN_STA_SET_MAC (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-set-mac */
Wi-Fi STA set MAC address command ID
#define NCP_RSP_WLAN_STA_SET_MAC (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi STA set MAC address command response ID
#define NCP_CMD_WLAN_STA_GET_MAC (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-get-mac */
Wi-Fi STA get MAC address command ID
#define NCP_RSP_WLAN_STA_GET_MAC (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi STA get MAC address command response ID
#define NCP_CMD_WLAN_STA_CONNECT_STAT (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000007) /* wlan-stat */
Wi-Fi STA connect state command ID
#define NCP_RSP_WLAN_STA_CONNECT_STAT (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000007)
Wi-Fi STA connect state command response ID
#define NCP_CMD_WLAN_STA_ROAMING (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-roaming */
Wi-Fi STA roaming command ID
#define NCP_RSP_WLAN_STA_ROAMING (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi STA roaming command response ID
#define NCP_CMD_WLAN_STA_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000009) /* wlan-set-antenna / wlan-get-antenna*/
Wi-Fi STA set/get antenna command ID
#define NCP_RSP_WLAN_STA_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000009)
Wi-Fi STA set/get antenna command response ID
#define NCP_CMD_WLAN_STA_SIGNAL (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000012) /* wlan-get-signal */
Wi-Fi STA signal command ID
#define NCP_RSP_WLAN_STA_SIGNAL (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000012)
Wi-Fi STA signal command response ID
#define NCP_CMD_WLAN_STA_CSI (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000020) /* wlan-csi */
Wi-Fi STA csi command ID
#define NCP_RSP_WLAN_STA_CSI (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000020)
Wi-Fi STA csi command response ID
#define NCP_CMD_WLAN_STA_11K_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000021) /* wlan-11k-enable */
Wi-Fi STA enable 11K command ID
#define NCP_RSP_WLAN_STA_11K_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000021)
Wi-Fi STA enable 11K command response ID
#define NCP_CMD_WLAN_STA_NEIGHBOR_REQ (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000022) /* wlan-11k-neighbor-req */
Wi-Fi STA neighbor request command ID
#define NCP_RSP_WLAN_STA_NEIGHBOR_REQ (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000022)
Wi-Fi STA neighbor request command response ID
#define NCP_CMD_WLAN_MBO_ENABLE (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000023) /*wlan-mbo-enable*/
Wi-Fi STA MBO enable command ID
#define NCP_RSP_WLAN_MBO_ENABLE (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000023)
Wi-Fi STA MBO enable command response ID
#define NCP_CMD_WLAN_MBO_NONPREFER_CH (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000024) /*wlan-mbo-nonprefer-ch*/
Wi-Fi STA MBO non prefer channel command ID
#define NCP_RSP_WLAN_MBO_NONPREFER_CH (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000024)
Wi-Fi STA MBO non prefer channel command response ID
#define NCP_CMD_WLAN_MBO_SET_CELL_CAPA (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000025) /*wlan-mbo-set-cell-capa*/
Wi-Fi STA MBO set cell capacity command ID
#define NCP_RSP_WLAN_MBO_SET_CELL_CAPA (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000025)
Wi-Fi STA MBO set cell capacity command response ID
#define NCP_CMD_WLAN_MBO_SET_OCE (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000026) /*wlan-mbo-set-oce*/
Wi-Fi STA MBO set OCE command ID
#define NCP_RSP_WLAN_MBO_SET_OCE (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000026)
Wi-Fi STA MBO set OCE command response ID
#define NCP_CMD_WLAN_STA_WPS_PBC (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000031) /* wlan-start-wps-pbc */
Wi-Fi STA start WPS PBC (push button configuration) command ID
#define NCP_RSP_WLAN_STA_WPS_PBC (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000031)
Wi-Fi STA start WPS PBC command response ID
#define NCP_CMD_WLAN_STA_GEN_WPS_PIN (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000032) /* wlan-generate-wps-pin */
Wi-Fi STA generate WPS pin code command ID
#define NCP_RSP_WLAN_STA_GEN_WPS_PIN (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000032)
Wi-Fi STA generate WPS pin code command response ID
#define NCP_CMD_WLAN_STA_WPS_PIN (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD |0x00000033) /* wlan-start-wps-pin */
Wi-Fi STA start WPS pin command ID
#define NCP_RSP_WLAN_STA_WPS_PIN (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000033)
Wi-Fi STA start WPS pin command response ID
#define NCP_CMD_WLAN_GET_CURRENT_NETWORK (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000034)
Wi-Fi STA get current network command ID
#define NCP_RSP_WLAN_GET_CURRENT_NETWORK (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000034)
Wi-Fi STA get current network command response ID
#define NCP_CMD_WLAN_NETWORKS_REMOVE_ALL (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_CMD | 0x00000035)
Wi-Fi STA remove all network command ID
#define NCP_RSP_WLAN_NETWORKS_REMOVE_ALL (NCP_CMD_WLAN | NCP_CMD_WLAN_STA | NCP_MSG_TYPE_RESP | 0x00000035)
Wi-Fi STA remove all network command response ID
#define NCP_CMD_WLAN_BASIC_WLAN_RESET (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-reset */
WLAN Basic command/response Wi-Fi reset command ID
#define NCP_RSP_WLAN_BASIC_WLAN_RESET (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi reset command response ID
#define NCP_CMD_WLAN_BASIC_WLAN_UAP_PROV_START (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-uap-prov-start */
Wi-Fi start UAP provisioning command ID
#define NCP_RSP_WLAN_BASIC_WLAN_UAP_PROV_START (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi start UAP provisioning command response ID
#define NCP_CMD_WLAN_BASIC_WLAN_UAP_PROV_RESET (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-uap-prov-reset */
Wi-Fi reset UAP provisioning command ID
#define NCP_RSP_WLAN_BASIC_WLAN_UAP_PROV_RESET (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi reset UAP provisioning command response ID
#define NCP_CMD_WLAN_BASIC_WLAN_UAP_PROV_SET_UAPCFG (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-uap-prov-set-uapcfg */
Wi-Fi UAP provisioning config command ID
#define NCP_RSP_WLAN_BASIC_WLAN_UAP_PROV_SET_UAPCFG (NCP_CMD_WLAN | NCP_CMD_WLAN_BASIC | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi UAP provisioning config command response ID
#define NCP_CMD_WLAN_HTTP_CON (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-http-connect */
WLAN Http command and response Wi-Fi http connect command ID
#define NCP_RSP_WLAN_HTTP_CON (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi http connect command response ID
#define NCP_CMD_WLAN_HTTP_DISCON (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-http-disconnect */
Wi-Fi http disconnect command ID
#define NCP_RSP_WLAN_HTTP_DISCON (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi http disconnect command response ID
#define NCP_CMD_WLAN_HTTP_REQ (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-http-req */
Wi-Fi http request command ID
#define NCP_RSP_WLAN_HTTP_REQ (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi http request command response ID
#define NCP_CMD_WLAN_HTTP_RECV (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-http-recv */
Wi-Fi http receive command ID
#define NCP_RSP_WLAN_HTTP_RECV (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi http request command response ID
#define NCP_CMD_WLAN_HTTP_SETH (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-http-seth */
Wi-Fi http set header command ID
#define NCP_RSP_WLAN_HTTP_SETH (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi http set header command response ID
#define NCP_CMD_WLAN_HTTP_UNSETH (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-http-unseth */
Wi-Fi http unset header command ID
#define NCP_RSP_WLAN_HTTP_UNSETH (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi http unset header command response ID
#define NCP_CMD_WLAN_WEBSOCKET_UPG (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000007) /* wlan-websocket-upg */
Wi-Fi web socket update command ID
#define NCP_RSP_WLAN_WEBSOCKET_UPG (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000007)
Wi-Fi web socket update command response ID
#define NCP_CMD_WLAN_WEBSOCKET_SEND (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-websocket-send */
Wi-Fi web socket send command ID
#define NCP_RSP_WLAN_WEBSOCKET_SEND (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi web socket send command response ID
#define NCP_CMD_WLAN_WEBSOCKET_RECV (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_CMD | 0x00000009) /* wlan-websocket-recv */
Wi-Fi web socket receive command ID
#define NCP_RSP_WLAN_WEBSOCKET_RECV (NCP_CMD_WLAN | NCP_CMD_WLAN_HTTP | NCP_MSG_TYPE_RESP | 0x00000009)
Wi-Fi web socket receive command response ID
#define NCP_CMD_WLAN_SOCKET_OPEN (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-socket-open */
WLAN Socket command Wi-Fi socket open command ID
#define NCP_RSP_WLAN_SOCKET_OPEN (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi socket open command response ID
#define NCP_CMD_WLAN_SOCKET_CON (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-socket-connect */
Wi-Fi socket connect command ID
#define NCP_RSP_WLAN_SOCKET_CON (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi socket connect command response ID
#define NCP_CMD_WLAN_SOCKET_RECV (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-socket-receive */
Wi-Fi socket receive command ID
#define NCP_RSP_WLAN_SOCKET_RECV (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi socket receive command response ID
#define NCP_CMD_WLAN_SOCKET_SEND (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-socket-send */
Wi-Fi socket send command ID
#define NCP_RSP_WLAN_SOCKET_SEND (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi socket send command response ID
#define NCP_CMD_WLAN_SOCKET_SENDTO (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-socket-sendto */
Wi-Fi socket sendto command ID
#define NCP_RSP_WLAN_SOCKET_SENDTO (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi socket sendto command response ID
#define NCP_CMD_WLAN_SOCKET_BIND (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-socket-bind */
Wi-Fi socket bind command ID
#define NCP_RSP_WLAN_SOCKET_BIND (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi socket bind command response ID
#define NCP_CMD_WLAN_SOCKET_LISTEN (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000007) /* wlan-socket-listen */
Wi-Fi socket listen command ID
#define NCP_RSP_WLAN_SOCKET_LISTEN (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000007)
Wi-Fi socket listen command response ID
#define NCP_CMD_WLAN_SOCKET_ACCEPT (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-socket-accept */
Wi-Fi socket accept command ID
#define NCP_RSP_WLAN_SOCKET_ACCEPT (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi socket accept command response ID
#define NCP_CMD_WLAN_SOCKET_CLOSE (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x00000009) /* wlan-socket-close */
Wi-Fi socket close command ID
#define NCP_RSP_WLAN_SOCKET_CLOSE (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x00000009)
Wi-Fi socket close command response ID
#define NCP_CMD_WLAN_SOCKET_RECVFROM (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_CMD | 0x0000000a) /* wlan-socket-recvfrom */
Wi-Fi socket receive from command ID
#define NCP_RSP_WLAN_SOCKET_RECVFROM (NCP_CMD_WLAN | NCP_CMD_WLAN_SOCKET | NCP_MSG_TYPE_RESP | 0x0000000a)
Wi-Fi socket receive from command response ID
#define NCP_CMD_WLAN_DEBUG_REGISTER_ACCESS (NCP_CMD_WLAN | NCP_CMD_WLAN_DEBUG | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-reg-access */
Wi-Fi Debug command/response Wi-Fi register access command ID
#define NCP_RSP_WLAN_DEBUG_REGISTER_ACCESS (NCP_CMD_WLAN | NCP_CMD_WLAN_DEBUG | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi register access command response ID
#define NCP_CMD_WLAN_MEMORY_HEAP_SIZE (NCP_CMD_WLAN | NCP_CMD_WLAN_MEMORY | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-mem-stat */
WLAN Memory command Wi-Fi memory state command ID
#define NCP_RSP_WLAN_MEMORY_HEAP_SIZE (NCP_CMD_WLAN | NCP_CMD_WLAN_MEMORY | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi memory state command response ID
#define NCP_CMD_WLAN_NETWORK_INFO (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-info */
WLAN Network command/response Wi-Fi network information command ID
#define NCP_RSP_WLAN_NETWORK_INFO (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi network information command response ID
#define NCP_CMD_WLAN_NETWORK_MONITOR (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-monitor */
Wi-Fi network monitor command ID
#define NCP_RSP_WLAN_NETWORK_MONITOR (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi network monitor command response ID
#define NCP_CMD_WLAN_NETWORK_ADD (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-add */
Wi-Fi add network command ID
#define NCP_RSP_WLAN_NETWORK_ADD (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi add network command response ID
#define NCP_CMD_WLAN_NETWORK_START (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-start-network */
Wi-Fi start network command ID
#define NCP_RSP_WLAN_NETWORK_START (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi start network command response ID
#define NCP_CMD_WLAN_NETWORK_STOP (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-stop-network */
Wi-Fi stop network command ID
#define NCP_RSP_WLAN_NETWORK_STOP (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi stop network command response ID
#define NCP_CMD_WLAN_NETWORK_GET_UAP_STA_LIST (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-get-uap-sta-list */
Wi-Fi get number of STAs connected to UAP command ID
#define NCP_RSP_WLAN_NETWORK_GET_UAP_STA_LIST (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi get number of STAs connected to UAP command response ID
#define NCP_CMD_WLAN_NETWORK_MDNS_QUERY (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000007) /* wlan-mdns-query */
Wi-Fi MDNS query command ID
#define NCP_RSP_WLAN_NETWORK_MDNS_QUERY (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000007)
Wi-Fi MDNS query command response ID
#define NCP_CMD_WLAN_NETWORK_LIST (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-list */
Wi-Fi get added network list command ID
#define NCP_RSP_WLAN_NETWORK_LIST (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi get added network list command response ID
#define NCP_CMD_WLAN_NETWORK_REMOVE (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x00000009) /* wlan-remove */
Wi-Fi remove already added network command ID
#define NCP_RSP_WLAN_NETWORK_REMOVE (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x00000009)
Wi-Fi remove already added network command response ID
#define NCP_CMD_WLAN_NETWORK_ADDRESS (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_CMD | 0x0000000A) /* wlan-address */
Wi-Fi get STA/UAP network IP address command ID
#define NCP_RSP_WLAN_NETWORK_ADDRESS (NCP_CMD_WLAN | NCP_CMD_WLAN_NETWORK | NCP_MSG_TYPE_RESP | 0x0000000A)
Wi-Fi get STA/UAP network IP address command response ID
#define NCP_CMD_WLAN_POWERMGMT_MEF (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-multi-mef */
Wi-Fi configure multiple MEF (memory efficient filtering) command ID
#define NCP_RSP_WLAN_POWERMGMT_MEF (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi configure multiple MEF command response ID
#define NCP_CMD_WLAN_POWERMGMT_DEEP_SLEEP_PS (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-deep-sleep-ps */
Wi-Fi enable/disable deep sleep power save mode command ID
#define NCP_RSP_WLAN_POWERMGMT_DEEP_SLEEP_PS (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi enable/disable deep sleep power save mode command response ID
#define NCP_CMD_WLAN_POWERMGMT_IEEE_PS (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-ieee-ps */
Wi-Fi enable/disable IEEE power save mode command ID
#define NCP_RSP_WLAN_POWERMGMT_IEEE_PS (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi enable/disable IEEE power save mode command response ID
#define NCP_CMD_WLAN_POWERMGMT_UAPSD (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-uapsd-enable */
Wi-Fi enable/disable WMM (Wi-Fi multimedia) power save mode command ID
#define NCP_RSP_WLAN_POWERMGMT_UAPSD (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi enable/disable WMM power save mode command response ID
#define NCP_CMD_WLAN_POWERMGMT_QOSINFO (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-uapsd-qosinfo */
Wi-Fi set/get WMM QOS (quality of service) information command ID
#define NCP_RSP_WLAN_POWERMGMT_QOSINFO (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi set/get WMM QOS information command response ID
#define NCP_CMD_WLAN_POWERMGMT_SLEEP_PERIOD (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-uapsd-sleep-period */
Wi-Fi set/get sleep period command ID
#define NCP_RSP_WLAN_POWERMGMT_SLEEP_PERIOD (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi set/get sleep period command response ID
#define NCP_CMD_WLAN_POWERMGMT_WOWLAN_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-wowlan-cfg */
Wi-Fi set wakeup conditions command ID
#define NCP_RSP_WLAN_POWERMGMT_WOWLAN_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi set wakeup conditions command response ID
#define NCP_CMD_WLAN_POWERMGMT_SUSPEND (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_CMD | 0x0000000a) /* wlan-suspend */
Wi-Fi device enter power save mode command ID
#define NCP_RSP_WLAN_POWERMGMT_SUSPEND (NCP_CMD_WLAN | NCP_CMD_WLAN_POWERMGMT | NCP_MSG_TYPE_RESP | 0x0000000a)
Wi-Fi device enter power save mode command response ID
#define NCP_CMD_WLAN_UAP_MAX_CLIENT_CNT (NCP_CMD_WLAN | NCP_CMD_WLAN_UAP | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-set-max-clients-count */
WLAN UAP command Wi-Fi set maximum client count command ID
#define NCP_RSP_WLAN_UAP_MAX_CLIENT_CNT (NCP_CMD_WLAN | NCP_CMD_WLAN_UAP | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi set maximum client count command response ID
#define NCP_CMD_11AX_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-set-11axcfg */
WLAN other command Wi-Fi configure 802.11ax features command ID
#define NCP_RSP_11AX_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi configure 802.11ax features command response ID
#define NCP_CMD_BTWT_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-set-11axcfg */
Wi-Fi configure broadcast TWT command ID
#define NCP_RSP_BTWT_CFG (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi configure broadcast TWT command response ID
#define NCP_CMD_TWT_SETUP (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-set-btwt-cfg */
Wi-Fi setup TWT command ID
#define NCP_RSP_TWT_SETUP (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi setup TWT command response ID
#define NCP_CMD_TWT_TEARDOWN (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-twt-teardown */
Wi-Fi disable TWT command ID
#define NCP_RSP_TWT_TEARDOWN (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi disable TWT command response ID
#define NCP_CMD_TWT_GET_REPORT (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-get-twt-report */
Wi-Fi get TWT information report command ID
#define NCP_RSP_TWT_GET_REPORT (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi get TWT information report command response ID
#define NCP_CMD_11D_ENABLE (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-set-11d-enable */
ID of Wi-Fi enable/disable STA/UAP 802.11d features command
#define NCP_RSP_11D_ENABLE (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi enable/disable STA/UAP 802.11d features command response ID
#define NCP_CMD_REGION_CODE (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000007) /* wlan-region-code */
ID of Wi-Fi set/get region code command
#define NCP_RSP_REGION_CODE (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000007)
ID of Wi-Fi set/get region code command response
#define NCP_CMD_DATE_TIME (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-set/get-time */
Wi-Fi set/get time date command ID
#define NCP_RSP_DATE_TIME (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi set/get time date command response ID
#define NCP_CMD_GET_TEMPERATUE (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x00000009) /* wlan-get-temp */
Wi-Fi get chip temperature command ID
#define NCP_RSP_GET_TEMPERATUE (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x00000009)
Wi-Fi get chip temperature command response ID
#define NCP_CMD_INVALID_CMD (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_CMD | 0x0000000a)
Wi-Fi invalid command ID
#define NCP_RSP_INVALID_CMD (NCP_CMD_WLAN | NCP_CMD_WLAN_OTHER | NCP_MSG_TYPE_RESP | 0x0000000a)
Wi-Fi invalid command response ID
#define NCP_CMD_WLAN_REGULATORY_ED_MAC_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000001) /* wlan-set-ed-mac-mode */
Wi-Fi enable/disable EU (encrypt unit) adaptivity command ID
#define NCP_RSP_WLAN_REGULATORY_ED_MAC_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000001)
Wi-Fi enable/disable EU adaptivity command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_TEST_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000002) /* wlan-set-rf-test-mode */
Wi-Fi set RF test mode command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_TEST_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000002)
Wi-Fi set RF test mode command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_TX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000003) /* wlan-set-rf-tx-antenna */
Wi-Fi set RF transmit antenna command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_TX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000003)
Wi-Fi set RF transmit antenna command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_RF_TX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000004) /* wlan-get-rf-tx-antenna */
Wi-Fi get RF transmit antenna command ID
#define NCP_RSP_WLAN_REGULATORY_GET_RF_TX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000004)
Wi-Fi get RF transmit antenna command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_RX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000005) /* wlan-set-rf-rx-antenna */
Wi-Fi set RF receive antenna command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_RX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000005)
Wi-Fi set RF receive antenna command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_RF_RX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000006) /* wlan-get-rf-rx-antenna */
Wi-Fi get RF receive antenna command ID
#define NCP_RSP_WLAN_REGULATORY_GET_RF_RX_ANTENNA (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000006)
Wi-Fi get RF receive antenna command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_BAND (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000007) /* wlan-set-rf-band */
Wi-Fi set RF band command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_BAND (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000007)
Wi-Fi set RF band command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_RF_BAND (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000008) /* wlan-get-rf-band */
Wi-Fi get RF band command ID
#define NCP_RSP_WLAN_REGULATORY_GET_RF_BAND (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000008)
Wi-Fi get RF band command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_BANDWIDTH (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000009) /* wlan-set-rf-bandwidth */
Wi-Fi set RF bandwidth command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_BANDWIDTH (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000009)
Wi-Fi set RF bandwidth command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_RF_BANDWIDTH (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x0000000a) /* wlan-get-rf-bandwidth */
Wi-Fi get RF bandwidth command ID
#define NCP_RSP_WLAN_REGULATORY_GET_RF_BANDWIDTH (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x0000000a)
Wi-Fi get RF bandwidth command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_CHANNEL (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x0000000b) /* wlan-set-rf-channel */
Wi-Fi set RF channel number command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_CHANNEL (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x0000000b)
Wi-Fi set RF channel number command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_RF_CHANNEL (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x0000000c) /* wlan-get-rf-channel */
Wi-Fi get RF channel number command ID
#define NCP_RSP_WLAN_REGULATORY_GET_RF_CHANNEL (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x0000000c)
Wi-Fi get RF channel number command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_RADIO_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x0000000d) /* wlan-set-rf-radio-mode */
Wi-Fi set RF radio mode command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_RADIO_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x0000000d)
Wi-Fi set RF radio mode command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_RF_RADIO_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x0000000e) /* wlan-get-rf-radio-mode */
Wi-Fi get RF radio mode command ID
#define NCP_RSP_WLAN_REGULATORY_GET_RF_RADIO_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x0000000e)
Wi-Fi get RF radio mode command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_TX_POWER (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x0000000f) /* wlan-set-rf-tx-power */
Wi-Fi set RF transmit power command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_TX_POWER (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x0000000f)
Wi-Fi set RF transmit power command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_TX_CONT_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000010) /* wlan-set-rf-tx-cont-mode */
Wi-Fi set RF transmit continuous configuration command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_TX_CONT_MODE (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000010)
Wi-Fi set RF transmit continuous configuration command response ID
#define NCP_CMD_WLAN_REGULATORY_SET_RF_TX_FRAME (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000011) /* wlan-set-rf-tx-frame */
Wi-Fi set RF transmit frame command ID
#define NCP_RSP_WLAN_REGULATORY_SET_RF_TX_FRAME (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000011)
Wi-Fi set RF transmit frame command response ID
#define NCP_CMD_WLAN_REGULATORY_GET_AND_RESET_RF_PER (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000012) /* wlan-get-and-reset-rf-per */
Wi-Fi get and reset RF per command ID
#define NCP_RSP_WLAN_REGULATORY_GET_AND_RESET_RF_PER (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000012)
Wi-Fi get and reset RF per command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_CCMP_128 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000013) /* wlan-eu-crypto-ccmp-128 */
Wi-Fi verify Algorithm AES-CCMP-128 encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_CCMP_128 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000013)
Wi-Fi verify Algorithm AES-CCMP-128 encryption decryption command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_GCMP_128 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000014) /* wlan-eu-crypto-gcmp-128 */
Wi-Fi verify Algorithm AES-GCMP-128 encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_GCMP_128 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000014)
Wi-Fi verify Algorithm AES-GCMP-128 encryption decryption command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_CCMP_256 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000015) /* wlan-eu-crypto-ccmp-256 */
Wi-Fi verify Algorithm AES-CCMP-256 encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_CCMP_256 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000015)
Wi-Fi verify Algorithm AES-CCMP-256 encryption decryption command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_GCMP_256 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000016) /* wlan-eu-crypto-gcmp-256 */
Wi-Fi verify Algorithm AES-GCMP-256 encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_GCMP_256 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000016)
Wi-Fi verify Algorithm AES-GCMP-256 encryption decryption command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_RC4 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000017) /* wlan-eu-crypto-rc4 */
Wi-Fi verify Algorithm RC4 encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_RC4 (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000017)
Wi-Fi verify Algorithm RC4 encryption decryption command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_AES_WRAP (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000018) /* wlan-eu-crypto-aes-wrap */
Wi-Fi verify Algorithm AES-WRAP encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_AES_WRAP (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000018)
Wi-Fi verify Algorithm AES-WRAP encryption decryption command response ID
#define NCP_CMD_WLAN_REGULATORY_EU_CRYPTO_AES_ECB (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_CMD | 0x00000019) /* wlan-eu-crypto-aes-ecb */
Wi-Fi verify Algorithm AES-ECB encryption decryption command ID
#define NCP_RSP_WLAN_REGULATORY_EU_CRYPTO_AES_ECB (NCP_CMD_WLAN | NCP_CMD_WLAN_REGULATORY | NCP_MSG_TYPE_RESP | 0x00000019)
Wi-Fi verify Algorithm AES-ECB encryption decryption command response ID
#define NCP_EVENT_MDNS_QUERY_RESULT (NCP_CMD_WLAN | NCP_CMD_WLAN_ASYNC_EVENT | NCP_MSG_TYPE_EVENT | 0x00000003) /* mdns-query-result */
WLAN events Wi-Fi MDNS query result event ID
#define NCP_EVENT_MDNS_RESOLVE_DOMAIN (NCP_CMD_WLAN | NCP_CMD_WLAN_ASYNC_EVENT | NCP_MSG_TYPE_EVENT | 0x00000004) /* mdns-resolve-domain-name */
Wi-Fi MDNS resolve domain event ID
#define NCP_EVENT_CSI_DATA (NCP_CMD_WLAN | NCP_CMD_WLAN_ASYNC_EVENT | NCP_MSG_TYPE_EVENT | 0x00000005) /* csi data */
Wi-Fi MDNS CSI (channel state information) data event ID
#define NCP_EVENT_WLAN_STA_CONNECT (NCP_CMD_WLAN | NCP_CMD_WLAN_ASYNC_EVENT | NCP_MSG_TYPE_EVENT | 0x00000006) /* wlan sta connect */
Wi-Fi station connect AP event ID
#define NCP_EVENT_WLAN_STA_DISCONNECT (NCP_CMD_WLAN | NCP_CMD_WLAN_ASYNC_EVENT | NCP_MSG_TYPE_EVENT | 0x00000007) /* wlan sta disconnect */
Wi-Fi station disconnect AP event ID
#define NCP_EVENT_WLAN_STOP_NETWORK (NCP_CMD_WLAN | NCP_CMD_WLAN_ASYNC_EVENT | NCP_MSG_TYPE_EVENT | 0x00000008) /* wlan stop network */
Wi-Fi UAP stop network event ID
#define NCP_CMD_NETWORK_SSID_TLV 0x0001
NCP WLAN TLV NCP network ssid tlv type
#define NCP_CMD_NETWORK_BSSID_TLV 0x0002
NCP network BSSID tlv type
#define NCP_CMD_NETWORK_CHANNEL_TLV 0x0003
NCP network channel tlv type
#define NCP_CMD_NETWORK_IP_TLV 0x0004
NCP network IP tlv type
#define NCP_CMD_NETWORK_SECURITY_TLV 0x0005
NCP network security tlv type
#define NCP_CMD_NETWORK_ROLE_TLV 0x0006
NCP network role tlv type
#define NCP_CMD_NETWORK_DTIM_TLV 0x0007
NCP network DTIM tlv type
#define NCP_CMD_NETWORK_CAPA_TLV 0x0008
NCP network capacity tlv type
#define NCP_CMD_NETWORK_ACSBAND_TLV 0x0009
NCP auto change band tlv type
#define NCP_CMD_NETWORK_PMF_TLV 0x000A
NCP management frame protection tlv type
#define NCP_CMD_NETWORK_PWE_TLV 0x000B
NCP network PWE (password element) tlv type
#define NCP_CMD_NETWORK_TR_TLV 0x000C
NCP transition_Disable tlv type
#define NCP_CMD_NETWORK_EAP_TLV 0x000D
NCP network EAP tlv type
#define NCP_CMD_WLAN_HE_CAP_TLV 0x00FF
NCP network high efficiency tlv type
#define NCP_CMD_NETWORK_MDNS_RESULT_PTR 0x0011
NCP MDNS result TLV NCP PTR (pointer records) resource record tlv type
#define NCP_CMD_NETWORK_MDNS_RESULT_SRV 0x0012
NCP SRV (service records) resource record tlv type
#define NCP_CMD_NETWORK_MDNS_RESULT_TXT 0x0013
NCP TXT (text) resource record tlv type
#define NCP_CMD_NETWORK_MDNS_RESULT_IP_ADDR 0x0014
NCP IPv4 and IPv6 resource record tlv type
#define WLAN_SET_MAX_CLIENT_CNT_SUCCESS 0
Set UAP max client count status
#define IP_ADDR_LEN 16
NCP Wi-Fi socket connect
#define SETH_NAME_LENGTH 64
NCP Wi-Fi Http Seth
#define HTTP_URI_LEN 512
NCP Wi-Fi http request
ncp_host_command_ble.h File Reference
NCP Bluetooth LE host command interfaces.
Function Documentation
int ble_set_adv_data_command (int argc, char ** argv)
This API is used to set Bluetooth LE advertising data
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 2 |
| in | argv | Argument vector. argv[0]: 'ble-set-adv-data' argv[1]: Advertising data to set (Required) Advertising data should follow structure: struct bt_data { U8 len; U8 type; const U8 *data; } Example: 0e094e43505f444542554731323334 Detail as: len : 0e(14 bytes, contain type and data) type: 09(BT_DATA_NAME_COMPLETE) data: 4e43505f444542554731323334(NCP_DEBUG1234) TYPE Reference: Core Specification Supplement, Part A, Data Types Specification |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_start_adv_command (int argc, char ** argv)
This API is used to start Bluetooth LE advertising
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 1 |
| in | argv | Argument vector. argv[0]: 'ble-start-adv' |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_stop_adv_command (int argc, char ** argv)
This API is used to stop Bluetooth LE advertising
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 1 |
| in | argv | Argument vector. argv[0]: 'ble-stop-adv' |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_set_scan_param_command (int argc, char ** argv)
This API is used to set Bluetooth LE scan parameter
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 4 |
| in | argv | Argument vector. argv[0]: 'ble-set-scan-param' argv[1]: filter option (Required) 0 – BT_LE_SCAN_OPT_NONE (Convenience value when no options are specified) 1 – BT_LE_SCAN_OPT_FILTER_DUPLICATE (Filter duplicates) 2 – BT_LE_SCAN_OPT_FILTER_ACCEPT_LIST (Filter using filter accept list) argv[2]: scan interval (Required) Range from 4 to 16384 (Decimal value) argv[3]: scan window (Required) Range: 4 to 16384 (Decimal value, window value shall be less than or equal to interval value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_start_scan_command (int argc, char ** argv)
This API is used to start Bluetooth LE scanning
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 2 |
| in | argv | Argument vector. argv[0]: 'ble-start-scan' argv[1] – scan type (Required) 0 – active scan 1 – passive scan |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_stop_scan_command (int argc, char ** argv)
This API is used to stop Bluetooth LE scanning
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 1 |
| in | argv | Argument vector. argv[0]: 'ble-stop-scan' |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_connect_command (int argc, char ** argv)
This API is used to connect the advertising device
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 3 |
| in | argv | Argument vector. argv[0]: 'ble-connect' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_disconnect_command (int argc, char ** argv)
This API is used to disconnect the connected device
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 3 |
| in | argv | Argument vector. argv[0]: 'ble-disconnect' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_connect_parameter_update_command (int argc, char ** argv)
This API is used to update the device connection parameter
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 7 |
| in | argv | Argument vector. argv[0]: 'ble-conn-param-update' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[3]: connection maximum interval (Required) Maximum value for the connection interval. This shall be greater than or equal to minimum connection interval. (Decimal value) argv[4]: connection minimum interval (Required) Minimum value for the connection interval. This shall be less than or equal to maximum connection interval. (Decimal value) argv[5]: connection latency Maximum Peripheral latency for the connection in number of subrated connection events. (Decimal value) argv[6]: connection timeout Supervision timeout for the Bluetooth LE link. (Decimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_set_phy_command (int argc, char ** argv)
This API is used to set the Bluetooth PHY
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 5 |
| in | argv | Argument vector. argv[0]: 'ble-set-phy' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[3]: Bluetooth TX PHY 1 – 1M PHY 2 – 2M PHY 4 – Coded PHY argv[4]: Bluetooth RX PHY 1 – 1M PHY 2 – 2M PHY 4 – Coded PHY |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_set_data_len_command (int argc, char ** argv)
This API is used to update data packet length
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 4 or 5 |
| in | argv | Argument vector. argv[0]: 'ble-set-data-len' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[3]: Maximum data length to transmit (Required) Range: 27 to 251 (Decimal value) argv[4]: Maximum TX transmit time (Optional) Range: 328 to 17040 (Decimal value, this parameter can be left unset when sending commands) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_set_filter_list_command (int argc, char ** argv)
This API is used to configure the filter list. After the filter list is set, use the ble-scan-param to scan the parameter. Select the filter option 2. Send the scan command.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be at least 4 |
| in | argv | Argument vector. argv[0]: 'ble-set-filter-list' argv[1]: The number of device address need to filter (Required) Range: 1 to 255 (Decimal value) argv[2]: address type (Required) 'public' – public address 'random' – random address argv[3]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) ...... argv[n-1]: address type (Optional) 'public' – public address 'random' – random address argv[n]: device address (Optional) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_start_encryption_command (int argc, char ** argv)
This API is used to initiate security connection. If peer is already paired, IUT (Implementation under test) is expected to enable security (encryption) with peer. If peer is not paired, the IUT start the pairing process.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 3 |
| in | argv | Argument vector. argv[0]: 'ble-start-encryption' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_read_characteristic_command (int argc, char ** argv)
This API is used to read profile characteristic value by handle. This API must be called after the device is connected
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 4 |
| in | argv | Argument vector. argv[0]: 'ble-read-characteristic' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[3]: attribute handle (Required) Range from 0x0000 ~ 0xffff (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_register_service_command (int argc, char ** argv)
This API is used to register the service that runs the profile on the NCP device
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be at least 3 |
| in | argv | Argument vector. argv[0]: 'ble-register-service' argv[1]: The number of service to register (Required) Range from 1 to 5 argv[2]: service id (Required) 1 – Peripheral HTS (Health Thermometer) 2 – Peripheral HRS (Health Rate) 3 – Peripheral BAS (Battery Service) 4 – Central HTS 5 – Central HRS ..... argv[n]: service id (Optional) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_set_power_mode_command (int argc, char ** argv)
This API is used to set the device power mode
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 2 |
| in | argv | Argument vector. argv[0]: 'ble-set-power-mode' argv[1]: device power mode 0 – enable controller auto sleep 1 – disable controller auto sleep |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_host_service_add_command (int argc, char ** argv)
This API is used to set the service parameters. One service may have several characteristic
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be at least 11 |
| in | argv | Argument vector. argv[0]: 'ble-host-svc-add' argv[1]: 'prim' (Required) argv[2]: primary service uuid (Required) XXXX (Hexadecimal value) argv[3]: 'chrc' (Required) argv[4]: characteristic uuid (Required) XXXX (Hexadecimal value) argv[5]: characteristic properties (Required) XX (Hexadecimal value) BIT 1: Broadcast BIT 2: Read BIT 3: Write Without Response BIT 4: Write BIT 5: Notify BIT 6: Indicate BIT 7: Authenticated Signed Writes BIT 8: Extended Properties argv[6]: characteristic permission (Required) XX (Hexadecimal value) 0: None BIT 0: Read BIT 1: Write BIT 2: Read with Encryption BIT 3: Write with Encryption BIT 4: Read with Authentication BIT 5: Write with Authentication BIT 6: Prepare Write BIT 7: Read with LE Secure Connection encryption BIT 8: Write with LE Secure Connection encryption argv[7]: 'ccc' (Required) argv[8]: client characteristic configuration uuid (Required) XXXX (Hexadecimal value) argv[9]: client characteristic configuration permissions (Required) XX (Hexadecimal value) 0: None BIT 0: Read BIT 1: Write BIT 2: Read with Encryption BIT 3: Write with Encryption BIT 4: Read with Authentication BIT 5: Write with Authentication BIT 6: Prepare Write BIT 7: Read with LE Secure Connection encryption BIT 8: Write with LE Secure Connection encryption ...... argv[n]: 'start' (Required) Example: Add hts service ble-host-svc-add prim 1809 chrc 2a1c 20 00 ccc 2902 03 start (same as the command 'ble-start-service hts' ) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_start_service_command (int argc, char ** argv)
This API is used to start service that runs the profile on the NCP host
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 2 |
| in | argv | Argument vector. argv[0]: 'ble-start-service' argv[1]: profile name (Required) 'hts' – Peripheral health thermometer 'htc' – Client health thermometer 'hrs' – Peripheral health rate 'hrc' – Client health rate 'bas' – Peripheral battery service |
Note
To use the command, enable the following macros:
CONFIG_NCP_BLE
CONFIG_NCP_BLE_PROFILE_MODE
CONFIG_NCP_HTS
CONFIG_NCP_HRS
CONFIG_NCP_HTC
CONFIG_NCP_HRC
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_cfg_subscribe_command (int argc, char ** argv)
This API is used to subscribe the ccc handle
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 6 |
| in | argv | Argument vector. argv[0]: 'ble-cfg-subscribe' argv[1]: property type (Required) 'indicate' – If set, changes to Characteristic Value are indicated 'notify' – If set, changes to Characteristic Value are notified argv[2]: address type (Required) 'public' – public address 'random' – random address argv[3]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[4]: enable subscription option (Required) 0 – disable subscription 1 – enable subscription argv[5]: client characteristic configuration handle (Required) specific one needs to be referred to the print ccc handle value of Discover the Descriptor Event (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_l2cap_connection_command (int argc, char ** argv)
This API is used to connect the l2cap PSM (Protocol service multiplexer).
The l2cap PSM need to be registered by remote device, then issue ble-l2cap-connect command to connect the remote device
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 4 |
| in | argv | Argument vector. argv[0]: 'ble-l2cap-connect' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[3]: Protocol service multiplexer value (Required) Range: 128 to 255 (Decimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_l2cap_disconnect_command (int argc, char ** argv)
This API is used to disconnect the l2cap channel
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 3 |
| in | argv | Argument vector. argv[0]: 'ble-l2cap-disconnect' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_l2cap_send_command (int argc, char ** argv)
This API is used to send the data with the l2cap PSM
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 4 |
| in | argv | Argument vector. argv[0]: 'ble-l2cap-send' argv[1]: address type (Required) 'public' – public address 'random' – random address argv[2]: device address (Required) device address format: XX:XX:XX:XX:XX:XX (Hexadecimal value) argv[3]: times the number of times a loop is sent (Decimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
int ble_l2cap_register_command (int argc, char ** argv)
This API is used to register the l2cap PSM
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 2 |
| in | argv | Argument vector. argv[0]: 'ble-l2cap-register' argv[1]: Protocol service multiplexer value (Required) Range: 128 to 255 (Decimal value) |
Returns
NCP_STATUS_SUCCESS if success
NCP_STATUS_ERROR if failure
MCU_NCPCmd_DS_BLE_COMMAND* ncp_host_get_cmd_buffer_ble (void )
Get NCP Bluetooth LE command buffer
Returns
A pointer to MCU_NCPCmd_DS_BLE_COMMAND
ncp_host_command_wifi.h File Reference
NCP host command interfaces.
Function Documentation
MCU_NCPCmd_DS_COMMAND* ncp_host_get_cmd_buffer_wifi (void )
Get NCP host TLV command buffer.
Returns
pointer to the host TLV command buffer.
void ping_wait_event (osa_event_flags_t flagsToWait)
This API is used for ping task to wait for user input ping command from console.
Parameters
| in | flagsToWait | Event flags that to wait |
Returns
void
void ping_set_event (osa_event_flags_t flagsToWait)
This API is used to send ping command response to ping_sock_task.
Parameters
| in | flagsToWait | Event flags that to wait |
Returns
void
void iperf_tx_wait_event (osa_event_flags_t flagsToWait)
This API is used to wait for transmit event.
Parameters
| in | flagsToWait | Event flags that to wait |
Returns
void
void iperf_tx_set_event (osa_event_flags_t flagsToWait)
This API is used to set transmit event flags that to wait.
Parameters
| in | flagsToWait | Event flags that to wait |
Returns
void
void iperf_rx_wait_event (osa_event_flags_t flagsToWait)
This API is used to wait for receive event IPERF_RX_START.
Parameters
| in | flagsToWait | Event flags that to wait |
Returns
void
void iperf_rx_set_event (osa_event_flags_t flagsToWait)
This API is used to set receive event flags.
Parameters
| in | flagsToWait | Event flags that to wait |
Returns
void
int wlan_uap_prov_start_command (int argc, char ** argv)
This API is used to start the UAP provisioning.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-uap-prov-start |
Returns
WM_SUCCESS if success.
int wlan_process_wlan_uap_prov_start_result_response (uint8_t * res)
This API is used to process start the UAP provisioning response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_uap_prov_reset_command (int argc, char ** argv)
This API is used to reset the UAP provisioning.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-uap-prov-reset |
Returns
WM_SUCCESS if success.
int wlan_uap_prov_set_uapcfg (int argc, char ** argv)
This API is used to configure the UAP provisioning.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2, 3 or 4. |
| in | argv | Argument vector. argv[0]: wlan-uap-prov-set-uapcfg argv[1]: ssid argv[2]: security type argv[3]: password string |
Returns
WM_SUCCESS if success.
int wlan_process_wlan_uap_prov_reset_result_response (uint8_t * res)
This API is used to process reset the UAP provisioning response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_get_signal_command (int argc, char ** argv)
This API is used to get the RSSI information.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-signal |
Returns
WM_SUCCESS.
int wlan_process_rssi_response (uint8_t * res)
This API is used to process the RSSI information response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RSSI. |
Returns
WM_SUCCESS if success.
int wlan_set_antenna_cfg_command (int argc, char ** argv)
This API is used to set the mode of TX/RX antenna.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2 or 3. |
| in | argv | Argument vector argv[0]: wlan-set-antenna-cfg argv[1]: string of antenna mode (Required) 0: TX/RX antenna 1 1: TX/RX antenna 2 15: TX/RX antenna diversity. argv[2]: string of evaluate_time (Optional) if ant mode = 15, SAD (software antenna diversity) evaluate time interval. default value is 6s(6000). |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_get_antenna_cfg_command (int argc, char ** argv)
This API is used to get the mode of TX/RX antenna.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-antenna-cfg |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_antenna_cfg_response (uint8_t * res)
This API is used to process set/get antenna configuration response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_ANTENNA_CFG. |
Returns
WM_SUCCESS if success.
int wlan_set_max_clients_count_command (int argc, char ** argv)
This API is used to set maximum number of the stations that can be allowed to connect to the UAP.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-max-clients-count argv[1]: string value of STA count, maximum supported STA count is 8. |
Returns
WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.
Note
Set operation in not allowed in WLAN_UAP_STARTED state.
int wlan_process_client_count_response (uint8_t * res)
This API is used to process set the maximum number of stations response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_CLIENT_CNT. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_ccmp128_command (int argc, char ** argv)
This API is used to verify the algorithm AES-CCMP-128 encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-ccmp-128 argv[1]: string value of decrypt or encypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_ccmp128_response (uint8_t * res)
This API is used to process the algorithm AES-CCMP-128 encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_gcmp128_command (int argc, char ** argv)
This API is used to verify the algorithm AES-GCMP-128 encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-gcmp-128 argv[1]: string value of decrypt or encypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_gcmp128_response (uint8_t * res)
This API is used to process the algorithm AES-GCMP-128 encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_gcmp256_command (int argc, char ** argv)
This API is used to verify the algorithm AES-GCMP-256 encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-gcmp-256 argv[1]: string value of decrypt or encypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_gcmp256_response (uint8_t * res)
This API is used to process the algorithm AES-GCMP-256 encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_ccmp256_command (int argc, char ** argv)
This API is used to verify the algorithm AES-CCMP-256 encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-ccmp-256 argv[1]: string value of decrypt or encrypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_ccmp256_response (uint8_t * res)
This API is used to process the algorithm AES-CCMP-256 encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_rc4_command (int argc, char ** argv)
This API is used to verify the algorithm RC4 encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-rc4 argv[1]: string value of decrypt or encrypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_rc4_response (uint8_t * res)
This API is used to process the algorithm RC4 encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_aes_wrap_command (int argc, char ** argv)
This API is used to verify the algorithm AES-WRAP encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-aes-wrap argv[1]: string value of decrypt or encrypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_aes_wrap_response (uint8_t * res)
This API is used to process the algorithm AES-WRAP encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_eu_crypto_aes_ecb_command (int argc, char ** argv)
This API is used to verify the algorithm AES-ECB encryption and decryption.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-eu-crypto-aes-ecb argv[1]: string value of decrypt or encrypt option. 0: decrypt 1: encrypt |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_eu_crypto_aes_ecb_response (uint8_t * res)
This API is used to process the algorithm AES-ECB encryption and decryption response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_ed_mac_mode_set_command (int argc, char ** argv)
This API is used to configure the ED (energy detect) MAC mode for station in Wi-Fi firmware.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, If enable CONFIG_NCP_5GHz_SUPPORT: argc should be 5. If disable CONFIG_NCP_5GHz_SUPPORT: argc should be 3. |
| in | argv | Argument vector. argv[0]: wlan-set-ed-mac-mode argv[1]: string of ed_ctrl_2g 0: disable EU adaptivity for 2.4GHz band. 1: enable EU adaptivity for 2.4GHz band. argv[2]: string of ed_offset_2g 0: default dnergy detect threshold. ed_threshold = ed_base - ed_offset_2g e.g., if ed_base default is -62dBm, ed_offset_2g is 0x8, then ed_threshold is -70dBm. #if CONFIG_NCP_5GHz_SUPPORT argv[3]: string of ed_ctrl_5g 0: disable EU adaptivity for 5GHz band. 1: enable EU adaptivity for 5GHz band. argv[4]: string of ed_offset_5g 0: default energy detect threshold. ed_threshold = ed_base - ed_offset_5g e.g., if ed_base default is -62dBm, ed_offset_5g is 0x8, then ed_threshold is -70dBm. #endif |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_ed_mac_mode_get_command (int argc, char ** argv)
This API is used to get the current ED MAC mode configuration for station.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-ed-mac-mode |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_ed_mac_response (uint8_t * res)
This API is used to process the response for the set/get ED (energy detect) MAC mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_ED_MAC. |
Returns
WM_SUCCESS if success.
int wlan_set_rf_test_mode_command (int argc, char ** argv)
This API is used to enable the RF test mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-test-mode |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
If you test with RF test mode, don’t use wlan-reset 2, it is not supported.
int wlan_process_set_rf_test_mode_response (uint8_t * res)
This API is used to process Wi-Fi set the RF test mode response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_set_rf_tx_antenna_command (int argc, char ** argv)
This API is used to set the RF TX antenna mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-tx-antenna argv[1]: antenna 1 – Main 2 – Aux |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_tx_antenna_response (uint8_t * res)
This API is used to process the Wi-Fi set RF TX antenna response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_get_rf_tx_antenna_command (int argc, char ** argv)
This API is used to get the RF TX antenna mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-rf-tx-antenna |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Please set RF TX antenna before get it.
int wlan_process_get_rf_tx_antenna_response (uint8_t * res)
This API is used to process the get RF TX antenna response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_TX_ANTENNA. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_rf_rx_antenna_command (int argc, char ** argv)
This API is used to set the RF RX antenna mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-rx-antenna argv[1]: antenna 1 – Main 2 – Aux |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_rx_antenna_response (uint8_t * res)
This API is used to process the response of the Wi-Fi set RF RX antenna mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_get_rf_rx_antenna_command (int argc, char ** argv)
This API is used to get the RF RX antenna mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-rf-rx-antenna |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Please set RF RX antenna before get it.
int wlan_process_get_rf_rx_antenna_response (uint8_t * res)
This API is used to process the response of the get RF RX antenna mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_RX_ANTENNA. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_rf_band_command (int argc, char ** argv)
This API is used to set the RF band.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-band argv[1]: band 0 – 2.4G 1 – 5G |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_band_response (uint8_t * res)
This API is used to process the response of the configure RF band command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_get_rf_band_command (int argc, char ** argv)
This API is used to get the RF band.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-rf-band |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Please set the RF band before get it.
int wlan_process_get_rf_band_response (uint8_t * res)
This API is used to process the response of the getting RF band command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_BAND. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_rf_bandwidth_command (int argc, char ** argv)
This API is used to set the RF bandwidth.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-bandwidth argv[1]: bandwidth 0 – 20MHz 1 – 40MHz 4 – 80MHz |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_bandwidth_response (uint8_t * res)
This API is used to process the response of the set RF bandwidth command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_get_rf_bandwidth_command (int argc, char ** argv)
This API is used to get the RF bandwidth.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-rf-bandwidth |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Please set the RF bandwidth before get it.
int wlan_process_get_rf_bandwidth_response (uint8_t * res)
This API is used to process the response of the get RF bandwidth command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_BANDWIDTH. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_rf_channel_command (int argc, char ** argv)
This API is used to set the RF channel.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-channel argv[1]: channel, 2.4G channel numbers or 5G channel numbers |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_channel_response (uint8_t * res)
This API is used to process the response of the set RF channel command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_get_rf_channel_command (int argc, char ** argv)
This API is used to get the RF channel.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-rf-channel |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Please set the RF channel before get it.
int wlan_process_get_rf_channel_response (uint8_t * res)
This API is used to process the response of the get RF channel command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_CHANNEL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_rf_radio_mode_command (int argc, char ** argv)
This API is used to set the RF radio mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-radio-mode argv[1]: radio_mode 0 – set the radio in power down mode 3 – set the radio in 5GHz band, 1X1 mode(path A) 11 – set the radio in 2.4GHz band, 1X1 mode(path A) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_radio_mode_response (uint8_t * res)
This API is used to process the response of setting RF radio mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_get_rf_radio_mode_command (int argc, char ** argv)
This API is used to get the RF radio mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-rf-radio-mode |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Please set RF radio mode before get it.
int wlan_process_get_rf_radio_mode_response (uint8_t * res)
This API is used to process the response of getting RF radio mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_RADIO_MODE. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_ncp_set_rf_tx_power_command (int argc, char ** argv)
This API is used to set the RF TX power.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-tx-power argv[1]: power 0 to 24 (dBm) argv[2]: modulation 0 – CCK 1 – OFDM 2 – MCS argv[3]: path ID 0 – PathA 1 – PathB 2 – PathA+B |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_tx_power_response (uint8_t * res)
This API is used to process the response for the setting RF TX power command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_ncp_set_rf_tx_cont_mode_command (int argc, char ** argv)
This API is used to set the RF TX continuous mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2 or 6. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-tx-cont-mode argv[1]: enable/disable RF TX cont mode (Required) 0 – disable RF TX cont mode 1 – enable RF TX cont mode argv[2]: continuous wave Mode (Optional) Required when argv[1] is 1. 0 – disable continuous Wave Mode 1 – enable continuous Wave Mode argv[3]: payload Pattern (Optional) Required when argv[1] is 1 0 to 0xFFFFFFFF (Enter hexadecimal value) argv[4]: CS mode (Optional) Required when argv[1] is 1. Applicable only when continuous wave is disabled. 0 – disable CS mode 1 – enable CS mode argv[5]: Active SubChannel (Optional) Required when argv[1] is 1. 0 – low 1 – upper 3 – both argv[6]: TX Data Rate (Optional) Required when argv[1] is 1. Rate index corresponding to legacy/HT/VHT rates. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_tx_cont_mode_response (uint8_t * res)
This API is used to process the response message for the setting RF TX continuous mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_ncp_set_rf_tx_frame_command (int argc, char ** argv)
This API is used to set the RF TX frame.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector. argv[0]: wlan-set-rf-tx-frame argv[1]: enable/disable RF TX frame (Required) 0 – disable RF TX frame 1 – enable RF TX frame argv[2]: TX data rate (Optional) Required when argv[1] is 1. Rate index corresponding to legacy/HT/VHT rates). argv[3]: Payload Pattern (Optional) Required when argv[1] is 1. 0 to 0xFFFFFFFF (Enter hexadecimal value) argv[4]: Payload Length (Optional) Required when argv[1] is 1. 1 to 0x400 (Enter hexadecimal value) argv[5]: Adjust burst SIFS3 gap (Optional) Required when argv[1] is 1. 0 – disable 1 – enable argv[6]: Burst SIFS in us (Optional) Required when argv[1] is 1. 0 to 255 (us) argv[7]: Short preamble (Optional) Required when argv[1] is 1. 0 – disable 1 – enable argv[8]: active subchannel (Optional) Required when argv[1] is 1. 0 – low 1 – upper 3 – both argv[9]: short GI (Optional) Required when argv[1] is 1. 0 – disable 1 – enable argv[10]: adv coding (Optional). Required when argv[1] is 1. 0 – disable 1 – enable argv[11]: Beamforming (Optional) Required when argv[1] is 1. 0 – disable 1 – enable argv[12]: GreenField Mode (Optional) Required when argv[1] is 1. 0 – disable 1 – enable argv[13]: STBC (Optional) Required when argv[1] is 1. 0 – disable 1 – enable argv[14]: BSSID (Optional) Required when argv[1] is 1. xx:xx:xx:xx:xx:xx |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_tx_frame_response (uint8_t * res)
This API is used to process set RF TX frame response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_ncp_set_rf_get_and_reset_rf_per_command (int argc, char ** argv)
This API is used to get and reset RF per.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-get-and-reset-rf-per |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_rf_get_and_reset_rf_per_response (uint8_t * res)
This API is used to process the response for the get and reset RF per command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_RF_PER. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_register_access_command (int argc, char ** argv)
This API is used to reads/writes adapter registers value.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv. argc should be 3 or 4. |
| in | argv | Argument vector. argv[0]: wlan-reg-access argv[1]: type (Required) 1: MAC 2: BBP 3: RF 4: CAU argv[2]: offset (Required) offset value of register. argv[3]: value (Optional) Set register value. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_register_access_response (uint8_t * res)
This API is used to process the response message for the reads/writes adapter registers value command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_REGISTER_ACCESS. |
Returns
WM_SUCCESS if success.
int wlan_memory_state_command (int argc, char ** argv)
This API is used to get the OS memory allocate and free info.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: wlan-mem-stat |
Returns
WM_SUCCESS if success.
int wlan_process_memory_state_response (uint8_t * res)
This API is used to process the response message for the get OS memory allocate and free info command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_MEM_STAT. |
Returns
WM_SUCCESS if success.
int wlan_scan_command (int argc, char ** argv)
This API is used to scan for Wi-Fi networks.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-scan |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_scan_response (uint8_t * res)
This API is used to process the response message for the scan Wi-Fi network command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_SCAN_NETWORK_INFO. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_connect_command (int argc, char ** argv)
This API is used to connect to a Wi-Fi network (access point).
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-connect argv[1]: string value of name (Required) A string representing the name of the network to connect to. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_con_response (uint8_t * res)
This API is used to process the response for the connect command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_WLAN_CONN. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_disconnect_command (int argc, char ** argv)
This API is used to disconnect from the current Wi-Fi network (access point).
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-disconnect |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_discon_response (uint8_t * res)
This API is used to process the response for the disconnect command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_version_command (int argc, char ** argv)
This API is used to get the Wi-Fi driver and firmware extended version.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-version |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_version_response (uint8_t * res)
This API is used to process the response for the wlan-version command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_FW_VERSION. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_stat_command (int argc, char ** argv)
This API is used to retrieve the connection state of the station and UAP.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-stat |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_stat_response (uint8_t * res)
This API is used to process the response of the Wi-Fi connection state command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_CONNECT_STAT. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_reset_command (int argc, char ** argv)
This API is used to reset the Wi-Fi driver.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-reset argv[1]: action (Required) 0: disable Wi-Fi 1: enable Wi-Fi 2: reset Wi-Fi |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
This API is used to control Wi-Fi system enable, disable and reset.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: should be "wlan-reset" argv[1]: string value of Wi-Fi reset type (Required) 0 – disable Wi-Fi 1 – enable Wi-Fi 2 – reset Wi-Fi |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_reset_response (uint8_t * res)
This API is used to process the response for the Wi-Fi reset command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_mac_address_command (int argc, char ** argv)
This API is used to set Wi-Fi MAC Address in Wi-Fi firmware.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-set-mac argv[1]: string value of MAC (Required) The MAC address format like "xx:xx:xx:xx:xx:xx". |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_set_mac_address (uint8_t * res)
This API is used to process the response for the set Wi-Fi MAC address command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_get_mac_address_command (int argc, char ** argv)
This API is used to get Wi-Fi MAC Address in Wi-Fi firmware.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-get-mac |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_get_mac_address (uint8_t * res)
This API is used to process the response for the get MAC address command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_GET_MAC_ADDRESS. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_info_command (int argc, char ** argv)
This API is used to Get the configured Wi-Fi network information.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-info |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_info (uint8_t * res)
This API is used to process the response for the get Wi-Fi network information command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_NETWORK_INFO. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_mdns_query_command (int argc, char ** argv)
This API is used to get the list of discovered service on the local network.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 3. |
| in | argv | Argument vector, argv[0]: wlan-mdns-query argv[1]: string value of service types (Required) The type of service to be discovered. The service types can be found at http://www.dns-sd.org/ServiceTypes.html. argv[2]: string value of protocol (Required) e.g. TCP or UDP |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_mdns_query_response (uint8_t * res)
This API is used to process the response for the MDNS query command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_mdns_query_result_event (uint8_t * res)
This API is used to process the MDNS query event.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Event body refer to NCP_EVT_MDNS_RESULT. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int ncp_ping_command (int argc, char ** argv)
This API is used to send an ICMP echo request, receive its response and print its statistics and result.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 5. |
| in | argv | Argument vector, argv[0]: ping argv[1]: value of -s <packet_size> (Optional) argv[2]: value of -c <packet_count> (Optional) argv[3]: value of -W <timeout in sec> (Optional) argv[4]: value of <ipv4 address> (Required) The ipv4 address of target device. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_add_command (int argc, char ** argv)
This API is used to add a network profile to the list of known networks.
The network’s ‘name’ field is unique and between WLAN_NETWORK_NAME_MIN_LENGTH and WLAN_NETWORK_NAME_MAX_LENGTH characters.
Note
The network must specify at least an SSID or BSSID.
This API is used to add profiles for station or UAP interfaces.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 3 to 14. |
| in | argv | Argument vector, argv[0]: wlan-add argv[1]: string value of profile name (Required) The name of network profile. argv[2]: string value of ssid (Optional) The network SSID, represented as a C string of up to 32 characters in length. argv[3]: string value of ip address (Optional) The ip address format like "ip:<ip_addr>,<gateway_ip>,<netmask>". The network IP address configuration specified by struct NCP_WLAN_IPV4_CONFIG that should be associated with this interface. If this profile is used in the UAP mode, this field is mandatory. If this profile is used in the station mode, this field is mandatory if using static IP, and is optional if using DHCP. argv[4]: string value of bssid (Optional) The network BSSID, represented as a 6-byte array. If this profile is used in the UAP mode, this field is ignored. If this profile is used in the station mode, this field is used to identify the network. Set all 6 bytes to 0 to use any BSSID, in which case only the SSID is used to find the network. argv[5]: string value of role (Required) The network Wi-Fi mode enum wlan_bss_role. Set this to specify what type of Wi-Fi network mode to use. This can either be WLAN_BSS_ROLE_STA for use in the station mode, or it can be WLAN_BSS_ROLE_UAP for use in the UAP mode. argv[6]: string value of security (Optional) The network security configuration specified for the network. argv[7]: channel (Optional) The channel for this network. If this profile is used in UAP mode, this field specifies the channel to start the UAP interface on. Set this to 0 for auto channel selection. If this profile is used in the station mode, this constrains the channel on which the network to connect should be present. Set this to 0 to allow the network to be found on any channel. argv[8]: capa (Optional) Wi-Fi capabilities of UAP network 802.11n, 802.11ac or/and 802.11ax. argv[9]: mfpc (Optional) Management frame protection capable (MFPC) argv[10]: mfpr (Optional) Management frame protection required (MFPR) argv[11]: dtim (Optional) DTIM period of associated BSS argv[12]: aid (Optional) Client anonymous identity argv[13]: string value of key_passwd (Optional) Client Key password |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_add_response (uint8_t * res)
This API is used to process the response for the add network command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_wmm_uapsd_command (int argc, char ** argv)
This API is used to set the mode of UAPSD (unscheduled automatic power save delivery).
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-uapsd-enable argv[1]: string of UAPSD mode (Required) 0 – disable UAPSD 1 – enable UAPSD. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wmm_uapsd_response (uint8_t * res)
This API is used to process the response for the set UAPSD command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_POWERMGMT_UAPSD. |
Returns
WM_SUCCESS if success.
int wlan_wmm_uapsd_qosinfo_command (int argc, char ** argv)
This API is used to set/get the QoS (Quality of service) information of UAPSD.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1 or 2. |
| in | argv | Argument vector, argv[0]: wlan-uapsd-qosinfo argv[1]: string of UAPSD QoS Info (Optional) if is NULL, get the QoS information of UAPSD, else, set the QoS information of UAPSD. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_uapsd_qosinfo_response (uint8_t * res)
This API is used to process the response for the set/get UAPSD QoS information command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_POWERMGMT_QOSINFO. |
Returns
WM_SUCCESS if success.
int wlan_uapsd_sleep_period_command (int argc, char ** argv)
This API is used to set/get the sleep period of UAPSD.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1 or 2. |
| in | argv | Argument vector, argv[0]: wlan-uapsd-sleep-period argv[1]: string of UAPSD sleep period (Optional) if is NULL, get the sleep period of UAPSD, else, set the sleep period of UAPSD. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_uapsd_sleep_period_response (uint8_t * res)
This API is used to process the response for the set/get UAPSD sleep period command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_POWERMGMT_SLEEP_PERIOD. |
Returns
WM_SUCCESS if success.
int wlan_start_wps_pbc_command (int argc, char ** argv)
This API is used to start WPS (Wi-Fi protected setup) PBC (push-button configuration) to quickly connect to the AP.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-start-wps-pbc |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wps_pbc_response (uint8_t * res)
This API is used to process WPS PBC response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
int wlan_wps_generate_pin_command (int argc, char ** argv)
This API is used to generate WPS PIN (personal identification number).
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-generate-wps-pin |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wps_generate_pin_response (uint8_t * res)
This API is used to process the response for the generate WPS PIN command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_WPS_GEN_PIN. |
Returns
WM_SUCCESS if success.
int wlan_start_wps_pin_command (int argc, char ** argv)
This API is used to start WPS PIN.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-start-wps-pin argv[1]: string of WPS PIN (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wps_pin_response (uint8_t * res)
This API is used to process the response for the start WPS PIN command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS if success.
int wlan_set_11axcfg_command (int argc, char ** argv)
This API is used to modify and set Wi-Fi 802.11ax config.
Note
Implemented as global variable arrays with default config. This API can get and change one parameter and it will be restored until reboot. Then this config data can be sent to Wi-Fi. Refer to NCP_CMD_11AX_CFG_INFO for config parameter usage and length.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be at least 2. |
| in | argv | Argument vector, argv[0]: wlan-set-11axcfg argv[1]: action in string (Required) help: show helper dump: dump parameter data currently restored set: set one parameter done: configure current data to Wi-Fi argv[2]: parameter name (Required when action is "set") argv[3]: parameter value in hexadecimal, have more argvs when value is more than one byte, like a byte array or uint16_t, uint32_t, uint16_t and uint32_t is ordered in little-endian (Required when action is "set") ... argv[x]: parameter value in hexadecimal, uint16_t and uint32_t is ordered in little-endian |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_11axcfg_response (uint8_t * res)
This API is used to process Wi-Fi 802.11ax config command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is MCU_NCPCmd_DS_COMMAND with result. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_btwt_command (int argc, char ** argv)
This API is used to modify and set Wi-Fi BTWT (broadcast target awake time) config.
Note
Implemented as global variable arrays with default config. This API can get and change one parameter and it will be restored until reboot. Then this config data can be sent to Wi-Fi. Refer to NCP_CMD_BTWT_CFG_INFO for config parameter usage and length.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be at least 2. |
| in | argv | Argument vector, argv[0]: wlan-set-btwt-cfg argv[1]: action in string (Required) help: show helper dump: dump parameter data currently restored set: set one parameter done: configure current data to Wi-Fi argv[2]: parameter name (Required when action is "set") argv[3]: parameter value in hexadecimal, have more argvs when value is more than one byte, like a byte array or uint16_t, uint32_t, uint16_t and uint32_t is ordered in little-endian (Required when action is "set") ... argv[x]: parameter value in hexadecimal, uint16_t and uint32_t is ordered in little-endian |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_btwt_response (uint8_t * res)
This API is used to process BTWT command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is MCU_NCPCmd_DS_COMMAND with result. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_twt_setup_command (int argc, char ** argv)
This API is used to modify and set TWT (target awake time) config.
Note
Implemented as global variable arrays with default config. This API can get and change one parameter and it will be restored until reboot. Then this config data can be sent to Wi-Fi. Refer to NCP_CMD_TWT_SETUP_CFG for config parameter usage and length.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be at least 2. |
| in | argv | Argument vector, argv[0]: wlan-twt-setup argv[1]: action in string (Required) help: show helper dump: dump parameter data currently restored set: set one parameter done: configure current data to Wi-Fi argv[2]: parameter name (Required when action is "set") argv[3]: parameter value in hexadecimal, have more argvs when value is more than one byte, like a byte array or uint16_t, uint32_t, uint16_t and uint32_t is ordered in little-endian (Required when action is "set") ... argv[x]: parameter value in hexadecimal, uint16_t and uint32_t is ordered in little-endian |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_twt_setup_response (uint8_t * res)
This API is used to process the response for the TWT setup command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is MCU_NCPCmd_DS_COMMAND with result. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_twt_teardown_command (int argc, char ** argv)
This API is used to modify and set TWT teardown config.
Note
Implemented as global variable arrays with default config. This API can get and change one parameter and it will be restored until reboot. Then this config data can be sent to Wi-Fi. Refer to NCP_CMD_TWT_TEARDOWN_CFG for config parameter usage and length.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be at least 2. |
| in | argv | Argument vector, argv[0]: wlan-twt-teardown argv[1]: action in string (Required) help: show helper dump: dump parameter data currently restored set: set one parameter done: configure current data to Wi-Fi argv[2]: parameter name (Required when action is "set") argv[3]: parameter value in hexadecimal, have more argvs when value is more than one byte, like a byte array or uint16_t, uint32_t, uint16_t and uint32_t is ordered in little-endian (Required when action is "set") ... argv[x]: parameter value in hexadecimal, uint16_t and uint32_t is ordered in little-endian |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_twt_teardown_response (uint8_t * res)
This API is used to process the response for the set TWT teardown command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is MCU_NCPCmd_DS_COMMAND with result. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_get_twt_report_command (int argc, char ** argv)
This API is used to get TWT report information.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-get-twt-report |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_twt_report_response (uint8_t * res)
This API is used to process the TWT report command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_TWT_REPORT. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_11d_enable_command (int argc, char ** argv)
This API is used to enable or disable Wi-Fi 802.11d feature.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 3. |
| in | argv | Argument vector, argv[0]: wlan-set-11d-enable argv[1]: mode in string, sta: staion, uap: soft AP argv[2]: state, 0: disable, 1: enable |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_11d_enable_response (uint8_t * res)
This API is used to process the set 802.11d feature state command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is MCU_NCPCmd_DS_COMMAND with result. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_region_code_command (int argc, char ** argv)
This API is used to set or get the Wi-Fi region code.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2 or 3. |
| in | argv | Argument vector, argv[0]: wlan-region-code argv[1]: action in string, get/set (Required) argv[2]: region code value to set (Required when action is "set") |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_region_code_response (uint8_t * res)
This API is used to process the response for the get/set region code command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_REGION_CODE_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_get_temperature_command (int argc, char ** argv)
This API is used to get the device temperature.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-get-temp |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_get_temperature_response (uint8_t * res)
This API is used to process the response for the get temperature command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_TEMPERATURE. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_time_command (int argc, char ** argv)
This API is used to set device time, the time includes year, month, day, hour, minute and second.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 7. |
| in | argv | Argument vector, argv[0]: wlan-set-time argv[1]: year argv[2]: month argv[3]: day argv[4]: hour argv[5]: minute argv[6]: second |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_get_time_command (int argc, char ** argv)
This API is used to get device time in date.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-get-time |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_time_response (uint8_t * res)
This API is used to process the response for the get time command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_DATE_TIME_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_roaming_command (int argc, char ** argv)
This API is used to set soft roaming configuration.
Call this API to enable/disable soft roaming by specifying the RSSI threshold.
Note
RSSI Threshold setting for soft roaming : The provided RSSI low threshold value is used to subscribe RSSI low event from firmware. On reception of this event, background scan is started in firmware with same RSSI threshold, to find out APs with better signal strength than RSSI threshold.
If AP is found then roam attempt is initiated, otherwise the background scan is started again until limit reaches to BG_SCAN_LIMIT.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 3. |
| in | argv | Argument vector. argv[0]: wlan-roaming argv[1]: string value of enable/disable roaming (Required) 0 – disable 1 – enable argv[2]: string value of RSSI low threshold (Optional) Default value is 70 |
Returns
WM_SUCCESS if the call was successful.
-WM_FAIL if failed.
int wlan_process_roaming_response (uint8_t * res)
This API is used to process the response for the roaming command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS.
int wlan_multi_mef_command (int argc, char ** argv)
This API is used to set/delete the MEF (memory efficient filtering) entries configuration.
Note
Use this API with command wlan-mcu-sleep with wakeup method MEF. Make sure to have connection on STA interface or start UAP.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 3. |
| in | argv | Argument vector. argv[0]: wlan-multi-mef argv[1]: Packet type string (Required) ping -– Add MEF entry for ping packets arp -– Add MEF entry for ARP packets multicast -– Add MEF entry for multicast packets ns -– Add MEF entry for IPV6 NS packets del -– Delete all MEF entries argv[2]: Sting value of action (Required) 0 –- Discard and not wakeup host 1 –- Discard and wakeup host 3 –- Allow and wakeup host |
Note
argv[2] is not needed if argv[1] is del.
Returns
WM_SUCCESS if the call was successful.
-WM_FAIL if failed.
int wlan_process_multi_mef_response (uint8_t * res)
This API is used to process multi MEF response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS.
int wlan_wakeup_condition_command (int argc, char ** argv)
This API is used to configure Wi-Fi wakeup conditions. Once any condition is meet, NCP device will be woken up by Wi-Fi. Some of the wakeup conditions needs connection on station or uAP.
Note
Use this API with wlan_multi_mef_command if MEF mode is used.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 3. |
| in | argv | Argument vector. argv[0]: wlan-wakeup-condition argv[1]: String of wakeup mode (Required) wowlan –- Default wakeup conditions mef –- MEF conditions argv[2]: String of wakeup bitmap for mode wowlan bit[0] – WAKE_ON_ALL_BROADCAST bit[1] – WAKE_ON_UNICAST bit[2] – WAKE_ON_MAC_EVENT bit[3] – WAKE_ON_MULTICAST bit[4] – WAKE_ON_ARP_BROADCAST bit[6] – WAKE_ON_MGMT_FRAME |
Note
The argv[2] is only required when argv[1] is wowlan.
If argv[1] is wowlan and all bits of argv[2] are 0, NCP device won’t be woken up by Wi-Fi.
Returns
WM_SUCCESS if the call was successful.
-WM_FAIL if failed.
int wlan_process_wakeup_condition_response (uint8_t * res)
This API is used to process the response for the configure Wi-Fi wakeup condition command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS.
int wlan_suspend_command (int argc, char ** argv)
This API is used to request NCP device enter specific low power mode.
Note
Should be used after API ncp_mcu_sleep_command with manual mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-suspend argv[1]: String value of low power mode 1 – PM1 2 – PM2 3 – PM3 |
Note
The allowed low power mode is controlled by configuration of ncp_wake_cfg_command.
For INTF wake mode, the allowed <power_mode> are PM1 and PM2.
For GPIO wake mode and RDRW612 as NCP device, the allowed <power_mode> are PM1, PM2 and PM3.
For GPIO wake mode and FRDMRW612 as NCP device, the allowed <power_mode> are PM1 and PM2.
For WIFI-NB wake mode and FRDRW612 as NCP device, the allowed <power_mode> are PM1, PM2 and PM3.
Returns
WM_SUCCESS if the call was successful.
-WM_FAIL if failed.
int wlan_process_suspend_response (uint8_t * res)
This API is used to process suspend response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS.
int wlan_deep_sleep_ps_command (int argc, char ** argv)
This API is used to enable/disable deep sleep power save mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-deep-sleep-ps argv[1]: enable/disable deep sleep power save mode. 0 – disable deep sleep 1 – enable deep sleep |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Deep sleep power save is enabled by default.
int wlan_process_deep_sleep_ps_response (uint8_t * res)
This API is used to process the response for the deep sleep power save mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_ieee_ps_command (int argc, char ** argv)
This API is used to enable/disable ieee power save mode.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: wlan-ieee-ps argv[1]: enable/disable ieee power save mode. 0 – disable ieee power save mode 1 – enable ieee power save mode |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
Note
Ieee power save is enabled by default.
int wlan_process_ieee_ps_response (uint8_t * res)
This API is used to process the response for the enable/disable ieee power save mode command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS
int wlan_socket_open_command (int argc, char ** argv)
This API is used to create a socket.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 4. |
| in | argv | Argument vector, argv[0]: wlan-socket-open argv[1]: string value of socket_type (Required) tcp – TCP socket udp – UDP socket raw – raw socket argv[2]: string value of socket domain (Optional) ipv4 – default is ipv4 domain ipv6 – ipv6 domain argv[3]: string value of socket procotol (Optional) icmp – default is icmp protocol icmpv6 – icmpv6 protocol |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_open_response (uint8_t * res)
This API is used to process the socket open command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_SOCKET_OPEN_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_con_command (int argc, char ** argv)
This API is used to connect peer socket.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 4. |
| in | argv | Argument vector, argv[0]: wlan-socket-connect argv[1]: string value of peer socket fd to connect (Required) argv[2]: string value of peer socket ipv4 address to connect, so far only support IPV4 address (Required) argv[3]: string value of peer socket port (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_con_response (uint8_t * res)
This API is used to process the socket connect command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_bind_command (int argc, char ** argv)
This API is used to bind socket.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 2 to 4. |
| in | argv | Argument vector, argv[0]: wlan-socket-bind argv[1]: string value of socket fd to bind (Required) argv[2]: string value of socket ipv4 address to connect, so far only support IPV4 address (Required) argv[3]: string value of socket port (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_bind_response (uint8_t * res)
This API is used to process socket bind command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_close_command (int argc, char ** argv)
This API is used to close the opened socket.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-socket-close argv[1]: string value of opened socket fd to close (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_close_response (uint8_t * res)
This API is used to process the response for the socket close command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_listen_command (int argc, char ** argv)
This API is used to listen TCP client’s connection.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 3. |
| in | argv | Argument vector, argv[0]: wlan-socket-listen argv[1]: string value of opened socket fd to listen (Required) argv[2]: string value of listen maximum number (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_listen_response (uint8_t * res)
This API is used to process the response for the socket listen command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_accept_command (int argc, char ** argv)
This API is used to accept the TCP server’s connection.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2, |
| in | argv | Argument vector, argv[0]: wlan-socket-accept argv[1]: string value of TCP server listen socket fd (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_accept_response (uint8_t * res)
This API is used to process the response for the socket accept command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_SOCKET_ACCEPT_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_send_command (int argc, char ** argv)
This API is used to send data.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 3 to 4. |
| in | argv | Argument vector, argv[0]: wlan-socket-send argv[1]: string value of socket fd, use the socket to send data (Required) argv[2]: string value of send data , the max send data buffer is 4076. (Required) argv[3]: string value of send data size, we can specify send data size (Optional) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_send_response (uint8_t * res)
This API is used to process socket send command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_sendto_command (int argc, char ** argv)
This API is used to send data to specified IP and port.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 6 to 7. |
| in | argv | Argument vector, argv[0]: wlan-socket-sendto argv[1]: int value of socket fd, use the socket to send data (Required) argv[2]: string value of peer ip addr, the max length is 16 (Required) argv[3]: string value of peer socket port (Required) argv[4]: string value of send data, the max length is 4056 (Required) argv[5]: string value of send data size, we can specify send data size (Optional) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_sendto_response (uint8_t * res)
This API is used to process the socket send command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response, Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_receive_command (int argc, char ** argv)
This API is used to receive data from socket.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-socket-receive argv[1]: string value of socket fd, receive data from the socket fd (Required) argv[2]: string value of receive size, the buffer max length is 4072 (Required) argv[3]: string value of wait time, return fail when timemout (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_receive_response (uint8_t * res)
This API is used to process the socket receive command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_SOCKET_RECEIVE_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_socket_recvfrom_command (int argc, char ** argv)
This API is used to receive data from socket and return peer socket ip and port.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-socket-recvfrom argv[1]: string value of socket fd, receive data from the socket fd (Required) argv[2]: string value of receive size, the buffer max length is 4072 (Required) argv[3]: string value of wait time, return fail when timemout (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_socket_recvfrom_response (uint8_t * res)
This API is used to process the socket recvfrom command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_SOCKET_RECVFROM_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_http_connect_command (int argc, char ** argv)
This API is used to connect the HTTP server.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 3. |
| in | argv | Argument vector, argv[0]: wlan-http-connect argv[1]: string value of http handle to connect, (Required) argv[2]: string value of http server host address, the string max length is 512 (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_http_con_response (uint8_t * res)
This API is used to process the HTTP connect command response.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_HTTP_CON_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_http_disconnect_command (int argc, char ** argv)
This API is used to disconnect the HTTP server.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 2. |
| in | argv | Argument vector, argv[0]: wlan-http-disconnect argv[1]: string value of http handle to disconnect, (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_http_discon_response (uint8_t * res)
This API is used to process the response for the HTTP disconnect command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_http_req_command (int argc, char ** argv)
This API is used to send request to the HTTP server.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 4 to 6. |
| in | argv | Argument vector, argv[0]: wlan-http-req argv[1]: int value of http handle to send http request (Required) argv[2]: string value of http method, the max length is 16 (Required) get – http request get method delete – http request delete method put – http request put method options – http request options method argv[3]: string value of http URL, the string max length is 512 (Required) argv[4]: string value of http send data, the buffer max length is 3560 (Optional) argv[5]: string value of http send data size (Optional) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_http_req_response (uint8_t * res)
This API is used to process the response for the HTTP request.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_HTTP_REQ_RESP_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_http_recv_command (int argc, char ** argv)
This API is used to receive the HTTP server data.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-http-receive argv[1]: string value of http handle to receive http data (Required) argv[2]: string value of http received data, the buffer max length is 4072. (Required) argv[3]: string value of http wait time, return fail when timemout (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure
int wlan_process_wlan_http_recv_response (uint8_t * res)
This API is used to process the response for the HTTP receive command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_HTTP_RECV_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_http_unseth_command (int argc, char ** argv)
This API is used to unset the HTTP request header.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-http-unseth argv[1]: string http header segment name, the max length is 64 (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_http_unseth_response (uint8_t * res)
This API is used to process the response for the HTTP unset header command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_http_seth_command (int argc, char ** argv)
This API is used to set the HTTP request header.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-http-seth argv[1]: string value of segment name of the header, the max length is 64 (Required) argv[2]: string value of segment value of the header, the max length is 128 (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_http_seth_response (uint8_t * res)
This API is used to process the response for the set HTTP header command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_websocket_upg_command (int argc, char ** argv)
This API is used to upgrade the HTTP to websocket.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-websocket-upg argv[1]: string value of http handle (Required) argv[2]: string value of websocket URI (Required) /ws/ – websocket uri is /ws/ argv[3]: string value of websocket type (Required) echo – websocket type is echo |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_websocket_upg_response (uint8_t * res)
This API is used to process the response for the websocket upgrade command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success otherwise return -WM_FAIL.
int wlan_websocket_send_command (int argc, char ** argv)
This API is used to send data to the websocket server.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 4 to 5. |
| in | argv | Argument vector, argv[0]: wlan-websocket-send argv[1]: string value of http handle upgraded to websocket (Required) argv[2]: string value of websocket type (Required) text – websocket text type data bin – websocket bin type data argv[3]: string value of send data, the buffer max length is 4060. (Required) argv[4]: string value of send data size (Optional) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_websocket_send_response (uint8_t * res)
This API is used to process the response for the websocket send data command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NULL. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_websocket_recv_command (int argc, char ** argv)
This API is used to receive data from the websocket server.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 4. |
| in | argv | Argument vector, argv[0]: wlan-websocket-recv argv[1]: string value of http handle to receive websocket data (Required) argv[2]: string value of websocket received data, the buffer max length is 4068. (Required) argv[3]: string value of websocket wait time, return fail when timemout (Required) |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_wlan_websocket_recv_response (uint8_t * res)
This API is used to process the response for the websocket receive data command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body is NCP_CMD_WEBSOCKET_RECV_CFG. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
void ncp_network_commissioning (ncp_commission_cfg_t * ncp_commission_cfg)
This API is used to the Wi-Fi receive commission information from Bluetooth LE.
Parameters
| in | ncp_commission_cfg | A pointer to ncp_commission_cfg_t from Bluetooth LE. |
int wlan_11k_neighbor_req_command (int argc, char ** argv)
This API is used to send the neighbor report request.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 1 or 2. |
| in | argv | Argument vector. argv[0]: should be "wlan-11k-neigbor-req". argv[1]: string value of the SSID for neighbor report (Required). |
Note
ssid parameter is optional
Returns
WM_SUCCESS if successful.
-WM_FAIL if failure.
int wlan_process_neighbor_req_response (uint8_t * res)
This API is used to process the response of the send neighbor report request.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_11k_cfg_command (int argc, char ** argv)
This API is used to enable or disable the 802.11k feature in Wi-Fi firmware.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: should be "wlan-11k-enable". argv[1]: string value of enable or disable 802.11k feature. 0: disable 802.11k feature. 1: enable 802.11k feature. |
Note
802.11k is disabled by default.
Returns
WM_SUCCESS if successful.
-WM_FAIL if failure.
int wlan_process_11k_cfg_response (uint8_t * res)
This API is used to process the command response of enable or disable 802.11k feature command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_csi_cfg_command (int argc, char ** argv)
This API is used to set the CSI configuration.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: should be "wlan-csi-cfg". |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_csi_response (uint8_t * res)
This API is used to process the response for the set CSI configuration command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_set_csi_param_header_command (int argc, char ** argv)
This API is used to set CSI header part of parameters.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 10. |
| in | argv | Argument vector. argv[0]: should be "wlan-set-csi-param-header". argv[1]: string value of bss type "sta": bss type is station "uap": bss type is UAP. argv[2]: string value of enable or disable csi. 1: enable csi 0: disable csi argv[3]: string value of head id head id is symbol placed at start of csi data used to separate CSI event records received from FW, could be set as any value. argv[4]: string value of tail id tail id is symbol placed at end of csi data used to separate CSI event records received from FW, could be set as any value. argv[5]: string value of chip id used to separate CSI event records received from FW, could be set as any value. argv[6]: band configure properties of csi channel bit[0:1]: Band Info 00: 2.4GHz 01: 5GHz bit[2:3]: chan Width 00: 20MHz 10: 40MHz 11: 80MHz bit[4:5]: chan to Offset 00: None 10: Above 11: Below bit[6:7]: scan Mode 00: manual 10: ACS. argv[7]: string value of channel number. argv[8]: string value of enable or disable csi monitor feature 1: enable csi monitor 0: disable csi monitor. argv[9]: string value of enable or disable csi ra for us feature 1: enable csi ra for us 0: disable csi ra for us. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_csi_filter_command (int argc, char ** argv)
This API is used to set the filter for CSI.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 2 or 6. 2: action for filter is delete, clear and dump 6: action for filter is add. |
| in | argv | Argument vector. argv[0]: should be "wlan-set-csi-filter". argv[1]: string value of action for filter "add": add one filter to CSI filter "delet": delete last filter entry of CSI filter "clear": clear all entries of CSI filter "dump": dump all entries of CSI filter. argv[2]: string value of mac address, format like 11:22:33:44:55:66. argv[3]: string value of 802.11 frame control filed type. argv[4]: string value of 802.11 frame control filed subtype. argv[5]: string value of flag bit[0]: reserved, must be set to 0 bit[1]: wait for trigger, not implement currently, must be set to 0 bit[2]: send CSI error event when timeout, not implement currently, must be set to 0. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_net_monitor_cfg_command (int argc, char ** argv)
This API is used to set the monitor configuration.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: should be "wlan-net-monitor-cfg" |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_monitor_response (uint8_t * res)
This API is used to process the response of the set monitor configuration command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body: None. |
Returns
WM_SUCCESS if success.
int wlan_set_monitor_filter_command (int argc, char ** argv)
This API is used to set the filter for monitor.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 2 or 3. 2: action for filter is delete, clear and dump 3: action for filter is add. |
| in | argv | Argument vector. argv[0]: should be "wlan-set-monitor-filter". argv[1]: string value of action for filter "add": add one filter to monitor filter "delet": delete last filter entry of monitor filter "clear": clear all entries of monitor filter "dump": dump all entries of monitor filter. argv[2]: string value of mac address, format like 11:22:33:44:55:66 |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_set_monitor_param_command (int argc, char ** argv)
This API is used to set the monitor parameters.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 6. |
| in | argv | Argument vector. argv[0]: should be "wlan-set-monitor-param". argv[1]: string value of action 1: action set. argv[2]: string value of enable or disable monitor 1: enable monitor other values: disable monitor. argv[3]: string value of filter flags bit[0]: enable or disable management frame 1: enable management frame 0: disable management frame bit[1]: enable or disable control frame 1: enable control frame 0: disable control frame bit[2]: enable or disable data frame 1: enable data frame 0: disable data frame. argv[4]: string value of radio type properties of monitor channel bit[0:1]: Band Info 00: 2.4GHz 01: 5GHz bit[2:3]: chan Width 00: 20MHz 10: 40MHz 11: 80MHz bit[4:5]: chan to Offset 00: None 10: Above 11: Below bit[6:7]: scan Mode 00: manual 10: ACS. argv[5]: string value of channel number |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_address_command (int argc, char ** argv)
This API is used to get IP address of the station.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should be 1. |
| in | argv | Argument vector, argv[0]: wlan-address |
Returns
WM_SUCCESS if success.
int wlan_process_address (uint8_t * res)
This API is used to process the response for the get STA IP address command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_NETWORK_ADDRESS. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_start_network_command (int argc, char ** argv)
This API is used to start a UAP.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: should be "wlan-start-network". argv[1]: string value of network name. |
Returns
WM_SUCCESS if successful.
-WM_FAIL if failure.
int wlan_process_start_network_response (uint8_t * res)
This API is used to process the response for the start UAP network command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_NETWORK_START. |
Returns
WM_SUCCESS if UAP starts successfully.
-WM_FAIL if failure.
int wlan_stop_network_command (int argc, char ** argv)
This API is used to stop a UAP network.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: should be "wlan-stop-netwok". |
Returns
WM_SUCCESS.
int wlan_process_stop_network_response (uint8_t * res)
This API is used to process the response for the stop UAP network command.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. |
Returns
WM_SUCCESS.
int wlan_get_uap_sta_list_command (int argc, char ** argv)
This API is used to get the information for all STAs those connected to an AP.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: should be "wlan-get-uap-sta-list". |
Returns
WM_SUCCESS if UAP starts successfully.
-WM_FAIL if failure.
int wlan_process_get_uap_sta_list (uint8_t * res)
This API is used to process the information for all STAs those connected to an AP.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_NETWORK_UAP_STA_LIST. |
Returns
WM_SUCCESS.
int wlan_list_command (int argc, char ** argv)
This API is used to get all the networks information those added locally.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 1. |
| in | argv | Argument vector. argv[0]: should be "wlan-list". |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_process_network_list_response (uint8_t * res)
This API is used to process information of all the network those added locally.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_NETWORK_LIST. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_remove_command (int argc, char ** argv)
This API is used to remove an AP from the local network list.
Parameters
| in | argc | Argument count, the number of string pointed to by argv, argc should be 2. |
| in | argv | Argument vector. argv[0]: should be "wlan-remove". argv[1]: string value of network name. |
Returns
WM_SUCCESS if successful.
-WM_FAIL if failure.
int wlan_process_network_remove_response (uint8_t * res)
This API is used to process the removed AP information.
Parameters
| in | res | A pointer to MCU_NCPCmd_DS_COMMAND response. Response body refer to NCP_CMD_NETWORK_REMOVE. |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure.
int wlan_ncp_iperf_command (int argc, char ** argv)
This is a private NCP throughput test API that needs to play with sample TCP/UDP server/client, and could not play with open source iperf.
Parameters
| in | argc | Argument count, the number of strings pointed to by argv, argc should range from 5 to 9. |
| in | argv | Argument vector, argv[0]: wlan-ncp-iperf argv[1]: string value of socket handle index opended (Required) argv[2]: string value of protocol type, "tcp" or "udp". (Required) argv[3]: string value of data direction, "tx"(send) or "rx"(receive) (Required) argv[4]: string value of packet count for TCP or string value of peer IP address for UDP (Required) argv[5]: string value of peer port number for UDP (Required) argv[6]: string value of packet count except to receive or send for UDP (Required) argv[7]: string value of data rate for UDP (Required) argv[8]: string value of duration for UDP (Optional). |
Returns
WM_SUCCESS if success.
-WM_FAIL if failure
Macro Documentation
#define MLAN_MAX_VER_STR_LEN 128
Maximum length of firmware software version string.
#define MLAN_MAC_ADDR_LENGTH 6
MAC address length.
#define WLAN_NETWORK_NAME_MAX_LENGTH 32
Maximum length of network name.
The space reserved for storing network names
#define IDENTITY_MAX_LENGTH 64
Maximum length of identity string .
#define PASSWORD_MAX_LENGTH 128
Maximum length of password string .
#define MAX_NUM_CLIENTS 16
Maximum number of STAs are connected to the UAP.
#define CSI_FILTER_MAX 16
Maximum CSI filter count
#define NCP_IPERF_END_TOKEN_SIZE 11
Size of iperf end token.
#define WLAN_NETWORK_NAME_MAX_LENGTH 32
Maximum length of network name.
The space reserved for storing network names
#define DNS_RRTYPE_A 1
A host address
#define DNS_RRTYPE_PTR 12
A domain name pointer
#define WLAN_PASSWORD_MAX_LENGTH 255
Wi-Fi password maximum length
Enumeration Type Documentation
enum wlan_bss_role
Network wireless BSS role.
Enumerator:
| WLAN_BSS_ROLE_STA | Infrastructure network. The system will act as a station connected to an Access Point. |
| WLAN_BSS_ROLE_UAP | UAP network. The system will act as an UAP node to which other Wireless clients can connect. |
| WLAN_BSS_ROLE_ANY | Either infrastructure network or UAP network |
enum wlan_security_type
WLAN network security type
Enumerator:
| WLAN_SECURITY_NONE | The network does not use security. |
| WLAN_SECURITY_WEP_OPEN | The network uses WEP (wired equivalent privacy) security with open key. |
| WLAN_SECURITY_WEP_SHARED | The network uses WEP security with shared key. |
| WLAN_SECURITY_WPA | The network uses WPA (Wi-Fi protected access) security with PSK. |
| WLAN_SECURITY_WPA2 | The network uses WPA2 (Wi-Fi protected access 2) security with PSK. |
| WLAN_SECURITY_WPA_WPA2_MIXED | The network uses WPA/WPA2 mixed security with PSK |
| WLAN_SECURITY_WPA2_FT | The network uses WPA2 security with PSK (pre-shared key) FT (fast BSS transition). |
| WLAN_SECURITY_WPA3_SAE | The network uses WPA3 security with SAE (simultaneous authentication of equals). |
| WLAN_SECURITY_WPA3_FT_SAE | The network uses WPA3 security with SAE FT. |
| WLAN_SECURITY_WPA3_SAE_EXT_KEY | The network uses WPA3 security with SAE EXT KEY. |
| WLAN_SECURITY_WPA2_WPA3_SAE_MIXED | The network uses WPA2/WPA3 SAE mixed security with PSK. This security mode is specific to uAP or SoftAP only |
| WLAN_SECURITY_OWE_ONLY | The network uses OWE only security without transition mode support. |
| WLAN_SECURITY_EAP_TLS | The network uses WPA2 Enterprise EAP-TLS (extensible authentication protocol transport layer security). The identity field in wlan_network structure is used |
| WLAN_SECURITY_EAP_TLS_SHA256 | The network uses WPA2 enterprise EAP-TLS SHA256 security The identity field in wlan_network structure is used |
| WLAN_SECURITY_EAP_TLS_FT | The network uses WPA2 Enterprise EAP-TLS FT security The identity field in wlan_network structure is used |
| WLAN_SECURITY_EAP_TLS_FT_SHA384 | The network uses WPA2 Enterprise EAP-TLS FT SHA384 security The identity field in wlan_network structure is used |
| WLAN_SECURITY_EAP_PEAP_MSCHAPV2 | The network uses WPA2 Enterprise EAP-PEAP-MSCHAPV2 security The anonymous identity, identity and password fields in wlan_network structure are used |
| WLAN_SECURITY_WILDCARD | The network can use any security method. This is often used when the user only knows the name and passphrase but not the security type. |
anonymous enum
Enumerator:
| ADDR_TYPE_STATIC | static IP address |
| ADDR_TYPE_DHCP | Dynamic IP address |
| ADDR_TYPE_LLA | Link level address |
enum wlan_ps_mode
Station power save mode.
Enumerator:
| WLAN_ACTIVE | Active mode. |
| WLAN_IEEE | IEEE power save mode. |
| WLAN_DEEP_SLEEP | Deep sleep power save mode. |
| WLAN_IEEE_DEEP_SLEEP | IEEE deep sleep power save mode. |
| WLAN_WNM | WNM power save mode. |
| WLAN_WNM_DEEP_SLEEP | WNM deep sleep power save mode. |
enum wlan_connection_state
Wi-Fi station/UAP/Wi-Fi direct connection/status state.
Enumerator:
| WLAN_DISCONNECTED | The Wi-Fi connection manager is not connected and no connection attempt is in progress. It is possible to connect to a network or scan. |
| WLAN_CONNECTING | The Wi-Fi connection manager is not connected but it is currently attempting to connect to a network. It is not possible to scan at this time. It is possible to connect to a different network. |
| WLAN_ASSOCIATED | The Wi-Fi connection manager is not connected but associated. |
| WLAN_AUTHENTICATED | The Wi-Fi connection manager is not connected but authenticated. |
| WLAN_CONNECTED | The Wi-Fi connection manager is connected. It is possible to scan and connect to another network at this time. Information about the current network configuration is available. |
| WLAN_UAP_STARTED | The Wi-Fi connection manager has started UAP |
| WLAN_UAP_STOPPED | The Wi-Fi connection manager has stopped UAP |
| WLAN_SCANNING | The Wi-Fi connection manager is not connected and network scan is in progress. |
| WLAN_ASSOCIATING | The Wi-Fi connection manager is not connected and network association is in progress. |
otopcode.h File Reference
This file provides interface to get Open Thread commands corresponding opcode.
Function Documentation
int8_t ot_get_opcode (uint8_t * userinputcmd, uint8_t otcmdlen)
Get OpenThread commands corresponding opcode. This function search OT command list to find command’s opcode.
Parameters
| in | userinputcmd | user input OT command. |
| in | otcmdlen | OT command length. |
Returns
opcode of the command.
service.h File Reference
Bluetooth service definitions.
Function Documentation
static void sys_put_le16 (uint16_t val, uint8_t dst[2])[inline], [static]
Put a 16-bit integer as little-endian to arbitrary location.
Put a 16-bit integer, originally in host endianness, to a potentially unaligned memory location in little-endian format.
Parameters
| in | val | 16-bit integer in host endianness. |
| in,out | dst | Destination memory address to store the result. |
Returns
void
static void sys_put_le32 (uint32_t val, uint8_t dst[4])[inline], [static]
Put a 32-bit integer as little-endian to arbitrary location.
Put a 32-bit integer, originally in host endianness, to a potentially unaligned memory location in little-endian format.
Parameters
| in | val | 32-bit integer in host endianness. |
| in,out | dst | Destination memory address to store the result. |
Returns
void
static void sys_put_le24 (uint32_t val, uint8_t dst[3])[inline], [static]
Put a 24-bit integer as little-endian to arbitrary location.
Put a 24-bit integer, originally in host endianness, to a potentially unaligned memory location in little-endian format.
Parameters
| in | val | 24-bit integer in host endianness. |
| in,out | dst | Destination memory address to store the result. |
Returns
void
static uint16_t sys_get_le16 (const uint8_t src[2])[inline], [static]
Get a 16-bit integer stored in little-endian format.
Get a 16-bit integer, stored in little-endian format in a potentially unaligned memory location, and convert it to the host endianness.
Parameters
| in,out | src | Location of the little-endian 16-bit integer to get. |
Returns
16-bit integer in host endianness.
static uint32_t sys_get_le32 (const uint8_t src[4])[inline], [static]
Get a 32-bit integer stored in little-endian format.
Get a 32-bit integer, stored in little-endian format in a potentially unaligned memory location, and convert it to the host endianness.
Parameters
| in,out | src | Location of the little-endian 32-bit integer to get. |
Returns
32-bit integer in host endianness.
static uint32_t sys_get_le24 (const uint8_t src[3])[inline], [static]
Get a 24-bit integer stored in little-endian format.
Get a 24-bit integer, stored in little-endian format in a potentially unaligned memory location, and convert it to the host endianness.
Parameters
| in,out | src | Location of the little-endian 24-bit integer to get. |
Returns
24-bit integer in host endianness.
Macro Documentation
#define NCP_BLE_SERVICE_PRIO 0
NCP Bluetooth LE priority
#define BT_BYTES_LIST_LE16( _v)
Value: (((_v) >> 0) & 0xFFU), \
(((_v) >> 8) & 0xFFU) \
NCP Bluetooth LE inline tool function
#define HOST_GATT_ATTRIBUTE( _type, _uuid, _props, _perm)
Value:{ \
.type = _type, \
.uuid = {BT_BYTES_LIST_LE16(_uuid)}, \
.uuid_length = BT_UUID_SIZE_16, \
.properties = _props, \
.permissions = _perm, \
}
NCP host set gatt attribute configuration
#define NCP_BLE_HOST_SERVICE_AUTO_START
Auto register host services into ncp device database
#define BT_GATT_CHRC_BROADCAST 0x01
Characteristic Properties Bit field values Bluetooth GATT Characteristic broadcast property.
If set, permits broadcasts of the Characteristic Value using Server Characteristic Configuration Descriptor.
#define BT_GATT_CHRC_READ 0x02
Bluetooth GATT Characteristic read property.
If set, permits reads of the Characteristic Value.
#define BT_GATT_CHRC_WRITE_WITHOUT_RESP 0x04
Bluetooth GATT Characteristic write without response property.
If set, permits write of the Characteristic Value without response.
#define BT_GATT_CHRC_WRITE 0x08
Bluetooth GATT Characteristic write with response property.
If set, permits write of the Characteristic Value with response.
#define BT_GATT_CHRC_NOTIFY 0x10
Bluetooth GATT Characteristic notify property.
If set, permits notifications of a Characteristic Value without acknowledgment.
#define BT_GATT_CHRC_INDICATE 0x20
Bluetooth GATT Characteristic indicate property.
If set, permits indications of a Characteristic Value with acknowledgment.
#define BT_GATT_CHRC_AUTH 0x40
Bluetooth GATT Characteristic Authenticated Signed Writes property.
If set, permits signed writes to the Characteristic Value.
#define BT_GATT_CHRC_EXT_PROP 0x80
Bluetooth GATT Characteristic Extended Properties.
If set, additional characteristic properties are defined in the Characteristic Extended Properties Descriptor.
#define BT_GATT_PERM_NONE 0x0000
GATT attribute permission bit field values No operations supported, e.g. for notify-only
#define BT_GATT_PERM_READ 0x0001
Attribute read permission.
#define BT_GATT_PERM_WRITE 0x0002
Attribute write permission.
#define BT_GATT_PERM_READ_ENCRYPT 0x0004
Attribute read permission with encryption.
If set, requires encryption for read access.
#define BT_GATT_PERM_WRITE_ENCRYPT 0x0008
Attribute write permission with encryption.
If set, requires encryption for write access.
#define BT_GATT_PERM_READ_AUTHEN 0x0010
Attribute read permission with authentication.
If set, requires encryption using authenticated link-key for read access.
#define BT_GATT_PERM_WRITE_AUTHEN 0x0020
Attribute write permission with authentication.
If set, requires encryption using authenticated link-key for write access.
#define BT_GATT_PERM_PREPARE_WRITE 0x0040
Attribute prepare write permission.
If set, allows prepare writes with use of BT_GATT_WRITE_FLAG_PREPARE passed to write callback.
#define BT_GATT_PERM_READ_LESC 0x0080
Attribute read permission with LE Secure Connection encryption.
If set, requires that LE Secure Connections is used for read access.
#define BT_GATT_PERM_WRITE_LESC 0x0100
Attribute write permission with LE Secure Connection encryption.
If set, requires that LE Secure Connections is used for write access.
#define BT_GATT_CCC_NOTIFY 0x0001
Client Characteristic Configuration Values Bluetooth GATT Client Characteristic Configuration notification.
If set, changes to Characteristic Value are notified.
Bluetooth GATT Client Characteristic Configuration values Bluetooth GATT Client Characteristic Configuration notification
If set, changes to Characteristic Value are notified.
#define BT_GATT_CCC_INDICATE 0x0002
Bluetooth GATT Client Characteristic Configuration indication.
If set, changes to Characteristic Value are indicated.
Bluetooth GATT Client Characteristic Configuration indication.
If set, changes to Characteristic Value are indicated.
#define UUID_GATT_PRIMARY 0x2800
GATT Primary Service UUID
#define UUID_GATT_CCC 0x2902
GATT Client Characteristic Configuration UUID
#define BT_GATT_CCC_NOTIFY 0x0001
Client Characteristic Configuration Values Bluetooth GATT Client Characteristic Configuration notification.
If set, changes to Characteristic Value are notified.
Bluetooth GATT Client Characteristic Configuration values Bluetooth GATT Client Characteristic Configuration notification
If set, changes to Characteristic Value are notified.
#define BT_GATT_CCC_INDICATE 0x0002
Bluetooth GATT Client Characteristic Configuration indication.
If set, changes to Characteristic Value are indicated.
Bluetooth GATT Client Characteristic Configuration indication.
If set, changes to Characteristic Value are indicated.
#define BT_DATA_FLAGS 0x01
EIR (Extended Inquiry Response)/AD (Advertising Data) data type definitions AD flags
#define BT_DATA_UUID16_SOME 0x02
16-bit UUID, more available
#define BT_DATA_UUID16_ALL 0x03
16-bit UUID, all listed
#define BT_DATA_UUID32_SOME 0x04
32-bit UUID, more available
#define BT_DATA_UUID32_ALL 0x05
32-bit UUID, all listed
#define BT_DATA_UUID128_SOME 0x06
128-bit UUID, more available
#define BT_DATA_UUID128_ALL 0x07
128-bit UUID, all listed
#define BT_DATA_NAME_SHORTENED 0x08
Shortened name
#define BT_DATA_NAME_COMPLETE 0x09
Complete name
#define BT_DATA_TX_POWER 0x0a
Tx Power
#define BT_DATA_SM_TK_VALUE 0x10
Security Manager TK Value
#define BT_DATA_SM_OOB_FLAGS 0x11
Security Manager OOB Flags
#define BT_DATA_SOLICIT16 0x14
Solicit UUIDs, 16-bit
#define BT_DATA_SOLICIT128 0x15
Solicit UUIDs, 128-bit
#define BT_DATA_SVC_DATA16 0x16
Service data, 16-bit UUID
#define BT_DATA_GAP_APPEARANCE 0x19
GAP appearance
#define BT_DATA_LE_BT_DEVICE_ADDRESS 0x1b
LE Bluetooth Device Address
#define BT_DATA_LE_ROLE 0x1c
LE Role
#define BT_DATA_SOLICIT32 0x1f
Solicit UUIDs, 32-bit
#define BT_DATA_SVC_DATA32 0x20
Service data, 32-bit UUID
#define BT_DATA_SVC_DATA128 0x21
Service data, 128-bit UUID
#define BT_DATA_LE_SC_CONFIRM_VALUE 0x22
LE Secure Connections Confirmation Value
#define BT_DATA_LE_SC_RANDOM_VALUE 0x23
LE Secure Connections Random Value
#define BT_DATA_URI 0x24
Uniform Resource Identifier
#define BT_DATA_LE_SUPPORTED_FEATURES 0x27
LE Supported Features
#define BT_DATA_CHANNEL_MAP_UPDATE_IND 0x28
Channel Map Update Indication
#define BT_DATA_MESH_PROV 0x29
Mesh Provisioning PDU
#define BT_DATA_MESH_MESSAGE 0x2a
Mesh Networking PDU
#define BT_DATA_MESH_BEACON 0x2b
Mesh Beacon
#define BT_DATA_BIG_INFO 0x2c
BIG Information
#define BT_DATA_BROADCAST_CODE 0x2d
Broadcast Code
#define BT_DATA_CSIS_RSI 0x2e
CSIS Random Set ID type
#define CENTRAL_HTC_SERVICE_ID 4
Device central profile service ID
Index
INDEX