Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/features/net/network-socket/WiFiInterface.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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