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

NetworkInterface.h@0:ea85c4bb5e1f, 2014-08-11 (annotated)

Committer:
dan_ackme
Date:
Mon Aug 11 09:58:24 2014 +0000
Revision:
0:ea85c4bb5e1f
Child:
1:6ec9998427ad
initial check-in

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 #include "WiconnectTypes.h"
dan_ackme 0:ea85c4bb5e1f 15 #include "types/ScanResultList.h"
dan_ackme 0:ea85c4bb5e1f 16
dan_ackme 0:ea85c4bb5e1f 17
dan_ackme 0:ea85c4bb5e1f 18 namespace wiconnect {
dan_ackme 0:ea85c4bb5e1f 19
dan_ackme 0:ea85c4bb5e1f 20
dan_ackme 0:ea85c4bb5e1f 21 class NetworkInterface
dan_ackme 0:ea85c4bb5e1f 22 {
dan_ackme 0:ea85c4bb5e1f 23 public:
dan_ackme 0:ea85c4bb5e1f 24 WiconnectResult startWebSetup(const char *ssid = NULL, const char *password = NULL, const Callback &completeHandler = Callback());
dan_ackme 0:ea85c4bb5e1f 25 WiconnectResult stopWebSetup();
dan_ackme 0:ea85c4bb5e1f 26 WiconnectResult isWebSetupRunning(bool *isRunningPtr);
dan_ackme 0:ea85c4bb5e1f 27
dan_ackme 0:ea85c4bb5e1f 28 WiconnectResult join(const char* ssid = NULL, const char *password = NULL, const Callback &completeHandler = Callback());
dan_ackme 0:ea85c4bb5e1f 29 WiconnectResult leave();
dan_ackme 0:ea85c4bb5e1f 30 WiconnectResult getNetworkStatus(NetworkStatus *statusPtr);
dan_ackme 0:ea85c4bb5e1f 31
dan_ackme 0:ea85c4bb5e1f 32 // WiconnectResult startSoftAp(const char* ssid = NULL, const char *password = NULL, const Callback &clientConnectedCallback = Callback());
dan_ackme 0:ea85c4bb5e1f 33 // WiconnectResult stopSoftAp();
dan_ackme 0:ea85c4bb5e1f 34 // WiconnectResult getSoftApClientList();
dan_ackme 0:ea85c4bb5e1f 35
dan_ackme 0:ea85c4bb5e1f 36 WiconnectResult scan(ScanResultList &resultList, const uint8_t *channelList = NULL, const char* ssid = NULL);
dan_ackme 0:ea85c4bb5e1f 37 WiconnectResult ping(const char *domain = NULL, uint32_t *timeMsPtr = NULL);
dan_ackme 0:ea85c4bb5e1f 38 WiconnectResult lookup(const char *domain, uint32_t *ipAddressPtr);
dan_ackme 0:ea85c4bb5e1f 39
dan_ackme 0:ea85c4bb5e1f 40 WiconnectResult setDhcpEnabled(bool enabled);
dan_ackme 0:ea85c4bb5e1f 41 WiconnectResult getDhcpEnabled(bool *enabledPtr);
dan_ackme 0:ea85c4bb5e1f 42 WiconnectResult setIpSettings(uint32_t ip, uint32_t netmask, uint32_t gateway);
dan_ackme 0:ea85c4bb5e1f 43 WiconnectResult setIpSettings(const char* ip, const char* netmask, const char* gateway);
dan_ackme 0:ea85c4bb5e1f 44 WiconnectResult getIpSettings(uint32_t *ip, uint32_t *netmask, uint32_t *gateway);
dan_ackme 0:ea85c4bb5e1f 45 WiconnectResult getSignalStrength(NetworkSignalStrength *signalStrengthPtr);
dan_ackme 0:ea85c4bb5e1f 46
dan_ackme 0:ea85c4bb5e1f 47 static bool strToIp(const char *str, uint32_t *intPtr);
dan_ackme 0:ea85c4bb5e1f 48 static const char* ipToStr(uint32_t ip, char *ipStrBuffer = NULL);
dan_ackme 0:ea85c4bb5e1f 49 static const char* networkStatusToStr(NetworkStatus status);
dan_ackme 0:ea85c4bb5e1f 50 static const char* signalStrengthToStr(NetworkSignalStrength signalStrenth);
dan_ackme 0:ea85c4bb5e1f 51 static NetworkSignalStrength rssiToSignalStrength(int rssi);
dan_ackme 0:ea85c4bb5e1f 52 static NetworkSecurity strToNetworkSecurity(const char *str);
dan_ackme 0:ea85c4bb5e1f 53 static const char* networkSecurityToStr(NetworkSecurity security);
dan_ackme 0:ea85c4bb5e1f 54 static bool strToSsid(const char *str, Ssid *ssid);
dan_ackme 0:ea85c4bb5e1f 55 static const char* ssidToStr(const Ssid *ssid, char *ssidStrBuffer = NULL);
dan_ackme 0:ea85c4bb5e1f 56 static bool strToMacAddress(const char *str, MacAddress *macAddress);
dan_ackme 0:ea85c4bb5e1f 57 static const char* macAddressToStr(const MacAddress *macAddress, char *macStrBuffer = NULL);
dan_ackme 0:ea85c4bb5e1f 58
dan_ackme 0:ea85c4bb5e1f 59 protected:
dan_ackme 0:ea85c4bb5e1f 60 NetworkInterface(Wiconnect *wiconnect);
dan_ackme 0:ea85c4bb5e1f 61
dan_ackme 0:ea85c4bb5e1f 62 WiconnectResult processScanResults(char *resultStr, ScanResultList &resultList);
dan_ackme 0:ea85c4bb5e1f 63
dan_ackme 0:ea85c4bb5e1f 64 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 0:ea85c4bb5e1f 65 Callback completeHandler;
dan_ackme 0:ea85c4bb5e1f 66 PeriodicTimer monitorTimer;
dan_ackme 0:ea85c4bb5e1f 67
dan_ackme 0:ea85c4bb5e1f 68 void webSetupStatusMonitor();
dan_ackme 0:ea85c4bb5e1f 69 void webSetupStatusCheckCallback(WiconnectResult result, void *arg1, void *arg2);
dan_ackme 0:ea85c4bb5e1f 70
dan_ackme 0:ea85c4bb5e1f 71 void joinStatusMonitor();
dan_ackme 0:ea85c4bb5e1f 72 void joinStatusCheckCallback(WiconnectResult result, void *arg1, void *arg2);
dan_ackme 0:ea85c4bb5e1f 73
dan_ackme 0:ea85c4bb5e1f 74 //void scanCompleteCallback(WiconnectResult result, void *arg1, void *arg2);
dan_ackme 0:ea85c4bb5e1f 75 #endif
dan_ackme 0:ea85c4bb5e1f 76
dan_ackme 0:ea85c4bb5e1f 77 private:
dan_ackme 0:ea85c4bb5e1f 78 Wiconnect *wiconnect;
dan_ackme 0:ea85c4bb5e1f 79 };
dan_ackme 0:ea85c4bb5e1f 80
dan_ackme 0:ea85c4bb5e1f 81 }
dan_ackme 0:ea85c4bb5e1f 82