esp8266/modnetwork.c - lite/micropython - Linaro Git Browser

 /*
  * This file is part of the Micro Python project, http://micropython.org/
  *
  * The MIT License (MIT)
  *
  * Copyright (c) 2015 Paul Sokolovsky
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */

 #include <stdio.h>
 #include <stdint.h>
 #include <string.h>
 #include <errno.h>

 #include "py/nlr.h"
 #include "py/objlist.h"
 #include "py/runtime.h"
 #include "netutils.h"
 #include "queue.h"
 #include "user_interface.h"
 #include "espconn.h"
 #include "spi_flash.h"
 #include "utils.h"

 void error_check(bool status, const char *msg);
 extern const mp_obj_module_t network_module;

 STATIC mp_obj_t get_module() {
     return (mp_obj_t)&network_module;
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(get_module_obj, get_module);

 STATIC mp_obj_t esp_connect(mp_uint_t n_args, const mp_obj_t *args) {
     struct station_config config = {{0}};
     mp_uint_t len;
     const char *p;

     p = mp_obj_str_get_data(args[0], &len);
     memcpy(config.ssid, p, len);
     p = mp_obj_str_get_data(args[1], &len);
     memcpy(config.password, p, len);

     error_check(wifi_station_set_config(&config), "Cannot set STA config");
     error_check(wifi_station_connect(), "Cannot connect to AP");

     return mp_const_none;
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(esp_connect_obj, 2, 6, esp_connect);

 STATIC mp_obj_t esp_disconnect() {
     error_check(wifi_station_disconnect(), "Cannot disconnect from AP");
     return mp_const_none;
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_disconnect_obj, esp_disconnect);

 #define MODNETWORK_INCLUDE_CONSTANTS (1)

 STATIC mp_obj_t esp_status() {
     return MP_OBJ_NEW_SMALL_INT(wifi_station_get_connect_status());
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_status_obj, esp_status);

 STATIC void esp_scan_cb(scaninfo *si, STATUS status) {
     struct bss_info *bs;
     if (si->pbss) {
         STAILQ_FOREACH(bs, si->pbss, next) {
             mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
             t->items[0] = mp_obj_new_bytes(bs->ssid, strlen((char*)bs->ssid));
             t->items[1] = mp_obj_new_bytes(bs->bssid, sizeof(bs->bssid));
             t->items[2] = MP_OBJ_NEW_SMALL_INT(bs->channel);
             t->items[3] = MP_OBJ_NEW_SMALL_INT(bs->rssi);
             t->items[4] = MP_OBJ_NEW_SMALL_INT(bs->authmode);
             t->items[5] = MP_OBJ_NEW_SMALL_INT(bs->is_hidden);
             call_function_1_protected(MP_STATE_PORT(scan_cb_obj), t);
         }
     }
 }

 STATIC mp_obj_t esp_scan(mp_obj_t cb_in) {
     MP_STATE_PORT(scan_cb_obj) = cb_in;
     if (wifi_get_opmode() == SOFTAP_MODE) {
         nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError,
             "Scan not supported in AP mode"));
     }
     wifi_station_scan(NULL, (scan_done_cb_t)esp_scan_cb);
     return mp_const_none;
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(esp_scan_obj, esp_scan);

 /// \method isconnected()
 /// Return True if connected to an AP and an IP address has been assigned,
 ///     false otherwise.
 STATIC mp_obj_t esp_isconnected() {
     if (wifi_station_get_connect_status() == STATION_GOT_IP) {
         return mp_const_true;
     }
     return mp_const_false;
 }

 STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_isconnected_obj, esp_isconnected);

 STATIC mp_obj_t esp_mac(mp_uint_t n_args, const mp_obj_t *args) {
     uint8_t mac[6];
     if (n_args == 0) {
         wifi_get_macaddr(STATION_IF, mac);
         return mp_obj_new_bytes(mac, sizeof(mac));
     } else {
         mp_buffer_info_t bufinfo;
         mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_READ);

         if (bufinfo.len != 6) {
             nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
                 "invalid buffer length"));
         }

         wifi_set_macaddr(STATION_IF, bufinfo.buf);
         return mp_const_none;
     }
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(esp_mac_obj, 0, 1, esp_mac);

 STATIC mp_obj_t esp_ifconfig(void) {
     struct ip_info info;
     wifi_get_ip_info(STATION_IF, &info);
     mp_obj_t ifconfig[4] = {
             netutils_format_ipv4_addr((uint8_t*)&info.ip, NETUTILS_BIG),
             netutils_format_ipv4_addr((uint8_t*)&info.netmask, NETUTILS_BIG),
             netutils_format_ipv4_addr((uint8_t*)&info.gw, NETUTILS_BIG),
             MP_OBJ_NEW_QSTR(MP_QSTR_), // no DNS server
     };
     return mp_obj_new_tuple(4, ifconfig);
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_ifconfig_obj, esp_ifconfig);

 STATIC const mp_map_elem_t mp_module_network_globals_table[] = {
     { MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_network) },
     // MicroPython "network" module interface requires it to contains classes
     // to instantiate. But as we have just a static network interace,
     // use module as a "class", and just make all methods module-global
     // functions.
     { MP_OBJ_NEW_QSTR(MP_QSTR_WLAN), (mp_obj_t)&get_module_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_connect), (mp_obj_t)&esp_connect_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_disconnect), (mp_obj_t)&esp_disconnect_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_status), (mp_obj_t)&esp_status_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_scan), (mp_obj_t)&esp_scan_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_isconnected), (mp_obj_t)&esp_isconnected_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_mac), (mp_obj_t)&esp_mac_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_ifconfig), (mp_obj_t)&esp_ifconfig_obj },

 #if MODNETWORK_INCLUDE_CONSTANTS
     { MP_OBJ_NEW_QSTR(MP_QSTR_STAT_IDLE),
         MP_OBJ_NEW_SMALL_INT(STATION_IDLE)},
     { MP_OBJ_NEW_QSTR(MP_QSTR_STAT_CONNECTING),
         MP_OBJ_NEW_SMALL_INT(STATION_CONNECTING)},
     { MP_OBJ_NEW_QSTR(MP_QSTR_STAT_WRONG_PASSWORD),
         MP_OBJ_NEW_SMALL_INT(STATION_WRONG_PASSWORD)},
     { MP_OBJ_NEW_QSTR(MP_QSTR_STAT_NO_AP_FOUND),
         MP_OBJ_NEW_SMALL_INT(STATION_NO_AP_FOUND)},
     { MP_OBJ_NEW_QSTR(MP_QSTR_STAT_CONNECT_FAIL),
         MP_OBJ_NEW_SMALL_INT(STATION_CONNECT_FAIL)},
     { MP_OBJ_NEW_QSTR(MP_QSTR_STAT_GOT_IP),
         MP_OBJ_NEW_SMALL_INT(STATION_GOT_IP)},
 #endif
 };

 STATIC MP_DEFINE_CONST_DICT(mp_module_network_globals, mp_module_network_globals_table);

 const mp_obj_module_t network_module = {
     .base = { &mp_type_module },
     .name = MP_QSTR_network,
     .globals = (mp_obj_dict_t*)&mp_module_network_globals,
 };
	/*
	* This file is part of the Micro Python project, http://micropython.org/
	*
	* The MIT License (MIT)
	*
	* Copyright (c) 2015 Paul Sokolovsky
	*
	* Permission is hereby granted, free of charge, to any person obtaining a copy
	* of this software and associated documentation files (the "Software"), to deal
	* in the Software without restriction, including without limitation the rights
	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	* copies of the Software, and to permit persons to whom the Software is
	* furnished to do so, subject to the following conditions:
	*
	* The above copyright notice and this permission notice shall be included in
	* all copies or substantial portions of the Software.
	*
	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	* THE SOFTWARE.
	*/

	#include <stdio.h>
	#include <stdint.h>
	#include <string.h>
	#include <errno.h>

	#include "py/nlr.h"
	#include "py/objlist.h"
	#include "py/runtime.h"
	#include "netutils.h"
	#include "queue.h"
	#include "user_interface.h"
	#include "espconn.h"
	#include "spi_flash.h"
	#include "utils.h"

	void error_check(bool status, const char *msg);
	extern const mp_obj_module_t network_module;

	STATIC mp_obj_t get_module() {
	return (mp_obj_t)&network_module;
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_0(get_module_obj, get_module);

	STATIC mp_obj_t esp_connect(mp_uint_t n_args, const mp_obj_t *args) {
	struct station_config config = {{0}};
	mp_uint_t len;
	const char *p;

	p = mp_obj_str_get_data(args[0], &len);
	memcpy(config.ssid, p, len);
	p = mp_obj_str_get_data(args[1], &len);
	memcpy(config.password, p, len);

	error_check(wifi_station_set_config(&config), "Cannot set STA config");
	error_check(wifi_station_connect(), "Cannot connect to AP");

	return mp_const_none;
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(esp_connect_obj, 2, 6, esp_connect);

	STATIC mp_obj_t esp_disconnect() {
	error_check(wifi_station_disconnect(), "Cannot disconnect from AP");
	return mp_const_none;
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_disconnect_obj, esp_disconnect);

	#define MODNETWORK_INCLUDE_CONSTANTS (1)

	STATIC mp_obj_t esp_status() {
	return MP_OBJ_NEW_SMALL_INT(wifi_station_get_connect_status());
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_status_obj, esp_status);

	STATIC void esp_scan_cb(scaninfo *si, STATUS status) {
	struct bss_info *bs;
	if (si->pbss) {
	STAILQ_FOREACH(bs, si->pbss, next) {
	mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
	t->items[0] = mp_obj_new_bytes(bs->ssid, strlen((char*)bs->ssid));
	t->items[1] = mp_obj_new_bytes(bs->bssid, sizeof(bs->bssid));
	t->items[2] = MP_OBJ_NEW_SMALL_INT(bs->channel);
	t->items[3] = MP_OBJ_NEW_SMALL_INT(bs->rssi);
	t->items[4] = MP_OBJ_NEW_SMALL_INT(bs->authmode);
	t->items[5] = MP_OBJ_NEW_SMALL_INT(bs->is_hidden);
	call_function_1_protected(MP_STATE_PORT(scan_cb_obj), t);
	}
	}
	}

	STATIC mp_obj_t esp_scan(mp_obj_t cb_in) {
	MP_STATE_PORT(scan_cb_obj) = cb_in;
	if (wifi_get_opmode() == SOFTAP_MODE) {
	nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError,
	"Scan not supported in AP mode"));
	}
	wifi_station_scan(NULL, (scan_done_cb_t)esp_scan_cb);
	return mp_const_none;
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_1(esp_scan_obj, esp_scan);

	/// \method isconnected()
	/// Return True if connected to an AP and an IP address has been assigned,
	/// false otherwise.
	STATIC mp_obj_t esp_isconnected() {
	if (wifi_station_get_connect_status() == STATION_GOT_IP) {
	return mp_const_true;
	}
	return mp_const_false;
	}

	STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_isconnected_obj, esp_isconnected);

	STATIC mp_obj_t esp_mac(mp_uint_t n_args, const mp_obj_t *args) {
	uint8_t mac[6];
	if (n_args == 0) {
	wifi_get_macaddr(STATION_IF, mac);
	return mp_obj_new_bytes(mac, sizeof(mac));
	} else {
	mp_buffer_info_t bufinfo;
	mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_READ);

	if (bufinfo.len != 6) {
	nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
	"invalid buffer length"));
	}

	wifi_set_macaddr(STATION_IF, bufinfo.buf);
	return mp_const_none;
	}
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(esp_mac_obj, 0, 1, esp_mac);

	STATIC mp_obj_t esp_ifconfig(void) {
	struct ip_info info;
	wifi_get_ip_info(STATION_IF, &info);
	mp_obj_t ifconfig[4] = {
	netutils_format_ipv4_addr((uint8_t*)&info.ip, NETUTILS_BIG),
	netutils_format_ipv4_addr((uint8_t*)&info.netmask, NETUTILS_BIG),
	netutils_format_ipv4_addr((uint8_t*)&info.gw, NETUTILS_BIG),
	MP_OBJ_NEW_QSTR(MP_QSTR_), // no DNS server
	};
	return mp_obj_new_tuple(4, ifconfig);
	}
	STATIC MP_DEFINE_CONST_FUN_OBJ_0(esp_ifconfig_obj, esp_ifconfig);

	STATIC const mp_map_elem_t mp_module_network_globals_table[] = {
	{ MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_network) },
	// MicroPython "network" module interface requires it to contains classes
	// to instantiate. But as we have just a static network interace,
	// use module as a "class", and just make all methods module-global
	// functions.
	{ MP_OBJ_NEW_QSTR(MP_QSTR_WLAN), (mp_obj_t)&get_module_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_connect), (mp_obj_t)&esp_connect_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_disconnect), (mp_obj_t)&esp_disconnect_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_status), (mp_obj_t)&esp_status_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_scan), (mp_obj_t)&esp_scan_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_isconnected), (mp_obj_t)&esp_isconnected_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_mac), (mp_obj_t)&esp_mac_obj },
	{ MP_OBJ_NEW_QSTR(MP_QSTR_ifconfig), (mp_obj_t)&esp_ifconfig_obj },

	#if MODNETWORK_INCLUDE_CONSTANTS
	{ MP_OBJ_NEW_QSTR(MP_QSTR_STAT_IDLE),
	MP_OBJ_NEW_SMALL_INT(STATION_IDLE)},
	{ MP_OBJ_NEW_QSTR(MP_QSTR_STAT_CONNECTING),
	MP_OBJ_NEW_SMALL_INT(STATION_CONNECTING)},
	{ MP_OBJ_NEW_QSTR(MP_QSTR_STAT_WRONG_PASSWORD),
	MP_OBJ_NEW_SMALL_INT(STATION_WRONG_PASSWORD)},
	{ MP_OBJ_NEW_QSTR(MP_QSTR_STAT_NO_AP_FOUND),
	MP_OBJ_NEW_SMALL_INT(STATION_NO_AP_FOUND)},
	{ MP_OBJ_NEW_QSTR(MP_QSTR_STAT_CONNECT_FAIL),
	MP_OBJ_NEW_SMALL_INT(STATION_CONNECT_FAIL)},
	{ MP_OBJ_NEW_QSTR(MP_QSTR_STAT_GOT_IP),
	MP_OBJ_NEW_SMALL_INT(STATION_GOT_IP)},
	#endif
	};

	STATIC MP_DEFINE_CONST_DICT(mp_module_network_globals, mp_module_network_globals_table);

	const mp_obj_module_t network_module = {
	.base = { &mp_type_module },
	.name = MP_QSTR_network,
	.globals = (mp_obj_dict_t*)&mp_module_network_globals,
	};