BA / Mbed OS BaBoRo_test2

mbed-os/features/netsocket/WiFiAccessPoint.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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