Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/netsocket/WiFiAccessPoint.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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