Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/features/netsocket/WiFiAccessPoint.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

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