yocto_wireless.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_wireless.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindWireless(), the high-level API for Wireless functions
 *
 * - - - - - - - - - License information: - - - - - - - - -
 *
 *  Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
 *
 *  Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
 *  non-exclusive license to use, modify, copy and integrate this
 *  file into your software for the sole purpose of interfacing
 *  with Yoctopuce products.
 *
 *  You may reproduce and distribute copies of this file in
 *  source or object form, as long as the sole purpose of this
 *  code is to interface with Yoctopuce products. You must retain
 *  this notice in the distributed source file.
 *
 *  You should refer to Yoctopuce General Terms and Conditions
 *  for additional information regarding your rights and
 *  obligations.
 *
 *  THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT
 *  WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 *  WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
 *  EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
 *  INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
 *  COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
 *  SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
 *  LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
 *  CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
 *  BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
 *  WARRANTY, OR OTHERWISE.
 *
 *********************************************************************/

#ifndef YOCTO_WIRELESS_H
#define YOCTO_WIRELESS_H

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

//--- (generated code: YWireless definitions)
class YWireless; // forward declaration

typedef void (*YWirelessValueCallback)(YWireless *func, const string& functionValue);
#ifndef _Y_SECURITY_ENUM
#define _Y_SECURITY_ENUM
typedef enum {
    Y_SECURITY_UNKNOWN = 0,
    Y_SECURITY_OPEN = 1,
    Y_SECURITY_WEP = 2,
    Y_SECURITY_WPA = 3,
    Y_SECURITY_WPA2 = 4,
    Y_SECURITY_INVALID = -1,
} Y_SECURITY_enum;
#endif
#ifndef _Y_WLANSTATE_ENUM
#define _Y_WLANSTATE_ENUM
typedef enum {
    Y_WLANSTATE_DOWN = 0,
    Y_WLANSTATE_SCANNING = 1,
    Y_WLANSTATE_CONNECTED = 2,
    Y_WLANSTATE_REJECTED = 3,
    Y_WLANSTATE_INVALID = -1,
} Y_WLANSTATE_enum;
#endif
#define Y_LINKQUALITY_INVALID           (YAPI_INVALID_UINT)
#define Y_SSID_INVALID                  (YAPI_INVALID_STRING)
#define Y_CHANNEL_INVALID               (YAPI_INVALID_UINT)
#define Y_MESSAGE_INVALID               (YAPI_INVALID_STRING)
#define Y_WLANCONFIG_INVALID            (YAPI_INVALID_STRING)
//--- (end of generated code: YWireless definitions)


//--- (generated code: YWlanRecord definitions)
//--- (end of generated code: YWlanRecord definitions)

//--- (generated code: YWlanRecord declaration)
class YOCTO_CLASS_EXPORT YWlanRecord {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of generated code: YWlanRecord declaration)
    //--- (generated code: YWlanRecord attributes)
    // Attributes (function value cache)
    string          _ssid;
    int             _channel;
    string          _sec;
    int             _rssi;
    //--- (end of generated code: YWlanRecord attributes)
    //--- (generated code: YWlanRecord constructor)

    //--- (end of generated code: YWlanRecord constructor)
    //--- (generated code: YWlanRecord initialization)
    //--- (end of generated code: YWlanRecord initialization)

public:
    YWlanRecord(const string& json);
    //--- (generated code: YWlanRecord accessors declaration)


    virtual string      get_ssid(void);

    virtual int         get_channel(void);

    virtual string      get_security(void);

    virtual int         get_linkQuality(void);

#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of generated code: YWlanRecord accessors declaration)
};




//--- (generated code: YWireless declaration)
class YOCTO_CLASS_EXPORT YWireless: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of generated code: YWireless declaration)
    //--- (generated code: YWireless attributes)
    // Attributes (function value cache)
    int             _linkQuality;
    string          _ssid;
    int             _channel;
    Y_SECURITY_enum _security;
    string          _message;
    string          _wlanConfig;
    Y_WLANSTATE_enum _wlanState;
    YWirelessValueCallback _valueCallbackWireless;

    friend YWireless *yFindWireless(const string& func);
    friend YWireless *yFirstWireless(void);

    // Function-specific method for parsing of JSON output and caching result
    virtual int     _parseAttr(YJSONObject* json_val);

    // Constructor is protected, use yFindWireless factory function to instantiate
    YWireless(const string& func);
    //--- (end of generated code: YWireless attributes)
    //--- (generated code: YWireless initialization)
    //--- (end of generated code: YWireless initialization)

