Crate esp_hosted

Source
Expand description

An interface for interacting with ESP-Hosted-MCU firmware, via UART.

Re-exports§

pub use proto_data::*;
pub use rf::*;

Modules§

Rpc_
Rpc_Event_StaConnected_
Rpc_Event_StaDisconnected_
Rpc_Event_StaScanDone_
Rpc_Req_WifiInit_
Rpc_Req_WifiScanStart_
Rpc_Req_WifiSetBandwidths_
Rpc_Req_WifiSetConfig_
Rpc_Req_WifiSetCountry_
Rpc_Req_WifiSetProtocols_
Rpc_Resp_WifiApGetStaList_
Rpc_Resp_WifiGetBandwidths_
Rpc_Resp_WifiGetConfig_
Rpc_Resp_WifiGetCountry_
Rpc_Resp_WifiGetProtocols_
Rpc_Resp_WifiScanGetApRecord_
Rpc_Resp_WifiStaGetApInfo_
proto_data
Contains data types specific to the ESP-Hosted-MCU proto buffer. This contains definitions for the data types [de]serialized. They’re not automatically generated from the .proto file, and are used in our higher-level API.
rf
This module contains Wi-Fi and BLE-specific functionality.
wifi_ap_config_
wifi_ap_record_
wifi_config_
wifi_csi_info_
wifi_promiscuous_pkt_
wifi_scan_config_
wifi_scan_time_
wifi_sta_config_

Macros§

copy_le
parse_le

Structs§

