Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/netsocket/WiFiAccessPoint.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* WiFiInterface
elessair 0:f269e3021894 2 * Copyright (c) 2015 - 2016 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 #ifndef WIFI_ACCESS_POINT_H
elessair 0:f269e3021894 18 #define WIFI_ACCESS_POINT_H
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 #include <string.h>
elessair 0:f269e3021894 21 #include "netsocket/nsapi_types.h"
elessair 0:f269e3021894 22
elessair 0:f269e3021894 23 /** WiFiAccessPoint class
elessair 0:f269e3021894 24 *
elessair 0:f269e3021894 25 * Class that represents a WiFi Access Point
elessair 0:f269e3021894 26 * Common interface that is shared between WiFi devices
elessair 0:f269e3021894 27 */
elessair 0:f269e3021894 28 class WiFiAccessPoint
elessair 0:f269e3021894 29 {
elessair 0:f269e3021894 30 /** WiFiAccessPoint lifetime
elessair 0:f269e3021894 31 */
elessair 0:f269e3021894 32 public:
elessair 0:f269e3021894 33 WiFiAccessPoint();
elessair 0:f269e3021894 34 WiFiAccessPoint(nsapi_wifi_ap_t ap);
elessair 0:f269e3021894 35
elessair 0:f269e3021894 36 /** Get an access point's ssid
elessair 0:f269e3021894 37 *
elessair 0:f269e3021894 38 * @return The ssid of the access point
elessair 0:f269e3021894 39 */
elessair 0:f269e3021894 40 const char *get_ssid() const;
elessair 0:f269e3021894 41
elessair 0:f269e3021894 42 /** Get an access point's bssid
elessair 0:f269e3021894 43 *
elessair 0:f269e3021894 44 * @return The bssid of the access point
elessair 0:f269e3021894 45 */
elessair 0:f269e3021894 46 const uint8_t *get_bssid() const;
elessair 0:f269e3021894 47
elessair 0:f269e3021894 48 /** Get an access point's security
elessair 0:f269e3021894 49 *
elessair 0:f269e3021894 50 * @return The security type of the access point
elessair 0:f269e3021894 51 */
elessair 0:f269e3021894 52 nsapi_security_t get_security() const;
elessair 0:f269e3021894 53
elessair 0:f269e3021894 54 /** Gets the radio signal strength for the access point
elessair 0:f269e3021894 55 *
elessair 0:f269e3021894 56 * @return Connection strength in dBm (negative value),
elessair 0:f269e3021894 57 * or 0 if measurement impossible
elessair 0:f269e3021894 58 */
elessair 0:f269e3021894 59 int8_t get_rssi() const;
elessair 0:f269e3021894 60
elessair 0:f269e3021894 61 /** Get the access point's channel
elessair 0:f269e3021894 62 *
elessair 0:f269e3021894 63 * @return The channel of the access point
elessair 0:f269e3021894 64 */
elessair 0:f269e3021894 65 uint8_t get_channel() const;
elessair 0:f269e3021894 66
elessair 0:f269e3021894 67 private:
elessair 0:f269e3021894 68 nsapi_wifi_ap_t _ap;
elessair 0:f269e3021894 69 };
elessair 0:f269e3021894 70
elessair 0:f269e3021894 71 #endif