WiFiClientStream added #289
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -110,7 +110,7 @@ | |
| // the minimum interval for sampling analog input | ||
| #define MINIMUM_SAMPLING_INTERVAL 1 | ||
|
|
||
| #define MAX_CONN_ATTEMPTS 20 // [500 ms] -> 10 s | ||
|
|
||
| /*============================================================================== | ||
| * GLOBAL VARIABLES | ||
|
|
@@ -130,8 +130,8 @@ IPAddress subnet(SUBNET_MASK); | |
| IPAddress gateway(GATEWAY_IP_ADDRESS); | ||
| #endif | ||
|
|
||
| int connectionAttempts = 0; | ||
| bool streamConnected = false; | ||
|
|
||
| /* analog inputs */ | ||
| int analogInputsToReport = 0; // bitwise array to store pin reporting | ||
|
|
@@ -308,6 +308,12 @@ void checkDigitalInputs(void) | |
| if (TOTAL_PORTS > 15 && reportPINs[15]) outputPort(15, readPort(15, portConfigInputs[15]), false); | ||
| } | ||
|
|
||
| // ----------------------------------------------------------------------------- | ||
| // function forward declarations | ||
| void enableI2CPins(); | ||
| void disableI2CPins(); | ||
| void reportAnalogCallback(byte analogPin, int value); | ||
|
|
||
| // ----------------------------------------------------------------------------- | ||
| /* sets the pin mode to the correct state and sets the relevant bits in the | ||
| * two bit-arrays that track Digital I/O and PWM status | ||
|
|
@@ -826,38 +832,26 @@ void systemResetCallback() | |
| } | ||
|
|
||
| void printWifiStatus() { | ||
| if ( WiFi.status() != WL_CONNECTED ) | ||
| { | ||
| DEBUG_PRINT( "WiFi connection failed. Status value: " ); | ||
| DEBUG_PRINTLN( WiFi.status() ); | ||
| } | ||
| else | ||
| { | ||
| // print the SSID of the network you're attached to: | ||
| DEBUG_PRINT( "SSID: " ); | ||
| DEBUG_PRINTLN( WiFi.SSID() ); | ||
|
|
||
| // print your WiFi shield's IP address: | ||
| DEBUG_PRINT( "IP Address: " ); | ||
| IPAddress ip = WiFi.localIP(); | ||
| DEBUG_PRINTLN( ip ); | ||
|
|
||
| // print the received signal strength: | ||
| DEBUG_PRINT( "signal strength (RSSI): " ); | ||
| long rssi = WiFi.RSSI(); | ||
| DEBUG_PRINT( rssi ); | ||
| DEBUG_PRINTLN( " dBm" ); | ||
| } | ||
| } | ||
|
|
@@ -890,7 +884,7 @@ void setup() | |
| #ifdef STATIC_IP_ADDRESS | ||
| DEBUG_PRINT( "Using static IP: " ); | ||
| DEBUG_PRINTLN( local_ip ); | ||
| #if defined(ESP8266_WIFI) || (defined(SUBNET_MASK) && defined(GATEWAY_IP_ADDRESS)) | ||
| stream.config( local_ip , gateway, subnet ); | ||
| #else | ||
| // you can also provide a static IP in the begin() functions, but this simplifies | ||
|
|
@@ -902,37 +896,36 @@ void setup() | |
| #endif | ||
|
|
||
| /* | ||
| * Configure WiFi security and initiate WiFi connection | ||
| */ | ||
| #if defined(WIFI_WEP_SECURITY) | ||
| DEBUG_PRINT( "Attempting to connect to WEP SSID: " ); | ||
| DEBUG_PRINTLN(ssid); | ||
| stream.begin(ssid, wep_index, wep_key); | ||
| #elif defined(WIFI_WPA_SECURITY) | ||
| DEBUG_PRINT( "Attempting to connect to WPA SSID: " ); | ||
| DEBUG_PRINTLN(ssid); | ||
| stream.begin(ssid, wpa_passphrase); | ||
| #else //OPEN network | ||
| DEBUG_PRINTLN( "Attempting to connect to open SSID: " ); | ||
| DEBUG_PRINTLN(ssid); | ||
| stream.begin(ssid); | ||
| #endif //defined(WIFI_WEP_SECURITY) | ||
| DEBUG_PRINTLN( "WiFi setup done" ); | ||
|
|
||
| /* | ||
| * Wait for TCP connection to be established | ||
| */ | ||
| while (!streamConnected && ++connectionAttempts <= MAX_CONN_ATTEMPTS) { | ||
| delay(500); | ||
| DEBUG_PRINT("."); | ||
| streamConnected = stream.maintain(); | ||
|
There was a problem hiding this comment. add: |
||
| } | ||
| if (streamConnected) { | ||
| DEBUG_PRINTLN( "TCP connection established" ); | ||
| } else { | ||
| DEBUG_PRINTLN( "failed to establish TCP connection" ); | ||
|
There was a problem hiding this comment. This is also reported in There was a problem hiding this comment. This is also misleading currently as I get the failed message if I am not fast enough in starting up my host application. Maybe the while loop should continue until a connection is made and/or use a much longer timeout). Previously the while loop only waited until a connection was made with the router. There was a problem hiding this comment. I didn't have a looked at the debug output so far. Waiting until connected is a drawback if you add active logic that runs independently of the host. That is one reason why I wanted to introduce a hostConnectedCallback. Regarding the timeout, I reduced it by about 30% because an ESP8266 with static IP typically connects in less than 1.5 seconds. Raising the timeout should help somewhat. There was a problem hiding this comment. #define MAX_CONN_ATTEMPTS 20 // [500 ms] -> 10 sshould be long enough for a WiFi connect + DHCP + TCP connect in most cases, but I know there are situations where it needs more time, especially if the signal strength is weak. I am still not sure if this is reason enough to use a higher timeout. An easy way to cope with different requirements would be to move the timeout value into the config file and assign a default. |
||
| } | ||
| printWifiStatus(); | ||
|
|
||
| /* | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| WiFiClientStream.h | ||
|
|
||
| An Arduino Stream that wraps an instance of a WiFiClient. For use | ||
| with legacy Arduino WiFi shield and other boards and shields that | ||
| are compatible with the Arduino WiFi library. | ||
|
|
||
| Copyright (C) 2016 Jens B. All rights reserved. | ||
|
|
||
| This library is free software; you can redistribute it and/or | ||
| modify it under the terms of the GNU Lesser General Public | ||
| License as published by the Free Software Foundation; either | ||
| version 2.1 of the License, or (at your option) any later version. | ||
|
|
||
| See file LICENSE.txt for further informations on licensing terms. | ||
|
|
||
| Parts of this class are based on | ||
|
|
||
| - EthernetClientStream - Copyright (C) 2013 Norbert Truchsess. All rights reserved. | ||
|
|
||
| published under the same license. | ||
|
|
||
| Last updated April 17th, 2016 | ||
| */ | ||
|
|
||
| #ifndef WIFI_CLIENT_STREAM_H | ||
| #define WIFI_CLIENT_STREAM_H | ||
|
|
||
| #include "WiFiStream.h" | ||
|
|
||
| #define MILLIS_RECONNECT 5000 | ||
|
|
||
| class WiFiClientStream : public WiFiStream | ||
| { | ||
| protected: | ||
| uint32_t _time_connect = 0; | ||
|
|
||
| /** | ||
| * check if TCP client is connected | ||
| * @return true if connected | ||
| */ | ||
| virtual inline bool connect_client() | ||
| { | ||
| if( _client && _client.connected() ) return true; | ||
|
|
||
| if( _connected ) | ||
| { | ||
| stop(); | ||
| } | ||
|
|
||
| // active TCP connect | ||
| if( WiFi.status() == WL_CONNECTED ) | ||
| { | ||
| // if the client is disconnected, try to reconnect every 5 seconds | ||
| if( millis() - _time_connect >= MILLIS_RECONNECT ) | ||
| { | ||
| _connected = _client.connect( _remote_ip, _port ); | ||
| if( !_connected ) | ||
| { | ||
| _time_connect = millis(); | ||
| } | ||
| else if ( _currentHostConnectionCallback ) | ||
| { | ||
| (*_currentHostConnectionCallback)(HOST_CONNECTION_CONNECTED); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return _connected; | ||
| } | ||
|
|
||
| public: | ||
| /** | ||
| * create a WiFi stream with a TCP client | ||
| */ | ||
| WiFiClientStream(IPAddress server_ip, uint16_t server_port) : WiFiStream(server_ip, server_port) {} | ||
|
|
||
| /** | ||
| * maintain WiFi and TCP connection | ||
| * @return true if WiFi and TCP connection are established | ||
| */ | ||
| virtual inline bool maintain() | ||
| { | ||
| return connect_client(); | ||
| } | ||
|
|
||
| /** | ||
| * stop client connection | ||
| */ | ||
| virtual inline void stop() | ||
| { | ||
| if( _client) | ||
| { | ||
| _client.stop(); | ||
| if ( _currentHostConnectionCallback ) | ||
| { | ||
| (*_currentHostConnectionCallback)(HOST_CONNECTION_DISCONNECTED); | ||
| } | ||
| } | ||
| _connected = false; | ||
| _time_connect = millis(); | ||
| } | ||
|
|
||
| }; | ||
|
|
||
| #endif //WIFI_CLIENT_STREAM_H |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
which compiler needs these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Xtensa Compiler for the ESP8266 can't do without forward declarations if you want to call a function before it is defined. I havn't checked the dependencies. If there are no circular references reordering the functions can avoid this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After reordering the functions in the sketch the forward definitions can be removed. But there is also the question of context, of keeping certain functions in a textual proximity or order to each other.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strange I have not run into any compiler errors when using the ESP8266 Arduino core and I have successfully compiled each module that library supports (except ThaiEasyElec's ESPino which fails). At least not as of version 2.1.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While compiling I see the version 1.20.0-26 for the Xtensa and a lot of compiler options that are handled by the Arduino IDE. Maybe one of them makes the difference (e.g. for Firmata.cpp):
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, you are compiling via the command line rather than using the Arduino IDE.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, I just changed to verbosity via IDE settings to see what is really happening.