ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

types/ScanResult.h@11:ea484e1b7fc4, 2014-08-12 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 12 02:34:46 2014 -0700
Revision:
11:ea484e1b7fc4
Parent:
1:6ec9998427ad
Child:
13:2b51f5267c92
updated documnetation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 0:ea85c4bb5e1f 1 /*
dan_ackme 0:ea85c4bb5e1f 2 * Copyright 2014, ACKme Networks
dan_ackme 0:ea85c4bb5e1f 3 * All Rights Reserved.
dan_ackme 0:ea85c4bb5e1f 4 *
dan_ackme 0:ea85c4bb5e1f 5 * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;
dan_ackme 0:ea85c4bb5e1f 6 * the contents of this file may not be disclosed to third parties, copied
dan_ackme 0:ea85c4bb5e1f 7 * or duplicated in any form, in whole or in part, without the prior
dan_ackme 0:ea85c4bb5e1f 8 * written permission of ACKme Networks.
dan_ackme 0:ea85c4bb5e1f 9 */
dan_ackme 0:ea85c4bb5e1f 10
dan_ackme 0:ea85c4bb5e1f 11 #pragma once
dan_ackme 0:ea85c4bb5e1f 12
dan_ackme 0:ea85c4bb5e1f 13
dan_ackme 0:ea85c4bb5e1f 14
dan_ackme 0:ea85c4bb5e1f 15 #include "WiconnectTypes.h"
dan_ackme 0:ea85c4bb5e1f 16 #include "StringUtil.h"
dan_ackme 0:ea85c4bb5e1f 17
dan_ackme 0:ea85c4bb5e1f 18
dan_ackme 0:ea85c4bb5e1f 19 namespace wiconnect
dan_ackme 0:ea85c4bb5e1f 20 {
dan_ackme 0:ea85c4bb5e1f 21
dan_ackme 11:ea484e1b7fc4 22 /**
dan_ackme 11:ea484e1b7fc4 23 * @ingroup types_network
dan_ackme 11:ea484e1b7fc4 24 *
dan_ackme 11:ea484e1b7fc4 25 * @brief Contains single entry from WiFi scan results
dan_ackme 11:ea484e1b7fc4 26 *
dan_ackme 11:ea484e1b7fc4 27 */
dan_ackme 0:ea85c4bb5e1f 28 class ScanResult
dan_ackme 0:ea85c4bb5e1f 29 {
dan_ackme 0:ea85c4bb5e1f 30 public:
dan_ackme 0:ea85c4bb5e1f 31 uint8_t getChannel() const;
dan_ackme 0:ea85c4bb5e1f 32 NetworkSignalStrength getSignalStrength() const;
dan_ackme 0:ea85c4bb5e1f 33 const MacAddress* getMacAddress() const;
dan_ackme 0:ea85c4bb5e1f 34 NetworkSecurity getSecurityType() const;
dan_ackme 0:ea85c4bb5e1f 35 uint32_t getRate() const;
dan_ackme 0:ea85c4bb5e1f 36 const char* getRateStr(char *buffer = NULL) const;
dan_ackme 0:ea85c4bb5e1f 37 const Ssid* getSsid() const;
dan_ackme 0:ea85c4bb5e1f 38
dan_ackme 0:ea85c4bb5e1f 39 const ScanResult* getNext() const;
dan_ackme 0:ea85c4bb5e1f 40 const ScanResult* getPrevious() const;
dan_ackme 0:ea85c4bb5e1f 41
dan_ackme 0:ea85c4bb5e1f 42 protected:
dan_ackme 0:ea85c4bb5e1f 43 ScanResult();
dan_ackme 0:ea85c4bb5e1f 44
dan_ackme 0:ea85c4bb5e1f 45 WiconnectResult init(const char *channelStr, const char *rssiStr, const char* macStr, const char *rateStr, const char *secStr, const char *ssidStr);
dan_ackme 0:ea85c4bb5e1f 46 ScanResult *next;
dan_ackme 0:ea85c4bb5e1f 47 ScanResult *previous;
dan_ackme 0:ea85c4bb5e1f 48 uint8_t channel;
dan_ackme 0:ea85c4bb5e1f 49 int16_t rssi;
dan_ackme 0:ea85c4bb5e1f 50 MacAddress mac;
dan_ackme 0:ea85c4bb5e1f 51 uint32_t rate;
dan_ackme 0:ea85c4bb5e1f 52 NetworkSecurity security;
dan_ackme 0:ea85c4bb5e1f 53 Ssid ssid;
dan_ackme 0:ea85c4bb5e1f 54
dan_ackme 0:ea85c4bb5e1f 55 void* operator new(size_t size);
dan_ackme 0:ea85c4bb5e1f 56 void operator delete(void*);
dan_ackme 0:ea85c4bb5e1f 57
dan_ackme 0:ea85c4bb5e1f 58 friend class ScanResultList;
dan_ackme 0:ea85c4bb5e1f 59 };
dan_ackme 0:ea85c4bb5e1f 60
dan_ackme 0:ea85c4bb5e1f 61
dan_ackme 0:ea85c4bb5e1f 62
dan_ackme 0:ea85c4bb5e1f 63
dan_ackme 0:ea85c4bb5e1f 64
dan_ackme 0:ea85c4bb5e1f 65
dan_ackme 0:ea85c4bb5e1f 66 }