Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: MAX44000 PWM_Tone_Library nexpaq_mdk
Fork of LED_Demo by
WiFiInterface.h
00001 /* WiFiInterface 00002 * Copyright (c) 2015 ARM Limited 00003 * 00004 * Licensed under the Apache License, Version 2.0 (the "License"); 00005 * you may not use this file except in compliance with the License. 00006 * You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an "AS IS" BASIS, 00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 00017 #ifndef WIFI_INTERFACE_H 00018 #define WIFI_INTERFACE_H 00019 00020 #include "network-socket/NetworkInterface.h" 00021 00022 00023 /** Enum of WiFi encryption types 00024 * 00025 * The security type specifies a particular security to use when 00026 * connected to a WiFi network 00027 * 00028 * @enum nsapi_protocol_t 00029 */ 00030 enum nsapi_security_t { 00031 NSAPI_SECURITY_NONE = 0, /*!< open access point */ 00032 NSAPI_SECURITY_WEP, /*!< phrase conforms to WEP */ 00033 NSAPI_SECURITY_WPA, /*!< phrase conforms to WPA */ 00034 NSAPI_SECURITY_WPA2, /*!< phrase conforms to WPA2 */ 00035 }; 00036 00037 /** WiFiInterface class 00038 * 00039 * Common interface that is shared between WiFi devices 00040 */ 00041 class WiFiInterface: public NetworkInterface 00042 { 00043 public: 00044 /** Start the interface 00045 * 00046 * Attempts to connect to a WiFi network. If passphrase is invalid, 00047 * NSAPI_ERROR_AUTH_ERROR is returned. 00048 * 00049 * @param ssid Name of the network to connect to 00050 * @param pass Security passphrase to connect to the network 00051 * @param security Type of encryption for connection 00052 * @return 0 on success, negative error code on failure 00053 */ 00054 virtual int connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE) = 0; 00055 00056 /** Stop the interface 00057 * 00058 * @return 0 on success, negative error code on failure 00059 */ 00060 virtual int disconnect() = 0; 00061 00062 /** Get the local MAC address 00063 * 00064 * @return Null-terminated representation of the local MAC address 00065 */ 00066 virtual const char *get_mac_address() = 0; 00067 }; 00068 00069 00070 #endif
Generated on Tue Jul 12 2022 12:28:59 by
