Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/WiFiAccessPoint.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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