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@16:7f1d6d359787, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 04:41:04 2014 -0700
Revision:
16:7f1d6d359787
Parent:
13:2b51f5267c92
Child:
24:e27e23297f02
updated documentation and copyright

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 16:7f1d6d359787 1 /**
dan_ackme 16:7f1d6d359787 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 16:7f1d6d359787 3 *
dan_ackme 16:7f1d6d359787 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 16:7f1d6d359787 5 * All rights reserved.
dan_ackme 16:7f1d6d359787 6 *
dan_ackme 16:7f1d6d359787 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 16:7f1d6d359787 8 * are permitted provided that the following conditions are met:
dan_ackme 16:7f1d6d359787 9 *
dan_ackme 16:7f1d6d359787 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 16:7f1d6d359787 11 * this list of conditions and the following disclaimer.
dan_ackme 16:7f1d6d359787 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 16:7f1d6d359787 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 16:7f1d6d359787 14 * and/or other materials provided with the distribution.
dan_ackme 16:7f1d6d359787 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 16:7f1d6d359787 16 * derived from this software without specific prior written permission.
dan_ackme 16:7f1d6d359787 17 *
dan_ackme 16:7f1d6d359787 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 16:7f1d6d359787 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 16:7f1d6d359787 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 16:7f1d6d359787 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 16:7f1d6d359787 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 16:7f1d6d359787 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 16:7f1d6d359787 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 16:7f1d6d359787 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 16:7f1d6d359787 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 16:7f1d6d359787 27 * OF SUCH DAMAGE.
dan_ackme 0:ea85c4bb5e1f 28 */
dan_ackme 0:ea85c4bb5e1f 29 #pragma once
dan_ackme 0:ea85c4bb5e1f 30
dan_ackme 0:ea85c4bb5e1f 31
dan_ackme 0:ea85c4bb5e1f 32
dan_ackme 0:ea85c4bb5e1f 33 #include "WiconnectTypes.h"
dan_ackme 0:ea85c4bb5e1f 34 #include "StringUtil.h"
dan_ackme 0:ea85c4bb5e1f 35
dan_ackme 0:ea85c4bb5e1f 36
dan_ackme 0:ea85c4bb5e1f 37 namespace wiconnect
dan_ackme 0:ea85c4bb5e1f 38 {
dan_ackme 0:ea85c4bb5e1f 39
dan_ackme 11:ea484e1b7fc4 40 /**
dan_ackme 13:2b51f5267c92 41 * @ingroup api_network_types
dan_ackme 11:ea484e1b7fc4 42 *
dan_ackme 11:ea484e1b7fc4 43 * @brief Contains single entry from WiFi scan results
dan_ackme 11:ea484e1b7fc4 44 *
dan_ackme 11:ea484e1b7fc4 45 */
dan_ackme 0:ea85c4bb5e1f 46 class ScanResult
dan_ackme 0:ea85c4bb5e1f 47 {
dan_ackme 0:ea85c4bb5e1f 48 public:
dan_ackme 0:ea85c4bb5e1f 49 uint8_t getChannel() const;
dan_ackme 0:ea85c4bb5e1f 50 NetworkSignalStrength getSignalStrength() const;
dan_ackme 0:ea85c4bb5e1f 51 const MacAddress* getMacAddress() const;
dan_ackme 0:ea85c4bb5e1f 52 NetworkSecurity getSecurityType() const;
dan_ackme 0:ea85c4bb5e1f 53 uint32_t getRate() const;
dan_ackme 0:ea85c4bb5e1f 54 const char* getRateStr(char *buffer = NULL) const;
dan_ackme 0:ea85c4bb5e1f 55 const Ssid* getSsid() const;
dan_ackme 0:ea85c4bb5e1f 56
dan_ackme 0:ea85c4bb5e1f 57 const ScanResult* getNext() const;
dan_ackme 0:ea85c4bb5e1f 58 const ScanResult* getPrevious() const;
dan_ackme 0:ea85c4bb5e1f 59
dan_ackme 0:ea85c4bb5e1f 60 protected:
dan_ackme 0:ea85c4bb5e1f 61 ScanResult();
dan_ackme 0:ea85c4bb5e1f 62
dan_ackme 0:ea85c4bb5e1f 63 WiconnectResult init(const char *channelStr, const char *rssiStr, const char* macStr, const char *rateStr, const char *secStr, const char *ssidStr);
dan_ackme 0:ea85c4bb5e1f 64 ScanResult *next;
dan_ackme 0:ea85c4bb5e1f 65 ScanResult *previous;
dan_ackme 0:ea85c4bb5e1f 66 uint8_t channel;
dan_ackme 0:ea85c4bb5e1f 67 int16_t rssi;
dan_ackme 0:ea85c4bb5e1f 68 MacAddress mac;
dan_ackme 0:ea85c4bb5e1f 69 uint32_t rate;
dan_ackme 0:ea85c4bb5e1f 70 NetworkSecurity security;
dan_ackme 0:ea85c4bb5e1f 71 Ssid ssid;
dan_ackme 0:ea85c4bb5e1f 72
dan_ackme 0:ea85c4bb5e1f 73 void* operator new(size_t size);
dan_ackme 0:ea85c4bb5e1f 74 void operator delete(void*);
dan_ackme 0:ea85c4bb5e1f 75
dan_ackme 0:ea85c4bb5e1f 76 friend class ScanResultList;
dan_ackme 0:ea85c4bb5e1f 77 };
dan_ackme 0:ea85c4bb5e1f 78
dan_ackme 0:ea85c4bb5e1f 79
dan_ackme 0:ea85c4bb5e1f 80
dan_ackme 0:ea85c4bb5e1f 81
dan_ackme 0:ea85c4bb5e1f 82
dan_ackme 0:ea85c4bb5e1f 83
dan_ackme 0:ea85c4bb5e1f 84 }