Mbed OS Reference | WicedInterface.h Source File

 /* Wiced implementation of NetworkInterfaceAPI
  * Copyright (c) 2017 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 #ifndef WICED_INTERFACE_H
 #define WICED_INTERFACE_H
 
 #if defined(MBED_CONF_NSAPI_PRESENT)
 
 #include "mbed.h"
 #include "EthernetInterface.h"
 #include "netsocket/OnboardNetworkStack.h"
 #include "wiced_emac.h"
 
 
 /** WicedInterface class
  *  Implementation of the NetworkStack for the Wiced
  */
 class WicedInterface : public WiFiInterface, public EMACInterface {
 public:
 
     WicedInterface(
         EMAC &emac = WICED_EMAC::get_instance(),
         OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
 
     /** Start the interface
      *
      *  Attempts to connect to a WiFi network. Requires ssid and passphrase to be set.
      *  If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
      *
      *  @return         0 on success, negative error code on failure
      */
     nsapi_error_t connect();
 
     /** Start the interface
      *
      *  Attempts to connect to a WiFi network.
      *
      *  @param ssid      Name of the network to connect to
      *  @param pass      Security passphrase to connect to the network
      *  @param security  Type of encryption for connection (Default: NSAPI_SECURITY_NONE)
      *  @param channel   This parameter is not supported, setting it to anything else than 0 will result in NSAPI_ERROR_UNSUPPORTED
      *  @return          0 on success, or error code on failure
      */
     nsapi_error_t connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0);
 
     /** Stop the interface
      *  @return             0 on success, negative on failure
      */
     nsapi_error_t disconnect();
 
     /** Set the WiFi network credentials
      *
      *  @param ssid      Name of the network to connect to
      *  @param pass      Security passphrase to connect to the network
      *  @param security  Type of encryption for connection
      *                   (defaults to NSAPI_SECURITY_NONE)
      *  @return          0 on success, or error code on failure
      */
     nsapi_error_t set_credentials(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE);
 
     /** Set the WiFi network channel - NOT SUPPORTED
      *
      * This function is not supported and will return NSAPI_ERROR_UNSUPPORTED
      *
      *  @param channel   Channel on which the connection is to be made, or 0 for any (Default: 0)
      *  @return          Not supported, returns NSAPI_ERROR_UNSUPPORTED
      */
     nsapi_error_t set_channel(uint8_t channel)
     {
         if (channel != 0) {
             return NSAPI_ERROR_UNSUPPORTED;
         }
 
         return 0;
     }
 
     /** Gets the current radio signal strength for active connection
      *
      * @return          Connection strength in dBm (negative value)
      */
     int8_t get_rssi();
 
     /** Scan for available networks
      *
      * This function will block.
      *
      * @param  ap       Pointer to allocated array to store discovered AP
      * @param  count    Size of allocated @a res array, or 0 to only count available AP
      * @param  timeout  Timeout in milliseconds; 0 for no timeout (Default: 0)
      * @return          Number of entries in @a, or if @a count was 0 number of available networks, negative on error
      *                  see @a nsapi_error
      */
     int scan(WiFiAccessPoint *res, unsigned count);
 
 private:
 
     char _ssid[33]; /* The longest possible name (defined in 802.11) +1 for the \0 */
     char _pass[64]; /* The longest allowed passphrase + 1 */
     nsapi_security_t _security;
 };
 
 #endif
 
 #endif
Important Information for this Arm website
