ESP8266_RTOS_SDK
v1.4.0
Generated by Doxygen 1.8.10
Tue Mar 1 2016 10:19:27
Contents
1 ESP8266_RTOS_SDK 1
2 Module Index 3
2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
3 Data Structure Index 5
3.1 Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4 Module Documentation 7
4.1 WiFi Related APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2 AirKiss APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.2.1 airkiss_lan_ret_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2.3.1 airkiss_lan_pack(airkiss_lan_cmdid_t ak_lan_cmdid, void ∗appid, void ∗deviceid,
void ∗_datain, unsigned short inlength, void ∗_dataout, unsigned short
∗outlength, const airkiss_config_t ∗config) . . . . . . . . . . . . . . . . . . . . 9
4.2.3.2 airkiss_lan_recv(const void ∗body, unsigned short length, const airkiss_config_t
∗config) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2.3.3 airkiss_version(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.3 Misc APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3.2.1 IP2STR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3.3.1 dhcp_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3.3.2 dhcps_offer_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.3.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.3.4.1 os_delay_us(uint16 us) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.3.4.2 os_install_putc1(void(∗p)(char c)) . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.3.4.3 os_putc(char c) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
iv CONTENTS
4.4 SoftAP APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.4.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4.2.1 wifi_softap_dhcps_start(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4.2.2 wifi_softap_dhcps_status(void) . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4.2.3 wifi_softap_dhcps_stop(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4.2.4 wifi_softap_free_station_info(void) . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4.2.5 wifi_softap_get_config(struct softap_config ∗config) . . . . . . . . . . . . . . . 15
4.4.2.6 wifi_softap_get_config_default(struct softap_config ∗config) . . . . . . . . . . . 15
4.4.2.7 wifi_softap_get_dhcps_lease(struct dhcps_lease ∗please) . . . . . . . . . . . . 15
4.4.2.8 wifi_softap_get_dhcps_lease_time(void) . . . . . . . . . . . . . . . . . . . . . 15
4.4.2.9 wifi_softap_get_station_info(void) . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.4.2.10 wifi_softap_get_station_num(void) . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.4.2.11 wifi_softap_reset_dhcps_lease_time(void) . . . . . . . . . . . . . . . . . . . . 16
4.4.2.12 wifi_softap_set_config(struct softap_config ∗config) . . . . . . . . . . . . . . . 17
4.4.2.13 wifi_softap_set_config_current(struct softap_config ∗config) . . . . . . . . . . . 17
4.4.2.14 wifi_softap_set_dhcps_lease(struct dhcps_lease ∗please) . . . . . . . . . . . . 17
4.4.2.15 wifi_softap_set_dhcps_lease_time(uint32 minute) . . . . . . . . . . . . . . . . 18
4.4.2.16 wifi_softap_set_dhcps_offer_option(uint8 level, void ∗optarg) . . . . . . . . . . . 18
4.5 Spiffs APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.5.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.5.2.1 esp_spiffs_deinit(uint8 format) . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.5.2.2 esp_spiffs_init(struct esp_spiffs_config ∗config) . . . . . . . . . . . . . . . . . . 19
4.6 SSC APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.2.1 ssc_attach(SscBaudRate bandrate) . . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.2.2 ssc_param_len(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.2.3 ssc_param_str(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.6.2.4 ssc_parse_param(char ∗pLine, char ∗argv[]) . . . . . . . . . . . . . . . . . . . 21
4.6.2.5 ssc_register(ssc_cmd_t ∗cmdset, uint8 cmdnum, void(∗help)(void)) . . . . . . . 21
4.7 Station APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7.2.1 scan_done_cb_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7.3.1 STATION_STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.7.4.1 wifi_station_ap_change(uint8 current_ap_id) . . . . . . . . . . . . . . . . . . . 24
Generated on Tue Mar 1 2016 10:19:27 for ESP8266_RTOS_SDK by Doxygen
CONTENTS v
4.7.4.2 wifi_station_ap_number_set(uint8 ap_number) . . . . . . . . . . . . . . . . . . 24
4.7.4.3 wifi_station_connect(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.7.4.4 wifi_station_dhcpc_start(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.7.4.5 wifi_station_dhcpc_status(void) . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.7.4.6 wifi_station_dhcpc_stop(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.7.4.7 wifi_station_disconnect(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.7.4.8 wifi_station_get_ap_info(struct station_config config[]) . . . . . . . . . . . . . . 26
4.7.4.9 wifi_station_get_auto_connect(void) . . . . . . . . . . . . . . . . . . . . . . . . 26
4.7.4.10 wifi_station_get_config(struct station_config ∗config) . . . . . . . . . . . . . . . 26
4.7.4.11 wifi_station_get_config_default(struct station_config ∗config) . . . . . . . . . . . 26
4.7.4.12 wifi_station_get_connect_status(void) . . . . . . . . . . . . . . . . . . . . . . . 27
4.7.4.13 wifi_station_get_current_ap_id(void) . . . . . . . . . . . . . . . . . . . . . . . 27
4.7.4.14 wifi_station_get_hostname(void) . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.7.4.15 wifi_station_get_reconnect_policy(void) . . . . . . . . . . . . . . . . . . . . . . 27
4.7.4.16 wifi_station_get_rssi(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4.7.4.17 wifi_station_scan(struct scan_config ∗config, scan_done_cb_t cb) . . . . . . . . 28
4.7.4.18 wifi_station_set_auto_connect(bool set) . . . . . . . . . . . . . . . . . . . . . . 28
4.7.4.19 wifi_station_set_config(struct station_config ∗config) . . . . . . . . . . . . . . . 29
4.7.4.20 wifi_station_set_config_current(struct station_config ∗config) . . . . . . . . . . . 29
4.7.4.21 wifi_station_set_hostname(char ∗name) . . . . . . . . . . . . . . . . . . . . . 30
4.7.4.22 wifi_station_set_reconnect_policy(bool set) . . . . . . . . . . . . . . . . . . . . 31
4.8 System APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.8.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.8.2.1 rst_reason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.8.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.8.3.1 system_adc_read(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.8.3.2 system_deep_sleep(uint32 time_in_us) . . . . . . . . . . . . . . . . . . . . . . 34
4.8.3.3 system_deep_sleep_set_option(uint8 option) . . . . . . . . . . . . . . . . . . . 34
4.8.3.4 system_get_chip_id(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4.8.3.5 system_get_free_heap_size(void) . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.8.3.6 system_get_rst_info(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.8.3.7 system_get_rtc_time(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.8.3.8 system_get_sdk_version(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.8.3.9 system_get_time(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.8.3.10 system_get_vdd33(void) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.8.3.11 system_param_load(uint16 start_sec, uint16 offset, void ∗param, uint16 len) . . 36
4.8.3.12 system_param_save_with_protect(uint16 start_sec, void ∗param, uint16 len) . . 37
4.8.3.13 system_phy_set_max_tpw(uint8 max_tpw) . . . . . . . . . . . . . . . . . . . . 37
4.8.3.14 system_phy_set_rfoption(uint8 option) . . . . . . . . . . . . . . . . . . . . . . 38
Generated on Tue Mar 1 2016 10:19:27 for ESP8266_RTOS_SDK by Doxygen