ConnectedSTAList
ParsedMsg
PayloadHeader
Adapted from esp-hosted-mcu/common/esp_hosted_header.h This is at the start of the message, and is followed by the RPC header. See ESP-hosted-MCU readme, section 7.1.
Rpc
RpcId
RpcIdP
RpcP
RpcType
RpcTypeP
Rpc_Event_AP_StaConnected
Rpc_Event_AP_StaDisconnected
Rpc_Event_ESPInit
Rpc_Event_Heartbeat
Rpc_Event_StaConnected
Rpc_Event_StaDisconnected
Rpc_Event_StaScanDone
Rpc_Event_WifiEventNoArgs
Rpc_Req_ConfigHeartbeat
Rpc_Req_GetCoprocessorFwVersion
Rpc_Req_GetMacAddress
Rpc_Req_GetMode
Rpc_Req_GetPs
Rpc_Req_OTABegin
Rpc_Req_OTAEnd
Rpc_Req_OTAWrite
Rpc_Req_SetMacAddress
Rpc_Req_SetMode
Rpc_Req_SetPs
Rpc_Req_WifiApGetStaAid
Rpc_Req_WifiApGetStaList
Rpc_Req_WifiClearApList
Rpc_Req_WifiClearFastConnect
Rpc_Req_WifiConnect
Rpc_Req_WifiDeauthSta
Rpc_Req_WifiDeinit
Rpc_Req_WifiDisconnect
Rpc_Req_WifiGetBand
Rpc_Req_WifiGetBandMode
Rpc_Req_WifiGetBandwidth
Rpc_Req_WifiGetBandwidths
Rpc_Req_WifiGetChannel
Rpc_Req_WifiGetConfig
Rpc_Req_WifiGetCountry
Rpc_Req_WifiGetCountryCode
Rpc_Req_WifiGetMaxTxPower
Rpc_Req_WifiGetProtocol
Rpc_Req_WifiGetProtocols
Rpc_Req_WifiInit
Rpc_Req_WifiRestore
Rpc_Req_WifiScanGetApNum
Rpc_Req_WifiScanGetApRecord
Rpc_Req_WifiScanGetApRecords
Rpc_Req_WifiScanStart
Rpc_Req_WifiScanStop
Rpc_Req_WifiSetBand
Rpc_Req_WifiSetBandMode
Rpc_Req_WifiSetBandwidth
Rpc_Req_WifiSetBandwidths
Rpc_Req_WifiSetChannel
Rpc_Req_WifiSetConfig
Rpc_Req_WifiSetCountry
Rpc_Req_WifiSetCountryCode
Rpc_Req_WifiSetMaxTxPower
Rpc_Req_WifiSetProtocol
Rpc_Req_WifiSetProtocols
Rpc_Req_WifiSetStorage
Rpc_Req_WifiStaGetAid
Rpc_Req_WifiStaGetApInfo
Rpc_Req_WifiStaGetNegotiatedPhymode
Rpc_Req_WifiStaGetRssi
Rpc_Req_WifiStart
Rpc_Req_WifiStop
Rpc_Resp_ConfigHeartbeat
Rpc_Resp_GetCoprocessorFwVersion
Rpc_Resp_GetMacAddress
Rpc_Resp_GetMode
Rpc_Resp_GetPs
Rpc_Resp_OTABegin
Rpc_Resp_OTAEnd
Rpc_Resp_OTAWrite
Rpc_Resp_SetMacAddress
Rpc_Resp_SetMode
Rpc_Resp_SetPs
Rpc_Resp_WifiApGetStaAid
Rpc_Resp_WifiApGetStaList
Rpc_Resp_WifiClearApList
Rpc_Resp_WifiClearFastConnect
Rpc_Resp_WifiConnect
Rpc_Resp_WifiDeauthSta
Rpc_Resp_WifiDeinit
Rpc_Resp_WifiDisconnect
Rpc_Resp_WifiGetBand
Rpc_Resp_WifiGetBandMode
Rpc_Resp_WifiGetBandwidth
Rpc_Resp_WifiGetBandwidths
Rpc_Resp_WifiGetChannel
Rpc_Resp_WifiGetConfig
Rpc_Resp_WifiGetCountry
Rpc_Resp_WifiGetCountryCode
Rpc_Resp_WifiGetMaxTxPower
Rpc_Resp_WifiGetProtocol
Rpc_Resp_WifiGetProtocols
Rpc_Resp_WifiInit
Rpc_Resp_WifiRestore
Rpc_Resp_WifiScanGetApNum
Rpc_Resp_WifiScanGetApRecord
Rpc_Resp_WifiScanGetApRecords
Rpc_Resp_WifiScanStart
Rpc_Resp_WifiScanStop
Rpc_Resp_WifiSetBand
Rpc_Resp_WifiSetBandMode
Rpc_Resp_WifiSetBandwidth
Rpc_Resp_WifiSetBandwidths
Rpc_Resp_WifiSetChannel
Rpc_Resp_WifiSetConfig
Rpc_Resp_WifiSetCountry
Rpc_Resp_WifiSetCountryCode
Rpc_Resp_WifiSetMaxTxPower
Rpc_Resp_WifiSetProtocol
Rpc_Resp_WifiSetProtocols
Rpc_Resp_WifiSetStorage
Rpc_Resp_WifiStaGetAid
Rpc_Resp_WifiStaGetApInfo
Rpc_Resp_WifiStaGetNegotiatedPhymode
Rpc_Resp_WifiStaGetRssi
Rpc_Resp_WifiStart
Rpc_Resp_WifiStop
ap_cred
wifi_action_tx_req
wifi_active_scan_time
wifi_ant_config
wifi_ant_gpio
wifi_ant_gpio_config
wifi_ap_config
wifi_ap_record
wifi_bandwidths
wifi_config
wifi_country
wifi_csi_config
wifi_csi_info
wifi_event_action_tx_status
wifi_event_ap_probe_req_rx
wifi_event_ap_wps_rg_fail_reason
wifi_event_ap_wps_rg_pin
wifi_event_ap_wps_rg_success
wifi_event_bss_rssi_low
wifi_event_ftm_report
wifi_event_roc_done
wifi_event_sta_authmode_change
wifi_event_sta_connected
wifi_event_sta_disconnected
wifi_event_sta_scan_done
wifi_event_sta_wps_er_pin
wifi_event_sta_wps_er_success
wifi_ftm_initiator_cfg
wifi_ftm_report_entry
wifi_he_ap_info
wifi_init_config
wifi_pkt_rx_ctrl
wifi_pmf_config
wifi_promiscuous_filter
wifi_promiscuous_pkt
wifi_protocols
wifi_scan_config
wifi_scan_threshold
wifi_scan_time
wifi_sta_config
wifi_sta_info
wifi_sta_list

Enums§

EspError
A simple error enum for our host-side protocol
InterfaceType
WireType
https://protobuf.dev/programming-guides/encoding/

Constants§

HEADER_SIZE

Functions§

cfg_heartbeat
parse_msg
Parse the payload header, and separate the RPC bytes from the whole message. Accepts the whole message received.
setup_rpc_proto
Sets up an RPC command using the direct protbuffer decoding. This is flexible, and allows writing arbitrary commands.
write_rpc_proto