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

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.