Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

features/net/network-socket/WiFiInterface.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nexpaq 0:6c56fb4bc5f0 1 /* WiFiInterface
nexpaq 0:6c56fb4bc5f0 2 * Copyright (c) 2015 ARM Limited
nexpaq 0:6c56fb4bc5f0 3 *
nexpaq 0:6c56fb4bc5f0 4 * Licensed under the Apache License, Version 2.0 (the "License");
nexpaq 0:6c56fb4bc5f0 5 * you may not use this file except in compliance with the License.
nexpaq 0:6c56fb4bc5f0 6 * You may obtain a copy of the License at
nexpaq 0:6c56fb4bc5f0 7 *
nexpaq 0:6c56fb4bc5f0 8 * http://www.apache.org/licenses/LICENSE-2.0
nexpaq 0:6c56fb4bc5f0 9 *
nexpaq 0:6c56fb4bc5f0 10 * Unless required by applicable law or agreed to in writing, software
nexpaq 0:6c56fb4bc5f0 11 * distributed under the License is distributed on an "AS IS" BASIS,
nexpaq 0:6c56fb4bc5f0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nexpaq 0:6c56fb4bc5f0 13 * See the License for the specific language governing permissions and
nexpaq 0:6c56fb4bc5f0 14 * limitations under the License.
nexpaq 0:6c56fb4bc5f0 15 */
nexpaq 0:6c56fb4bc5f0 16
nexpaq 0:6c56fb4bc5f0 17 #ifndef WIFI_INTERFACE_H
nexpaq 0:6c56fb4bc5f0 18 #define WIFI_INTERFACE_H
nexpaq 0:6c56fb4bc5f0 19
nexpaq 0:6c56fb4bc5f0 20 #include "network-socket/NetworkInterface.h"
nexpaq 0:6c56fb4bc5f0 21
nexpaq 0:6c56fb4bc5f0 22
nexpaq 0:6c56fb4bc5f0 23 /** Enum of WiFi encryption types
nexpaq 0:6c56fb4bc5f0 24 *
nexpaq 0:6c56fb4bc5f0 25 * The security type specifies a particular security to use when
nexpaq 0:6c56fb4bc5f0 26 * connected to a WiFi network
nexpaq 0:6c56fb4bc5f0 27 *
nexpaq 0:6c56fb4bc5f0 28 * @enum nsapi_protocol_t
nexpaq 0:6c56fb4bc5f0 29 */
nexpaq 0:6c56fb4bc5f0 30 enum nsapi_security_t {
nexpaq 0:6c56fb4bc5f0 31 NSAPI_SECURITY_NONE = 0, /*!< open access point */
nexpaq 0:6c56fb4bc5f0 32 NSAPI_SECURITY_WEP, /*!< phrase conforms to WEP */
nexpaq 0:6c56fb4bc5f0 33 NSAPI_SECURITY_WPA, /*!< phrase conforms to WPA */
nexpaq 0:6c56fb4bc5f0 34 NSAPI_SECURITY_WPA2, /*!< phrase conforms to WPA2 */
nexpaq 0:6c56fb4bc5f0 35 };
nexpaq 0:6c56fb4bc5f0 36
nexpaq 0:6c56fb4bc5f0 37 /** WiFiInterface class
nexpaq 0:6c56fb4bc5f0 38 *
nexpaq 0:6c56fb4bc5f0 39 * Common interface that is shared between WiFi devices
nexpaq 0:6c56fb4bc5f0 40 */
nexpaq 0:6c56fb4bc5f0 41 class WiFiInterface: public NetworkInterface
nexpaq 0:6c56fb4bc5f0 42 {
nexpaq 0:6c56fb4bc5f0 43 public:
nexpaq 0:6c56fb4bc5f0 44 /** Start the interface
nexpaq 0:6c56fb4bc5f0 45 *
nexpaq 0:6c56fb4bc5f0 46 * Attempts to connect to a WiFi network. If passphrase is invalid,
nexpaq 0:6c56fb4bc5f0 47 * NSAPI_ERROR_AUTH_ERROR is returned.
nexpaq 0:6c56fb4bc5f0 48 *
nexpaq 0:6c56fb4bc5f0 49 * @param ssid Name of the network to connect to
nexpaq 0:6c56fb4bc5f0 50 * @param pass Security passphrase to connect to the network
nexpaq 0:6c56fb4bc5f0 51 * @param security Type of encryption for connection
nexpaq 0:6c56fb4bc5f0 52 * @return 0 on success, negative error code on failure
nexpaq 0:6c56fb4bc5f0 53 */
nexpaq 0:6c56fb4bc5f0 54 virtual int connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE) = 0;
nexpaq 0:6c56fb4bc5f0 55
nexpaq 0:6c56fb4bc5f0 56 /** Stop the interface
nexpaq 0:6c56fb4bc5f0 57 *
nexpaq 0:6c56fb4bc5f0 58 * @return 0 on success, negative error code on failure
nexpaq 0:6c56fb4bc5f0 59 */
nexpaq 0:6c56fb4bc5f0 60 virtual int disconnect() = 0;
nexpaq 0:6c56fb4bc5f0 61
nexpaq 0:6c56fb4bc5f0 62 /** Get the local MAC address
nexpaq 0:6c56fb4bc5f0 63 *
nexpaq 0:6c56fb4bc5f0 64 * @return Null-terminated representation of the local MAC address
nexpaq 0:6c56fb4bc5f0 65 */
nexpaq 0:6c56fb4bc5f0 66 virtual const char *get_mac_address() = 0;
nexpaq 0:6c56fb4bc5f0 67 };
nexpaq 0:6c56fb4bc5f0 68
nexpaq 0:6c56fb4bc5f0 69
nexpaq 0:6c56fb4bc5f0 70 #endif