public:
    ~YWireless();
    //--- (generated code: YWireless accessors declaration)

    static const int LINKQUALITY_INVALID = YAPI_INVALID_UINT;
    static const string SSID_INVALID;
    static const int CHANNEL_INVALID = YAPI_INVALID_UINT;
    static const Y_SECURITY_enum SECURITY_UNKNOWN = Y_SECURITY_UNKNOWN;
    static const Y_SECURITY_enum SECURITY_OPEN = Y_SECURITY_OPEN;
    static const Y_SECURITY_enum SECURITY_WEP = Y_SECURITY_WEP;
    static const Y_SECURITY_enum SECURITY_WPA = Y_SECURITY_WPA;
    static const Y_SECURITY_enum SECURITY_WPA2 = Y_SECURITY_WPA2;
    static const Y_SECURITY_enum SECURITY_INVALID = Y_SECURITY_INVALID;
    static const string MESSAGE_INVALID;
    static const string WLANCONFIG_INVALID;
    static const Y_WLANSTATE_enum WLANSTATE_DOWN = Y_WLANSTATE_DOWN;
    static const Y_WLANSTATE_enum WLANSTATE_SCANNING = Y_WLANSTATE_SCANNING;
    static const Y_WLANSTATE_enum WLANSTATE_CONNECTED = Y_WLANSTATE_CONNECTED;
    static const Y_WLANSTATE_enum WLANSTATE_REJECTED = Y_WLANSTATE_REJECTED;
    static const Y_WLANSTATE_enum WLANSTATE_INVALID = Y_WLANSTATE_INVALID;

    int                 get_linkQuality(void);

    inline int          linkQuality(void)
    { return this->get_linkQuality(); }

    string              get_ssid(void);

    inline string       ssid(void)
    { return this->get_ssid(); }

    int                 get_channel(void);

    inline int          channel(void)
    { return this->get_channel(); }

    Y_SECURITY_enum     get_security(void);

    inline Y_SECURITY_enum security(void)
    { return this->get_security(); }

    string              get_message(void);

    inline string       message(void)
    { return this->get_message(); }

    string              get_wlanConfig(void);

    inline string       wlanConfig(void)
    { return this->get_wlanConfig(); }

    int             set_wlanConfig(const string& newval);
    inline int      setWlanConfig(const string& newval)
    { return this->set_wlanConfig(newval); }

    Y_WLANSTATE_enum    get_wlanState(void);

    inline Y_WLANSTATE_enum wlanState(void)
    { return this->get_wlanState(); }

    static YWireless*   FindWireless(string func);

    virtual int         registerValueCallback(YWirelessValueCallback callback);
    using YFunction::registerValueCallback;

    virtual int         _invokeValueCallback(string value);

    virtual int         startWlanScan(void);

    virtual int         joinNetwork(string ssid,string securityKey);

    virtual int         adhocNetwork(string ssid,string securityKey);

    virtual int         softAPNetwork(string ssid,string securityKey);

    virtual vector<YWlanRecord> get_detectedWlans(void);


    inline static YWireless* Find(string func)
    { return YWireless::FindWireless(func); }

           YWireless       *nextWireless(void);
    inline YWireless       *next(void)
    { return this->nextWireless();}

           static YWireless* FirstWireless(void);
    inline static YWireless* First(void)
    { return YWireless::FirstWireless();}
#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of generated code: YWireless accessors declaration)
};

//--- (generated code: YWireless functions declaration)

inline YWireless* yFindWireless(const string& func)
{ return YWireless::FindWireless(func);}
inline YWireless* yFirstWireless(void)
{ return YWireless::FirstWireless();}

//--- (end of generated code: YWireless functions declaration)

#endif