226 changed files with 33895 additions and 0 deletions
@ -0,0 +1,42 @@ |
|||
// Include the libraries we need
|
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino
|
|||
#define ONE_WIRE_BUS 12 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature.
|
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
/*
|
|||
* The setup function. We only start the sensors here |
|||
*/ |
|||
void setup(void) |
|||
{ |
|||
// start serial port
|
|||
Serial.begin(115200); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library
|
|||
sensors.begin(); |
|||
} |
|||
|
|||
/*
|
|||
* Main function, get and show the temperature |
|||
*/ |
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature
|
|||
// request to all devices on the bus
|
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); // Send the command to get temperatures
|
|||
Serial.println("DONE"); |
|||
// After we got the temperatures, we can print them here.
|
|||
// We use the function ByIndex, and as an example get the temperature from the first sensor only.
|
|||
Serial.print("Temperature for the device 1 (index 0) is: "); |
|||
Serial.println(sensors.getTempCByIndex(0)); |
|||
delay(1000); |
|||
} |
|||
@ -0,0 +1,164 @@ |
|||
#include <Arduino.h> |
|||
#include <ESP8266WiFi.h> |
|||
#include <Hash.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#include <ESPAsyncWebServer.h> |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is connected to GPIO 4
|
|||
#define ONE_WIRE_BUS 12 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices
|
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature sensor
|
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
// Replace with your network credentials
|
|||
const char* ssid = "YOUR_SSID"; |
|||
const char* password = "YOUR_PASSWORD"; |
|||
|
|||
// Create AsyncWebServer object on port 80
|
|||
AsyncWebServer server(80); |
|||
|
|||
String readDSTemperatureC() { |
|||
// Call sensors.requestTemperatures() to issue a global temperature and Requests to all devices on the bus
|
|||
sensors.requestTemperatures(); |
|||
float tempC = sensors.getTempCByIndex(0); |
|||
|
|||
if(tempC == -127.00) { |
|||
Serial.println("Failed to read from DS18B20 sensor"); |
|||
return "--"; |
|||
} else { |
|||
Serial.print("Temperature Celsius: "); |
|||
Serial.println(tempC); |
|||
} |
|||
return String(tempC); |
|||
} |
|||
|
|||
String readDSTemperatureF() { |
|||
// Call sensors.requestTemperatures() to issue a global temperature and Requests to all devices on the bus
|
|||
sensors.requestTemperatures(); |
|||
float tempF = sensors.getTempFByIndex(0); |
|||
|
|||
if(int(tempF) == -196){ |
|||
Serial.println("Failed to read from DS18B20 sensor"); |
|||
return "--"; |
|||
} else { |
|||
Serial.print("Temperature Fahrenheit: "); |
|||
Serial.println(tempF); |
|||
} |
|||
return String(tempF); |
|||
} |
|||
|
|||
const char index_html[] PROGMEM = R"rawliteral( |
|||
<!DOCTYPE HTML><html> |
|||
<head> |
|||
<meta name="viewport" content="width=device-width, initial-scale=1"> |
|||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous"> |
|||
<style> |
|||
html { |
|||
font-family: Arial; |
|||
display: inline-block; |
|||
margin: 0px auto; |
|||
text-align: center; |
|||
} |
|||
h2 { font-size: 3.0rem; } |
|||
p { font-size: 3.0rem; } |
|||
.units { font-size: 1.2rem; } |
|||
.ds-labels{ |
|||
font-size: 1.5rem; |
|||
vertical-align:middle; |
|||
padding-bottom: 15px; |
|||
} |
|||
</style> |
|||
</head> |
|||
<body> |
|||
<h2>ESP DS18B20 Server</h2> |
|||
<p> |
|||
<i class="fas fa-thermometer-half" style="color:#059e8a;"></i> |
|||
<span class="ds-labels">Temperature Celsius</span> |
|||
<span id="temperaturec">%TEMPERATUREC%</span> |
|||
<sup class="units">°C</sup> |
|||
</p> |
|||
<p> |
|||
<i class="fas fa-thermometer-half" style="color:#059e8a;"></i> |
|||
<span class="ds-labels">Temperature Fahrenheit</span> |
|||
<span id="temperaturef">%TEMPERATUREF%</span> |
|||
<sup class="units">°F</sup> |
|||
</p> |
|||
</body> |
|||
<script> |
|||
setInterval(function ( ) { |
|||
var xhttp = new XMLHttpRequest(); |
|||
xhttp.onreadystatechange = function() { |
|||
if (this.readyState == 4 && this.status == 200) { |
|||
document.getElementById("temperaturec").innerHTML = this.responseText; |
|||
} |
|||
}; |
|||
xhttp.open("GET", "/temperaturec", true); |
|||
xhttp.send(); |
|||
}, 10000) ; |
|||
setInterval(function ( ) { |
|||
var xhttp = new XMLHttpRequest(); |
|||
xhttp.onreadystatechange = function() { |
|||
if (this.readyState == 4 && this.status == 200) { |
|||
document.getElementById("temperaturef").innerHTML = this.responseText; |
|||
} |
|||
}; |
|||
xhttp.open("GET", "/temperaturef", true); |
|||
xhttp.send(); |
|||
}, 10000) ; |
|||
</script> |
|||
</html>)rawliteral"; |
|||
|
|||
// Replaces placeholder with DHT values
|
|||
String processor(const String& var){ |
|||
//Serial.println(var);
|
|||
if(var == "TEMPERATUREC"){ |
|||
return readDSTemperatureC(); |
|||
} |
|||
else if(var == "TEMPERATUREF"){ |
|||
return readDSTemperatureF(); |
|||
} |
|||
return String(); |
|||
} |
|||
|
|||
void setup(){ |
|||
// Serial port for debugging purposes
|
|||
Serial.begin(115200); |
|||
Serial.println(); |
|||
|
|||
// Start up the DS18B20 library
|
|||
sensors.begin(); |
|||
|
|||
// Connect to Wi-Fi
|
|||
WiFi.begin(ssid, password); |
|||
Serial.println("Connecting to WiFi"); |
|||
while (WiFi.status() != WL_CONNECTED) { |
|||
delay(500); |
|||
Serial.print("."); |
|||
} |
|||
Serial.println(); |
|||
|
|||
// Print ESP Local IP Address
|
|||
Serial.println(WiFi.localIP()); |
|||
|
|||
// Route for root / web page
|
|||
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){ |
|||
request->send_P(200, "text/html", index_html, processor); |
|||
}); |
|||
server.on("/temperaturec", HTTP_GET, [](AsyncWebServerRequest *request){ |
|||
request->send_P(200, "text/plain", readDSTemperatureC().c_str()); |
|||
}); |
|||
server.on("/temperaturef", HTTP_GET, [](AsyncWebServerRequest *request){ |
|||
request->send_P(200, "text/plain", readDSTemperatureF().c_str()); |
|||
}); |
|||
// Start server
|
|||
server.begin(); |
|||
} |
|||
|
|||
void loop(){ |
|||
|
|||
} |
|||
@ -0,0 +1,674 @@ |
|||
GNU GENERAL PUBLIC LICENSE |
|||
Version 3, 29 June 2007 |
|||
|
|||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
|||
Everyone is permitted to copy and distribute verbatim copies |
|||
of this license document, but changing it is not allowed. |
|||
|
|||
Preamble |
|||
|
|||
The GNU General Public License is a free, copyleft license for |
|||
software and other kinds of works. |
|||
|
|||
The licenses for most software and other practical works are designed |
|||
to take away your freedom to share and change the works. By contrast, |
|||
the GNU General Public License is intended to guarantee your freedom to |
|||
share and change all versions of a program--to make sure it remains free |
|||
software for all its users. We, the Free Software Foundation, use the |
|||
GNU General Public License for most of our software; it applies also to |
|||
any other work released this way by its authors. You can apply it to |
|||
your programs, too. |
|||
|
|||
When we speak of free software, we are referring to freedom, not |
|||
price. Our General Public Licenses are designed to make sure that you |
|||
have the freedom to distribute copies of free software (and charge for |
|||
them if you wish), that you receive source code or can get it if you |
|||
want it, that you can change the software or use pieces of it in new |
|||
free programs, and that you know you can do these things. |
|||
|
|||
To protect your rights, we need to prevent others from denying you |
|||
these rights or asking you to surrender the rights. Therefore, you have |
|||
certain responsibilities if you distribute copies of the software, or if |
|||
you modify it: responsibilities to respect the freedom of others. |
|||
|
|||
For example, if you distribute copies of such a program, whether |
|||
gratis or for a fee, you must pass on to the recipients the same |
|||
freedoms that you received. You must make sure that they, too, receive |
|||
or can get the source code. And you must show them these terms so they |
|||
know their rights. |
|||
|
|||
Developers that use the GNU GPL protect your rights with two steps: |
|||
(1) assert copyright on the software, and (2) offer you this License |
|||
giving you legal permission to copy, distribute and/or modify it. |
|||
|
|||
For the developers' and authors' protection, the GPL clearly explains |
|||
that there is no warranty for this free software. For both users' and |
|||
authors' sake, the GPL requires that modified versions be marked as |
|||
changed, so that their problems will not be attributed erroneously to |
|||
authors of previous versions. |
|||
|
|||
Some devices are designed to deny users access to install or run |
|||
modified versions of the software inside them, although the manufacturer |
|||
can do so. This is fundamentally incompatible with the aim of |
|||
protecting users' freedom to change the software. The systematic |
|||
pattern of such abuse occurs in the area of products for individuals to |
|||
use, which is precisely where it is most unacceptable. Therefore, we |
|||
have designed this version of the GPL to prohibit the practice for those |
|||
products. If such problems arise substantially in other domains, we |
|||
stand ready to extend this provision to those domains in future versions |
|||
of the GPL, as needed to protect the freedom of users. |
|||
|
|||
Finally, every program is threatened constantly by software patents. |
|||
States should not allow patents to restrict development and use of |
|||
software on general-purpose computers, but in those that do, we wish to |
|||
avoid the special danger that patents applied to a free program could |
|||
make it effectively proprietary. To prevent this, the GPL assures that |
|||
patents cannot be used to render the program non-free. |
|||
|
|||
The precise terms and conditions for copying, distribution and |
|||
modification follow. |
|||
|
|||
TERMS AND CONDITIONS |
|||
|
|||
0. Definitions. |
|||
|
|||
"This License" refers to version 3 of the GNU General Public License. |
|||
|
|||
"Copyright" also means copyright-like laws that apply to other kinds of |
|||
works, such as semiconductor masks. |
|||
|
|||
"The Program" refers to any copyrightable work licensed under this |
|||
License. Each licensee is addressed as "you". "Licensees" and |
|||
"recipients" may be individuals or organizations. |
|||
|
|||
To "modify" a work means to copy from or adapt all or part of the work |
|||
in a fashion requiring copyright permission, other than the making of an |
|||
exact copy. The resulting work is called a "modified version" of the |
|||
earlier work or a work "based on" the earlier work. |
|||
|
|||
A "covered work" means either the unmodified Program or a work based |
|||
on the Program. |
|||
|
|||
To "propagate" a work means to do anything with it that, without |
|||
permission, would make you directly or secondarily liable for |
|||
infringement under applicable copyright law, except executing it on a |
|||
computer or modifying a private copy. Propagation includes copying, |
|||
distribution (with or without modification), making available to the |
|||
public, and in some countries other activities as well. |
|||
|
|||
To "convey" a work means any kind of propagation that enables other |
|||
parties to make or receive copies. Mere interaction with a user through |
|||
a computer network, with no transfer of a copy, is not conveying. |
|||
|
|||
An interactive user interface displays "Appropriate Legal Notices" |
|||
to the extent that it includes a convenient and prominently visible |
|||
feature that (1) displays an appropriate copyright notice, and (2) |
|||
tells the user that there is no warranty for the work (except to the |
|||
extent that warranties are provided), that licensees may convey the |
|||
work under this License, and how to view a copy of this License. If |
|||
the interface presents a list of user commands or options, such as a |
|||
menu, a prominent item in the list meets this criterion. |
|||
|
|||
1. Source Code. |
|||
|
|||
The "source code" for a work means the preferred form of the work |
|||
for making modifications to it. "Object code" means any non-source |
|||
form of a work. |
|||
|
|||
A "Standard Interface" means an interface that either is an official |
|||
standard defined by a recognized standards body, or, in the case of |
|||
interfaces specified for a particular programming language, one that |
|||
is widely used among developers working in that language. |
|||
|
|||
The "System Libraries" of an executable work include anything, other |
|||
than the work as a whole, that (a) is included in the normal form of |
|||
packaging a Major Component, but which is not part of that Major |
|||
Component, and (b) serves only to enable use of the work with that |
|||
Major Component, or to implement a Standard Interface for which an |
|||
implementation is available to the public in source code form. A |
|||
"Major Component", in this context, means a major essential component |
|||
(kernel, window system, and so on) of the specific operating system |
|||
(if any) on which the executable work runs, or a compiler used to |
|||
produce the work, or an object code interpreter used to run it. |
|||
|
|||
The "Corresponding Source" for a work in object code form means all |
|||
the source code needed to generate, install, and (for an executable |
|||
work) run the object code and to modify the work, including scripts to |
|||
control those activities. However, it does not include the work's |
|||
System Libraries, or general-purpose tools or generally available free |
|||
programs which are used unmodified in performing those activities but |
|||
which are not part of the work. For example, Corresponding Source |
|||
includes interface definition files associated with source files for |
|||
the work, and the source code for shared libraries and dynamically |
|||
linked subprograms that the work is specifically designed to require, |
|||
such as by intimate data communication or control flow between those |
|||
subprograms and other parts of the work. |
|||
|
|||
The Corresponding Source need not include anything that users |
|||
can regenerate automatically from other parts of the Corresponding |
|||
Source. |
|||
|
|||
The Corresponding Source for a work in source code form is that |
|||
same work. |
|||
|
|||
2. Basic Permissions. |
|||
|
|||
All rights granted under this License are granted for the term of |
|||
copyright on the Program, and are irrevocable provided the stated |
|||
conditions are met. This License explicitly affirms your unlimited |
|||
permission to run the unmodified Program. The output from running a |
|||
covered work is covered by this License only if the output, given its |
|||
content, constitutes a covered work. This License acknowledges your |
|||
rights of fair use or other equivalent, as provided by copyright law. |
|||
|
|||
You may make, run and propagate covered works that you do not |
|||
convey, without conditions so long as your license otherwise remains |
|||
in force. You may convey covered works to others for the sole purpose |
|||
of having them make modifications exclusively for you, or provide you |
|||
with facilities for running those works, provided that you comply with |
|||
the terms of this License in conveying all material for which you do |
|||
not control copyright. Those thus making or running the covered works |
|||
for you must do so exclusively on your behalf, under your direction |
|||
and control, on terms that prohibit them from making any copies of |
|||
your copyrighted material outside their relationship with you. |
|||
|
|||
Conveying under any other circumstances is permitted solely under |
|||
the conditions stated below. Sublicensing is not allowed; section 10 |
|||
makes it unnecessary. |
|||
|
|||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
|||
|
|||
No covered work shall be deemed part of an effective technological |
|||
measure under any applicable law fulfilling obligations under article |
|||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
|||
similar laws prohibiting or restricting circumvention of such |
|||
measures. |
|||
|
|||
When you convey a covered work, you waive any legal power to forbid |
|||
circumvention of technological measures to the extent such circumvention |
|||
is effected by exercising rights under this License with respect to |
|||
the covered work, and you disclaim any intention to limit operation or |
|||
modification of the work as a means of enforcing, against the work's |
|||
users, your or third parties' legal rights to forbid circumvention of |
|||
technological measures. |
|||
|
|||
4. Conveying Verbatim Copies. |
|||
|
|||
You may convey verbatim copies of the Program's source code as you |
|||
receive it, in any medium, provided that you conspicuously and |
|||
appropriately publish on each copy an appropriate copyright notice; |
|||
keep intact all notices stating that this License and any |
|||
non-permissive terms added in accord with section 7 apply to the code; |
|||
keep intact all notices of the absence of any warranty; and give all |
|||
recipients a copy of this License along with the Program. |
|||
|
|||
You may charge any price or no price for each copy that you convey, |
|||
and you may offer support or warranty protection for a fee. |
|||
|
|||
5. Conveying Modified Source Versions. |
|||
|
|||
You may convey a work based on the Program, or the modifications to |
|||
produce it from the Program, in the form of source code under the |
|||
terms of section 4, provided that you also meet all of these conditions: |
|||
|
|||
a) The work must carry prominent notices stating that you modified |
|||
it, and giving a relevant date. |
|||
|
|||
b) The work must carry prominent notices stating that it is |
|||
released under this License and any conditions added under section |
|||
7. This requirement modifies the requirement in section 4 to |
|||
"keep intact all notices". |
|||
|
|||
c) You must license the entire work, as a whole, under this |
|||
License to anyone who comes into possession of a copy. This |
|||
License will therefore apply, along with any applicable section 7 |
|||
additional terms, to the whole of the work, and all its parts, |
|||
regardless of how they are packaged. This License gives no |
|||
permission to license the work in any other way, but it does not |
|||
invalidate such permission if you have separately received it. |
|||
|
|||
d) If the work has interactive user interfaces, each must display |
|||
Appropriate Legal Notices; however, if the Program has interactive |
|||
interfaces that do not display Appropriate Legal Notices, your |
|||
work need not make them do so. |
|||
|
|||
A compilation of a covered work with other separate and independent |
|||
works, which are not by their nature extensions of the covered work, |
|||
and which are not combined with it such as to form a larger program, |
|||
in or on a volume of a storage or distribution medium, is called an |
|||
"aggregate" if the compilation and its resulting copyright are not |
|||
used to limit the access or legal rights of the compilation's users |
|||
beyond what the individual works permit. Inclusion of a covered work |
|||
in an aggregate does not cause this License to apply to the other |
|||
parts of the aggregate. |
|||
|
|||
6. Conveying Non-Source Forms. |
|||
|
|||
You may convey a covered work in object code form under the terms |
|||
of sections 4 and 5, provided that you also convey the |
|||
machine-readable Corresponding Source under the terms of this License, |
|||
in one of these ways: |
|||
|
|||
a) Convey the object code in, or embodied in, a physical product |
|||
(including a physical distribution medium), accompanied by the |
|||
Corresponding Source fixed on a durable physical medium |
|||
customarily used for software interchange. |
|||
|
|||
b) Convey the object code in, or embodied in, a physical product |
|||
(including a physical distribution medium), accompanied by a |
|||
written offer, valid for at least three years and valid for as |
|||
long as you offer spare parts or customer support for that product |
|||
model, to give anyone who possesses the object code either (1) a |
|||
copy of the Corresponding Source for all the software in the |
|||
product that is covered by this License, on a durable physical |
|||
medium customarily used for software interchange, for a price no |
|||
more than your reasonable cost of physically performing this |
|||
conveying of source, or (2) access to copy the |
|||
Corresponding Source from a network server at no charge. |
|||
|
|||
c) Convey individual copies of the object code with a copy of the |
|||
written offer to provide the Corresponding Source. This |
|||
alternative is allowed only occasionally and noncommercially, and |
|||
only if you received the object code with such an offer, in accord |
|||
with subsection 6b. |
|||
|
|||
d) Convey the object code by offering access from a designated |
|||
place (gratis or for a charge), and offer equivalent access to the |
|||
Corresponding Source in the same way through the same place at no |
|||
further charge. You need not require recipients to copy the |
|||
Corresponding Source along with the object code. If the place to |
|||
copy the object code is a network server, the Corresponding Source |
|||
may be on a different server (operated by you or a third party) |
|||
that supports equivalent copying facilities, provided you maintain |
|||
clear directions next to the object code saying where to find the |
|||
Corresponding Source. Regardless of what server hosts the |
|||
Corresponding Source, you remain obligated to ensure that it is |
|||
available for as long as needed to satisfy these requirements. |
|||
|
|||
e) Convey the object code using peer-to-peer transmission, provided |
|||
you inform other peers where the object code and Corresponding |
|||
Source of the work are being offered to the general public at no |
|||
charge under subsection 6d. |
|||
|
|||
A separable portion of the object code, whose source code is excluded |
|||
from the Corresponding Source as a System Library, need not be |
|||
included in conveying the object code work. |
|||
|
|||
A "User Product" is either (1) a "consumer product", which means any |
|||
tangible personal property which is normally used for personal, family, |
|||
or household purposes, or (2) anything designed or sold for incorporation |
|||
into a dwelling. In determining whether a product is a consumer product, |
|||
doubtful cases shall be resolved in favor of coverage. For a particular |
|||
product received by a particular user, "normally used" refers to a |
|||
typical or common use of that class of product, regardless of the status |
|||
of the particular user or of the way in which the particular user |
|||
actually uses, or expects or is expected to use, the product. A product |
|||
is a consumer product regardless of whether the product has substantial |
|||
commercial, industrial or non-consumer uses, unless such uses represent |
|||
the only significant mode of use of the product. |
|||
|
|||
"Installation Information" for a User Product means any methods, |
|||
procedures, authorization keys, or other information required to install |
|||
and execute modified versions of a covered work in that User Product from |
|||
a modified version of its Corresponding Source. The information must |
|||
suffice to ensure that the continued functioning of the modified object |
|||
code is in no case prevented or interfered with solely because |
|||
modification has been made. |
|||
|
|||
If you convey an object code work under this section in, or with, or |
|||
specifically for use in, a User Product, and the conveying occurs as |
|||
part of a transaction in which the right of possession and use of the |
|||
User Product is transferred to the recipient in perpetuity or for a |
|||
fixed term (regardless of how the transaction is characterized), the |
|||
Corresponding Source conveyed under this section must be accompanied |
|||
by the Installation Information. But this requirement does not apply |
|||
if neither you nor any third party retains the ability to install |
|||
modified object code on the User Product (for example, the work has |
|||
been installed in ROM). |
|||
|
|||
The requirement to provide Installation Information does not include a |
|||
requirement to continue to provide support service, warranty, or updates |
|||
for a work that has been modified or installed by the recipient, or for |
|||
the User Product in which it has been modified or installed. Access to a |
|||
network may be denied when the modification itself materially and |
|||
adversely affects the operation of the network or violates the rules and |
|||
protocols for communication across the network. |
|||
|
|||
Corresponding Source conveyed, and Installation Information provided, |
|||
in accord with this section must be in a format that is publicly |
|||
documented (and with an implementation available to the public in |
|||
source code form), and must require no special password or key for |
|||
unpacking, reading or copying. |
|||
|
|||
7. Additional Terms. |
|||
|
|||
"Additional permissions" are terms that supplement the terms of this |
|||
License by making exceptions from one or more of its conditions. |
|||
Additional permissions that are applicable to the entire Program shall |
|||
be treated as though they were included in this License, to the extent |
|||
that they are valid under applicable law. If additional permissions |
|||
apply only to part of the Program, that part may be used separately |
|||
under those permissions, but the entire Program remains governed by |
|||
this License without regard to the additional permissions. |
|||
|
|||
When you convey a copy of a covered work, you may at your option |
|||
remove any additional permissions from that copy, or from any part of |
|||
it. (Additional permissions may be written to require their own |
|||
removal in certain cases when you modify the work.) You may place |
|||
additional permissions on material, added by you to a covered work, |
|||
for which you have or can give appropriate copyright permission. |
|||
|
|||
Notwithstanding any other provision of this License, for material you |
|||
add to a covered work, you may (if authorized by the copyright holders of |
|||
that material) supplement the terms of this License with terms: |
|||
|
|||
a) Disclaiming warranty or limiting liability differently from the |
|||
terms of sections 15 and 16 of this License; or |
|||
|
|||
b) Requiring preservation of specified reasonable legal notices or |
|||
author attributions in that material or in the Appropriate Legal |
|||
Notices displayed by works containing it; or |
|||
|
|||
c) Prohibiting misrepresentation of the origin of that material, or |
|||
requiring that modified versions of such material be marked in |
|||
reasonable ways as different from the original version; or |
|||
|
|||
d) Limiting the use for publicity purposes of names of licensors or |
|||
authors of the material; or |
|||
|
|||
e) Declining to grant rights under trademark law for use of some |
|||
trade names, trademarks, or service marks; or |
|||
|
|||
f) Requiring indemnification of licensors and authors of that |
|||
material by anyone who conveys the material (or modified versions of |
|||
it) with contractual assumptions of liability to the recipient, for |
|||
any liability that these contractual assumptions directly impose on |
|||
those licensors and authors. |
|||
|
|||
All other non-permissive additional terms are considered "further |
|||
restrictions" within the meaning of section 10. If the Program as you |
|||
received it, or any part of it, contains a notice stating that it is |
|||
governed by this License along with a term that is a further |
|||
restriction, you may remove that term. If a license document contains |
|||
a further restriction but permits relicensing or conveying under this |
|||
License, you may add to a covered work material governed by the terms |
|||
of that license document, provided that the further restriction does |
|||
not survive such relicensing or conveying. |
|||
|
|||
If you add terms to a covered work in accord with this section, you |
|||
must place, in the relevant source files, a statement of the |
|||
additional terms that apply to those files, or a notice indicating |
|||
where to find the applicable terms. |
|||
|
|||
Additional terms, permissive or non-permissive, may be stated in the |
|||
form of a separately written license, or stated as exceptions; |
|||
the above requirements apply either way. |
|||
|
|||
8. Termination. |
|||
|
|||
You may not propagate or modify a covered work except as expressly |
|||
provided under this License. Any attempt otherwise to propagate or |
|||
modify it is void, and will automatically terminate your rights under |
|||
this License (including any patent licenses granted under the third |
|||
paragraph of section 11). |
|||
|
|||
However, if you cease all violation of this License, then your |
|||
license from a particular copyright holder is reinstated (a) |
|||
provisionally, unless and until the copyright holder explicitly and |
|||
finally terminates your license, and (b) permanently, if the copyright |
|||
holder fails to notify you of the violation by some reasonable means |
|||
prior to 60 days after the cessation. |
|||
|
|||
Moreover, your license from a particular copyright holder is |
|||
reinstated permanently if the copyright holder notifies you of the |
|||
violation by some reasonable means, this is the first time you have |
|||
received notice of violation of this License (for any work) from that |
|||
copyright holder, and you cure the violation prior to 30 days after |
|||
your receipt of the notice. |
|||
|
|||
Termination of your rights under this section does not terminate the |
|||
licenses of parties who have received copies or rights from you under |
|||
this License. If your rights have been terminated and not permanently |
|||
reinstated, you do not qualify to receive new licenses for the same |
|||
material under section 10. |
|||
|
|||
9. Acceptance Not Required for Having Copies. |
|||
|
|||
You are not required to accept this License in order to receive or |
|||
run a copy of the Program. Ancillary propagation of a covered work |
|||
occurring solely as a consequence of using peer-to-peer transmission |
|||
to receive a copy likewise does not require acceptance. However, |
|||
nothing other than this License grants you permission to propagate or |
|||
modify any covered work. These actions infringe copyright if you do |
|||
not accept this License. Therefore, by modifying or propagating a |
|||
covered work, you indicate your acceptance of this License to do so. |
|||
|
|||
10. Automatic Licensing of Downstream Recipients. |
|||
|
|||
Each time you convey a covered work, the recipient automatically |
|||
receives a license from the original licensors, to run, modify and |
|||
propagate that work, subject to this License. You are not responsible |
|||
for enforcing compliance by third parties with this License. |
|||
|
|||
An "entity transaction" is a transaction transferring control of an |
|||
organization, or substantially all assets of one, or subdividing an |
|||
organization, or merging organizations. If propagation of a covered |
|||
work results from an entity transaction, each party to that |
|||
transaction who receives a copy of the work also receives whatever |
|||
licenses to the work the party's predecessor in interest had or could |
|||
give under the previous paragraph, plus a right to possession of the |
|||
Corresponding Source of the work from the predecessor in interest, if |
|||
the predecessor has it or can get it with reasonable efforts. |
|||
|
|||
You may not impose any further restrictions on the exercise of the |
|||
rights granted or affirmed under this License. For example, you may |
|||
not impose a license fee, royalty, or other charge for exercise of |
|||
rights granted under this License, and you may not initiate litigation |
|||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
|||
any patent claim is infringed by making, using, selling, offering for |
|||
sale, or importing the Program or any portion of it. |
|||
|
|||
11. Patents. |
|||
|
|||
A "contributor" is a copyright holder who authorizes use under this |
|||
License of the Program or a work on which the Program is based. The |
|||
work thus licensed is called the contributor's "contributor version". |
|||
|
|||
A contributor's "essential patent claims" are all patent claims |
|||
owned or controlled by the contributor, whether already acquired or |
|||
hereafter acquired, that would be infringed by some manner, permitted |
|||
by this License, of making, using, or selling its contributor version, |
|||
but do not include claims that would be infringed only as a |
|||
consequence of further modification of the contributor version. For |
|||
purposes of this definition, "control" includes the right to grant |
|||
patent sublicenses in a manner consistent with the requirements of |
|||
this License. |
|||
|
|||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
|||
patent license under the contributor's essential patent claims, to |
|||
make, use, sell, offer for sale, import and otherwise run, modify and |
|||
propagate the contents of its contributor version. |
|||
|
|||
In the following three paragraphs, a "patent license" is any express |
|||
agreement or commitment, however denominated, not to enforce a patent |
|||
(such as an express permission to practice a patent or covenant not to |
|||
sue for patent infringement). To "grant" such a patent license to a |
|||
party means to make such an agreement or commitment not to enforce a |
|||
patent against the party. |
|||
|
|||
If you convey a covered work, knowingly relying on a patent license, |
|||
and the Corresponding Source of the work is not available for anyone |
|||
to copy, free of charge and under the terms of this License, through a |
|||
publicly available network server or other readily accessible means, |
|||
then you must either (1) cause the Corresponding Source to be so |
|||
available, or (2) arrange to deprive yourself of the benefit of the |
|||
patent license for this particular work, or (3) arrange, in a manner |
|||
consistent with the requirements of this License, to extend the patent |
|||
license to downstream recipients. "Knowingly relying" means you have |
|||
actual knowledge that, but for the patent license, your conveying the |
|||
covered work in a country, or your recipient's use of the covered work |
|||
in a country, would infringe one or more identifiable patents in that |
|||
country that you have reason to believe are valid. |
|||
|
|||
If, pursuant to or in connection with a single transaction or |
|||
arrangement, you convey, or propagate by procuring conveyance of, a |
|||
covered work, and grant a patent license to some of the parties |
|||
receiving the covered work authorizing them to use, propagate, modify |
|||
or convey a specific copy of the covered work, then the patent license |
|||
you grant is automatically extended to all recipients of the covered |
|||
work and works based on it. |
|||
|
|||
A patent license is "discriminatory" if it does not include within |
|||
the scope of its coverage, prohibits the exercise of, or is |
|||
conditioned on the non-exercise of one or more of the rights that are |
|||
specifically granted under this License. You may not convey a covered |
|||
work if you are a party to an arrangement with a third party that is |
|||
in the business of distributing software, under which you make payment |
|||
to the third party based on the extent of your activity of conveying |
|||
the work, and under which the third party grants, to any of the |
|||
parties who would receive the covered work from you, a discriminatory |
|||
patent license (a) in connection with copies of the covered work |
|||
conveyed by you (or copies made from those copies), or (b) primarily |
|||
for and in connection with specific products or compilations that |
|||
contain the covered work, unless you entered into that arrangement, |
|||
or that patent license was granted, prior to 28 March 2007. |
|||
|
|||
Nothing in this License shall be construed as excluding or limiting |
|||
any implied license or other defenses to infringement that may |
|||
otherwise be available to you under applicable patent law. |
|||
|
|||
12. No Surrender of Others' Freedom. |
|||
|
|||
If conditions are imposed on you (whether by court order, agreement or |
|||
otherwise) that contradict the conditions of this License, they do not |
|||
excuse you from the conditions of this License. If you cannot convey a |
|||
covered work so as to satisfy simultaneously your obligations under this |
|||
License and any other pertinent obligations, then as a consequence you may |
|||
not convey it at all. For example, if you agree to terms that obligate you |
|||
to collect a royalty for further conveying from those to whom you convey |
|||
the Program, the only way you could satisfy both those terms and this |
|||
License would be to refrain entirely from conveying the Program. |
|||
|
|||
13. Use with the GNU Affero General Public License. |
|||
|
|||
Notwithstanding any other provision of this License, you have |
|||
permission to link or combine any covered work with a work licensed |
|||
under version 3 of the GNU Affero General Public License into a single |
|||
combined work, and to convey the resulting work. The terms of this |
|||
License will continue to apply to the part which is the covered work, |
|||
but the special requirements of the GNU Affero General Public License, |
|||
section 13, concerning interaction through a network will apply to the |
|||
combination as such. |
|||
|
|||
14. Revised Versions of this License. |
|||
|
|||
The Free Software Foundation may publish revised and/or new versions of |
|||
the GNU General Public License from time to time. Such new versions will |
|||
be similar in spirit to the present version, but may differ in detail to |
|||
address new problems or concerns. |
|||
|
|||
Each version is given a distinguishing version number. If the |
|||
Program specifies that a certain numbered version of the GNU General |
|||
Public License "or any later version" applies to it, you have the |
|||
option of following the terms and conditions either of that numbered |
|||
version or of any later version published by the Free Software |
|||
Foundation. If the Program does not specify a version number of the |
|||
GNU General Public License, you may choose any version ever published |
|||
by the Free Software Foundation. |
|||
|
|||
If the Program specifies that a proxy can decide which future |
|||
versions of the GNU General Public License can be used, that proxy's |
|||
public statement of acceptance of a version permanently authorizes you |
|||
to choose that version for the Program. |
|||
|
|||
Later license versions may give you additional or different |
|||
permissions. However, no additional obligations are imposed on any |
|||
author or copyright holder as a result of your choosing to follow a |
|||
later version. |
|||
|
|||
15. Disclaimer of Warranty. |
|||
|
|||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
|||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
|||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
|||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
|||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
|||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
|||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
|||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
|||
|
|||
16. Limitation of Liability. |
|||
|
|||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
|||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
|||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
|||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
|||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
|||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
|||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
|||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
|||
SUCH DAMAGES. |
|||
|
|||
17. Interpretation of Sections 15 and 16. |
|||
|
|||
If the disclaimer of warranty and limitation of liability provided |
|||
above cannot be given local legal effect according to their terms, |
|||
reviewing courts shall apply local law that most closely approximates |
|||
an absolute waiver of all civil liability in connection with the |
|||
Program, unless a warranty or assumption of liability accompanies a |
|||
copy of the Program in return for a fee. |
|||
|
|||
END OF TERMS AND CONDITIONS |
|||
|
|||
How to Apply These Terms to Your New Programs |
|||
|
|||
If you develop a new program, and you want it to be of the greatest |
|||
possible use to the public, the best way to achieve this is to make it |
|||
free software which everyone can redistribute and change under these terms. |
|||
|
|||
To do so, attach the following notices to the program. It is safest |
|||
to attach them to the start of each source file to most effectively |
|||
state the exclusion of warranty; and each file should have at least |
|||
the "copyright" line and a pointer to where the full notice is found. |
|||
|
|||
<one line to give the program's name and a brief idea of what it does.> |
|||
Copyright (C) <year> <name of author> |
|||
|
|||
This program is free software: you can redistribute it and/or modify |
|||
it under the terms of the GNU General Public License as published by |
|||
the Free Software Foundation, either version 3 of the License, or |
|||
(at your option) any later version. |
|||
|
|||
This program is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
GNU General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU General Public License |
|||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
|||
|
|||
Also add information on how to contact you by electronic and paper mail. |
|||
|
|||
If the program does terminal interaction, make it output a short |
|||
notice like this when it starts in an interactive mode: |
|||
|
|||
<program> Copyright (C) <year> <name of author> |
|||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
|||
This is free software, and you are welcome to redistribute it |
|||
under certain conditions; type `show c' for details. |
|||
|
|||
The hypothetical commands `show w' and `show c' should show the appropriate |
|||
parts of the General Public License. Of course, your program's commands |
|||
might be different; for a GUI interface, you would use an "about box". |
|||
|
|||
You should also get your employer (if you work as a programmer) or school, |
|||
if any, to sign a "copyright disclaimer" for the program, if necessary. |
|||
For more information on this, and how to apply and follow the GNU GPL, see |
|||
<https://www.gnu.org/licenses/>. |
|||
|
|||
The GNU General Public License does not permit incorporating your program |
|||
into proprietary programs. If your program is a subroutine library, you |
|||
may consider it more useful to permit linking proprietary applications with |
|||
the library. If this is what you want to do, use the GNU Lesser General |
|||
Public License instead of this License. But first, please read |
|||
<https://www.gnu.org/licenses/why-not-lgpl.html>. |
|||
@ -0,0 +1,30 @@ |
|||
# Interfacing DS18B20 with Arduino and ESP8266 |
|||
|
|||
 |
|||
|
|||
Video tutorial : |
|||
|
|||
In this project we are going to Interface the DS18B20 Temperature Sensor with Arduino UNO and ESP8266. |
|||
|
|||
The DS18B20 is a temperature sensor like DHT11 but it is more robust and accurate in comparison to DHT11.It also covers a larger temperature range in comparison to the DHT11 sensor. |
|||
|
|||
So.in this project we will first interface this Sensor with Arduino UNO and display its temperature reading on the Serial Monitor of Arduino IDE and after that we will connect this sensor with ESP8266 and after that we will dislay the temperature sensed on a beautiful web server. |
|||
|
|||
You must check out [PCBWAY](https://www.pcbway.com/) for ordering PCBs online for cheap! |
|||
|
|||
You get 10 good quality PCBs manufactured and shipped to your doorstep for cheap. You will also get a discount on shipping on your first order. Upload your Gerber files onto [PCBWAY](https://www.pcbway.com/) to get them manufactured with good quality and quick turnaround time. |
|||
Check out their online [Gerber viewer](https://www.pcbway.com/project/OnlineGerberViewer.html) function. With reward points you can get free stuff from their [gift shop](https://www.pcbway.com/project/gifts.html). |
|||
 |
|||
|
|||
 |
|||
|
|||
 |
|||
|
|||
|
|||
|
|||
### These are the schematics for this project: |
|||
Schematic for Arduino UNO |
|||
 |
|||
|
|||
Schematic for ESP8266 |
|||
 |
|||
|
After Width: | Height: | Size: 153 KiB |
|
After Width: | Height: | Size: 539 KiB |
|
After Width: | Height: | Size: 181 KiB |
|
After Width: | Height: | Size: 21 KiB |
|
After Width: | Height: | Size: 409 KiB |
|
After Width: | Height: | Size: 546 KiB |
|
After Width: | Height: | Size: 412 KiB |
|
After Width: | Height: | Size: 746 KiB |
|
After Width: | Height: | Size: 157 KiB |
|
After Width: | Height: | Size: 140 KiB |
|
After Width: | Height: | Size: 185 KiB |
|
After Width: | Height: | Size: 846 KiB |
|
After Width: | Height: | Size: 902 KiB |
@ -0,0 +1,885 @@ |
|||
// 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.
|
|||
|
|||
#include "DallasTemperature.h" |
|||
|
|||
#if ARDUINO >= 100 |
|||
#include "Arduino.h" |
|||
#else |
|||
extern "C" { |
|||
#include "WConstants.h" |
|||
} |
|||
#endif |
|||
|
|||
// OneWire commands
|
|||
#define STARTCONVO 0x44 // Tells device to take a temperature reading and put it on the scratchpad
|
|||
#define COPYSCRATCH 0x48 // Copy EEPROM
|
|||
#define READSCRATCH 0xBE // Read EEPROM
|
|||
#define WRITESCRATCH 0x4E // Write to EEPROM
|
|||
#define RECALLSCRATCH 0xB8 // Reload from last known
|
|||
#define READPOWERSUPPLY 0xB4 // Determine if device needs parasite power
|
|||
#define ALARMSEARCH 0xEC // Query bus for devices with an alarm condition
|
|||
|
|||
// Scratchpad locations
|
|||
#define TEMP_LSB 0 |
|||
#define TEMP_MSB 1 |
|||
#define HIGH_ALARM_TEMP 2 |
|||
#define LOW_ALARM_TEMP 3 |
|||
#define CONFIGURATION 4 |
|||
#define INTERNAL_BYTE 5 |
|||
#define COUNT_REMAIN 6 |
|||
#define COUNT_PER_C 7 |
|||
#define SCRATCHPAD_CRC 8 |
|||
|
|||
// Device resolution
|
|||
#define TEMP_9_BIT 0x1F // 9 bit
|
|||
#define TEMP_10_BIT 0x3F // 10 bit
|
|||
#define TEMP_11_BIT 0x5F // 11 bit
|
|||
#define TEMP_12_BIT 0x7F // 12 bit
|
|||
|
|||
#define NO_ALARM_HANDLER ((AlarmHandler *)0) |
|||
|
|||
DallasTemperature::DallasTemperature() |
|||
{ |
|||
#if REQUIRESALARMS |
|||
setAlarmHandler(NO_ALARM_HANDLER); |
|||
#endif |
|||
} |
|||
DallasTemperature::DallasTemperature(OneWire* _oneWire) |
|||
{ |
|||
setOneWire(_oneWire); |
|||
#if REQUIRESALARMS |
|||
setAlarmHandler(NO_ALARM_HANDLER); |
|||
#endif |
|||
} |
|||
|
|||
bool DallasTemperature::validFamily(const uint8_t* deviceAddress) { |
|||
switch (deviceAddress[0]) { |
|||
case DS18S20MODEL: |
|||
case DS18B20MODEL: |
|||
case DS1822MODEL: |
|||
case DS1825MODEL: |
|||
case DS28EA00MODEL: |
|||
return true; |
|||
default: |
|||
return false; |
|||
} |
|||
} |
|||
|
|||
void DallasTemperature::setOneWire(OneWire* _oneWire) { |
|||
|
|||
_wire = _oneWire; |
|||
devices = 0; |
|||
ds18Count = 0; |
|||
parasite = false; |
|||
bitResolution = 9; |
|||
waitForConversion = true; |
|||
checkForConversion = true; |
|||
|
|||
} |
|||
|
|||
// initialise the bus
|
|||
void DallasTemperature::begin(void) { |
|||
|
|||
DeviceAddress deviceAddress; |
|||
|
|||
_wire->reset_search(); |
|||
devices = 0; // Reset the number of devices when we enumerate wire devices
|
|||
ds18Count = 0; // Reset number of DS18xxx Family devices
|
|||
|
|||
while (_wire->search(deviceAddress)) { |
|||
|
|||
if (validAddress(deviceAddress)) { |
|||
|
|||
if (!parasite && readPowerSupply(deviceAddress)) |
|||
parasite = true; |
|||
|
|||
bitResolution = max(bitResolution, getResolution(deviceAddress)); |
|||
|
|||
devices++; |
|||
if (validFamily(deviceAddress)) { |
|||
ds18Count++; |
|||
} |
|||
} |
|||
} |
|||
|
|||
} |
|||
|
|||
// returns the number of devices found on the bus
|
|||
uint8_t DallasTemperature::getDeviceCount(void) { |
|||
return devices; |
|||
} |
|||
|
|||
uint8_t DallasTemperature::getDS18Count(void) { |
|||
return ds18Count; |
|||
} |
|||
|
|||
// returns true if address is valid
|
|||
bool DallasTemperature::validAddress(const uint8_t* deviceAddress) { |
|||
return (_wire->crc8(deviceAddress, 7) == deviceAddress[7]); |
|||
} |
|||
|
|||
// finds an address at a given index on the bus
|
|||
// returns true if the device was found
|
|||
bool DallasTemperature::getAddress(uint8_t* deviceAddress, uint8_t index) { |
|||
|
|||
uint8_t depth = 0; |
|||
|
|||
_wire->reset_search(); |
|||
|
|||
while (depth <= index && _wire->search(deviceAddress)) { |
|||
if (depth == index && validAddress(deviceAddress)) |
|||
return true; |
|||
depth++; |
|||
} |
|||
|
|||
return false; |
|||
|
|||
} |
|||
|
|||
// attempt to determine if the device at the given address is connected to the bus
|
|||
bool DallasTemperature::isConnected(const uint8_t* deviceAddress) { |
|||
|
|||
ScratchPad scratchPad; |
|||
return isConnected(deviceAddress, scratchPad); |
|||
|
|||
} |
|||
|
|||
// attempt to determine if the device at the given address is connected to the bus
|
|||
// also allows for updating the read scratchpad
|
|||
bool DallasTemperature::isConnected(const uint8_t* deviceAddress, |
|||
uint8_t* scratchPad) { |
|||
bool b = readScratchPad(deviceAddress, scratchPad); |
|||
return b && (_wire->crc8(scratchPad, 8) == scratchPad[SCRATCHPAD_CRC]); |
|||
} |
|||
|
|||
bool DallasTemperature::readScratchPad(const uint8_t* deviceAddress, |
|||
uint8_t* scratchPad) { |
|||
|
|||
// send the reset command and fail fast
|
|||
int b = _wire->reset(); |
|||
if (b == 0) |
|||
return false; |
|||
|
|||
_wire->select(deviceAddress); |
|||
_wire->write(READSCRATCH); |
|||
|
|||
// Read all registers in a simple loop
|
|||
// byte 0: temperature LSB
|
|||
// byte 1: temperature MSB
|
|||
// byte 2: high alarm temp
|
|||
// byte 3: low alarm temp
|
|||
// byte 4: DS18S20: store for crc
|
|||
// DS18B20 & DS1822: configuration register
|
|||
// byte 5: internal use & crc
|
|||
// byte 6: DS18S20: COUNT_REMAIN
|
|||
// DS18B20 & DS1822: store for crc
|
|||
// byte 7: DS18S20: COUNT_PER_C
|
|||
// DS18B20 & DS1822: store for crc
|
|||
// byte 8: SCRATCHPAD_CRC
|
|||
for (uint8_t i = 0; i < 9; i++) { |
|||
scratchPad[i] = _wire->read(); |
|||
} |
|||
|
|||
b = _wire->reset(); |
|||
return (b == 1); |
|||
} |
|||
|
|||
void DallasTemperature::writeScratchPad(const uint8_t* deviceAddress, |
|||
const uint8_t* scratchPad) { |
|||
|
|||
_wire->reset(); |
|||
_wire->select(deviceAddress); |
|||
_wire->write(WRITESCRATCH); |
|||
_wire->write(scratchPad[HIGH_ALARM_TEMP]); // high alarm temp
|
|||
_wire->write(scratchPad[LOW_ALARM_TEMP]); // low alarm temp
|
|||
|
|||
// DS1820 and DS18S20 have no configuration register
|
|||
if (deviceAddress[0] != DS18S20MODEL) |
|||
_wire->write(scratchPad[CONFIGURATION]); |
|||
|
|||
_wire->reset(); |
|||
|
|||
// save the newly written values to eeprom
|
|||
_wire->select(deviceAddress); |
|||
_wire->write(COPYSCRATCH, parasite); |
|||
delay(20); // <--- added 20ms delay to allow 10ms long EEPROM write operation (as specified by datasheet)
|
|||
|
|||
if (parasite) |
|||
delay(10); // 10ms delay
|
|||
_wire->reset(); |
|||
|
|||
} |
|||
|
|||
bool DallasTemperature::readPowerSupply(const uint8_t* deviceAddress) { |
|||
|
|||
bool ret = false; |
|||
_wire->reset(); |
|||
_wire->select(deviceAddress); |
|||
_wire->write(READPOWERSUPPLY); |
|||
if (_wire->read_bit() == 0) |
|||
ret = true; |
|||
_wire->reset(); |
|||
return ret; |
|||
|
|||
} |
|||
|
|||
// set resolution of all devices to 9, 10, 11, or 12 bits
|
|||
// if new resolution is out of range, it is constrained.
|
|||
void DallasTemperature::setResolution(uint8_t newResolution) { |
|||
|
|||
bitResolution = constrain(newResolution, 9, 12); |
|||
DeviceAddress deviceAddress; |
|||
for (int i = 0; i < devices; i++) { |
|||
getAddress(deviceAddress, i); |
|||
setResolution(deviceAddress, bitResolution, true); |
|||
} |
|||
|
|||
} |
|||
|
|||
// set resolution of a device to 9, 10, 11, or 12 bits
|
|||
// if new resolution is out of range, 9 bits is used.
|
|||
bool DallasTemperature::setResolution(const uint8_t* deviceAddress, |
|||
uint8_t newResolution, bool skipGlobalBitResolutionCalculation) { |
|||
|
|||
// ensure same behavior as setResolution(uint8_t newResolution)
|
|||
newResolution = constrain(newResolution, 9, 12); |
|||
|
|||
// return when stored value == new value
|
|||
if (getResolution(deviceAddress) == newResolution) |
|||
return true; |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
|
|||
// DS1820 and DS18S20 have no resolution configuration register
|
|||
if (deviceAddress[0] != DS18S20MODEL) { |
|||
|
|||
switch (newResolution) { |
|||
case 12: |
|||
scratchPad[CONFIGURATION] = TEMP_12_BIT; |
|||
break; |
|||
case 11: |
|||
scratchPad[CONFIGURATION] = TEMP_11_BIT; |
|||
break; |
|||
case 10: |
|||
scratchPad[CONFIGURATION] = TEMP_10_BIT; |
|||
break; |
|||
case 9: |
|||
default: |
|||
scratchPad[CONFIGURATION] = TEMP_9_BIT; |
|||
break; |
|||
} |
|||
writeScratchPad(deviceAddress, scratchPad); |
|||
|
|||
// without calculation we can always set it to max
|
|||
bitResolution = max(bitResolution, newResolution); |
|||
|
|||
if (!skipGlobalBitResolutionCalculation |
|||
&& (bitResolution > newResolution)) { |
|||
bitResolution = newResolution; |
|||
DeviceAddress deviceAddr; |
|||
for (int i = 0; i < devices; i++) { |
|||
getAddress(deviceAddr, i); |
|||
bitResolution = max(bitResolution, |
|||
getResolution(deviceAddr)); |
|||
} |
|||
} |
|||
} |
|||
return true; // new value set
|
|||
} |
|||
|
|||
return false; |
|||
|
|||
} |
|||
|
|||
// returns the global resolution
|
|||
uint8_t DallasTemperature::getResolution() { |
|||
return bitResolution; |
|||
} |
|||
|
|||
// returns the current resolution of the device, 9-12
|
|||
// returns 0 if device not found
|
|||
uint8_t DallasTemperature::getResolution(const uint8_t* deviceAddress) { |
|||
|
|||
// DS1820 and DS18S20 have no resolution configuration register
|
|||
if (deviceAddress[0] == DS18S20MODEL) |
|||
return 12; |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
switch (scratchPad[CONFIGURATION]) { |
|||
case TEMP_12_BIT: |
|||
return 12; |
|||
|
|||
case TEMP_11_BIT: |
|||
return 11; |
|||
|
|||
case TEMP_10_BIT: |
|||
return 10; |
|||
|
|||
case TEMP_9_BIT: |
|||
return 9; |
|||
} |
|||
} |
|||
return 0; |
|||
|
|||
} |
|||
|
|||
// sets the value of the waitForConversion flag
|
|||
// TRUE : function requestTemperature() etc returns when conversion is ready
|
|||
// FALSE: function requestTemperature() etc returns immediately (USE WITH CARE!!)
|
|||
// (1) programmer has to check if the needed delay has passed
|
|||
// (2) but the application can do meaningful things in that time
|
|||
void DallasTemperature::setWaitForConversion(bool flag) { |
|||
waitForConversion = flag; |
|||
} |
|||
|
|||
// gets the value of the waitForConversion flag
|
|||
bool DallasTemperature::getWaitForConversion() { |
|||
return waitForConversion; |
|||
} |
|||
|
|||
// sets the value of the checkForConversion flag
|
|||
// TRUE : function requestTemperature() etc will 'listen' to an IC to determine whether a conversion is complete
|
|||
// FALSE: function requestTemperature() etc will wait a set time (worst case scenario) for a conversion to complete
|
|||
void DallasTemperature::setCheckForConversion(bool flag) { |
|||
checkForConversion = flag; |
|||
} |
|||
|
|||
// gets the value of the waitForConversion flag
|
|||
bool DallasTemperature::getCheckForConversion() { |
|||
return checkForConversion; |
|||
} |
|||
|
|||
bool DallasTemperature::isConversionComplete() { |
|||
uint8_t b = _wire->read_bit(); |
|||
return (b == 1); |
|||
} |
|||
|
|||
// sends command for all devices on the bus to perform a temperature conversion
|
|||
void DallasTemperature::requestTemperatures() { |
|||
|
|||
_wire->reset(); |
|||
_wire->skip(); |
|||
_wire->write(STARTCONVO, parasite); |
|||
|
|||
// ASYNC mode?
|
|||
if (!waitForConversion) |
|||
return; |
|||
blockTillConversionComplete(bitResolution); |
|||
|
|||
} |
|||
|
|||
// sends command for one device to perform a temperature by address
|
|||
// returns FALSE if device is disconnected
|
|||
// returns TRUE otherwise
|
|||
bool DallasTemperature::requestTemperaturesByAddress( |
|||
const uint8_t* deviceAddress) { |
|||
|
|||
uint8_t bitResolution = getResolution(deviceAddress); |
|||
if (bitResolution == 0) { |
|||
return false; //Device disconnected
|
|||
} |
|||
|
|||
_wire->reset(); |
|||
_wire->select(deviceAddress); |
|||
_wire->write(STARTCONVO, parasite); |
|||
|
|||
// ASYNC mode?
|
|||
if (!waitForConversion) |
|||
return true; |
|||
|
|||
blockTillConversionComplete(bitResolution); |
|||
|
|||
return true; |
|||
|
|||
} |
|||
|
|||
// Continue to check if the IC has responded with a temperature
|
|||
void DallasTemperature::blockTillConversionComplete(uint8_t bitResolution) { |
|||
|
|||
int delms = millisToWaitForConversion(bitResolution); |
|||
if (checkForConversion && !parasite) { |
|||
unsigned long now = millis(); |
|||
while (!isConversionComplete() && (millis() - delms < now)) |
|||
; |
|||
} else { |
|||
delay(delms); |
|||
} |
|||
|
|||
} |
|||
|
|||
// returns number of milliseconds to wait till conversion is complete (based on IC datasheet)
|
|||
int16_t DallasTemperature::millisToWaitForConversion(uint8_t bitResolution) { |
|||
|
|||
switch (bitResolution) { |
|||
case 9: |
|||
return 94; |
|||
case 10: |
|||
return 188; |
|||
case 11: |
|||
return 375; |
|||
default: |
|||
return 750; |
|||
} |
|||
|
|||
} |
|||
|
|||
// sends command for one device to perform a temp conversion by index
|
|||
bool DallasTemperature::requestTemperaturesByIndex(uint8_t deviceIndex) { |
|||
|
|||
DeviceAddress deviceAddress; |
|||
getAddress(deviceAddress, deviceIndex); |
|||
|
|||
return requestTemperaturesByAddress(deviceAddress); |
|||
|
|||
} |
|||
|
|||
// Fetch temperature for device index
|
|||
float DallasTemperature::getTempCByIndex(uint8_t deviceIndex) { |
|||
|
|||
DeviceAddress deviceAddress; |
|||
if (!getAddress(deviceAddress, deviceIndex)) { |
|||
return DEVICE_DISCONNECTED_C; |
|||
} |
|||
|
|||
return getTempC((uint8_t*) deviceAddress); |
|||
|
|||
} |
|||
|
|||
// Fetch temperature for device index
|
|||
float DallasTemperature::getTempFByIndex(uint8_t deviceIndex) { |
|||
|
|||
DeviceAddress deviceAddress; |
|||
|
|||
if (!getAddress(deviceAddress, deviceIndex)) { |
|||
return DEVICE_DISCONNECTED_F; |
|||
} |
|||
|
|||
return getTempF((uint8_t*) deviceAddress); |
|||
|
|||
} |
|||
|
|||
// reads scratchpad and returns fixed-point temperature, scaling factor 2^-7
|
|||
int16_t DallasTemperature::calculateTemperature(const uint8_t* deviceAddress, |
|||
uint8_t* scratchPad) { |
|||
|
|||
int16_t fpTemperature = (((int16_t) scratchPad[TEMP_MSB]) << 11) |
|||
| (((int16_t) scratchPad[TEMP_LSB]) << 3); |
|||
|
|||
/*
|
|||
DS1820 and DS18S20 have a 9-bit temperature register. |
|||
|
|||
Resolutions greater than 9-bit can be calculated using the data from |
|||
the temperature, and COUNT REMAIN and COUNT PER °C registers in the |
|||
scratchpad. The resolution of the calculation depends on the model. |
|||
|
|||
While the COUNT PER °C register is hard-wired to 16 (10h) in a |
|||
DS18S20, it changes with temperature in DS1820. |
|||
|
|||
After reading the scratchpad, the TEMP_READ value is obtained by |
|||
truncating the 0.5°C bit (bit 0) from the temperature data. The |
|||
extended resolution temperature can then be calculated using the |
|||
following equation: |
|||
|
|||
COUNT_PER_C - COUNT_REMAIN |
|||
TEMPERATURE = TEMP_READ - 0.25 + -------------------------- |
|||
COUNT_PER_C |
|||
|
|||
Hagai Shatz simplified this to integer arithmetic for a 12 bits |
|||
value for a DS18S20, and James Cameron added legacy DS1820 support. |
|||
|
|||
See - http://myarduinotoy.blogspot.co.uk/2013/02/12bit-result-from-ds18s20.html
|
|||
*/ |
|||
|
|||
if (deviceAddress[0] == DS18S20MODEL) { |
|||
fpTemperature = ((fpTemperature & 0xfff0) << 3) - 16 |
|||
+ (((scratchPad[COUNT_PER_C] - scratchPad[COUNT_REMAIN]) << 7) |
|||
/ scratchPad[COUNT_PER_C]); |
|||
} |
|||
|
|||
return fpTemperature; |
|||
} |
|||
|
|||
// returns temperature in 1/128 degrees C or DEVICE_DISCONNECTED_RAW if the
|
|||
// device's scratch pad cannot be read successfully.
|
|||
// the numeric value of DEVICE_DISCONNECTED_RAW is defined in
|
|||
// DallasTemperature.h. It is a large negative number outside the
|
|||
// operating range of the device
|
|||
int16_t DallasTemperature::getTemp(const uint8_t* deviceAddress) { |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) |
|||
return calculateTemperature(deviceAddress, scratchPad); |
|||
return DEVICE_DISCONNECTED_RAW; |
|||
|
|||
} |
|||
|
|||
// returns temperature in degrees C or DEVICE_DISCONNECTED_C if the
|
|||
// device's scratch pad cannot be read successfully.
|
|||
// the numeric value of DEVICE_DISCONNECTED_C is defined in
|
|||
// DallasTemperature.h. It is a large negative number outside the
|
|||
// operating range of the device
|
|||
float DallasTemperature::getTempC(const uint8_t* deviceAddress) { |
|||
return rawToCelsius(getTemp(deviceAddress)); |
|||
} |
|||
|
|||
// returns temperature in degrees F or DEVICE_DISCONNECTED_F if the
|
|||
// device's scratch pad cannot be read successfully.
|
|||
// the numeric value of DEVICE_DISCONNECTED_F is defined in
|
|||
// DallasTemperature.h. It is a large negative number outside the
|
|||
// operating range of the device
|
|||
float DallasTemperature::getTempF(const uint8_t* deviceAddress) { |
|||
return rawToFahrenheit(getTemp(deviceAddress)); |
|||
} |
|||
|
|||
// returns true if the bus requires parasite power
|
|||
bool DallasTemperature::isParasitePowerMode(void) { |
|||
return parasite; |
|||
} |
|||
|
|||
// IF alarm is not used one can store a 16 bit int of userdata in the alarm
|
|||
// registers. E.g. an ID of the sensor.
|
|||
// See github issue #29
|
|||
|
|||
// note if device is not connected it will fail writing the data.
|
|||
void DallasTemperature::setUserData(const uint8_t* deviceAddress, |
|||
int16_t data) { |
|||
// return when stored value == new value
|
|||
if (getUserData(deviceAddress) == data) |
|||
return; |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
scratchPad[HIGH_ALARM_TEMP] = data >> 8; |
|||
scratchPad[LOW_ALARM_TEMP] = data & 255; |
|||
writeScratchPad(deviceAddress, scratchPad); |
|||
} |
|||
} |
|||
|
|||
int16_t DallasTemperature::getUserData(const uint8_t* deviceAddress) { |
|||
int16_t data = 0; |
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
data = scratchPad[HIGH_ALARM_TEMP] << 8; |
|||
data += scratchPad[LOW_ALARM_TEMP]; |
|||
} |
|||
return data; |
|||
} |
|||
|
|||
// note If address cannot be found no error will be reported.
|
|||
int16_t DallasTemperature::getUserDataByIndex(uint8_t deviceIndex) { |
|||
DeviceAddress deviceAddress; |
|||
getAddress(deviceAddress, deviceIndex); |
|||
return getUserData((uint8_t*) deviceAddress); |
|||
} |
|||
|
|||
void DallasTemperature::setUserDataByIndex(uint8_t deviceIndex, int16_t data) { |
|||
DeviceAddress deviceAddress; |
|||
getAddress(deviceAddress, deviceIndex); |
|||
setUserData((uint8_t*) deviceAddress, data); |
|||
} |
|||
|
|||
// Convert float Celsius to Fahrenheit
|
|||
float DallasTemperature::toFahrenheit(float celsius) { |
|||
return (celsius * 1.8) + 32; |
|||
} |
|||
|
|||
// Convert float Fahrenheit to Celsius
|
|||
float DallasTemperature::toCelsius(float fahrenheit) { |
|||
return (fahrenheit - 32) * 0.555555556; |
|||
} |
|||
|
|||
// convert from raw to Celsius
|
|||
float DallasTemperature::rawToCelsius(int16_t raw) { |
|||
|
|||
if (raw <= DEVICE_DISCONNECTED_RAW) |
|||
return DEVICE_DISCONNECTED_C; |
|||
// C = RAW/128
|
|||
return (float) raw * 0.0078125; |
|||
|
|||
} |
|||
|
|||
// convert from raw to Fahrenheit
|
|||
float DallasTemperature::rawToFahrenheit(int16_t raw) { |
|||
|
|||
if (raw <= DEVICE_DISCONNECTED_RAW) |
|||
return DEVICE_DISCONNECTED_F; |
|||
// C = RAW/128
|
|||
// F = (C*1.8)+32 = (RAW/128*1.8)+32 = (RAW*0.0140625)+32
|
|||
return ((float) raw * 0.0140625) + 32; |
|||
|
|||
} |
|||
|
|||
#if REQUIRESALARMS |
|||
|
|||
/*
|
|||
|
|||
ALARMS: |
|||
|
|||
TH and TL Register Format |
|||
|
|||
BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 BIT 2 BIT 1 BIT 0 |
|||
S 2^6 2^5 2^4 2^3 2^2 2^1 2^0 |
|||
|
|||
Only bits 11 through 4 of the temperature register are used |
|||
in the TH and TL comparison since TH and TL are 8-bit |
|||
registers. If the measured temperature is lower than or equal |
|||
to TL or higher than or equal to TH, an alarm condition exists |
|||
and an alarm flag is set inside the DS18B20. This flag is |
|||
updated after every temperature measurement; therefore, if the |
|||
alarm condition goes away, the flag will be turned off after |
|||
the next temperature conversion. |
|||
|
|||
*/ |
|||
|
|||
// sets the high alarm temperature for a device in degrees Celsius
|
|||
// accepts a float, but the alarm resolution will ignore anything
|
|||
// after a decimal point. valid range is -55C - 125C
|
|||
void DallasTemperature::setHighAlarmTemp(const uint8_t* deviceAddress, |
|||
int8_t celsius) { |
|||
|
|||
// return when stored value == new value
|
|||
if (getHighAlarmTemp(deviceAddress) == celsius) |
|||
return; |
|||
|
|||
// make sure the alarm temperature is within the device's range
|
|||
if (celsius > 125) |
|||
celsius = 125; |
|||
else if (celsius < -55) |
|||
celsius = -55; |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
scratchPad[HIGH_ALARM_TEMP] = (uint8_t) celsius; |
|||
writeScratchPad(deviceAddress, scratchPad); |
|||
} |
|||
|
|||
} |
|||
|
|||
// sets the low alarm temperature for a device in degrees Celsius
|
|||
// accepts a float, but the alarm resolution will ignore anything
|
|||
// after a decimal point. valid range is -55C - 125C
|
|||
void DallasTemperature::setLowAlarmTemp(const uint8_t* deviceAddress, |
|||
int8_t celsius) { |
|||
|
|||
// return when stored value == new value
|
|||
if (getLowAlarmTemp(deviceAddress) == celsius) |
|||
return; |
|||
|
|||
// make sure the alarm temperature is within the device's range
|
|||
if (celsius > 125) |
|||
celsius = 125; |
|||
else if (celsius < -55) |
|||
celsius = -55; |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
scratchPad[LOW_ALARM_TEMP] = (uint8_t) celsius; |
|||
writeScratchPad(deviceAddress, scratchPad); |
|||
} |
|||
|
|||
} |
|||
|
|||
// returns a int8_t with the current high alarm temperature or
|
|||
// DEVICE_DISCONNECTED for an address
|
|||
int8_t DallasTemperature::getHighAlarmTemp(const uint8_t* deviceAddress) { |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) |
|||
return (int8_t) scratchPad[HIGH_ALARM_TEMP]; |
|||
return DEVICE_DISCONNECTED_C; |
|||
|
|||
} |
|||
|
|||
// returns a int8_t with the current low alarm temperature or
|
|||
// DEVICE_DISCONNECTED for an address
|
|||
int8_t DallasTemperature::getLowAlarmTemp(const uint8_t* deviceAddress) { |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) |
|||
return (int8_t) scratchPad[LOW_ALARM_TEMP]; |
|||
return DEVICE_DISCONNECTED_C; |
|||
|
|||
} |
|||
|
|||
// resets internal variables used for the alarm search
|
|||
void DallasTemperature::resetAlarmSearch() { |
|||
|
|||
alarmSearchJunction = -1; |
|||
alarmSearchExhausted = 0; |
|||
for (uint8_t i = 0; i < 7; i++) { |
|||
alarmSearchAddress[i] = 0; |
|||
} |
|||
|
|||
} |
|||
|
|||
// This is a modified version of the OneWire::search method.
|
|||
//
|
|||
// Also added the OneWire search fix documented here:
|
|||
// http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1238032295
|
|||
//
|
|||
// Perform an alarm search. If this function returns a '1' then it has
|
|||
// enumerated the next device and you may retrieve the ROM from the
|
|||
// OneWire::address variable. If there are no devices, no further
|
|||
// devices, or something horrible happens in the middle of the
|
|||
// enumeration then a 0 is returned. If a new device is found then
|
|||
// its address is copied to newAddr. Use
|
|||
// DallasTemperature::resetAlarmSearch() to start over.
|
|||
bool DallasTemperature::alarmSearch(uint8_t* newAddr) { |
|||
|
|||
uint8_t i; |
|||
int8_t lastJunction = -1; |
|||
uint8_t done = 1; |
|||
|
|||
if (alarmSearchExhausted) |
|||
return false; |
|||
if (!_wire->reset()) |
|||
return false; |
|||
|
|||
// send the alarm search command
|
|||
_wire->write(0xEC, 0); |
|||
|
|||
for (i = 0; i < 64; i++) { |
|||
|
|||
uint8_t a = _wire->read_bit(); |
|||
uint8_t nota = _wire->read_bit(); |
|||
uint8_t ibyte = i / 8; |
|||
uint8_t ibit = 1 << (i & 7); |
|||
|
|||
// I don't think this should happen, this means nothing responded, but maybe if
|
|||
// something vanishes during the search it will come up.
|
|||
if (a && nota) |
|||
return false; |
|||
|
|||
if (!a && !nota) { |
|||
if (i == alarmSearchJunction) { |
|||
// this is our time to decide differently, we went zero last time, go one.
|
|||
a = 1; |
|||
alarmSearchJunction = lastJunction; |
|||
} else if (i < alarmSearchJunction) { |
|||
|
|||
// take whatever we took last time, look in address
|
|||
if (alarmSearchAddress[ibyte] & ibit) { |
|||
a = 1; |
|||
} else { |
|||
// Only 0s count as pending junctions, we've already exhausted the 0 side of 1s
|
|||
a = 0; |
|||
done = 0; |
|||
lastJunction = i; |
|||
} |
|||
} else { |
|||
// we are blazing new tree, take the 0
|
|||
a = 0; |
|||
alarmSearchJunction = i; |
|||
done = 0; |
|||
} |
|||
// OneWire search fix
|
|||
// See: http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1238032295
|
|||
} |
|||
|
|||
if (a) |
|||
alarmSearchAddress[ibyte] |= ibit; |
|||
else |
|||
alarmSearchAddress[ibyte] &= ~ibit; |
|||
|
|||
_wire->write_bit(a); |
|||
} |
|||
|
|||
if (done) |
|||
alarmSearchExhausted = 1; |
|||
for (i = 0; i < 8; i++) |
|||
newAddr[i] = alarmSearchAddress[i]; |
|||
return true; |
|||
|
|||
} |
|||
|
|||
// returns true if device address might have an alarm condition
|
|||
// (only an alarm search can verify this)
|
|||
bool DallasTemperature::hasAlarm(const uint8_t* deviceAddress) { |
|||
|
|||
ScratchPad scratchPad; |
|||
if (isConnected(deviceAddress, scratchPad)) { |
|||
|
|||
int8_t temp = calculateTemperature(deviceAddress, scratchPad) >> 7; |
|||
|
|||
// check low alarm
|
|||
if (temp <= (int8_t) scratchPad[LOW_ALARM_TEMP]) |
|||
return true; |
|||
|
|||
// check high alarm
|
|||
if (temp >= (int8_t) scratchPad[HIGH_ALARM_TEMP]) |
|||
return true; |
|||
} |
|||
|
|||
// no alarm
|
|||
return false; |
|||
|
|||
} |
|||
|
|||
// returns true if any device is reporting an alarm condition on the bus
|
|||
bool DallasTemperature::hasAlarm(void) { |
|||
|
|||
DeviceAddress deviceAddress; |
|||
resetAlarmSearch(); |
|||
return alarmSearch(deviceAddress); |
|||
} |
|||
|
|||
// runs the alarm handler for all devices returned by alarmSearch()
|
|||
// unless there no _AlarmHandler exist.
|
|||
void DallasTemperature::processAlarms(void) { |
|||
|
|||
if (!hasAlarmHandler()) |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
resetAlarmSearch(); |
|||
DeviceAddress alarmAddr; |
|||
|
|||
while (alarmSearch(alarmAddr)) { |
|||
if (validAddress(alarmAddr)) { |
|||
_AlarmHandler(alarmAddr); |
|||
} |
|||
} |
|||
} |
|||
|
|||
// sets the alarm handler
|
|||
void DallasTemperature::setAlarmHandler(const AlarmHandler *handler) { |
|||
_AlarmHandler = handler; |
|||
} |
|||
|
|||
// checks if AlarmHandler has been set.
|
|||
bool DallasTemperature::hasAlarmHandler() |
|||
{ |
|||
return _AlarmHandler != NO_ALARM_HANDLER; |
|||
} |
|||
|
|||
#endif |
|||
|
|||
#if REQUIRESNEW |
|||
|
|||
// MnetCS - Allocates memory for DallasTemperature. Allows us to instance a new object
|
|||
void* DallasTemperature::operator new(unsigned int size) { // Implicit NSS obj size
|
|||
|
|||
void * p;// void pointer
|
|||
p = malloc(size);// Allocate memory
|
|||
memset((DallasTemperature*)p,0,size);// Initialise memory
|
|||
|
|||
//!!! CANT EXPLICITLY CALL CONSTRUCTOR - workaround by using an init() methodR - workaround by using an init() method
|
|||
return (DallasTemperature*) p;// Cast blank region to NSS pointer
|
|||
} |
|||
|
|||
// MnetCS 2009 - Free the memory used by this instance
|
|||
void DallasTemperature::operator delete(void* p) { |
|||
|
|||
DallasTemperature* pNss = (DallasTemperature*) p; // Cast to NSS pointer
|
|||
pNss->~DallasTemperature();// Destruct the object
|
|||
|
|||
free(p);// Free the memory
|
|||
} |
|||
|
|||
#endif |
|||
@ -0,0 +1,251 @@ |
|||
#ifndef DallasTemperature_h |
|||
#define DallasTemperature_h |
|||
|
|||
#define DALLASTEMPLIBVERSION "3.7.9" // To be deprecated
|
|||
|
|||
// 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.
|
|||
|
|||
// set to true to include code for new and delete operators
|
|||
#ifndef REQUIRESNEW |
|||
#define REQUIRESNEW false |
|||
#endif |
|||
|
|||
// set to true to include code implementing alarm search functions
|
|||
#ifndef REQUIRESALARMS |
|||
#define REQUIRESALARMS true |
|||
#endif |
|||
|
|||
#include <inttypes.h> |
|||
#include <OneWire.h> |
|||
|
|||
// Model IDs
|
|||
#define DS18S20MODEL 0x10 // also DS1820
|
|||
#define DS18B20MODEL 0x28 |
|||
#define DS1822MODEL 0x22 |
|||
#define DS1825MODEL 0x3B |
|||
#define DS28EA00MODEL 0x42 |
|||
|
|||
// Error Codes
|
|||
#define DEVICE_DISCONNECTED_C -127 |
|||
#define DEVICE_DISCONNECTED_F -196.6 |
|||
#define DEVICE_DISCONNECTED_RAW -7040 |
|||
|
|||
typedef uint8_t DeviceAddress[8]; |
|||
|
|||
class DallasTemperature { |
|||
public: |
|||
|
|||
DallasTemperature(); |
|||
DallasTemperature(OneWire*); |
|||
|
|||
void setOneWire(OneWire*); |
|||
|
|||
// initialise bus
|
|||
void begin(void); |
|||
|
|||
// returns the number of devices found on the bus
|
|||
uint8_t getDeviceCount(void); |
|||
|
|||
// returns the number of DS18xxx Family devices on bus
|
|||
uint8_t getDS18Count(void); |
|||
|
|||
// returns true if address is valid
|
|||
bool validAddress(const uint8_t*); |
|||
|
|||
// returns true if address is of the family of sensors the lib supports.
|
|||
bool validFamily(const uint8_t* deviceAddress); |
|||
|
|||
// finds an address at a given index on the bus
|
|||
bool getAddress(uint8_t*, uint8_t); |
|||
|
|||
// attempt to determine if the device at the given address is connected to the bus
|
|||
bool isConnected(const uint8_t*); |
|||
|
|||
// attempt to determine if the device at the given address is connected to the bus
|
|||
// also allows for updating the read scratchpad
|
|||
bool isConnected(const uint8_t*, uint8_t*); |
|||
|
|||
// read device's scratchpad
|
|||
bool readScratchPad(const uint8_t*, uint8_t*); |
|||
|
|||
// write device's scratchpad
|
|||
void writeScratchPad(const uint8_t*, const uint8_t*); |
|||
|
|||
// read device's power requirements
|
|||
bool readPowerSupply(const uint8_t*); |
|||
|
|||
// get global resolution
|
|||
uint8_t getResolution(); |
|||
|
|||
// set global resolution to 9, 10, 11, or 12 bits
|
|||
void setResolution(uint8_t); |
|||
|
|||
// returns the device resolution: 9, 10, 11, or 12 bits
|
|||
uint8_t getResolution(const uint8_t*); |
|||
|
|||
// set resolution of a device to 9, 10, 11, or 12 bits
|
|||
bool setResolution(const uint8_t*, uint8_t, |
|||
bool skipGlobalBitResolutionCalculation = false); |
|||
|
|||
// sets/gets the waitForConversion flag
|
|||
void setWaitForConversion(bool); |
|||
bool getWaitForConversion(void); |
|||
|
|||
// sets/gets the checkForConversion flag
|
|||
void setCheckForConversion(bool); |
|||
bool getCheckForConversion(void); |
|||
|
|||
// sends command for all devices on the bus to perform a temperature conversion
|
|||
void requestTemperatures(void); |
|||
|
|||
// sends command for one device to perform a temperature conversion by address
|
|||
bool requestTemperaturesByAddress(const uint8_t*); |
|||
|
|||
// sends command for one device to perform a temperature conversion by index
|
|||
bool requestTemperaturesByIndex(uint8_t); |
|||
|
|||
// returns temperature raw value (12 bit integer of 1/128 degrees C)
|
|||
int16_t getTemp(const uint8_t*); |
|||
|
|||
// returns temperature in degrees C
|
|||
float getTempC(const uint8_t*); |
|||
|
|||
// returns temperature in degrees F
|
|||
float getTempF(const uint8_t*); |
|||
|
|||
// Get temperature for device index (slow)
|
|||
float getTempCByIndex(uint8_t); |
|||
|
|||
// Get temperature for device index (slow)
|
|||
float getTempFByIndex(uint8_t); |
|||
|
|||
// returns true if the bus requires parasite power
|
|||
bool isParasitePowerMode(void); |
|||
|
|||
// Is a conversion complete on the wire? Only applies to the first sensor on the wire.
|
|||
bool isConversionComplete(void); |
|||
|
|||
int16_t millisToWaitForConversion(uint8_t); |
|||
|
|||
#if REQUIRESALARMS |
|||
|
|||
typedef void AlarmHandler(const uint8_t*); |
|||
|
|||
// sets the high alarm temperature for a device
|
|||
// accepts a int8_t. valid range is -55C - 125C
|
|||
void setHighAlarmTemp(const uint8_t*, int8_t); |
|||
|
|||
// sets the low alarm temperature for a device
|
|||
// accepts a int8_t. valid range is -55C - 125C
|
|||
void setLowAlarmTemp(const uint8_t*, int8_t); |
|||
|
|||
// returns a int8_t with the current high alarm temperature for a device
|
|||
// in the range -55C - 125C
|
|||
int8_t getHighAlarmTemp(const uint8_t*); |
|||
|
|||
// returns a int8_t with the current low alarm temperature for a device
|
|||
// in the range -55C - 125C
|
|||
int8_t getLowAlarmTemp(const uint8_t*); |
|||
|
|||
// resets internal variables used for the alarm search
|
|||
void resetAlarmSearch(void); |
|||
|
|||
// search the wire for devices with active alarms
|
|||
bool alarmSearch(uint8_t*); |
|||
|
|||
// returns true if ia specific device has an alarm
|
|||
bool hasAlarm(const uint8_t*); |
|||
|
|||
// returns true if any device is reporting an alarm on the bus
|
|||
bool hasAlarm(void); |
|||
|
|||
// runs the alarm handler for all devices returned by alarmSearch()
|
|||
void processAlarms(void); |
|||
|
|||
// sets the alarm handler
|
|||
void setAlarmHandler(const AlarmHandler *); |
|||
|
|||
// returns true if an AlarmHandler has been set
|
|||
bool hasAlarmHandler(); |
|||
|
|||
#endif |
|||
|
|||
// if no alarm handler is used the two bytes can be used as user data
|
|||
// example of such usage is an ID.
|
|||
// note if device is not connected it will fail writing the data.
|
|||
// note if address cannot be found no error will be reported.
|
|||
// in short use carefully
|
|||
void setUserData(const uint8_t*, int16_t); |
|||
void setUserDataByIndex(uint8_t, int16_t); |
|||
int16_t getUserData(const uint8_t*); |
|||
int16_t getUserDataByIndex(uint8_t); |
|||
|
|||
// convert from Celsius to Fahrenheit
|
|||
static float toFahrenheit(float); |
|||
|
|||
// convert from Fahrenheit to Celsius
|
|||
static float toCelsius(float); |
|||
|
|||
// convert from raw to Celsius
|
|||
static float rawToCelsius(int16_t); |
|||
|
|||
// convert from raw to Fahrenheit
|
|||
static float rawToFahrenheit(int16_t); |
|||
|
|||
#if REQUIRESNEW |
|||
|
|||
// initialize memory area
|
|||
void* operator new (unsigned int); |
|||
|
|||
// delete memory reference
|
|||
void operator delete(void*); |
|||
|
|||
#endif |
|||
|
|||
private: |
|||
typedef uint8_t ScratchPad[9]; |
|||
|
|||
// parasite power on or off
|
|||
bool parasite; |
|||
|
|||
// used to determine the delay amount needed to allow for the
|
|||
// temperature conversion to take place
|
|||
uint8_t bitResolution; |
|||
|
|||
// used to requestTemperature with or without delay
|
|||
bool waitForConversion; |
|||
|
|||
// used to requestTemperature to dynamically check if a conversion is complete
|
|||
bool checkForConversion; |
|||
|
|||
// count of devices on the bus
|
|||
uint8_t devices; |
|||
|
|||
// count of DS18xxx Family devices on bus
|
|||
uint8_t ds18Count; |
|||
|
|||
// Take a pointer to one wire instance
|
|||
OneWire* _wire; |
|||
|
|||
// reads scratchpad and returns the raw temperature
|
|||
int16_t calculateTemperature(const uint8_t*, uint8_t*); |
|||
|
|||
void blockTillConversionComplete(uint8_t); |
|||
|
|||
#if REQUIRESALARMS |
|||
|
|||
// required for alarmSearch
|
|||
uint8_t alarmSearchAddress[8]; |
|||
int8_t alarmSearchJunction; |
|||
uint8_t alarmSearchExhausted; |
|||
|
|||
// the alarm handler function pointer
|
|||
AlarmHandler *_AlarmHandler; |
|||
|
|||
#endif |
|||
|
|||
}; |
|||
#endif |
|||
@ -0,0 +1,67 @@ |
|||
# Arduino Library for Maxim Temperature Integrated Circuits |
|||
|
|||
## Usage |
|||
|
|||
This library supports the following devices : |
|||
|
|||
|
|||
* DS18B20 |
|||
* DS18S20 - Please note there appears to be an issue with this series. |
|||
* DS1822 |
|||
* DS1820 |
|||
* MAX31820 |
|||
|
|||
|
|||
You will need a pull-up resistor of about 5 KOhm between the 1-Wire data line |
|||
and your 5V power. If you are using the DS18B20, ground pins 1 and 3. The |
|||
centre pin is the data line '1-wire'. |
|||
|
|||
We have included a "REQUIRESNEW" and "REQUIRESALARMS" definition. If you |
|||
want to slim down the code feel free to use either of these by including |
|||
|
|||
|
|||
|
|||
#define REQUIRESNEW |
|||
|
|||
or |
|||
|
|||
#define REQUIRESALARMS |
|||
|
|||
|
|||
at the top of DallasTemperature.h |
|||
|
|||
Finally, please include OneWire from Paul Stoffregen in the library manager before you begin. |
|||
|
|||
## Credits |
|||
|
|||
The OneWire code has been derived from |
|||
http://www.arduino.cc/playground/Learning/OneWire. |
|||
Miles Burton <miles@mnetcs.com> originally developed this library. |
|||
Tim Newsome <nuisance@casualhacker.net> added support for multiple sensors on |
|||
the same bus. |
|||
Guil Barros [gfbarros@bappos.com] added getTempByAddress (v3.5) |
|||
Note: these are implemented as getTempC(address) and getTempF(address) |
|||
Rob Tillaart [rob.tillaart@gmail.com] added async modus (v3.7.0) |
|||
|
|||
|
|||
## Website |
|||
|
|||
|
|||
You can find the latest version of the library at |
|||
https://www.milesburton.com/Dallas_Temperature_Control_Library |
|||
|
|||
# License |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
@ -0,0 +1,162 @@ |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
// arrays to hold device addresses |
|||
DeviceAddress insideThermometer, outsideThermometer; |
|||
|
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library |
|||
sensors.begin(); |
|||
|
|||
// locate devices on the bus |
|||
Serial.print("Found "); |
|||
Serial.print(sensors.getDeviceCount(), DEC); |
|||
Serial.println(" devices."); |
|||
|
|||
// search for devices on the bus and assign based on an index. |
|||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0"); |
|||
if (!sensors.getAddress(outsideThermometer, 1)) Serial.println("Unable to find address for Device 1"); |
|||
|
|||
// show the addresses we found on the bus |
|||
Serial.print("Device 0 Address: "); |
|||
printAddress(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Device 0 Alarms: "); |
|||
printAlarms(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Device 1 Address: "); |
|||
printAddress(outsideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Device 1 Alarms: "); |
|||
printAlarms(outsideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.println("Setting alarm temps..."); |
|||
|
|||
// alarm when temp is higher than 30C |
|||
sensors.setHighAlarmTemp(insideThermometer, 30); |
|||
|
|||
// alarm when temp is lower than -10C |
|||
sensors.setLowAlarmTemp(insideThermometer, -10); |
|||
|
|||
// alarm when temp is higher than 31C |
|||
sensors.setHighAlarmTemp(outsideThermometer, 31); |
|||
|
|||
// alarn when temp is lower than 27C |
|||
sensors.setLowAlarmTemp(outsideThermometer, 27); |
|||
|
|||
Serial.print("New Device 0 Alarms: "); |
|||
printAlarms(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("New Device 1 Alarms: "); |
|||
printAlarms(outsideThermometer); |
|||
Serial.println(); |
|||
} |
|||
|
|||
// function to print a device address |
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
} |
|||
|
|||
// function to print the temperature for a device |
|||
void printTemperature(DeviceAddress deviceAddress) |
|||
{ |
|||
float tempC = sensors.getTempC(deviceAddress); |
|||
Serial.print("Temp C: "); |
|||
Serial.print(tempC); |
|||
Serial.print(" Temp F: "); |
|||
Serial.print(DallasTemperature::toFahrenheit(tempC)); |
|||
} |
|||
|
|||
void printAlarms(uint8_t deviceAddress[]) |
|||
{ |
|||
char temp; |
|||
temp = sensors.getHighAlarmTemp(deviceAddress); |
|||
Serial.print("High Alarm: "); |
|||
Serial.print(temp, DEC); |
|||
Serial.print("C/"); |
|||
Serial.print(DallasTemperature::toFahrenheit(temp)); |
|||
Serial.print("F | Low Alarm: "); |
|||
temp = sensors.getLowAlarmTemp(deviceAddress); |
|||
Serial.print(temp, DEC); |
|||
Serial.print("C/"); |
|||
Serial.print(DallasTemperature::toFahrenheit(temp)); |
|||
Serial.print("F"); |
|||
} |
|||
|
|||
// main function to print information about a device |
|||
void printData(DeviceAddress deviceAddress) |
|||
{ |
|||
Serial.print("Device Address: "); |
|||
printAddress(deviceAddress); |
|||
Serial.print(" "); |
|||
printTemperature(deviceAddress); |
|||
Serial.println(); |
|||
} |
|||
|
|||
void checkAlarm(DeviceAddress deviceAddress) |
|||
{ |
|||
if (sensors.hasAlarm(deviceAddress)) |
|||
{ |
|||
Serial.print("ALARM: "); |
|||
printData(deviceAddress); |
|||
} |
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature |
|||
// request to all devices on the bus |
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); |
|||
Serial.println("DONE"); |
|||
|
|||
// Method 1: |
|||
// check each address individually for an alarm condition |
|||
checkAlarm(insideThermometer); |
|||
checkAlarm(outsideThermometer); |
|||
/* |
|||
// Alternate method: |
|||
// Search the bus and iterate through addresses of devices with alarms |
|||
|
|||
// space for the alarm device's address |
|||
DeviceAddress alarmAddr; |
|||
|
|||
Serial.println("Searching for alarms..."); |
|||
|
|||
// resetAlarmSearch() must be called before calling alarmSearch() |
|||
sensors.resetAlarmSearch(); |
|||
|
|||
// alarmSearch() returns 0 when there are no devices with alarms |
|||
while (sensors.alarmSearch(alarmAddr)) |
|||
{ |
|||
Serial.print("ALARM: "); |
|||
printData(alarmAddr); |
|||
} |
|||
*/ |
|||
|
|||
} |
|||
|
|||
@ -0,0 +1,144 @@ |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
// arrays to hold device addresses |
|||
DeviceAddress insideThermometer, outsideThermometer; |
|||
|
|||
// function that will be called when an alarm condition exists during DallasTemperatures::processAlarms(); |
|||
void newAlarmHandler(uint8_t* deviceAddress) |
|||
{ |
|||
Serial.println("Alarm Handler Start"); |
|||
printAlarmInfo(deviceAddress); |
|||
printTemp(deviceAddress); |
|||
Serial.println(); |
|||
Serial.println("Alarm Handler Finish"); |
|||
} |
|||
|
|||
void printCurrentTemp(DeviceAddress deviceAddress) |
|||
{ |
|||
printAddress(deviceAddress); |
|||
printTemp(deviceAddress); |
|||
Serial.println(); |
|||
} |
|||
|
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
Serial.print("Address: "); |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
Serial.print(" "); |
|||
} |
|||
|
|||
void printTemp(DeviceAddress deviceAddress) |
|||
{ |
|||
float tempC = sensors.getTempC(deviceAddress); |
|||
if (tempC != DEVICE_DISCONNECTED_C) |
|||
{ |
|||
Serial.print("Current Temp C: "); |
|||
Serial.print(tempC); |
|||
} |
|||
else Serial.print("DEVICE DISCONNECTED"); |
|||
Serial.print(" "); |
|||
} |
|||
|
|||
void printAlarmInfo(DeviceAddress deviceAddress) |
|||
{ |
|||
char temp; |
|||
printAddress(deviceAddress); |
|||
temp = sensors.getHighAlarmTemp(deviceAddress); |
|||
Serial.print("High Alarm: "); |
|||
Serial.print(temp, DEC); |
|||
Serial.print("C"); |
|||
Serial.print(" Low Alarm: "); |
|||
temp = sensors.getLowAlarmTemp(deviceAddress); |
|||
Serial.print(temp, DEC); |
|||
Serial.print("C"); |
|||
Serial.print(" "); |
|||
} |
|||
|
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library |
|||
sensors.begin(); |
|||
|
|||
// locate devices on the bus |
|||
Serial.print("Found "); |
|||
Serial.print(sensors.getDeviceCount(), DEC); |
|||
Serial.println(" devices."); |
|||
|
|||
// search for devices on the bus and assign based on an index |
|||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0"); |
|||
if (!sensors.getAddress(outsideThermometer, 1)) Serial.println("Unable to find address for Device 1"); |
|||
|
|||
Serial.print("Device insideThermometer "); |
|||
printAlarmInfo(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Device outsideThermometer "); |
|||
printAlarmInfo(outsideThermometer); |
|||
Serial.println(); |
|||
|
|||
// set alarm ranges |
|||
Serial.println("Setting alarm temps..."); |
|||
sensors.setHighAlarmTemp(insideThermometer, 26); |
|||
sensors.setLowAlarmTemp(insideThermometer, 22); |
|||
sensors.setHighAlarmTemp(outsideThermometer, 25); |
|||
sensors.setLowAlarmTemp(outsideThermometer, 21); |
|||
|
|||
Serial.print("New insideThermometer "); |
|||
printAlarmInfo(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("New outsideThermometer "); |
|||
printAlarmInfo(outsideThermometer); |
|||
Serial.println(); |
|||
|
|||
// attach alarm handler |
|||
sensors.setAlarmHandler(&newAlarmHandler); |
|||
|
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
// ask the devices to measure the temperature |
|||
sensors.requestTemperatures(); |
|||
|
|||
// if an alarm condition exists as a result of the most recent |
|||
// requestTemperatures() request, it exists until the next time |
|||
// requestTemperatures() is called AND there isn't an alarm condition |
|||
// on the device |
|||
if (sensors.hasAlarm()) |
|||
{ |
|||
Serial.println("Oh noes! There is at least one alarm on the bus."); |
|||
} |
|||
|
|||
// call alarm handler function defined by sensors.setAlarmHandler |
|||
// for each device reporting an alarm |
|||
sensors.processAlarms(); |
|||
|
|||
if (!sensors.hasAlarm()) |
|||
{ |
|||
// just print out the current temperature |
|||
printCurrentTemp(insideThermometer); |
|||
printCurrentTemp(outsideThermometer); |
|||
} |
|||
|
|||
delay(1000); |
|||
} |
|||
|
|||
@ -0,0 +1,43 @@ |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
OneWire ds18x20[] = { 3, 7 }; |
|||
const int oneWireCount = sizeof(ds18x20)/sizeof(OneWire); |
|||
DallasTemperature sensor[oneWireCount]; |
|||
|
|||
void setup(void) { |
|||
// start serial port
|
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature Multiple Bus Control Library Simple Demo"); |
|||
Serial.print("============Ready with "); |
|||
Serial.print(oneWireCount); |
|||
Serial.println(" Sensors================"); |
|||
|
|||
// Start up the library on all defined bus-wires
|
|||
DeviceAddress deviceAddress; |
|||
for (int i = 0; i < oneWireCount; i++) {; |
|||
sensor[i].setOneWire(&ds18x20[i]); |
|||
sensor[i].begin(); |
|||
if (sensor[i].getAddress(deviceAddress, 0)) sensor[i].setResolution(deviceAddress, 12); |
|||
} |
|||
} |
|||
|
|||
void loop(void) { |
|||
// call sensors.requestTemperatures() to issue a global temperature
|
|||
// request to all devices on the bus
|
|||
Serial.print("Requesting temperatures..."); |
|||
for (int i = 0; i < oneWireCount; i++) { |
|||
sensor[i].requestTemperatures(); |
|||
} |
|||
Serial.println("DONE"); |
|||
|
|||
delay(1000); |
|||
for (int i = 0; i < oneWireCount; i++) { |
|||
float temperature = sensor[i].getTempCByIndex(0); |
|||
Serial.print("Temperature for the sensor "); |
|||
Serial.print(i); |
|||
Serial.print(" is "); |
|||
Serial.println(temperature); |
|||
} |
|||
Serial.println(); |
|||
} |
|||
@ -0,0 +1,143 @@ |
|||
// Include the libraries we need |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
#define TEMPERATURE_PRECISION 9 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
// arrays to hold device addresses |
|||
DeviceAddress insideThermometer, outsideThermometer; |
|||
|
|||
// Assign address manually. The addresses below will beed to be changed |
|||
// to valid device addresses on your bus. Device address can be retrieved |
|||
// by using either oneWire.search(deviceAddress) or individually via |
|||
// sensors.getAddress(deviceAddress, index) |
|||
// DeviceAddress insideThermometer = { 0x28, 0x1D, 0x39, 0x31, 0x2, 0x0, 0x0, 0xF0 }; |
|||
// DeviceAddress outsideThermometer = { 0x28, 0x3F, 0x1C, 0x31, 0x2, 0x0, 0x0, 0x2 }; |
|||
|
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library |
|||
sensors.begin(); |
|||
|
|||
// locate devices on the bus |
|||
Serial.print("Locating devices..."); |
|||
Serial.print("Found "); |
|||
Serial.print(sensors.getDeviceCount(), DEC); |
|||
Serial.println(" devices."); |
|||
|
|||
// report parasite power requirements |
|||
Serial.print("Parasite power is: "); |
|||
if (sensors.isParasitePowerMode()) Serial.println("ON"); |
|||
else Serial.println("OFF"); |
|||
|
|||
// Search for devices on the bus and assign based on an index. Ideally, |
|||
// you would do this to initially discover addresses on the bus and then |
|||
// use those addresses and manually assign them (see above) once you know |
|||
// the devices on your bus (and assuming they don't change). |
|||
// |
|||
// method 1: by index |
|||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0"); |
|||
if (!sensors.getAddress(outsideThermometer, 1)) Serial.println("Unable to find address for Device 1"); |
|||
|
|||
// method 2: search() |
|||
// search() looks for the next device. Returns 1 if a new address has been |
|||
// returned. A zero might mean that the bus is shorted, there are no devices, |
|||
// or you have already retrieved all of them. It might be a good idea to |
|||
// check the CRC to make sure you didn't get garbage. The order is |
|||
// deterministic. You will always get the same devices in the same order |
|||
// |
|||
// Must be called before search() |
|||
//oneWire.reset_search(); |
|||
// assigns the first address found to insideThermometer |
|||
//if (!oneWire.search(insideThermometer)) Serial.println("Unable to find address for insideThermometer"); |
|||
// assigns the seconds address found to outsideThermometer |
|||
//if (!oneWire.search(outsideThermometer)) Serial.println("Unable to find address for outsideThermometer"); |
|||
|
|||
// show the addresses we found on the bus |
|||
Serial.print("Device 0 Address: "); |
|||
printAddress(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Device 1 Address: "); |
|||
printAddress(outsideThermometer); |
|||
Serial.println(); |
|||
|
|||
// set the resolution to 9 bit per device |
|||
sensors.setResolution(insideThermometer, TEMPERATURE_PRECISION); |
|||
sensors.setResolution(outsideThermometer, TEMPERATURE_PRECISION); |
|||
|
|||
Serial.print("Device 0 Resolution: "); |
|||
Serial.print(sensors.getResolution(insideThermometer), DEC); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Device 1 Resolution: "); |
|||
Serial.print(sensors.getResolution(outsideThermometer), DEC); |
|||
Serial.println(); |
|||
} |
|||
|
|||
// function to print a device address |
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
// zero pad the address if necessary |
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
} |
|||
|
|||
// function to print the temperature for a device |
|||
void printTemperature(DeviceAddress deviceAddress) |
|||
{ |
|||
float tempC = sensors.getTempC(deviceAddress); |
|||
Serial.print("Temp C: "); |
|||
Serial.print(tempC); |
|||
Serial.print(" Temp F: "); |
|||
Serial.print(DallasTemperature::toFahrenheit(tempC)); |
|||
} |
|||
|
|||
// function to print a device's resolution |
|||
void printResolution(DeviceAddress deviceAddress) |
|||
{ |
|||
Serial.print("Resolution: "); |
|||
Serial.print(sensors.getResolution(deviceAddress)); |
|||
Serial.println(); |
|||
} |
|||
|
|||
// main function to print information about a device |
|||
void printData(DeviceAddress deviceAddress) |
|||
{ |
|||
Serial.print("Device Address: "); |
|||
printAddress(deviceAddress); |
|||
Serial.print(" "); |
|||
printTemperature(deviceAddress); |
|||
Serial.println(); |
|||
} |
|||
|
|||
/* |
|||
Main function, calls the temperatures in a loop. |
|||
*/ |
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature |
|||
// request to all devices on the bus |
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); |
|||
Serial.println("DONE"); |
|||
|
|||
// print the device information |
|||
printData(insideThermometer); |
|||
printData(outsideThermometer); |
|||
} |
|||
@ -0,0 +1,41 @@ |
|||
// Include the libraries we need |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
/* |
|||
* The setup function. We only start the sensors here |
|||
*/ |
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library |
|||
sensors.begin(); |
|||
} |
|||
|
|||
/* |
|||
* Main function, get and show the temperature |
|||
*/ |
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature |
|||
// request to all devices on the bus |
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); // Send the command to get temperatures |
|||
Serial.println("DONE"); |
|||
// After we got the temperatures, we can print them here. |
|||
// We use the function ByIndex, and as an example get the temperature from the first sensor only. |
|||
Serial.print("Temperature for the device 1 (index 0) is: "); |
|||
Serial.println(sensors.getTempCByIndex(0)); |
|||
} |
|||
@ -0,0 +1,116 @@ |
|||
// Include the libraries we need |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
// arrays to hold device address |
|||
DeviceAddress insideThermometer; |
|||
|
|||
/* |
|||
* Setup function. Here we do the basics |
|||
*/ |
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// locate devices on the bus |
|||
Serial.print("Locating devices..."); |
|||
sensors.begin(); |
|||
Serial.print("Found "); |
|||
Serial.print(sensors.getDeviceCount(), DEC); |
|||
Serial.println(" devices."); |
|||
|
|||
// report parasite power requirements |
|||
Serial.print("Parasite power is: "); |
|||
if (sensors.isParasitePowerMode()) Serial.println("ON"); |
|||
else Serial.println("OFF"); |
|||
|
|||
// Assign address manually. The addresses below will beed to be changed |
|||
// to valid device addresses on your bus. Device address can be retrieved |
|||
// by using either oneWire.search(deviceAddress) or individually via |
|||
// sensors.getAddress(deviceAddress, index) |
|||
// Note that you will need to use your specific address here |
|||
//insideThermometer = { 0x28, 0x1D, 0x39, 0x31, 0x2, 0x0, 0x0, 0xF0 }; |
|||
|
|||
// Method 1: |
|||
// Search for devices on the bus and assign based on an index. Ideally, |
|||
// you would do this to initially discover addresses on the bus and then |
|||
// use those addresses and manually assign them (see above) once you know |
|||
// the devices on your bus (and assuming they don't change). |
|||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0"); |
|||
|
|||
// method 2: search() |
|||
// search() looks for the next device. Returns 1 if a new address has been |
|||
// returned. A zero might mean that the bus is shorted, there are no devices, |
|||
// or you have already retrieved all of them. It might be a good idea to |
|||
// check the CRC to make sure you didn't get garbage. The order is |
|||
// deterministic. You will always get the same devices in the same order |
|||
// |
|||
// Must be called before search() |
|||
//oneWire.reset_search(); |
|||
// assigns the first address found to insideThermometer |
|||
//if (!oneWire.search(insideThermometer)) Serial.println("Unable to find address for insideThermometer"); |
|||
|
|||
// show the addresses we found on the bus |
|||
Serial.print("Device 0 Address: "); |
|||
printAddress(insideThermometer); |
|||
Serial.println(); |
|||
|
|||
// set the resolution to 9 bit (Each Dallas/Maxim device is capable of several different resolutions) |
|||
sensors.setResolution(insideThermometer, 9); |
|||
|
|||
Serial.print("Device 0 Resolution: "); |
|||
Serial.print(sensors.getResolution(insideThermometer), DEC); |
|||
Serial.println(); |
|||
} |
|||
|
|||
// function to print the temperature for a device |
|||
void printTemperature(DeviceAddress deviceAddress) |
|||
{ |
|||
// method 1 - slower |
|||
//Serial.print("Temp C: "); |
|||
//Serial.print(sensors.getTempC(deviceAddress)); |
|||
//Serial.print(" Temp F: "); |
|||
//Serial.print(sensors.getTempF(deviceAddress)); // Makes a second call to getTempC and then converts to Fahrenheit |
|||
|
|||
// method 2 - faster |
|||
float tempC = sensors.getTempC(deviceAddress); |
|||
Serial.print("Temp C: "); |
|||
Serial.print(tempC); |
|||
Serial.print(" Temp F: "); |
|||
Serial.println(DallasTemperature::toFahrenheit(tempC)); // Converts tempC to Fahrenheit |
|||
} |
|||
/* |
|||
* Main function. It will request the tempC from the sensors and display on Serial. |
|||
*/ |
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature |
|||
// request to all devices on the bus |
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); // Send the command to get temperatures |
|||
Serial.println("DONE"); |
|||
|
|||
// It responds almost immediately. Let's print out the data |
|||
printTemperature(insideThermometer); // Use a simple function to print out the data |
|||
} |
|||
|
|||
// function to print a device address |
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
} |
|||
@ -0,0 +1,124 @@ |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
#define TEMPERATURE_PRECISION 9 // Lower resolution |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
int numberOfDevices; // Number of temperature devices found |
|||
|
|||
DeviceAddress tempDeviceAddress; // We'll use this variable to store a found device address |
|||
|
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library |
|||
sensors.begin(); |
|||
|
|||
// Grab a count of devices on the wire |
|||
numberOfDevices = sensors.getDeviceCount(); |
|||
|
|||
// locate devices on the bus |
|||
Serial.print("Locating devices..."); |
|||
|
|||
Serial.print("Found "); |
|||
Serial.print(numberOfDevices, DEC); |
|||
Serial.println(" devices."); |
|||
|
|||
// report parasite power requirements |
|||
Serial.print("Parasite power is: "); |
|||
if (sensors.isParasitePowerMode()) Serial.println("ON"); |
|||
else Serial.println("OFF"); |
|||
|
|||
// Loop through each device, print out address |
|||
for(int i=0;i<numberOfDevices; i++) |
|||
{ |
|||
// Search the wire for address |
|||
if(sensors.getAddress(tempDeviceAddress, i)) |
|||
{ |
|||
Serial.print("Found device "); |
|||
Serial.print(i, DEC); |
|||
Serial.print(" with address: "); |
|||
printAddress(tempDeviceAddress); |
|||
Serial.println(); |
|||
|
|||
Serial.print("Setting resolution to "); |
|||
Serial.println(TEMPERATURE_PRECISION, DEC); |
|||
|
|||
// set the resolution to TEMPERATURE_PRECISION bit (Each Dallas/Maxim device is capable of several different resolutions) |
|||
sensors.setResolution(tempDeviceAddress, TEMPERATURE_PRECISION); |
|||
|
|||
Serial.print("Resolution actually set to: "); |
|||
Serial.print(sensors.getResolution(tempDeviceAddress), DEC); |
|||
Serial.println(); |
|||
}else{ |
|||
Serial.print("Found ghost device at "); |
|||
Serial.print(i, DEC); |
|||
Serial.print(" but could not detect address. Check power and cabling"); |
|||
} |
|||
} |
|||
|
|||
} |
|||
|
|||
// function to print the temperature for a device |
|||
void printTemperature(DeviceAddress deviceAddress) |
|||
{ |
|||
// method 1 - slower |
|||
//Serial.print("Temp C: "); |
|||
//Serial.print(sensors.getTempC(deviceAddress)); |
|||
//Serial.print(" Temp F: "); |
|||
//Serial.print(sensors.getTempF(deviceAddress)); // Makes a second call to getTempC and then converts to Fahrenheit |
|||
|
|||
// method 2 - faster |
|||
float tempC = sensors.getTempC(deviceAddress); |
|||
Serial.print("Temp C: "); |
|||
Serial.print(tempC); |
|||
Serial.print(" Temp F: "); |
|||
Serial.println(DallasTemperature::toFahrenheit(tempC)); // Converts tempC to Fahrenheit |
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature |
|||
// request to all devices on the bus |
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); // Send the command to get temperatures |
|||
Serial.println("DONE"); |
|||
|
|||
|
|||
// Loop through each device, print out temperature data |
|||
for(int i=0;i<numberOfDevices; i++) |
|||
{ |
|||
// Search the wire for address |
|||
if(sensors.getAddress(tempDeviceAddress, i)) |
|||
{ |
|||
// Output the device ID |
|||
Serial.print("Temperature for device: "); |
|||
Serial.println(i,DEC); |
|||
|
|||
// It responds almost immediately. Let's print out the data |
|||
printTemperature(tempDeviceAddress); // Use a simple function to print out the data |
|||
} |
|||
//else ghost device! Check your power requirements and cabling |
|||
|
|||
} |
|||
} |
|||
|
|||
// function to print a device address |
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
} |
|||
@ -0,0 +1,45 @@ |
|||
//
|
|||
// FILE: TwoPin_DS18B20.ino
|
|||
// AUTHOR: Rob Tillaart
|
|||
// VERSION: 0.1.00
|
|||
// PURPOSE: two pins for two sensors demo
|
|||
// DATE: 2014-06-13
|
|||
// URL: http://forum.arduino.cc/index.php?topic=216835.msg1764333#msg1764333
|
|||
//
|
|||
// Released to the public domain
|
|||
//
|
|||
|
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
#define ONE_WIRE_BUS_1 2 |
|||
#define ONE_WIRE_BUS_2 4 |
|||
|
|||
OneWire oneWire_in(ONE_WIRE_BUS_1); |
|||
OneWire oneWire_out(ONE_WIRE_BUS_2); |
|||
|
|||
DallasTemperature sensor_inhouse(&oneWire_in); |
|||
DallasTemperature sensor_outhouse(&oneWire_out); |
|||
|
|||
void setup(void) |
|||
{ |
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature Control Library Demo - TwoPin_DS18B20"); |
|||
|
|||
sensor_inhouse.begin(); |
|||
sensor_outhouse.begin(); |
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
Serial.print("Requesting temperatures..."); |
|||
sensor_inhouse.requestTemperatures(); |
|||
sensor_outhouse.requestTemperatures(); |
|||
Serial.println(" done"); |
|||
|
|||
Serial.print("Inhouse: "); |
|||
Serial.println(sensor_inhouse.getTempCByIndex(0)); |
|||
|
|||
Serial.print("Outhouse: "); |
|||
Serial.println(sensor_outhouse.getTempCByIndex(0)); |
|||
} |
|||
@ -0,0 +1,115 @@ |
|||
//
|
|||
// FILE: UserDataDemo.ino
|
|||
// AUTHOR: Rob Tillaart
|
|||
// VERSION: 0.1.0
|
|||
// PURPOSE: use of alarm field as user identification demo
|
|||
// DATE: 2019-12-23
|
|||
// URL:
|
|||
//
|
|||
// Released to the public domain
|
|||
//
|
|||
|
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
uint8_t deviceCount = 0; |
|||
|
|||
// Add 4 prepared sensors to the bus
|
|||
// use the UserDataWriteBatch demo to prepare 4 different labeled sensors
|
|||
struct |
|||
{ |
|||
int id; |
|||
DeviceAddress addr; |
|||
} T[4]; |
|||
|
|||
float getTempByID(int id) |
|||
{ |
|||
for (uint8_t index = 0; index < deviceCount; index++) |
|||
{ |
|||
if (T[index].id == id) |
|||
{ |
|||
return sensors.getTempC(T[index].addr); |
|||
} |
|||
} |
|||
return -999; |
|||
} |
|||
|
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
// zero pad the address if necessary
|
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
} |
|||
|
|||
void setup(void) |
|||
{ |
|||
Serial.begin(115200); |
|||
Serial.println(__FILE__); |
|||
Serial.println("Dallas Temperature Demo"); |
|||
|
|||
sensors.begin(); |
|||
|
|||
// count devices
|
|||
deviceCount = sensors.getDeviceCount(); |
|||
Serial.print("#devices: "); |
|||
Serial.println(deviceCount); |
|||
|
|||
// Read ID's per sensor
|
|||
// and put them in T array
|
|||
for (uint8_t index = 0; index < deviceCount; index++) |
|||
{ |
|||
// go through sensors
|
|||
sensors.getAddress(T[index].addr, index); |
|||
T[index].id = sensors.getUserData(T[index].addr); |
|||
} |
|||
|
|||
// Check all 4 sensors are set
|
|||
for (uint8_t index = 0; index < deviceCount; index++) |
|||
{ |
|||
Serial.println(); |
|||
Serial.println(T[index].id); |
|||
printAddress(T[index].addr); |
|||
Serial.println(); |
|||
} |
|||
Serial.println(); |
|||
|
|||
} |
|||
|
|||
|
|||
void loop(void) |
|||
{ |
|||
Serial.println(); |
|||
Serial.print(millis()); |
|||
Serial.println("\treq temp"); |
|||
sensors.requestTemperatures(); |
|||
|
|||
Serial.print(millis()); |
|||
Serial.println("\tGet temp by address"); |
|||
for (int i = 0; i < 4; i++) |
|||
{ |
|||
Serial.print(millis()); |
|||
Serial.print("\t temp:\t"); |
|||
Serial.println(sensors.getTempC(T[i].addr)); |
|||
} |
|||
|
|||
Serial.print(millis()); |
|||
Serial.println("\tGet temp by ID"); // assume ID = 0, 1, 2, 3
|
|||
for (int id = 0; id < 4; id++) |
|||
{ |
|||
Serial.print(millis()); |
|||
Serial.print("\t temp:\t"); |
|||
Serial.println(getTempByID(id)); |
|||
} |
|||
|
|||
delay(1000); |
|||
} |
|||
|
|||
// END OF FILE
|
|||
@ -0,0 +1,107 @@ |
|||
//
|
|||
// FILE: UserDataWriteBatch.ino
|
|||
// AUTHOR: Rob Tillaart
|
|||
// VERSION: 0.1.0
|
|||
// PURPOSE: use of alarm field as user identification demo
|
|||
// DATE: 2019-12-23
|
|||
// URL:
|
|||
//
|
|||
// Released to the public domain
|
|||
//
|
|||
|
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
uint8_t deviceCount = 0; |
|||
|
|||
void printAddress(DeviceAddress deviceAddress) |
|||
{ |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
// zero pad the address if necessary
|
|||
if (deviceAddress[i] < 16) Serial.print("0"); |
|||
Serial.print(deviceAddress[i], HEX); |
|||
} |
|||
} |
|||
|
|||
|
|||
|
|||
void setup(void) |
|||
{ |
|||
Serial.begin(115200); |
|||
Serial.println(__FILE__); |
|||
Serial.println("Write user ID to DS18B20\n"); |
|||
|
|||
sensors.begin(); |
|||
|
|||
// count devices
|
|||
deviceCount = sensors.getDeviceCount(); |
|||
Serial.print("#devices: "); |
|||
Serial.println(deviceCount); |
|||
|
|||
Serial.println(); |
|||
Serial.println("current ID's"); |
|||
for (uint8_t index = 0; index < deviceCount; index++) |
|||
{ |
|||
DeviceAddress t; |
|||
sensors.getAddress(t, index); |
|||
printAddress(t); |
|||
Serial.print("\t\tID: "); |
|||
int id = sensors.getUserData(t); |
|||
Serial.println(id); |
|||
} |
|||
|
|||
Serial.println(); |
|||
Serial.print("Enter ID for batch: "); |
|||
int c = 0; |
|||
int id = 0; |
|||
while (c != '\n' && c != '\r') |
|||
{ |
|||
c = Serial.read(); |
|||
switch(c) |
|||
{ |
|||
case '0'...'9': |
|||
id *= 10; |
|||
id += (c - '0'); |
|||
break; |
|||
default: |
|||
break; |
|||
} |
|||
} |
|||
Serial.println(); |
|||
Serial.println(id); |
|||
Serial.println(); |
|||
|
|||
Serial.println("Start labeling ..."); |
|||
for (uint8_t index = 0; index < deviceCount; index++) |
|||
{ |
|||
Serial.print("."); |
|||
DeviceAddress t; |
|||
sensors.getAddress(t, index); |
|||
sensors.setUserData(t, id); |
|||
} |
|||
Serial.println(); |
|||
|
|||
Serial.println(); |
|||
Serial.println("Show results ..."); |
|||
for (uint8_t index = 0; index < deviceCount; index++) |
|||
{ |
|||
DeviceAddress t; |
|||
sensors.getAddress(t, index); |
|||
printAddress(t); |
|||
Serial.print("\t\tID: "); |
|||
int id = sensors.getUserData(t); |
|||
Serial.println(id); |
|||
} |
|||
Serial.println("Done ..."); |
|||
|
|||
} |
|||
|
|||
void loop(void) {} |
|||
|
|||
// END OF FILE
|
|||
@ -0,0 +1,66 @@ |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
void setup(void) |
|||
{ |
|||
// start serial port |
|||
Serial.begin(115200); |
|||
Serial.println("Dallas Temperature Control Library - Async Demo"); |
|||
Serial.println("\nDemo shows the difference in length of the call\n\n"); |
|||
|
|||
// Start up the library |
|||
sensors.begin(); |
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
// Request temperature conversion (traditional) |
|||
Serial.println("Before blocking requestForConversion"); |
|||
unsigned long start = millis(); |
|||
|
|||
sensors.requestTemperatures(); |
|||
|
|||
unsigned long stop = millis(); |
|||
Serial.println("After blocking requestForConversion"); |
|||
Serial.print("Time used: "); |
|||
Serial.println(stop - start); |
|||
|
|||
// get temperature |
|||
Serial.print("Temperature: "); |
|||
Serial.println(sensors.getTempCByIndex(0)); |
|||
Serial.println("\n"); |
|||
|
|||
// Request temperature conversion - non-blocking / async |
|||
Serial.println("Before NON-blocking/async requestForConversion"); |
|||
start = millis(); |
|||
sensors.setWaitForConversion(false); // makes it async |
|||
sensors.requestTemperatures(); |
|||
sensors.setWaitForConversion(true); |
|||
stop = millis(); |
|||
Serial.println("After NON-blocking/async requestForConversion"); |
|||
Serial.print("Time used: "); |
|||
Serial.println(stop - start); |
|||
|
|||
|
|||
// 9 bit resolution by default |
|||
// Note the programmer is responsible for the right delay |
|||
// we could do something usefull here instead of the delay |
|||
int resolution = 9; |
|||
delay(750/ (1 << (12-resolution))); |
|||
|
|||
// get temperature |
|||
Serial.print("Temperature: "); |
|||
Serial.println(sensors.getTempCByIndex(0)); |
|||
Serial.println("\n\n\n\n"); |
|||
|
|||
delay(5000); |
|||
} |
|||
@ -0,0 +1,80 @@ |
|||
// |
|||
// Sample of using Async reading of Dallas Temperature Sensors |
|||
// |
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino |
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs) |
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature. |
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
DeviceAddress tempDeviceAddress; |
|||
|
|||
int resolution = 12; |
|||
unsigned long lastTempRequest = 0; |
|||
int delayInMillis = 0; |
|||
float temperature = 0.0; |
|||
int idle = 0; |
|||
// |
|||
// SETUP |
|||
// |
|||
void setup(void) |
|||
{ |
|||
Serial.begin(115200); |
|||
Serial.println("Dallas Temperature Control Library - Async Demo"); |
|||
Serial.print("Library Version: "); |
|||
Serial.println(DALLASTEMPLIBVERSION); |
|||
Serial.println("\n"); |
|||
|
|||
sensors.begin(); |
|||
sensors.getAddress(tempDeviceAddress, 0); |
|||
sensors.setResolution(tempDeviceAddress, resolution); |
|||
|
|||
sensors.setWaitForConversion(false); |
|||
sensors.requestTemperatures(); |
|||
delayInMillis = 750 / (1 << (12 - resolution)); |
|||
lastTempRequest = millis(); |
|||
|
|||
pinMode(13, OUTPUT); |
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
|
|||
if (millis() - lastTempRequest >= delayInMillis) // waited long enough?? |
|||
{ |
|||
digitalWrite(13, LOW); |
|||
Serial.print(" Temperature: "); |
|||
temperature = sensors.getTempCByIndex(0); |
|||
Serial.println(temperature, resolution - 8); |
|||
Serial.print(" Resolution: "); |
|||
Serial.println(resolution); |
|||
Serial.print("Idle counter: "); |
|||
Serial.println(idle); |
|||
Serial.println(); |
|||
|
|||
idle = 0; |
|||
|
|||
// immediately after fetching the temperature we request a new sample |
|||
// in the async modus |
|||
// for the demo we let the resolution change to show differences |
|||
resolution++; |
|||
if (resolution > 12) resolution = 9; |
|||
|
|||
sensors.setResolution(tempDeviceAddress, resolution); |
|||
sensors.requestTemperatures(); |
|||
delayInMillis = 750 / (1 << (12 - resolution)); |
|||
lastTempRequest = millis(); |
|||
} |
|||
|
|||
digitalWrite(13, HIGH); |
|||
// we can do usefull things here |
|||
// for the demo we just count the idle time in millis |
|||
delay(1); |
|||
idle++; |
|||
} |
|||
@ -0,0 +1,67 @@ |
|||
//
|
|||
// FILE: oneWireSearch.ino
|
|||
// AUTHOR: Rob Tillaart
|
|||
// VERSION: 0.1.02
|
|||
// PURPOSE: scan for 1-Wire devices + code snippet generator
|
|||
// DATE: 2015-june-30
|
|||
// URL: http://forum.arduino.cc/index.php?topic=333923
|
|||
//
|
|||
// inspired by http://www.hacktronics.com/Tutorials/arduino-1-wire-address-finder.html
|
|||
//
|
|||
// Released to the public domain
|
|||
//
|
|||
// 0.1.00 initial version
|
|||
// 0.1.01 first published version
|
|||
// 0.1.02 small output changes
|
|||
|
|||
#include <OneWire.h> |
|||
|
|||
void setup() |
|||
{ |
|||
Serial.begin(115200); |
|||
Serial.println("//\n// Start oneWireSearch.ino \n//"); |
|||
|
|||
for (uint8_t pin = 2; pin < 13; pin++) |
|||
{ |
|||
findDevices(pin); |
|||
} |
|||
Serial.println("\n//\n// End oneWireSearch.ino \n//"); |
|||
} |
|||
|
|||
void loop() |
|||
{ |
|||
} |
|||
|
|||
uint8_t findDevices(int pin) |
|||
{ |
|||
OneWire ow(pin); |
|||
|
|||
uint8_t address[8]; |
|||
uint8_t count = 0; |
|||
|
|||
|
|||
if (ow.search(address)) |
|||
{ |
|||
Serial.print("\nuint8_t pin"); |
|||
Serial.print(pin, DEC); |
|||
Serial.println("[][8] = {"); |
|||
do { |
|||
count++; |
|||
Serial.println(" {"); |
|||
for (uint8_t i = 0; i < 8; i++) |
|||
{ |
|||
Serial.print("0x"); |
|||
if (address[i] < 0x10) Serial.print("0"); |
|||
Serial.print(address[i], HEX); |
|||
if (i < 7) Serial.print(", "); |
|||
} |
|||
Serial.println(" },"); |
|||
} while (ow.search(address)); |
|||
|
|||
Serial.println("};"); |
|||
Serial.print("// nr devices found: "); |
|||
Serial.println(count); |
|||
} |
|||
|
|||
return count; |
|||
} |
|||
@ -0,0 +1,47 @@ |
|||
//
|
|||
// This sketch does not use the ALARM registers and uses those 2 bytes as a counter
|
|||
// these 2 bytes can be used for other purposes as well e.g. last temperature or
|
|||
// a specific ID.
|
|||
//
|
|||
|
|||
#include <OneWire.h> |
|||
#include <DallasTemperature.h> |
|||
|
|||
// Data wire is plugged into port 2 on the Arduino
|
|||
#define ONE_WIRE_BUS 2 |
|||
|
|||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
|||
OneWire oneWire(ONE_WIRE_BUS); |
|||
|
|||
// Pass our oneWire reference to Dallas Temperature.
|
|||
DallasTemperature sensors(&oneWire); |
|||
|
|||
int count = 0; |
|||
|
|||
void setup(void) |
|||
{ |
|||
// start serial port
|
|||
Serial.begin(9600); |
|||
Serial.println("Dallas Temperature IC Control Library Demo"); |
|||
|
|||
// Start up the library
|
|||
sensors.begin(); |
|||
|
|||
} |
|||
|
|||
void loop(void) |
|||
{ |
|||
// call sensors.requestTemperatures() to issue a global temperature
|
|||
// request to all devices on the bus
|
|||
Serial.print("Requesting temperatures..."); |
|||
sensors.requestTemperatures(); // Send the command to get temperatures
|
|||
Serial.println("DONE"); |
|||
|
|||
Serial.print("Temperature for the device 1 (index 0) is: "); |
|||
Serial.println(sensors.getTempCByIndex(0)); |
|||
|
|||
count++; |
|||
sensors.setUserDataByIndex(0, count); |
|||
int x = sensors.getUserDataByIndex(0); |
|||
Serial.println(count); |
|||
} |
|||
@ -0,0 +1,54 @@ |
|||
####################################### |
|||
# Syntax Coloring Map For DallasTemperature |
|||
####################################### |
|||
|
|||
####################################### |
|||
# Datatypes (KEYWORD1) |
|||
####################################### |
|||
DallasTemperature KEYWORD1 |
|||
OneWire KEYWORD1 |
|||
AlarmHandler KEYWORD1 |
|||
DeviceAddress KEYWORD1 |
|||
|
|||
####################################### |
|||
# Methods and Functions (KEYWORD2) |
|||
####################################### |
|||
|
|||
setResolution KEYWORD2 |
|||
getResolution KEYWORD2 |
|||
getTempC KEYWORD2 |
|||
toFahrenheit KEYWORD2 |
|||
getTempF KEYWORD2 |
|||
getTempCByIndex KEYWORD2 |
|||
getTempFByIndex KEYWORD2 |
|||
setWaitForConversion KEYWORD2 |
|||
getWaitForConversion KEYWORD2 |
|||
requestTemperatures KEYWORD2 |
|||
requestTemperaturesByAddress KEYWORD2 |
|||
requestTemperaturesByIndex KEYWORD2 |
|||
isParasitePowerMode KEYWORD2 |
|||
begin KEYWORD2 |
|||
getDeviceCount KEYWORD2 |
|||
getAddress KEYWORD2 |
|||
validAddress KEYWORD2 |
|||
isConnected KEYWORD2 |
|||
readScratchPad KEYWORD2 |
|||
writeScratchPad KEYWORD2 |
|||
readPowerSupply KEYWORD2 |
|||
setHighAlarmTemp KEYWORD2 |
|||
setLowAlarmTemp KEYWORD2 |
|||
getHighAlarmTemp KEYWORD2 |
|||
getLowAlarmTemp KEYWORD2 |
|||
resetAlarmSearch KEYWORD2 |
|||
alarmSearch KEYWORD2 |
|||
hasAlarm KEYWORD2 |
|||
toCelsius KEYWORD2 |
|||
processAlarmss KEYWORD2 |
|||
setAlarmHandlers KEYWORD2 |
|||
defaultAlarmHandler KEYWORD2 |
|||
calculateTemperature KEYWORD2 |
|||
|
|||
####################################### |
|||
# Constants (LITERAL1) |
|||
####################################### |
|||
|
|||
@ -0,0 +1,40 @@ |
|||
{ |
|||
"name": "DallasTemperature", |
|||
"keywords": "onewire, 1-wire, bus, sensor, temperature", |
|||
"description": "Arduino Library for Dallas Temperature ICs (DS18B20, DS18S20, DS1822, DS1820)", |
|||
"repository": |
|||
{ |
|||
"type": "git", |
|||
"url": "https://github.com/milesburton/Arduino-Temperature-Control-Library.git" |
|||
}, |
|||
"authors": |
|||
[ |
|||
{ |
|||
"name": "Miles Burton", |
|||
"email": "miles@mnetcs.com", |
|||
"url": "http://www.milesburton.com", |
|||
"maintainer": true |
|||
}, |
|||
{ |
|||
"name": "Tim Newsome", |
|||
"email": "nuisance@casualhacker.net" |
|||
}, |
|||
{ |
|||
"name": "Guil Barros", |
|||
"email": "gfbarros@bappos.com" |
|||
}, |
|||
{ |
|||
"name": "Rob Tillaart", |
|||
"email": "rob.tillaart@gmail.com" |
|||
} |
|||
], |
|||
"dependencies": |
|||
{ |
|||
"name": "OneWire", |
|||
"authors": "Paul Stoffregen", |
|||
"frameworks": "arduino" |
|||
}, |
|||
"version": "3.8.0", |
|||
"frameworks": "arduino", |
|||
"platforms": "*" |
|||
} |
|||
@ -0,0 +1,9 @@ |
|||
name=DallasTemperature |
|||
version=3.8.0 |
|||
author=Miles Burton <miles@mnetcs.com>, Tim Newsome <nuisance@casualhacker.net>, Guil Barros <gfbarros@bappos.com>, Rob Tillaart <rob.tillaart@gmail.com> |
|||
maintainer=Miles Burton <miles@mnetcs.com> |
|||
sentence=Arduino Library for Dallas Temperature ICs |
|||
paragraph=Supports DS18B20, DS18S20, DS1822, DS1820 |
|||
category=Sensors |
|||
url=https://github.com/milesburton/Arduino-Temperature-Control-Library |
|||
architectures=* |
|||
@ -0,0 +1,165 @@ |
|||
GNU LESSER GENERAL PUBLIC LICENSE |
|||
Version 3, 29 June 2007 |
|||
|
|||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
|||
Everyone is permitted to copy and distribute verbatim copies |
|||
of this license document, but changing it is not allowed. |
|||
|
|||
|
|||
This version of the GNU Lesser General Public License incorporates |
|||
the terms and conditions of version 3 of the GNU General Public |
|||
License, supplemented by the additional permissions listed below. |
|||
|
|||
0. Additional Definitions. |
|||
|
|||
As used herein, "this License" refers to version 3 of the GNU Lesser |
|||
General Public License, and the "GNU GPL" refers to version 3 of the GNU |
|||
General Public License. |
|||
|
|||
"The Library" refers to a covered work governed by this License, |
|||
other than an Application or a Combined Work as defined below. |
|||
|
|||
An "Application" is any work that makes use of an interface provided |
|||
by the Library, but which is not otherwise based on the Library. |
|||
Defining a subclass of a class defined by the Library is deemed a mode |
|||
of using an interface provided by the Library. |
|||
|
|||
A "Combined Work" is a work produced by combining or linking an |
|||
Application with the Library. The particular version of the Library |
|||
with which the Combined Work was made is also called the "Linked |
|||
Version". |
|||
|
|||
The "Minimal Corresponding Source" for a Combined Work means the |
|||
Corresponding Source for the Combined Work, excluding any source code |
|||
for portions of the Combined Work that, considered in isolation, are |
|||
based on the Application, and not on the Linked Version. |
|||
|
|||
The "Corresponding Application Code" for a Combined Work means the |
|||
object code and/or source code for the Application, including any data |
|||
and utility programs needed for reproducing the Combined Work from the |
|||
Application, but excluding the System Libraries of the Combined Work. |
|||
|
|||
1. Exception to Section 3 of the GNU GPL. |
|||
|
|||
You may convey a covered work under sections 3 and 4 of this License |
|||
without being bound by section 3 of the GNU GPL. |
|||
|
|||
2. Conveying Modified Versions. |
|||
|
|||
If you modify a copy of the Library, and, in your modifications, a |
|||
facility refers to a function or data to be supplied by an Application |
|||
that uses the facility (other than as an argument passed when the |
|||
facility is invoked), then you may convey a copy of the modified |
|||
version: |
|||
|
|||
a) under this License, provided that you make a good faith effort to |
|||
ensure that, in the event an Application does not supply the |
|||
function or data, the facility still operates, and performs |
|||
whatever part of its purpose remains meaningful, or |
|||
|
|||
b) under the GNU GPL, with none of the additional permissions of |
|||
this License applicable to that copy. |
|||
|
|||
3. Object Code Incorporating Material from Library Header Files. |
|||
|
|||
The object code form of an Application may incorporate material from |
|||
a header file that is part of the Library. You may convey such object |
|||
code under terms of your choice, provided that, if the incorporated |
|||
material is not limited to numerical parameters, data structure |
|||
layouts and accessors, or small macros, inline functions and templates |
|||
(ten or fewer lines in length), you do both of the following: |
|||
|
|||
a) Give prominent notice with each copy of the object code that the |
|||
Library is used in it and that the Library and its use are |
|||
covered by this License. |
|||
|
|||
b) Accompany the object code with a copy of the GNU GPL and this license |
|||
document. |
|||
|
|||
4. Combined Works. |
|||
|
|||
You may convey a Combined Work under terms of your choice that, |
|||
taken together, effectively do not restrict modification of the |
|||
portions of the Library contained in the Combined Work and reverse |
|||
engineering for debugging such modifications, if you also do each of |
|||
the following: |
|||
|
|||
a) Give prominent notice with each copy of the Combined Work that |
|||
the Library is used in it and that the Library and its use are |
|||
covered by this License. |
|||
|
|||
b) Accompany the Combined Work with a copy of the GNU GPL and this license |
|||
document. |
|||
|
|||
c) For a Combined Work that displays copyright notices during |
|||
execution, include the copyright notice for the Library among |
|||
these notices, as well as a reference directing the user to the |
|||
copies of the GNU GPL and this license document. |
|||
|
|||
d) Do one of the following: |
|||
|
|||
0) Convey the Minimal Corresponding Source under the terms of this |
|||
License, and the Corresponding Application Code in a form |
|||
suitable for, and under terms that permit, the user to |
|||
recombine or relink the Application with a modified version of |
|||
the Linked Version to produce a modified Combined Work, in the |
|||
manner specified by section 6 of the GNU GPL for conveying |
|||
Corresponding Source. |
|||
|
|||
1) Use a suitable shared library mechanism for linking with the |
|||
Library. A suitable mechanism is one that (a) uses at run time |
|||
a copy of the Library already present on the user's computer |
|||
system, and (b) will operate properly with a modified version |
|||
of the Library that is interface-compatible with the Linked |
|||
Version. |
|||
|
|||
e) Provide Installation Information, but only if you would otherwise |
|||
be required to provide such information under section 6 of the |
|||
GNU GPL, and only to the extent that such information is |
|||
necessary to install and execute a modified version of the |
|||
Combined Work produced by recombining or relinking the |
|||
Application with a modified version of the Linked Version. (If |
|||
you use option 4d0, the Installation Information must accompany |
|||
the Minimal Corresponding Source and Corresponding Application |
|||
Code. If you use option 4d1, you must provide the Installation |
|||
Information in the manner specified by section 6 of the GNU GPL |
|||
for conveying Corresponding Source.) |
|||
|
|||
5. Combined Libraries. |
|||
|
|||
You may place library facilities that are a work based on the |
|||
Library side by side in a single library together with other library |
|||
facilities that are not Applications and are not covered by this |
|||
License, and convey such a combined library under terms of your |
|||
choice, if you do both of the following: |
|||
|
|||
a) Accompany the combined library with a copy of the same work based |
|||
on the Library, uncombined with any other library facilities, |
|||
conveyed under the terms of this License. |
|||
|
|||
b) Give prominent notice with the combined library that part of it |
|||
is a work based on the Library, and explaining where to find the |
|||
accompanying uncombined form of the same work. |
|||
|
|||
6. Revised Versions of the GNU Lesser General Public License. |
|||
|
|||
The Free Software Foundation may publish revised and/or new versions |
|||
of the GNU Lesser General Public License from time to time. Such new |
|||
versions will be similar in spirit to the present version, but may |
|||
differ in detail to address new problems or concerns. |
|||
|
|||
Each version is given a distinguishing version number. If the |
|||
Library as you received it specifies that a certain numbered version |
|||
of the GNU Lesser General Public License "or any later version" |
|||
applies to it, you have the option of following the terms and |
|||
conditions either of that published version or of any later version |
|||
published by the Free Software Foundation. If the Library as you |
|||
received it does not specify a version number of the GNU Lesser |
|||
General Public License, you may choose any version of the GNU Lesser |
|||
General Public License ever published by the Free Software Foundation. |
|||
|
|||
If the Library as you received it specifies that a proxy can decide |
|||
whether future versions of the GNU Lesser General Public License shall |
|||
apply, that proxy's public statement of acceptance of any version is |
|||
permanent authorization for you to choose that version for the |
|||
Library. |
|||
@ -0,0 +1,32 @@ |
|||
# ESPAsyncTCP |
|||
[](https://travis-ci.org/me-no-dev/ESPAsyncTCP)  |
|||
|
|||
### Async TCP Library for ESP8266 Arduino |
|||
|
|||
For ESP32 look [HERE](https://github.com/me-no-dev/AsyncTCP) |
|||
|
|||
[](https://gitter.im/me-no-dev/ESPAsyncWebServer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
|||
|
|||
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP8266 MCUs. |
|||
|
|||
This library is the base for [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) |
|||
|
|||
## AsyncClient and AsyncServer |
|||
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use. |
|||
|
|||
## AsyncPrinter |
|||
This class can be used to send data like any other ```Print``` interface (```Serial``` for example). |
|||
The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data using ```onData```. The object can be checked if the underlying ```AsyncClient```is connected, or hook to the ```onDisconnect``` callback. |
|||
|
|||
## AsyncTCPbuffer |
|||
This class is really similar to the ```AsyncPrinter```, but it differs in the fact that it can buffer some of the incoming data. |
|||
|
|||
## SyncClient |
|||
It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in ```ESP8266WiFi``` |
|||
|
|||
## Libraries and projects that use AsyncTCP |
|||
- [ESP Async Web Server](https://github.com/me-no-dev/ESPAsyncWebServer) |
|||
- [Async MQTT client](https://github.com/marvinroger/async-mqtt-client) |
|||
- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets) |
|||
- [ESP8266 Smart Home](https://github.com/baruch/esp8266_smart_home) |
|||
- [KBox Firmware](https://github.com/sarfata/kbox-firmware) |
|||
@ -0,0 +1,62 @@ |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
|
|||
extern "C" { |
|||
#include <osapi.h> |
|||
#include <os_type.h> |
|||
} |
|||
|
|||
#include "config.h" |
|||
|
|||
static os_timer_t intervalTimer; |
|||
|
|||
static void replyToServer(void* arg) { |
|||
AsyncClient* client = reinterpret_cast<AsyncClient*>(arg); |
|||
|
|||
// send reply
|
|||
if (client->space() > 32 && client->canSend()) { |
|||
char message[32]; |
|||
sprintf(message, "this is from %s", WiFi.localIP().toString().c_str()); |
|||
client->add(message, strlen(message)); |
|||
client->send(); |
|||
} |
|||
} |
|||
|
|||
/* event callbacks */ |
|||
static void handleData(void* arg, AsyncClient* client, void *data, size_t len) { |
|||
Serial.printf("\n data received from %s \n", client->remoteIP().toString().c_str()); |
|||
Serial.write((uint8_t*)data, len); |
|||
|
|||
os_timer_arm(&intervalTimer, 2000, true); // schedule for reply to server at next 2s
|
|||
} |
|||
|
|||
void onConnect(void* arg, AsyncClient* client) { |
|||
Serial.printf("\n client has been connected to %s on port %d \n", SERVER_HOST_NAME, TCP_PORT); |
|||
replyToServer(client); |
|||
} |
|||
|
|||
|
|||
void setup() { |
|||
Serial.begin(115200); |
|||
delay(20); |
|||
|
|||
// connects to access point
|
|||
WiFi.mode(WIFI_STA); |
|||
WiFi.begin(SSID, PASSWORD); |
|||
while (WiFi.status() != WL_CONNECTED) { |
|||
Serial.print('.'); |
|||
delay(500); |
|||
} |
|||
|
|||
AsyncClient* client = new AsyncClient; |
|||
client->onData(&handleData, client); |
|||
client->onConnect(&onConnect, client); |
|||
client->connect(SERVER_HOST_NAME, TCP_PORT); |
|||
|
|||
os_timer_disarm(&intervalTimer); |
|||
os_timer_setfn(&intervalTimer, &replyToServer, client); |
|||
} |
|||
|
|||
void loop() { |
|||
|
|||
} |
|||
@ -0,0 +1,23 @@ |
|||
#ifndef CONFIG_H |
|||
#define CONFIG_H |
|||
|
|||
/*
|
|||
* This example demonstrate how to use asynchronous client & server APIs |
|||
* in order to establish tcp socket connections in client server manner. |
|||
* server is running (on port 7050) on one ESP, acts as AP, and other clients running on |
|||
* remaining ESPs acts as STAs. after connection establishment between server and clients |
|||
* there is a simple message transfer in every 2s. clients connect to server via it's host name |
|||
* (in this case 'esp_server') with help of DNS service running on server side. |
|||
* |
|||
* Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s. |
|||
*/ |
|||
|
|||
#define SSID "ESP-TEST" |
|||
#define PASSWORD "123456789" |
|||
|
|||
#define SERVER_HOST_NAME "esp_server" |
|||
|
|||
#define TCP_PORT 7050 |
|||
#define DNS_PORT 53 |
|||
|
|||
#endif // CONFIG_H
|
|||
@ -0,0 +1,73 @@ |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#include <DNSServer.h> |
|||
#include <vector> |
|||
|
|||
#include "config.h" |
|||
|
|||
static DNSServer DNS; |
|||
|
|||
static std::vector<AsyncClient*> clients; // a list to hold all clients
|
|||
|
|||
/* clients events */ |
|||
static void handleError(void* arg, AsyncClient* client, int8_t error) { |
|||
Serial.printf("\n connection error %s from client %s \n", client->errorToString(error), client->remoteIP().toString().c_str()); |
|||
} |
|||
|
|||
static void handleData(void* arg, AsyncClient* client, void *data, size_t len) { |
|||
Serial.printf("\n data received from client %s \n", client->remoteIP().toString().c_str()); |
|||
Serial.write((uint8_t*)data, len); |
|||
|
|||
// reply to client
|
|||
if (client->space() > 32 && client->canSend()) { |
|||
char reply[32]; |
|||
sprintf(reply, "this is from %s", SERVER_HOST_NAME); |
|||
client->add(reply, strlen(reply)); |
|||
client->send(); |
|||
} |
|||
} |
|||
|
|||
static void handleDisconnect(void* arg, AsyncClient* client) { |
|||
Serial.printf("\n client %s disconnected \n", client->remoteIP().toString().c_str()); |
|||
} |
|||
|
|||
static void handleTimeOut(void* arg, AsyncClient* client, uint32_t time) { |
|||
Serial.printf("\n client ACK timeout ip: %s \n", client->remoteIP().toString().c_str()); |
|||
} |
|||
|
|||
|
|||
/* server events */ |
|||
static void handleNewClient(void* arg, AsyncClient* client) { |
|||
Serial.printf("\n new client has been connected to server, ip: %s", client->remoteIP().toString().c_str()); |
|||
|
|||
// add to list
|
|||
clients.push_back(client); |
|||
|
|||
// register events
|
|||
client->onData(&handleData, NULL); |
|||
client->onError(&handleError, NULL); |
|||
client->onDisconnect(&handleDisconnect, NULL); |
|||
client->onTimeout(&handleTimeOut, NULL); |
|||
} |
|||
|
|||
void setup() { |
|||
Serial.begin(115200); |
|||
delay(20); |
|||
|
|||
// create access point
|
|||
while (!WiFi.softAP(SSID, PASSWORD, 6, false, 15)) { |
|||
delay(500); |
|||
} |
|||
|
|||
// start dns server
|
|||
if (!DNS.start(DNS_PORT, SERVER_HOST_NAME, WiFi.softAPIP())) |
|||
Serial.printf("\n failed to start dns service \n"); |
|||
|
|||
AsyncServer* server = new AsyncServer(TCP_PORT); // start listening on tcp port 7050
|
|||
server->onClient(&handleNewClient, server); |
|||
server->begin(); |
|||
} |
|||
|
|||
void loop() { |
|||
DNS.processNextRequest(); |
|||
} |
|||
@ -0,0 +1,23 @@ |
|||
#ifndef CONFIG_H |
|||
#define CONFIG_H |
|||
|
|||
/*
|
|||
* This example demonstrate how to use asynchronous client & server APIs |
|||
* in order to establish tcp socket connections in client server manner. |
|||
* server is running (on port 7050) on one ESP, acts as AP, and other clients running on |
|||
* remaining ESPs acts as STAs. after connection establishment between server and clients |
|||
* there is a simple message transfer in every 2s. clients connect to server via it's host name |
|||
* (in this case 'esp_server') with help of DNS service running on server side. |
|||
* |
|||
* Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s. |
|||
*/ |
|||
|
|||
#define SSID "ESP-TEST" |
|||
#define PASSWORD "123456789" |
|||
|
|||
#define SERVER_HOST_NAME "esp_server" |
|||
|
|||
#define TCP_PORT 7050 |
|||
#define DNS_PORT 53 |
|||
|
|||
#endif // CONFIG_H
|
|||
@ -0,0 +1,54 @@ |
|||
#ifdef ESP8266 |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESP8266mDNS.h> |
|||
#include <ArduinoOTA.h> |
|||
#else |
|||
#include <ESP31BWiFi.h> |
|||
#endif |
|||
#include "ESPAsyncTCP.h" |
|||
#include "SyncClient.h" |
|||
|
|||
const char* ssid = "**********"; |
|||
const char* password = "************"; |
|||
|
|||
void setup(){ |
|||
Serial.begin(115200); |
|||
WiFi.begin(ssid, password); |
|||
if (WiFi.waitForConnectResult() != WL_CONNECTED) { |
|||
Serial.printf("WiFi Failed!\n"); |
|||
return; |
|||
} |
|||
Serial.printf("WiFi Connected!\n"); |
|||
Serial.println(WiFi.localIP()); |
|||
#ifdef ESP8266 |
|||
ArduinoOTA.begin(); |
|||
#endif |
|||
|
|||
SyncClient client; |
|||
if(!client.connect("www.google.com", 80)){ |
|||
Serial.println("Connect Failed"); |
|||
return; |
|||
} |
|||
client.setTimeout(2); |
|||
if(client.printf("GET / HTTP/1.1\r\nHost: www.google.com\r\nConnection: close\r\n\r\n") > 0){ |
|||
while(client.connected() && client.available() == 0){ |
|||
delay(1); |
|||
} |
|||
while(client.available()){ |
|||
Serial.write(client.read()); |
|||
} |
|||
if(client.connected()){ |
|||
client.stop(); |
|||
} |
|||
} else { |
|||
client.stop(); |
|||
Serial.println("Send Failed"); |
|||
while(client.connected()) delay(0); |
|||
} |
|||
} |
|||
|
|||
void loop(){ |
|||
#ifdef ESP8266 |
|||
ArduinoOTA.handle(); |
|||
#endif |
|||
} |
|||
@ -0,0 +1,22 @@ |
|||
{ |
|||
"name":"ESPAsyncTCP", |
|||
"description":"Asynchronous TCP Library for ESP8266", |
|||
"keywords":"async,tcp", |
|||
"authors": |
|||
{ |
|||
"name": "Hristo Gochkov", |
|||
"maintainer": true |
|||
}, |
|||
"repository": |
|||
{ |
|||
"type": "git", |
|||
"url": "https://github.com/me-no-dev/ESPAsyncTCP.git" |
|||
}, |
|||
"version": "1.2.2", |
|||
"license": "LGPL-3.0", |
|||
"frameworks": "arduino", |
|||
"platforms": "espressif8266", |
|||
"build": { |
|||
"libCompatMode": 2 |
|||
} |
|||
} |
|||
@ -0,0 +1,9 @@ |
|||
name=ESP AsyncTCP |
|||
version=1.2.2 |
|||
author=Me-No-Dev |
|||
maintainer=Me-No-Dev |
|||
sentence=Async TCP Library for ESP8266 and ESP31B |
|||
paragraph=Async TCP Library for ESP8266 and ESP31B |
|||
category=Other |
|||
url=https://github.com/me-no-dev/ESPAsyncTCP |
|||
architectures=* |
|||
@ -0,0 +1,214 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
|
|||
#include "AsyncPrinter.h" |
|||
|
|||
AsyncPrinter::AsyncPrinter() |
|||
: _client(NULL) |
|||
, _data_cb(NULL) |
|||
, _data_arg(NULL) |
|||
, _close_cb(NULL) |
|||
, _close_arg(NULL) |
|||
, _tx_buffer(NULL) |
|||
, _tx_buffer_size(TCP_MSS) |
|||
, next(NULL) |
|||
{} |
|||
|
|||
AsyncPrinter::AsyncPrinter(AsyncClient *client, size_t txBufLen) |
|||
: _client(client) |
|||
, _data_cb(NULL) |
|||
, _data_arg(NULL) |
|||
, _close_cb(NULL) |
|||
, _close_arg(NULL) |
|||
, _tx_buffer(NULL) |
|||
, _tx_buffer_size(txBufLen) |
|||
, next(NULL) |
|||
{ |
|||
_attachCallbacks(); |
|||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size); |
|||
if(_tx_buffer == NULL) { |
|||
panic(); //What should we do?
|
|||
} |
|||
} |
|||
|
|||
AsyncPrinter::~AsyncPrinter(){ |
|||
_on_close(); |
|||
} |
|||
|
|||
void AsyncPrinter::onData(ApDataHandler cb, void *arg){ |
|||
_data_cb = cb; |
|||
_data_arg = arg; |
|||
} |
|||
|
|||
void AsyncPrinter::onClose(ApCloseHandler cb, void *arg){ |
|||
_close_cb = cb; |
|||
_close_arg = arg; |
|||
} |
|||
|
|||
int AsyncPrinter::connect(IPAddress ip, uint16_t port){ |
|||
if(_client != NULL && connected()) |
|||
return 0; |
|||
_client = new (std::nothrow) AsyncClient(); |
|||
if (_client == NULL) { |
|||
panic(); |
|||
} |
|||
|
|||
_client->onConnect([](void *obj, AsyncClient *c){ ((AsyncPrinter*)(obj))->_onConnect(c); }, this); |
|||
if(_client->connect(ip, port)){ |
|||
while(_client && _client->state() < 4) |
|||
delay(1); |
|||
return connected(); |
|||
} |
|||
return 0; |
|||
} |
|||
|
|||
int AsyncPrinter::connect(const char *host, uint16_t port){ |
|||
if(_client != NULL && connected()) |
|||
return 0; |
|||
_client = new (std::nothrow) AsyncClient(); |
|||
if (_client == NULL) { |
|||
panic(); |
|||
} |
|||
|
|||
_client->onConnect([](void *obj, AsyncClient *c){ ((AsyncPrinter*)(obj))->_onConnect(c); }, this); |
|||
if(_client->connect(host, port)){ |
|||
while(_client && _client->state() < 4) |
|||
delay(1); |
|||
return connected(); |
|||
} |
|||
return 0; |
|||
} |
|||
|
|||
void AsyncPrinter::_onConnect(AsyncClient *c){ |
|||
(void)c; |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size); |
|||
if(_tx_buffer) { |
|||
panic(); |
|||
} |
|||
|
|||
_attachCallbacks(); |
|||
} |
|||
|
|||
AsyncPrinter::operator bool(){ return connected(); } |
|||
|
|||
AsyncPrinter & AsyncPrinter::operator=(const AsyncPrinter &other){ |
|||
if(_client != NULL){ |
|||
_client->close(true); |
|||
_client = NULL; |
|||
} |
|||
_tx_buffer_size = other._tx_buffer_size; |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
_tx_buffer = new (std::nothrow) cbuf(other._tx_buffer_size); |
|||
if(_tx_buffer == NULL) { |
|||
panic(); |
|||
} |
|||
|
|||
_client = other._client; |
|||
_attachCallbacks(); |
|||
return *this; |
|||
} |
|||
|
|||
size_t AsyncPrinter::write(uint8_t data){ |
|||
return write(&data, 1); |
|||
} |
|||
|
|||
size_t AsyncPrinter::write(const uint8_t *data, size_t len){ |
|||
if(_tx_buffer == NULL || !connected()) |
|||
return 0; |
|||
size_t toWrite = 0; |
|||
size_t toSend = len; |
|||
while(_tx_buffer->room() < toSend){ |
|||
toWrite = _tx_buffer->room(); |
|||
_tx_buffer->write((const char*)data, toWrite); |
|||
while(connected() && !_client->canSend()) |
|||
delay(0); |
|||
if(!connected()) |
|||
return 0; // or len - toSend;
|
|||
_sendBuffer(); |
|||
toSend -= toWrite; |
|||
} |
|||
_tx_buffer->write((const char*)(data+(len - toSend)), toSend); |
|||
while(connected() && !_client->canSend()) delay(0); |
|||
if(!connected()) return 0; // or len - toSend;
|
|||
_sendBuffer(); |
|||
return len; |
|||
} |
|||
|
|||
bool AsyncPrinter::connected(){ |
|||
return (_client != NULL && _client->connected()); |
|||
} |
|||
|
|||
void AsyncPrinter::close(){ |
|||
if(_client != NULL) |
|||
_client->close(true); |
|||
} |
|||
|
|||
size_t AsyncPrinter::_sendBuffer(){ |
|||
size_t available = _tx_buffer->available(); |
|||
if(!connected() || !_client->canSend() || available == 0) |
|||
return 0; |
|||
size_t sendable = _client->space(); |
|||
if(sendable < available) |
|||
available= sendable; |
|||
char *out = new (std::nothrow) char[available]; |
|||
if (out == NULL) { |
|||
panic(); // Connection should be aborted instead
|
|||
} |
|||
|
|||
_tx_buffer->read(out, available); |
|||
size_t sent = _client->write(out, available); |
|||
delete out; |
|||
return sent; |
|||
} |
|||
|
|||
void AsyncPrinter::_onData(void *data, size_t len){ |
|||
if(_data_cb) |
|||
_data_cb(_data_arg, this, (uint8_t*)data, len); |
|||
} |
|||
|
|||
void AsyncPrinter::_on_close(){ |
|||
if(_client != NULL){ |
|||
_client = NULL; |
|||
} |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
if(_close_cb) |
|||
_close_cb(_close_arg, this); |
|||
} |
|||
|
|||
void AsyncPrinter::_attachCallbacks(){ |
|||
_client->onPoll([](void *obj, AsyncClient* c){ (void)c; ((AsyncPrinter*)(obj))->_sendBuffer(); }, this); |
|||
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time){ (void)c; (void)len; (void)time; ((AsyncPrinter*)(obj))->_sendBuffer(); }, this); |
|||
_client->onDisconnect([](void *obj, AsyncClient* c){ ((AsyncPrinter*)(obj))->_on_close(); delete c; }, this); |
|||
_client->onData([](void *obj, AsyncClient* c, void *data, size_t len){ (void)c; ((AsyncPrinter*)(obj))->_onData(data, len); }, this); |
|||
} |
|||
@ -0,0 +1,73 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
|
|||
#ifndef ASYNCPRINTER_H_ |
|||
#define ASYNCPRINTER_H_ |
|||
|
|||
#include "Arduino.h" |
|||
#include "ESPAsyncTCP.h" |
|||
#include "cbuf.h" |
|||
|
|||
class AsyncPrinter; |
|||
|
|||
typedef std::function<void(void*, AsyncPrinter*, uint8_t*, size_t)> ApDataHandler; |
|||
typedef std::function<void(void*, AsyncPrinter*)> ApCloseHandler; |
|||
|
|||
class AsyncPrinter: public Print { |
|||
private: |
|||
AsyncClient *_client; |
|||
ApDataHandler _data_cb; |
|||
void *_data_arg; |
|||
ApCloseHandler _close_cb; |
|||
void *_close_arg; |
|||
cbuf *_tx_buffer; |
|||
size_t _tx_buffer_size; |
|||
|
|||
void _onConnect(AsyncClient *c); |
|||
public: |
|||
AsyncPrinter *next; |
|||
|
|||
AsyncPrinter(); |
|||
AsyncPrinter(AsyncClient *client, size_t txBufLen = TCP_MSS); |
|||
virtual ~AsyncPrinter(); |
|||
|
|||
int connect(IPAddress ip, uint16_t port); |
|||
int connect(const char *host, uint16_t port); |
|||
|
|||
void onData(ApDataHandler cb, void *arg); |
|||
void onClose(ApCloseHandler cb, void *arg); |
|||
|
|||
operator bool(); |
|||
AsyncPrinter & operator=(const AsyncPrinter &other); |
|||
|
|||
size_t write(uint8_t data); |
|||
size_t write(const uint8_t *data, size_t len); |
|||
|
|||
bool connected(); |
|||
void close(); |
|||
|
|||
size_t _sendBuffer(); |
|||
void _onData(void *data, size_t len); |
|||
void _on_close(); |
|||
void _attachCallbacks(); |
|||
}; |
|||
|
|||
#endif /* ASYNCPRINTER_H_ */ |
|||
@ -0,0 +1,96 @@ |
|||
#ifndef _DEBUG_PRINT_MACROS_H |
|||
#define _DEBUG_PRINT_MACROS_H |
|||
// Some customizable print macros to suite the debug needs de jour.
|
|||
|
|||
// Debug macros
|
|||
// #include <pgmspace.h>
|
|||
// https://stackoverflow.com/questions/8487986/file-macro-shows-full-path
|
|||
// This value is resolved at compile time.
|
|||
#define _FILENAME_ strrchr("/" __FILE__, '/') |
|||
|
|||
// #define DEBUG_ESP_ASYNC_TCP 1
|
|||
// #define DEBUG_ESP_TCP_SSL 1
|
|||
// #define DEBUG_ESP_PORT Serial
|
|||
|
|||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_TIME_STAMP_FMT) |
|||
#define DEBUG_TIME_STAMP_FMT "%06u.%03u " |
|||
struct _DEBUG_TIME_STAMP { |
|||
unsigned dec; |
|||
unsigned whole; |
|||
}; |
|||
inline struct _DEBUG_TIME_STAMP debugTimeStamp(void) { |
|||
struct _DEBUG_TIME_STAMP st; |
|||
unsigned now = millis() % 1000000000; |
|||
st.dec = now % 1000; |
|||
st.whole = now / 1000; |
|||
return st; |
|||
} |
|||
#endif |
|||
|
|||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC) |
|||
#define DEBUG_GENERIC( module, format, ... ) \ |
|||
do { \ |
|||
struct _DEBUG_TIME_STAMP st = debugTimeStamp(); \ |
|||
DEBUG_ESP_PORT.printf( DEBUG_TIME_STAMP_FMT module " " format, st.whole, st.dec, ##__VA_ARGS__ ); \ |
|||
} while(false) |
|||
#endif |
|||
#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC_P) |
|||
#define DEBUG_GENERIC_P( module, format, ... ) \ |
|||
do { \ |
|||
struct _DEBUG_TIME_STAMP st = debugTimeStamp(); \ |
|||
DEBUG_ESP_PORT.printf_P(PSTR( DEBUG_TIME_STAMP_FMT module " " format ), st.whole, st.dec, ##__VA_ARGS__ ); \ |
|||
} while(false) |
|||
#endif |
|||
|
|||
#if defined(DEBUG_GENERIC) && !defined(ASSERT_GENERIC) |
|||
#define ASSERT_GENERIC( a, module ) \ |
|||
do { \ |
|||
if ( !(a) ) { \ |
|||
DEBUG_GENERIC( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \ |
|||
DEBUG_ESP_PORT.flush(); \ |
|||
} \ |
|||
} while(false) |
|||
#endif |
|||
#if defined(DEBUG_GENERIC_P) && !defined(ASSERT_GENERIC_P) |
|||
#define ASSERT_GENERIC_P( a, module ) \ |
|||
do { \ |
|||
if ( !(a) ) { \ |
|||
DEBUG_GENERIC_P( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \ |
|||
DEBUG_ESP_PORT.flush(); \ |
|||
} \ |
|||
} while(false) |
|||
#endif |
|||
|
|||
#ifndef DEBUG_GENERIC |
|||
#define DEBUG_GENERIC(...) do { (void)0;} while(false) |
|||
#endif |
|||
|
|||
#ifndef DEBUG_GENERIC_P |
|||
#define DEBUG_GENERIC_P(...) do { (void)0;} while(false) |
|||
#endif |
|||
|
|||
#ifndef ASSERT_GENERIC |
|||
#define ASSERT_GENERIC(...) do { (void)0;} while(false) |
|||
#endif |
|||
|
|||
#ifndef ASSERT_GENERIC_P |
|||
#define ASSERT_GENERIC_P(...) do { (void)0;} while(false) |
|||
#endif |
|||
|
|||
#ifndef DEBUG_ESP_PRINTF |
|||
#define DEBUG_ESP_PRINTF( format, ...) DEBUG_GENERIC_P("[%s]", format, &_FILENAME_[1], ##__VA_ARGS__) |
|||
#endif |
|||
|
|||
#if defined(DEBUG_ESP_ASYNC_TCP) && !defined(ASYNC_TCP_DEBUG) |
|||
#define ASYNC_TCP_DEBUG( format, ...) DEBUG_GENERIC_P("[ASYNC_TCP]", format, ##__VA_ARGS__) |
|||
#endif |
|||
|
|||
#ifndef ASYNC_TCP_ASSERT |
|||
#define ASYNC_TCP_ASSERT( a ) ASSERT_GENERIC_P( (a), "[ASYNC_TCP]") |
|||
#endif |
|||
|
|||
#if defined(DEBUG_ESP_TCP_SSL) && !defined(TCP_SSL_DEBUG) |
|||
#define TCP_SSL_DEBUG( format, ...) DEBUG_GENERIC_P("[TCP_SSL]", format, ##__VA_ARGS__) |
|||
#endif |
|||
|
|||
#endif //_DEBUG_PRINT_MACROS_H
|
|||
File diff suppressed because it is too large
@ -0,0 +1,327 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
|
|||
#ifndef ASYNCTCP_H_ |
|||
#define ASYNCTCP_H_ |
|||
|
|||
#include <async_config.h> |
|||
#include "IPAddress.h" |
|||
#include <functional> |
|||
#include <memory> |
|||
|
|||
extern "C" { |
|||
#include "lwip/init.h" |
|||
#include "lwip/err.h" |
|||
#include "lwip/pbuf.h" |
|||
}; |
|||
|
|||
class AsyncClient; |
|||
class AsyncServer; |
|||
class ACErrorTracker; |
|||
|
|||
#define ASYNC_MAX_ACK_TIME 5000 |
|||
#define ASYNC_WRITE_FLAG_COPY 0x01 //will allocate new buffer to hold the data while sending (else will hold reference to the data given)
|
|||
#define ASYNC_WRITE_FLAG_MORE 0x02 //will not send PSH flag, meaning that there should be more data to be sent before the application should react.
|
|||
|
|||
struct tcp_pcb; |
|||
struct ip_addr; |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
struct SSL_; |
|||
typedef struct SSL_ SSL; |
|||
struct SSL_CTX_; |
|||
typedef struct SSL_CTX_ SSL_CTX; |
|||
#endif |
|||
|
|||
typedef std::function<void(void*, AsyncClient*)> AcConnectHandler; |
|||
typedef std::function<void(void*, AsyncClient*, size_t len, uint32_t time)> AcAckHandler; |
|||
typedef std::function<void(void*, AsyncClient*, err_t error)> AcErrorHandler; |
|||
typedef std::function<void(void*, AsyncClient*, void *data, size_t len)> AcDataHandler; |
|||
typedef std::function<void(void*, AsyncClient*, struct pbuf *pb)> AcPacketHandler; |
|||
typedef std::function<void(void*, AsyncClient*, uint32_t time)> AcTimeoutHandler; |
|||
typedef std::function<void(void*, size_t event)> AsNotifyHandler; |
|||
|
|||
enum error_events { |
|||
EE_OK = 0, |
|||
EE_ABORTED, // Callback or foreground aborted connections
|
|||
EE_ERROR_CB, // Stack initiated aborts via error Callbacks.
|
|||
EE_CONNECTED_CB, |
|||
EE_RECV_CB, |
|||
EE_ACCEPT_CB, |
|||
EE_MAX |
|||
}; |
|||
// DEBUG_MORE is for gathering more information on which CBs close events are
|
|||
// occuring and count.
|
|||
// #define DEBUG_MORE 1
|
|||
class ACErrorTracker { |
|||
private: |
|||
AsyncClient *_client; |
|||
err_t _close_error; |
|||
int _errored; |
|||
#if DEBUG_ESP_ASYNC_TCP |
|||
size_t _connectionId; |
|||
#endif |
|||
#ifdef DEBUG_MORE |
|||
AsNotifyHandler _error_event_cb; |
|||
void* _error_event_cb_arg; |
|||
#endif |
|||
|
|||
protected: |
|||
friend class AsyncClient; |
|||
friend class AsyncServer; |
|||
#ifdef DEBUG_MORE |
|||
void onErrorEvent(AsNotifyHandler cb, void *arg); |
|||
#endif |
|||
#if DEBUG_ESP_ASYNC_TCP |
|||
void setConnectionId(size_t id) { _connectionId=id;} |
|||
size_t getConnectionId(void) { return _connectionId;} |
|||
#endif |
|||
void setCloseError(err_t e); |
|||
void setErrored(size_t errorEvent); |
|||
err_t getCallbackCloseError(void); |
|||
void clearClient(void){ if (_client) _client = NULL;} |
|||
|
|||
public: |
|||
err_t getCloseError(void) const { return _close_error;} |
|||
bool hasClient(void) const { return (_client != NULL);} |
|||
ACErrorTracker(AsyncClient *c); |
|||
~ACErrorTracker() {} |
|||
}; |
|||
|
|||
class AsyncClient { |
|||
protected: |
|||
friend class AsyncTCPbuffer; |
|||
friend class AsyncServer; |
|||
tcp_pcb* _pcb; |
|||
AcConnectHandler _connect_cb; |
|||
void* _connect_cb_arg; |
|||
AcConnectHandler _discard_cb; |
|||
void* _discard_cb_arg; |
|||
AcAckHandler _sent_cb; |
|||
void* _sent_cb_arg; |
|||
AcErrorHandler _error_cb; |
|||
void* _error_cb_arg; |
|||
AcDataHandler _recv_cb; |
|||
void* _recv_cb_arg; |
|||
AcPacketHandler _pb_cb; |
|||
void* _pb_cb_arg; |
|||
AcTimeoutHandler _timeout_cb; |
|||
void* _timeout_cb_arg; |
|||
AcConnectHandler _poll_cb; |
|||
void* _poll_cb_arg; |
|||
bool _pcb_busy; |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
bool _pcb_secure; |
|||
bool _handshake_done; |
|||
#endif |
|||
uint32_t _pcb_sent_at; |
|||
bool _close_pcb; |
|||
bool _ack_pcb; |
|||
uint32_t _tx_unacked_len; |
|||
uint32_t _tx_acked_len; |
|||
uint32_t _tx_unsent_len; |
|||
uint32_t _rx_ack_len; |
|||
uint32_t _rx_last_packet; |
|||
uint32_t _rx_since_timeout; |
|||
uint32_t _ack_timeout; |
|||
uint16_t _connect_port; |
|||
u8_t _recv_pbuf_flags; |
|||
std::shared_ptr<ACErrorTracker> _errorTracker; |
|||
|
|||
void _close(); |
|||
void _connected(std::shared_ptr<ACErrorTracker>& closeAbort, void* pcb, err_t err); |
|||
void _error(err_t err); |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
void _ssl_error(int8_t err); |
|||
#endif |
|||
void _poll(std::shared_ptr<ACErrorTracker>& closeAbort, tcp_pcb* pcb); |
|||
void _sent(std::shared_ptr<ACErrorTracker>& closeAbort, tcp_pcb* pcb, uint16_t len); |
|||
#if LWIP_VERSION_MAJOR == 1 |
|||
void _dns_found(struct ip_addr *ipaddr); |
|||
#else |
|||
void _dns_found(const ip_addr *ipaddr); |
|||
#endif |
|||
static err_t _s_poll(void *arg, struct tcp_pcb *tpcb); |
|||
static err_t _s_recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *pb, err_t err); |
|||
static void _s_error(void *arg, err_t err); |
|||
static err_t _s_sent(void *arg, struct tcp_pcb *tpcb, uint16_t len); |
|||
static err_t _s_connected(void* arg, void* tpcb, err_t err); |
|||
#if LWIP_VERSION_MAJOR == 1 |
|||
static void _s_dns_found(const char *name, struct ip_addr *ipaddr, void *arg); |
|||
#else |
|||
static void _s_dns_found(const char *name, const ip_addr *ipaddr, void *arg); |
|||
#endif |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
static void _s_data(void *arg, struct tcp_pcb *tcp, uint8_t * data, size_t len); |
|||
static void _s_handshake(void *arg, struct tcp_pcb *tcp, SSL *ssl); |
|||
static void _s_ssl_error(void *arg, struct tcp_pcb *tcp, int8_t err); |
|||
#endif |
|||
std::shared_ptr<ACErrorTracker> getACErrorTracker(void) const { return _errorTracker; }; |
|||
void setCloseError(err_t e) const { _errorTracker->setCloseError(e);} |
|||
|
|||
public: |
|||
AsyncClient* prev; |
|||
AsyncClient* next; |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
AsyncClient(tcp_pcb* pcb = 0, SSL_CTX * ssl_ctx = NULL); |
|||
#else |
|||
AsyncClient(tcp_pcb* pcb = 0); |
|||
#endif |
|||
~AsyncClient(); |
|||
|
|||
AsyncClient & operator=(const AsyncClient &other); |
|||
AsyncClient & operator+=(const AsyncClient &other); |
|||
|
|||
bool operator==(const AsyncClient &other); |
|||
|
|||
bool operator!=(const AsyncClient &other) { |
|||
return !(*this == other); |
|||
} |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
bool connect(IPAddress ip, uint16_t port, bool secure=false); |
|||
bool connect(const char* host, uint16_t port, bool secure=false); |
|||
#else |
|||
bool connect(IPAddress ip, uint16_t port); |
|||
bool connect(const char* host, uint16_t port); |
|||
#endif |
|||
void close(bool now = false); |
|||
void stop(); |
|||
void abort(); |
|||
bool free(); |
|||
|
|||
bool canSend();//ack is not pending
|
|||
size_t space(); |
|||
size_t add(const char* data, size_t size, uint8_t apiflags=0);//add for sending
|
|||
bool send();//send all data added with the method above
|
|||
size_t ack(size_t len); //ack data that you have not acked using the method below
|
|||
void ackLater(){ _ack_pcb = false; } //will not ack the current packet. Call from onData
|
|||
bool isRecvPush(){ return !!(_recv_pbuf_flags & PBUF_FLAG_PUSH); } |
|||
#if DEBUG_ESP_ASYNC_TCP |
|||
size_t getConnectionId(void) const { return _errorTracker->getConnectionId();} |
|||
#endif |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
SSL *getSSL(); |
|||
#endif |
|||
|
|||
size_t write(const char* data); |
|||
size_t write(const char* data, size_t size, uint8_t apiflags=0); //only when canSend() == true
|
|||
|
|||
uint8_t state(); |
|||
bool connecting(); |
|||
bool connected(); |
|||
bool disconnecting(); |
|||
bool disconnected(); |
|||
bool freeable();//disconnected or disconnecting
|
|||
|
|||
uint16_t getMss(); |
|||
uint32_t getRxTimeout(); |
|||
void setRxTimeout(uint32_t timeout);//no RX data timeout for the connection in seconds
|
|||
uint32_t getAckTimeout(); |
|||
void setAckTimeout(uint32_t timeout);//no ACK timeout for the last sent packet in milliseconds
|
|||
void setNoDelay(bool nodelay); |
|||
bool getNoDelay(); |
|||
uint32_t getRemoteAddress(); |
|||
uint16_t getRemotePort(); |
|||
uint32_t getLocalAddress(); |
|||
uint16_t getLocalPort(); |
|||
|
|||
IPAddress remoteIP(); |
|||
uint16_t remotePort(); |
|||
IPAddress localIP(); |
|||
uint16_t localPort(); |
|||
|
|||
void onConnect(AcConnectHandler cb, void* arg = 0); //on successful connect
|
|||
void onDisconnect(AcConnectHandler cb, void* arg = 0); //disconnected
|
|||
void onAck(AcAckHandler cb, void* arg = 0); //ack received
|
|||
void onError(AcErrorHandler cb, void* arg = 0); //unsuccessful connect or error
|
|||
void onData(AcDataHandler cb, void* arg = 0); //data received (called if onPacket is not used)
|
|||
void onPacket(AcPacketHandler cb, void* arg = 0); //data received
|
|||
void onTimeout(AcTimeoutHandler cb, void* arg = 0); //ack timeout
|
|||
void onPoll(AcConnectHandler cb, void* arg = 0); //every 125ms when connected
|
|||
void ackPacket(struct pbuf * pb); |
|||
|
|||
const char * errorToString(err_t error); |
|||
const char * stateToString(); |
|||
|
|||
void _recv(std::shared_ptr<ACErrorTracker>& closeAbort, tcp_pcb* pcb, pbuf* pb, err_t err); |
|||
err_t getCloseError(void) const { return _errorTracker->getCloseError();} |
|||
}; |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
typedef std::function<int(void* arg, const char *filename, uint8_t **buf)> AcSSlFileHandler; |
|||
struct pending_pcb; |
|||
#endif |
|||
|
|||
|
|||
class AsyncServer { |
|||
protected: |
|||
uint16_t _port; |
|||
IPAddress _addr; |
|||
bool _noDelay; |
|||
tcp_pcb* _pcb; |
|||
AcConnectHandler _connect_cb; |
|||
void* _connect_cb_arg; |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
struct pending_pcb * _pending; |
|||
SSL_CTX * _ssl_ctx; |
|||
AcSSlFileHandler _file_cb; |
|||
void* _file_cb_arg; |
|||
#endif |
|||
#ifdef DEBUG_MORE |
|||
int _event_count[EE_MAX]; |
|||
#endif |
|||
|
|||
public: |
|||
|
|||
AsyncServer(IPAddress addr, uint16_t port); |
|||
AsyncServer(uint16_t port); |
|||
~AsyncServer(); |
|||
void onClient(AcConnectHandler cb, void* arg); |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
void onSslFileRequest(AcSSlFileHandler cb, void* arg); |
|||
void beginSecure(const char *cert, const char *private_key_file, const char *password); |
|||
#endif |
|||
void begin(); |
|||
void end(); |
|||
void setNoDelay(bool nodelay); |
|||
bool getNoDelay(); |
|||
uint8_t status(); |
|||
#ifdef DEBUG_MORE |
|||
int getEventCount(size_t ee) const { return _event_count[ee];} |
|||
#endif |
|||
protected: |
|||
err_t _accept(tcp_pcb* newpcb, err_t err); |
|||
static err_t _s_accept(void *arg, tcp_pcb* newpcb, err_t err); |
|||
#ifdef DEBUG_MORE |
|||
int incEventCount(size_t ee) { return ++_event_count[ee];} |
|||
#endif |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
int _cert(const char *filename, uint8_t **buf); |
|||
err_t _poll(tcp_pcb* pcb); |
|||
err_t _recv(tcp_pcb *pcb, struct pbuf *pb, err_t err); |
|||
static int _s_cert(void *arg, const char *filename, uint8_t **buf); |
|||
static err_t _s_poll(void *arg, struct tcp_pcb *tpcb); |
|||
static err_t _s_recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *pb, err_t err); |
|||
#endif |
|||
}; |
|||
|
|||
|
|||
#endif /* ASYNCTCP_H_ */ |
|||
@ -0,0 +1,555 @@ |
|||
/**
|
|||
* @file ESPAsyncTCPbuffer.cpp |
|||
* @date 22.01.2016 |
|||
* @author Markus Sattler |
|||
* |
|||
* Copyright (c) 2015 Markus Sattler. All rights reserved. |
|||
* This file is part of the Asynv TCP for ESP. |
|||
* |
|||
* 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. |
|||
* |
|||
* This library is distributed in the hope that it will be useful, |
|||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
* Lesser General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU Lesser General Public |
|||
* License along with this library; if not, write to the Free Software |
|||
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
* |
|||
*/ |
|||
|
|||
|
|||
#include <Arduino.h> |
|||
#include <debug.h> |
|||
|
|||
#include "ESPAsyncTCPbuffer.h" |
|||
|
|||
|
|||
AsyncTCPbuffer::AsyncTCPbuffer(AsyncClient* client) { |
|||
if(client == NULL) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] client is null!!!\n"); |
|||
panic(); |
|||
} |
|||
|
|||
_client = client; |
|||
_TXbufferWrite = new (std::nothrow) cbuf(TCP_MSS); |
|||
_TXbufferRead = _TXbufferWrite; |
|||
_RXbuffer = new (std::nothrow) cbuf(100); |
|||
_RXmode = ATB_RX_MODE_FREE; |
|||
_rxSize = 0; |
|||
_rxTerminator = 0x00; |
|||
_rxReadBytesPtr = NULL; |
|||
_rxReadStringPtr = NULL; |
|||
_cbDisconnect = NULL; |
|||
|
|||
_cbRX = NULL; |
|||
_cbDone = NULL; |
|||
_attachCallbacks(); |
|||
} |
|||
|
|||
AsyncTCPbuffer::~AsyncTCPbuffer() { |
|||
if(_client) { |
|||
_client->close(); |
|||
} |
|||
|
|||
if(_RXbuffer) { |
|||
delete _RXbuffer; |
|||
_RXbuffer = NULL; |
|||
} |
|||
|
|||
if(_TXbufferWrite) { |
|||
// will be deleted in _TXbufferRead chain
|
|||
_TXbufferWrite = NULL; |
|||
} |
|||
|
|||
if(_TXbufferRead) { |
|||
cbuf * next = _TXbufferRead->next; |
|||
delete _TXbufferRead; |
|||
while(next != NULL) { |
|||
_TXbufferRead = next; |
|||
next = _TXbufferRead->next; |
|||
delete _TXbufferRead; |
|||
} |
|||
_TXbufferRead = NULL; |
|||
} |
|||
} |
|||
|
|||
size_t AsyncTCPbuffer::write(String & data) { |
|||
return write(data.c_str(), data.length()); |
|||
} |
|||
|
|||
size_t AsyncTCPbuffer::write(uint8_t data) { |
|||
return write(&data, 1); |
|||
} |
|||
|
|||
size_t AsyncTCPbuffer::write(const char* data) { |
|||
return write((const uint8_t *) data, strlen(data)); |
|||
} |
|||
|
|||
size_t AsyncTCPbuffer::write(const char *data, size_t len) { |
|||
return write((const uint8_t *) data, len); |
|||
} |
|||
|
|||
/**
|
|||
* write data in to buffer and try to send the data |
|||
* @param data |
|||
* @param len |
|||
* @return |
|||
*/ |
|||
size_t AsyncTCPbuffer::write(const uint8_t *data, size_t len) { |
|||
if(_TXbufferWrite == NULL || _client == NULL || !_client->connected() || data == NULL || len == 0) { |
|||
return 0; |
|||
} |
|||
|
|||
size_t bytesLeft = len; |
|||
while(bytesLeft) { |
|||
size_t w = _TXbufferWrite->write((const char*) data, bytesLeft); |
|||
bytesLeft -= w; |
|||
data += w; |
|||
_sendBuffer(); |
|||
|
|||
// add new buffer since we have more data
|
|||
if(_TXbufferWrite->full() && bytesLeft > 0) { |
|||
|
|||
// to less ram!!!
|
|||
if(ESP.getFreeHeap() < 4096) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] run out of Heap can not send all Data!\n"); |
|||
return (len - bytesLeft); |
|||
} |
|||
|
|||
cbuf * next = new (std::nothrow) cbuf(TCP_MSS); |
|||
if(next == NULL) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] run out of Heap!\n"); |
|||
panic(); |
|||
} else { |
|||
DEBUG_ASYNC_TCP("[A-TCP] new cbuf\n"); |
|||
} |
|||
|
|||
// add new buffer to chain (current cbuf)
|
|||
_TXbufferWrite->next = next; |
|||
|
|||
// move ptr for next data
|
|||
_TXbufferWrite = next; |
|||
} |
|||
} |
|||
|
|||
return len; |
|||
|
|||
} |
|||
|
|||
/**
|
|||
* wait until all data has send out |
|||
*/ |
|||
void AsyncTCPbuffer::flush() { |
|||
while(!_TXbufferWrite->empty()) { |
|||
while(connected() && !_client->canSend()) { |
|||
delay(0); |
|||
} |
|||
if(!connected()) |
|||
return; |
|||
_sendBuffer(); |
|||
} |
|||
} |
|||
|
|||
void AsyncTCPbuffer::noCallback() { |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
} |
|||
|
|||
void AsyncTCPbuffer::readStringUntil(char terminator, String * str, AsyncTCPbufferDoneCb done) { |
|||
if(_client == NULL) { |
|||
return; |
|||
} |
|||
DEBUG_ASYNC_TCP("[A-TCP] readStringUntil terminator: %02X\n", terminator); |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone = done; |
|||
_rxReadStringPtr = str; |
|||
_rxTerminator = terminator; |
|||
_rxSize = 0; |
|||
_RXmode = ATB_RX_MODE_TERMINATOR_STRING; |
|||
} |
|||
|
|||
/*
|
|||
void AsyncTCPbuffer::readBytesUntil(char terminator, char *buffer, size_t length, AsyncTCPbufferDoneCb done) { |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone = done; |
|||
_rxReadBytesPtr = (uint8_t *) buffer; |
|||
_rxTerminator = terminator; |
|||
_rxSize = length; |
|||
_RXmode = ATB_RX_MODE_TERMINATOR; |
|||
_handleRxBuffer(NULL, 0); |
|||
} |
|||
|
|||
void AsyncTCPbuffer::readBytesUntil(char terminator, uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done) { |
|||
readBytesUntil(terminator, (char *) buffer, length, done); |
|||
} |
|||
*/ |
|||
|
|||
void AsyncTCPbuffer::readBytes(char *buffer, size_t length, AsyncTCPbufferDoneCb done) { |
|||
if(_client == NULL) { |
|||
return; |
|||
} |
|||
DEBUG_ASYNC_TCP("[A-TCP] readBytes length: %d\n", length); |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone = done; |
|||
_rxReadBytesPtr = (uint8_t *) buffer; |
|||
_rxSize = length; |
|||
_RXmode = ATB_RX_MODE_READ_BYTES; |
|||
} |
|||
|
|||
void AsyncTCPbuffer::readBytes(uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done) { |
|||
readBytes((char *) buffer, length, done); |
|||
} |
|||
|
|||
void AsyncTCPbuffer::onData(AsyncTCPbufferDataCb cb) { |
|||
if(_client == NULL) { |
|||
return; |
|||
} |
|||
DEBUG_ASYNC_TCP("[A-TCP] onData\n"); |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone = NULL; |
|||
_cbRX = cb; |
|||
_RXmode = ATB_RX_MODE_FREE; |
|||
} |
|||
|
|||
void AsyncTCPbuffer::onDisconnect(AsyncTCPbufferDisconnectCb cb) { |
|||
_cbDisconnect = cb; |
|||
} |
|||
|
|||
IPAddress AsyncTCPbuffer::remoteIP() { |
|||
if(!_client) { |
|||
return IPAddress(0U); |
|||
} |
|||
return _client->remoteIP(); |
|||
} |
|||
|
|||
uint16_t AsyncTCPbuffer::remotePort() { |
|||
if(!_client) { |
|||
return 0; |
|||
} |
|||
return _client->remotePort(); |
|||
} |
|||
|
|||
bool AsyncTCPbuffer::connected() { |
|||
if(!_client) { |
|||
return false; |
|||
} |
|||
return _client->connected(); |
|||
} |
|||
|
|||
void AsyncTCPbuffer::stop() { |
|||
|
|||
if(!_client) { |
|||
return; |
|||
} |
|||
_client->stop(); |
|||
_client = NULL; |
|||
|
|||
if(_cbDone) { |
|||
switch(_RXmode) { |
|||
case ATB_RX_MODE_READ_BYTES: |
|||
case ATB_RX_MODE_TERMINATOR: |
|||
case ATB_RX_MODE_TERMINATOR_STRING: |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone(false, NULL); |
|||
break; |
|||
default: |
|||
break; |
|||
} |
|||
} |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
} |
|||
|
|||
void AsyncTCPbuffer::close() { |
|||
stop(); |
|||
} |
|||
|
|||
|
|||
///--------------------------------
|
|||
|
|||
/**
|
|||
* attachCallbacks to AsyncClient class |
|||
*/ |
|||
void AsyncTCPbuffer::_attachCallbacks() { |
|||
if(!_client) { |
|||
return; |
|||
} |
|||
DEBUG_ASYNC_TCP("[A-TCP] attachCallbacks\n"); |
|||
|
|||
_client->onPoll([](void *obj, AsyncClient* c) { |
|||
(void)c; |
|||
AsyncTCPbuffer* b = ((AsyncTCPbuffer*)(obj)); |
|||
if((b->_TXbufferRead != NULL) && !b->_TXbufferRead->empty()) { |
|||
b->_sendBuffer(); |
|||
} |
|||
// if(!b->_RXbuffer->empty()) {
|
|||
// b->_handleRxBuffer(NULL, 0);
|
|||
// }
|
|||
}, this); |
|||
|
|||
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time) { |
|||
(void)c; |
|||
(void)len; |
|||
(void)time; |
|||
DEBUG_ASYNC_TCP("[A-TCP] onAck\n"); |
|||
((AsyncTCPbuffer*)(obj))->_sendBuffer(); |
|||
}, this); |
|||
|
|||
_client->onDisconnect([](void *obj, AsyncClient* c) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] onDisconnect\n"); |
|||
AsyncTCPbuffer* b = ((AsyncTCPbuffer*)(obj)); |
|||
b->_client = NULL; |
|||
bool del = true; |
|||
if(b->_cbDisconnect) { |
|||
del = b->_cbDisconnect(b); |
|||
} |
|||
delete c; |
|||
if(del) { |
|||
delete b; |
|||
} |
|||
}, this); |
|||
|
|||
_client->onData([](void *obj, AsyncClient* c, void *buf, size_t len) { |
|||
(void)c; |
|||
AsyncTCPbuffer* b = ((AsyncTCPbuffer*)(obj)); |
|||
b->_rxData((uint8_t *)buf, len); |
|||
}, this); |
|||
|
|||
_client->onTimeout([](void *obj, AsyncClient* c, uint32_t time){ |
|||
(void)obj; |
|||
(void)time; |
|||
DEBUG_ASYNC_TCP("[A-TCP] onTimeout\n"); |
|||
c->close(); |
|||
}, this); |
|||
|
|||
DEBUG_ASYNC_TCP("[A-TCP] attachCallbacks Done.\n"); |
|||
} |
|||
|
|||
/**
|
|||
* send TX buffer if possible |
|||
*/ |
|||
void AsyncTCPbuffer::_sendBuffer() { |
|||
//DEBUG_ASYNC_TCP("[A-TCP] _sendBuffer...\n");
|
|||
size_t available = _TXbufferRead->available(); |
|||
if(available == 0 || _client == NULL || !_client->connected() || !_client->canSend()) { |
|||
return; |
|||
} |
|||
|
|||
while(connected() && (_client->space() > 0) && (_TXbufferRead->available() > 0) && _client->canSend()) { |
|||
|
|||
available = _TXbufferRead->available(); |
|||
|
|||
if(available > _client->space()) { |
|||
available = _client->space(); |
|||
} |
|||
|
|||
char *out = new (std::nothrow) char[available]; |
|||
if(out == NULL) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] to less heap, try later.\n"); |
|||
return; |
|||
} |
|||
|
|||
// read data from buffer
|
|||
_TXbufferRead->peek(out, available); |
|||
|
|||
// send data
|
|||
size_t send = _client->write((const char*) out, available); |
|||
if(send != available) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] write failed send: %d available: %d \n", send, available); |
|||
if(!connected()) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] incomplete transfer, connection lost.\n"); |
|||
} |
|||
} |
|||
|
|||
// remove really send data from buffer
|
|||
_TXbufferRead->remove(send); |
|||
|
|||
// if buffer is empty and there is a other buffer in chain delete the empty one
|
|||
if(_TXbufferRead->available() == 0 && _TXbufferRead->next != NULL) { |
|||
cbuf * old = _TXbufferRead; |
|||
_TXbufferRead = _TXbufferRead->next; |
|||
delete old; |
|||
DEBUG_ASYNC_TCP("[A-TCP] delete cbuf\n"); |
|||
} |
|||
|
|||
delete out; |
|||
} |
|||
|
|||
} |
|||
|
|||
/**
|
|||
* called on incoming data |
|||
* @param buf |
|||
* @param len |
|||
*/ |
|||
void AsyncTCPbuffer::_rxData(uint8_t *buf, size_t len) { |
|||
if(!_client || !_client->connected()) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] not connected!\n"); |
|||
return; |
|||
} |
|||
if(!_RXbuffer) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] _rxData no _RXbuffer!\n"); |
|||
return; |
|||
} |
|||
DEBUG_ASYNC_TCP("[A-TCP] _rxData len: %d RXmode: %d\n", len, _RXmode); |
|||
|
|||
size_t handled = 0; |
|||
|
|||
if(_RXmode != ATB_RX_MODE_NONE) { |
|||
handled = _handleRxBuffer((uint8_t *) buf, len); |
|||
buf += handled; |
|||
len -= handled; |
|||
|
|||
// handle as much as possible before using the buffer
|
|||
if(_RXbuffer->empty()) { |
|||
while(_RXmode != ATB_RX_MODE_NONE && handled != 0 && len > 0) { |
|||
handled = _handleRxBuffer(buf, len); |
|||
buf += handled; |
|||
len -= handled; |
|||
} |
|||
} |
|||
} |
|||
|
|||
if(len > 0) { |
|||
|
|||
if(_RXbuffer->room() < len) { |
|||
// to less space
|
|||
DEBUG_ASYNC_TCP("[A-TCP] _rxData buffer full try resize\n"); |
|||
_RXbuffer->resizeAdd((len + _RXbuffer->room())); |
|||
|
|||
if(_RXbuffer->room() < len) { |
|||
DEBUG_ASYNC_TCP("[A-TCP] _rxData buffer to full can only handle %d!!!\n", _RXbuffer->room()); |
|||
} |
|||
} |
|||
|
|||
_RXbuffer->write((const char *) (buf), len); |
|||
} |
|||
|
|||
if(!_RXbuffer->empty() && _RXmode != ATB_RX_MODE_NONE) { |
|||
// handle as much as possible data in buffer
|
|||
handled = _handleRxBuffer(NULL, 0); |
|||
while(_RXmode != ATB_RX_MODE_NONE && handled != 0) { |
|||
handled = _handleRxBuffer(NULL, 0); |
|||
} |
|||
} |
|||
|
|||
// clean up ram
|
|||
if(_RXbuffer->empty() && _RXbuffer->room() != 100) { |
|||
_RXbuffer->resize(100); |
|||
} |
|||
|
|||
} |
|||
|
|||
/**
|
|||
* |
|||
*/ |
|||
size_t AsyncTCPbuffer::_handleRxBuffer(uint8_t *buf, size_t len) { |
|||
if(!_client || !_client->connected() || _RXbuffer == NULL) { |
|||
return 0; |
|||
} |
|||
|
|||
DEBUG_ASYNC_TCP("[A-TCP] _handleRxBuffer len: %d RXmode: %d\n", len, _RXmode); |
|||
|
|||
size_t BufferAvailable = _RXbuffer->available(); |
|||
size_t r = 0; |
|||
|
|||
if(_RXmode == ATB_RX_MODE_NONE) { |
|||
return 0; |
|||
} else if(_RXmode == ATB_RX_MODE_FREE) { |
|||
if(_cbRX == NULL) { |
|||
return 0; |
|||
} |
|||
|
|||
if(BufferAvailable > 0) { |
|||
uint8_t * b = new (std::nothrow) uint8_t[BufferAvailable]; |
|||
if(b == NULL){ |
|||
panic(); //TODO: What action should this be ?
|
|||
} |
|||
_RXbuffer->peek((char *) b, BufferAvailable); |
|||
r = _cbRX(b, BufferAvailable); |
|||
_RXbuffer->remove(r); |
|||
} |
|||
|
|||
if(r == BufferAvailable && buf && (len > 0)) { |
|||
return _cbRX(buf, len); |
|||
} else { |
|||
return 0; |
|||
} |
|||
|
|||
} else if(_RXmode == ATB_RX_MODE_READ_BYTES) { |
|||
if(_rxReadBytesPtr == NULL || _cbDone == NULL) { |
|||
return 0; |
|||
} |
|||
|
|||
size_t newReadCount = 0; |
|||
|
|||
if(BufferAvailable) { |
|||
r = _RXbuffer->read((char *) _rxReadBytesPtr, _rxSize); |
|||
_rxSize -= r; |
|||
_rxReadBytesPtr += r; |
|||
} |
|||
|
|||
if(_RXbuffer->empty() && (len > 0) && buf) { |
|||
r = len; |
|||
if(r > _rxSize) { |
|||
r = _rxSize; |
|||
} |
|||
memcpy(_rxReadBytesPtr, buf, r); |
|||
_rxReadBytesPtr += r; |
|||
_rxSize -= r; |
|||
newReadCount += r; |
|||
} |
|||
|
|||
if(_rxSize == 0) { |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone(true, NULL); |
|||
} |
|||
|
|||
// add left over bytes to Buffer
|
|||
return newReadCount; |
|||
|
|||
} else if(_RXmode == ATB_RX_MODE_TERMINATOR) { |
|||
// TODO implement read terminator non string
|
|||
|
|||
} else if(_RXmode == ATB_RX_MODE_TERMINATOR_STRING) { |
|||
if(_rxReadStringPtr == NULL || _cbDone == NULL) { |
|||
return 0; |
|||
} |
|||
|
|||
// handle Buffer
|
|||
if(BufferAvailable > 0) { |
|||
while(!_RXbuffer->empty()) { |
|||
char c = _RXbuffer->read(); |
|||
if(c == _rxTerminator || c == 0x00) { |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone(true, _rxReadStringPtr); |
|||
return 0; |
|||
} else { |
|||
(*_rxReadStringPtr) += c; |
|||
} |
|||
} |
|||
} |
|||
|
|||
if(_RXbuffer->empty() && (len > 0) && buf) { |
|||
size_t newReadCount = 0; |
|||
while(newReadCount < len) { |
|||
char c = (char) *buf; |
|||
buf++; |
|||
newReadCount++; |
|||
if(c == _rxTerminator || c == 0x00) { |
|||
_RXmode = ATB_RX_MODE_NONE; |
|||
_cbDone(true, _rxReadStringPtr); |
|||
return newReadCount; |
|||
} else { |
|||
(*_rxReadStringPtr) += c; |
|||
} |
|||
} |
|||
return newReadCount; |
|||
} |
|||
} |
|||
|
|||
return 0; |
|||
} |
|||
@ -0,0 +1,118 @@ |
|||
/**
|
|||
* @file ESPAsyncTCPbuffer.h |
|||
* @date 22.01.2016 |
|||
* @author Markus Sattler |
|||
* |
|||
* Copyright (c) 2015 Markus Sattler. All rights reserved. |
|||
* This file is part of the Asynv TCP for ESP. |
|||
* |
|||
* 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. |
|||
* |
|||
* This library is distributed in the hope that it will be useful, |
|||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
* Lesser General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU Lesser General Public |
|||
* License along with this library; if not, write to the Free Software |
|||
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
* |
|||
*/ |
|||
|
|||
#ifndef ESPASYNCTCPBUFFER_H_ |
|||
#define ESPASYNCTCPBUFFER_H_ |
|||
|
|||
//#define DEBUG_ASYNC_TCP(...) while(((U0S >> USTXC) & 0x7F) != 0x00); os_printf( __VA_ARGS__ ); while(((U0S >> USTXC) & 0x7F) != 0x00)
|
|||
//#define DEBUG_ASYNC_TCP ASYNC_TCP_DEBUG
|
|||
#ifndef DEBUG_ASYNC_TCP |
|||
#define DEBUG_ASYNC_TCP(...) |
|||
#endif |
|||
|
|||
#include <Arduino.h> |
|||
#include <cbuf.h> |
|||
|
|||
#include "ESPAsyncTCP.h" |
|||
|
|||
|
|||
|
|||
typedef enum { |
|||
ATB_RX_MODE_NONE, |
|||
ATB_RX_MODE_FREE, |
|||
ATB_RX_MODE_READ_BYTES, |
|||
ATB_RX_MODE_TERMINATOR, |
|||
ATB_RX_MODE_TERMINATOR_STRING |
|||
} atbRxMode_t; |
|||
|
|||
class AsyncTCPbuffer: public Print { |
|||
|
|||
public: |
|||
|
|||
typedef std::function<size_t(uint8_t * payload, size_t length)> AsyncTCPbufferDataCb; |
|||
typedef std::function<void(bool ok, void * ret)> AsyncTCPbufferDoneCb; |
|||
typedef std::function<bool(AsyncTCPbuffer * obj)> AsyncTCPbufferDisconnectCb; |
|||
|
|||
AsyncTCPbuffer(AsyncClient* c); |
|||
virtual ~AsyncTCPbuffer(); |
|||
|
|||
size_t write(String & data); |
|||
size_t write(uint8_t data); |
|||
size_t write(const char* data); |
|||
size_t write(const char *data, size_t len); |
|||
size_t write(const uint8_t *data, size_t len); |
|||
|
|||
void flush(); |
|||
|
|||
void noCallback(); |
|||
|
|||
void readStringUntil(char terminator, String * str, AsyncTCPbufferDoneCb done); |
|||
|
|||
// TODO implement read terminator non string
|
|||
//void readBytesUntil(char terminator, char *buffer, size_t length, AsyncTCPbufferDoneCb done);
|
|||
//void readBytesUntil(char terminator, uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done);
|
|||
|
|||
void readBytes(char *buffer, size_t length, AsyncTCPbufferDoneCb done); |
|||
void readBytes(uint8_t *buffer, size_t length, AsyncTCPbufferDoneCb done); |
|||
|
|||
// TODO implement
|
|||
// void setTimeout(size_t timeout);
|
|||
|
|||
void onData(AsyncTCPbufferDataCb cb); |
|||
void onDisconnect(AsyncTCPbufferDisconnectCb cb); |
|||
|
|||
IPAddress remoteIP(); |
|||
uint16_t remotePort(); |
|||
IPAddress localIP(); |
|||
uint16_t localPort(); |
|||
|
|||
bool connected(); |
|||
|
|||
void stop(); |
|||
void close(); |
|||
|
|||
protected: |
|||
AsyncClient* _client; |
|||
cbuf * _TXbufferRead; |
|||
cbuf * _TXbufferWrite; |
|||
cbuf * _RXbuffer; |
|||
atbRxMode_t _RXmode; |
|||
size_t _rxSize; |
|||
char _rxTerminator; |
|||
uint8_t * _rxReadBytesPtr; |
|||
String * _rxReadStringPtr; |
|||
|
|||
AsyncTCPbufferDataCb _cbRX; |
|||
AsyncTCPbufferDoneCb _cbDone; |
|||
AsyncTCPbufferDisconnectCb _cbDisconnect; |
|||
|
|||
void _attachCallbacks(); |
|||
void _sendBuffer(); |
|||
void _on_close(); |
|||
void _rxData(uint8_t *buf, size_t len); |
|||
size_t _handleRxBuffer(uint8_t *buf, size_t len); |
|||
|
|||
}; |
|||
|
|||
#endif /* ESPASYNCTCPBUFFER_H_ */ |
|||
@ -0,0 +1,414 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#include "Arduino.h" |
|||
#include "SyncClient.h" |
|||
#include "ESPAsyncTCP.h" |
|||
#include "cbuf.h" |
|||
#include <interrupts.h> |
|||
|
|||
#define DEBUG_ESP_SYNC_CLIENT |
|||
#if defined(DEBUG_ESP_SYNC_CLIENT) && !defined(SYNC_CLIENT_DEBUG) |
|||
#define SYNC_CLIENT_DEBUG( format, ...) DEBUG_GENERIC_P("[SYNC_CLIENT]", format, ##__VA_ARGS__) |
|||
#endif |
|||
#ifndef SYNC_CLIENT_DEBUG |
|||
#define SYNC_CLIENT_DEBUG(...) do { (void)0;} while(false) |
|||
#endif |
|||
|
|||
/*
|
|||
Without LWIP_NETIF_TX_SINGLE_PBUF, all tcp_writes default to "no copy". |
|||
Referenced data must be preserved and free-ed from the specified tcp_sent() |
|||
callback. Alternative, tcp_writes need to use the TCP_WRITE_FLAG_COPY |
|||
attribute. |
|||
*/ |
|||
static_assert(LWIP_NETIF_TX_SINGLE_PBUF, "Required, tcp_write() must always copy."); |
|||
|
|||
SyncClient::SyncClient(size_t txBufLen) |
|||
: _client(NULL) |
|||
, _tx_buffer(NULL) |
|||
, _tx_buffer_size(txBufLen) |
|||
, _rx_buffer(NULL) |
|||
, _ref(NULL) |
|||
{ |
|||
ref(); |
|||
} |
|||
|
|||
SyncClient::SyncClient(AsyncClient *client, size_t txBufLen) |
|||
: _client(client) |
|||
, _tx_buffer(new (std::nothrow) cbuf(txBufLen)) |
|||
, _tx_buffer_size(txBufLen) |
|||
, _rx_buffer(NULL) |
|||
, _ref(NULL) |
|||
{ |
|||
if(ref() > 0 && _client != NULL) |
|||
_attachCallbacks(); |
|||
} |
|||
|
|||
SyncClient::~SyncClient(){ |
|||
if (0 == unref()) |
|||
_release(); |
|||
} |
|||
|
|||
void SyncClient::_release(){ |
|||
if(_client != NULL){ |
|||
_client->onData(NULL, NULL); |
|||
_client->onAck(NULL, NULL); |
|||
_client->onPoll(NULL, NULL); |
|||
_client->abort(); |
|||
_client = NULL; |
|||
} |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
while(_rx_buffer != NULL){ |
|||
cbuf *b = _rx_buffer; |
|||
_rx_buffer = _rx_buffer->next; |
|||
delete b; |
|||
} |
|||
} |
|||
|
|||
int SyncClient::ref(){ |
|||
if(_ref == NULL){ |
|||
_ref = new (std::nothrow) int; |
|||
if(_ref != NULL) |
|||
*_ref = 0; |
|||
else |
|||
return -1; |
|||
} |
|||
return (++*_ref); |
|||
} |
|||
|
|||
int SyncClient::unref(){ |
|||
int count = -1; |
|||
if (_ref != NULL) { |
|||
count = --*_ref; |
|||
if (0 == count) { |
|||
delete _ref; |
|||
_ref = NULL; |
|||
} |
|||
} |
|||
return count; |
|||
} |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
int SyncClient::_connect(const IPAddress& ip, uint16_t port, bool secure){ |
|||
#else |
|||
int SyncClient::_connect(const IPAddress& ip, uint16_t port){ |
|||
#endif |
|||
if(connected()) |
|||
return 0; |
|||
if(_client != NULL) |
|||
delete _client; |
|||
|
|||
_client = new (std::nothrow) AsyncClient(); |
|||
if (_client == NULL) |
|||
return 0; |
|||
|
|||
_client->onConnect([](void *obj, AsyncClient *c){ ((SyncClient*)(obj))->_onConnect(c); }, this); |
|||
_attachCallbacks_Disconnect(); |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
if(_client->connect(ip, port, secure)){ |
|||
#else |
|||
if(_client->connect(ip, port)){ |
|||
#endif |
|||
while(_client != NULL && !_client->connected() && !_client->disconnecting()) |
|||
delay(1); |
|||
return connected(); |
|||
} |
|||
return 0; |
|||
} |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
int SyncClient::connect(const char *host, uint16_t port, bool secure){ |
|||
#else |
|||
int SyncClient::connect(const char *host, uint16_t port){ |
|||
#endif |
|||
if(connected()) |
|||
return 0; |
|||
if(_client != NULL) |
|||
delete _client; |
|||
|
|||
_client = new (std::nothrow) AsyncClient(); |
|||
if (_client == NULL) |
|||
return 0; |
|||
|
|||
_client->onConnect([](void *obj, AsyncClient *c){ ((SyncClient*)(obj))->_onConnect(c); }, this); |
|||
_attachCallbacks_Disconnect(); |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
if(_client->connect(host, port, secure)){ |
|||
#else |
|||
if(_client->connect(host, port)){ |
|||
#endif |
|||
while(_client != NULL && !_client->connected() && !_client->disconnecting()) |
|||
delay(1); |
|||
return connected(); |
|||
} |
|||
return 0; |
|||
} |
|||
//#define SYNCCLIENT_NEW_OPERATOR_EQUAL
|
|||
#ifdef SYNCCLIENT_NEW_OPERATOR_EQUAL |
|||
/*
|
|||
New behavior for operator= |
|||
|
|||
Allow for the object to be placed on a queue and transfered to a new container |
|||
with buffers still in tact. Avoiding receive data drops. Transfers rx and tx |
|||
buffers. Supports return by value. |
|||
|
|||
Note, this is optional, the old behavior is the default. |
|||
|
|||
*/ |
|||
SyncClient & SyncClient::operator=(const SyncClient &other){ |
|||
int *rhsref = other._ref; |
|||
++*rhsref; // Just in case the left and right side are the same object with different containers
|
|||
if (0 == unref()) |
|||
_release(); |
|||
_ref = other._ref; |
|||
ref(); |
|||
--*rhsref; |
|||
// Why do I not test _tx_buffer for != NULL and free?
|
|||
// I allow for the lh target container, to be a copy of an active
|
|||
// connection. Thus we are just reusing the container.
|
|||
// The above unref() handles releaseing the previous client of the container.
|
|||
_tx_buffer_size = other._tx_buffer_size; |
|||
_tx_buffer = other._tx_buffer; |
|||
_client = other._client; |
|||
if (_client != NULL && _tx_buffer == NULL) |
|||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size); |
|||
|
|||
_rx_buffer = other._rx_buffer; |
|||
if(_client) |
|||
_attachCallbacks(); |
|||
return *this; |
|||
} |
|||
#else // ! SYNCCLIENT_NEW_OPERATOR_EQUAL
|
|||
// This is the origianl logic with null checks
|
|||
SyncClient & SyncClient::operator=(const SyncClient &other){ |
|||
if(_client != NULL){ |
|||
_client->abort(); |
|||
_client->free(); |
|||
_client = NULL; |
|||
} |
|||
_tx_buffer_size = other._tx_buffer_size; |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
while(_rx_buffer != NULL){ |
|||
cbuf *b = _rx_buffer; |
|||
_rx_buffer = b->next; |
|||
delete b; |
|||
} |
|||
if(other._client != NULL) |
|||
_tx_buffer = new (std::nothrow) cbuf(other._tx_buffer_size); |
|||
|
|||
_client = other._client; |
|||
if(_client) |
|||
_attachCallbacks(); |
|||
|
|||
return *this; |
|||
} |
|||
#endif |
|||
|
|||
void SyncClient::setTimeout(uint32_t seconds){ |
|||
if(_client != NULL) |
|||
_client->setRxTimeout(seconds); |
|||
} |
|||
|
|||
uint8_t SyncClient::status(){ |
|||
if(_client == NULL) |
|||
return 0; |
|||
return _client->state(); |
|||
} |
|||
|
|||
uint8_t SyncClient::connected(){ |
|||
return (_client != NULL && _client->connected()); |
|||
} |
|||
|
|||
bool SyncClient::stop(unsigned int maxWaitMs){ |
|||
(void)maxWaitMs; |
|||
if(_client != NULL) |
|||
_client->close(true); |
|||
return true; |
|||
} |
|||
|
|||
size_t SyncClient::_sendBuffer(){ |
|||
if(_client == NULL || _tx_buffer == NULL) |
|||
return 0; |
|||
size_t available = _tx_buffer->available(); |
|||
if(!connected() || !_client->canSend() || available == 0) |
|||
return 0; |
|||
size_t sendable = _client->space(); |
|||
if(sendable < available) |
|||
available= sendable; |
|||
char *out = new (std::nothrow) char[available]; |
|||
if(out == NULL) |
|||
return 0; |
|||
|
|||
_tx_buffer->read(out, available); |
|||
size_t sent = _client->write(out, available); |
|||
delete[] out; |
|||
return sent; |
|||
} |
|||
|
|||
void SyncClient::_onData(void *data, size_t len){ |
|||
_client->ackLater(); |
|||
cbuf *b = new (std::nothrow) cbuf(len+1); |
|||
if(b != NULL){ |
|||
b->write((const char *)data, len); |
|||
if(_rx_buffer == NULL) |
|||
_rx_buffer = b; |
|||
else { |
|||
cbuf *p = _rx_buffer; |
|||
while(p->next != NULL) |
|||
p = p->next; |
|||
p->next = b; |
|||
} |
|||
} else { |
|||
// We ran out of memory. This fail causes lost receive data.
|
|||
// The connection should be closed in a manner that conveys something
|
|||
// bad/abnormal has happened to the connection. Hence, we abort the
|
|||
// connection to avoid possible data corruption.
|
|||
// Note, callbacks maybe called.
|
|||
_client->abort(); |
|||
} |
|||
} |
|||
|
|||
void SyncClient::_onDisconnect(){ |
|||
if(_client != NULL){ |
|||
_client = NULL; |
|||
} |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
} |
|||
|
|||
void SyncClient::_onConnect(AsyncClient *c){ |
|||
_client = c; |
|||
if(_tx_buffer != NULL){ |
|||
cbuf *b = _tx_buffer; |
|||
_tx_buffer = NULL; |
|||
delete b; |
|||
} |
|||
_tx_buffer = new (std::nothrow) cbuf(_tx_buffer_size); |
|||
_attachCallbacks_AfterConnected(); |
|||
} |
|||
|
|||
void SyncClient::_attachCallbacks(){ |
|||
_attachCallbacks_Disconnect(); |
|||
_attachCallbacks_AfterConnected(); |
|||
} |
|||
|
|||
void SyncClient::_attachCallbacks_AfterConnected(){ |
|||
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time){ (void)c; (void)len; (void)time; ((SyncClient*)(obj))->_sendBuffer(); }, this); |
|||
_client->onData([](void *obj, AsyncClient* c, void *data, size_t len){ (void)c; ((SyncClient*)(obj))->_onData(data, len); }, this); |
|||
_client->onTimeout([](void *obj, AsyncClient* c, uint32_t time){ (void)obj; (void)time; c->close(); }, this); |
|||
} |
|||
|
|||
void SyncClient::_attachCallbacks_Disconnect(){ |
|||
_client->onDisconnect([](void *obj, AsyncClient* c){ ((SyncClient*)(obj))->_onDisconnect(); delete c; }, this); |
|||
} |
|||
|
|||
size_t SyncClient::write(uint8_t data){ |
|||
return write(&data, 1); |
|||
} |
|||
|
|||
size_t SyncClient::write(const uint8_t *data, size_t len){ |
|||
if(_tx_buffer == NULL || !connected()){ |
|||
return 0; |
|||
} |
|||
size_t toWrite = 0; |
|||
size_t toSend = len; |
|||
while(_tx_buffer->room() < toSend){ |
|||
toWrite = _tx_buffer->room(); |
|||
_tx_buffer->write((const char*)data, toWrite); |
|||
while(connected() && !_client->canSend()) |
|||
delay(0); |
|||
if(!connected()) |
|||
return 0; |
|||
_sendBuffer(); |
|||
toSend -= toWrite; |
|||
} |
|||
_tx_buffer->write((const char*)(data+(len - toSend)), toSend); |
|||
if(connected() && _client->canSend()) |
|||
_sendBuffer(); |
|||
return len; |
|||
} |
|||
|
|||
int SyncClient::available(){ |
|||
if(_rx_buffer == NULL) return 0; |
|||
size_t a = 0; |
|||
cbuf *b = _rx_buffer; |
|||
while(b != NULL){ |
|||
a += b->available(); |
|||
b = b->next; |
|||
} |
|||
return a; |
|||
} |
|||
|
|||
int SyncClient::peek(){ |
|||
if(_rx_buffer == NULL) return -1; |
|||
return _rx_buffer->peek(); |
|||
} |
|||
|
|||
int SyncClient::read(uint8_t *data, size_t len){ |
|||
if(_rx_buffer == NULL) return -1; |
|||
|
|||
size_t readSoFar = 0; |
|||
while(_rx_buffer != NULL && (len - readSoFar) >= _rx_buffer->available()){ |
|||
cbuf *b = _rx_buffer; |
|||
_rx_buffer = _rx_buffer->next; |
|||
size_t toRead = b->available(); |
|||
readSoFar += b->read((char*)(data+readSoFar), toRead); |
|||
if(connected()){ |
|||
_client->ack(b->size() - 1); |
|||
} |
|||
delete b; |
|||
} |
|||
if(_rx_buffer != NULL && readSoFar < len){ |
|||
readSoFar += _rx_buffer->read((char*)(data+readSoFar), (len - readSoFar)); |
|||
} |
|||
return readSoFar; |
|||
} |
|||
|
|||
int SyncClient::read(){ |
|||
uint8_t res = 0; |
|||
if(read(&res, 1) != 1) |
|||
return -1; |
|||
return res; |
|||
} |
|||
|
|||
bool SyncClient::flush(unsigned int maxWaitMs){ |
|||
(void)maxWaitMs; |
|||
if(_tx_buffer == NULL || !connected()) |
|||
return false; |
|||
if(_tx_buffer->available()){ |
|||
while(connected() && !_client->canSend()) |
|||
delay(0); |
|||
if(_client == NULL || _tx_buffer == NULL) |
|||
return false; |
|||
_sendBuffer(); |
|||
} |
|||
return true; |
|||
} |
|||
@ -0,0 +1,109 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
|
|||
#ifndef SYNCCLIENT_H_ |
|||
#define SYNCCLIENT_H_ |
|||
|
|||
#include "Client.h" |
|||
// Needed for Arduino core releases prior to 2.5.0, because of changes
|
|||
// made to accommodate Arduino core 2.5.0
|
|||
// CONST was 1st defined in Core 2.5.0 in IPAddress.h
|
|||
#ifndef CONST |
|||
#define CONST |
|||
#endif |
|||
#include <async_config.h> |
|||
class cbuf; |
|||
class AsyncClient; |
|||
|
|||
class SyncClient: public Client { |
|||
private: |
|||
AsyncClient *_client; |
|||
cbuf *_tx_buffer; |
|||
size_t _tx_buffer_size; |
|||
cbuf *_rx_buffer; |
|||
int *_ref; |
|||
|
|||
size_t _sendBuffer(); |
|||
void _onData(void *data, size_t len); |
|||
void _onConnect(AsyncClient *c); |
|||
void _onDisconnect(); |
|||
void _attachCallbacks(); |
|||
void _attachCallbacks_Disconnect(); |
|||
void _attachCallbacks_AfterConnected(); |
|||
void _release(); |
|||
|
|||
public: |
|||
SyncClient(size_t txBufLen = TCP_MSS); |
|||
SyncClient(AsyncClient *client, size_t txBufLen = TCP_MSS); |
|||
virtual ~SyncClient(); |
|||
|
|||
int ref(); |
|||
int unref(); |
|||
operator bool(){ return connected(); } |
|||
SyncClient & operator=(const SyncClient &other); |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
int _connect(const IPAddress& ip, uint16_t port, bool secure); |
|||
int connect(CONST IPAddress& ip, uint16_t port, bool secure){ |
|||
return _connect(ip, port, secure); |
|||
} |
|||
int connect(IPAddress ip, uint16_t port, bool secure){ |
|||
return _connect(reinterpret_cast<const IPAddress&>(ip), port, secure); |
|||
} |
|||
int connect(const char *host, uint16_t port, bool secure); |
|||
int connect(CONST IPAddress& ip, uint16_t port){ |
|||
return _connect(ip, port, false); |
|||
} |
|||
int connect(IPAddress ip, uint16_t port){ |
|||
return _connect(reinterpret_cast<const IPAddress&>(ip), port, false); |
|||
} |
|||
int connect(const char *host, uint16_t port){ |
|||
return connect(host, port, false); |
|||
} |
|||
#else |
|||
int _connect(const IPAddress& ip, uint16_t port); |
|||
int connect(CONST IPAddress& ip, uint16_t port){ |
|||
return _connect(ip, port); |
|||
} |
|||
int connect(IPAddress ip, uint16_t port){ |
|||
return _connect(reinterpret_cast<const IPAddress&>(ip), port); |
|||
} |
|||
int connect(const char *host, uint16_t port); |
|||
#endif |
|||
void setTimeout(uint32_t seconds); |
|||
|
|||
uint8_t status(); |
|||
uint8_t connected(); |
|||
|
|||
bool stop(unsigned int maxWaitMs); |
|||
bool flush(unsigned int maxWaitMs); |
|||
void stop() { (void)stop(0);} |
|||
void flush() { (void)flush(0);} |
|||
size_t write(uint8_t data); |
|||
size_t write(const uint8_t *data, size_t len); |
|||
|
|||
int available(); |
|||
int peek(); |
|||
int read(); |
|||
int read(uint8_t *data, size_t len); |
|||
}; |
|||
|
|||
#endif /* SYNCCLIENT_H_ */ |
|||
@ -0,0 +1,38 @@ |
|||
#ifndef LIBRARIES_ESPASYNCTCP_SRC_ASYNC_CONFIG_H_ |
|||
#define LIBRARIES_ESPASYNCTCP_SRC_ASYNC_CONFIG_H_ |
|||
|
|||
#ifndef ASYNC_TCP_SSL_ENABLED |
|||
#define ASYNC_TCP_SSL_ENABLED 0 |
|||
#endif |
|||
|
|||
#ifndef TCP_MSS |
|||
// May have been definded as a -DTCP_MSS option on the compile line or not.
|
|||
// Arduino core 2.3.0 or earlier does not do the -DTCP_MSS option.
|
|||
// Later versions may set this option with info from board.txt.
|
|||
// However, Core 2.4.0 and up board.txt does not define TCP_MSS for lwIP v1.4
|
|||
#define TCP_MSS (1460) |
|||
#endif |
|||
|
|||
// #define ASYNC_TCP_DEBUG(...) ets_printf(__VA_ARGS__)
|
|||
// #define TCP_SSL_DEBUG(...) ets_printf(__VA_ARGS__)
|
|||
// #define ASYNC_TCP_ASSERT( a ) do{ if(!(a)){ets_printf("ASSERT: %s %u \n", __FILE__, __LINE__);}}while(0)
|
|||
|
|||
// Starting with Arduino Core 2.4.0 and up the define of DEBUG_ESP_PORT
|
|||
// can be handled through the Arduino IDE Board options instead of here.
|
|||
// #define DEBUG_ESP_PORT Serial
|
|||
|
|||
// #define DEBUG_ESP_ASYNC_TCP 1
|
|||
// #define DEBUG_ESP_TCP_SSL 1
|
|||
#include <DebugPrintMacros.h> |
|||
|
|||
#ifndef ASYNC_TCP_ASSERT |
|||
#define ASYNC_TCP_ASSERT(...) do { (void)0;} while(false) |
|||
#endif |
|||
#ifndef ASYNC_TCP_DEBUG |
|||
#define ASYNC_TCP_DEBUG(...) do { (void)0;} while(false) |
|||
#endif |
|||
#ifndef TCP_SSL_DEBUG |
|||
#define TCP_SSL_DEBUG(...) do { (void)0;} while(false) |
|||
#endif |
|||
|
|||
#endif /* LIBRARIES_ESPASYNCTCP_SRC_ASYNC_CONFIG_H_ */ |
|||
@ -0,0 +1,588 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
/*
|
|||
* Compatibility for AxTLS with LWIP raw tcp mode (http://lwip.wikia.com/wiki/Raw/TCP)
|
|||
* Original Code and Inspiration: Slavey Karadzhov |
|||
*/ |
|||
#include <async_config.h> |
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
|
|||
#include "lwip/opt.h" |
|||
#include "lwip/tcp.h" |
|||
#include "lwip/inet.h" |
|||
#include <stdlib.h> |
|||
#include <stdint.h> |
|||
#include <stdarg.h> |
|||
#include <stdbool.h> |
|||
#include <tcp_axtls.h> |
|||
|
|||
uint8_t * default_private_key = NULL; |
|||
uint16_t default_private_key_len = 0; |
|||
|
|||
uint8_t * default_certificate = NULL; |
|||
uint16_t default_certificate_len = 0; |
|||
|
|||
static uint8_t _tcp_ssl_has_client = 0; |
|||
|
|||
SSL_CTX * tcp_ssl_new_server_ctx(const char *cert, const char *private_key_file, const char *password){ |
|||
uint32_t options = SSL_CONNECT_IN_PARTS; |
|||
SSL_CTX *ssl_ctx; |
|||
|
|||
if(private_key_file){ |
|||
options |= SSL_NO_DEFAULT_KEY; |
|||
} |
|||
|
|||
if ((ssl_ctx = ssl_ctx_new(options, SSL_DEFAULT_SVR_SESS)) == NULL){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_server_ctx: failed to allocate context\n"); |
|||
return NULL; |
|||
} |
|||
|
|||
if (private_key_file){ |
|||
int obj_type = SSL_OBJ_RSA_KEY; |
|||
if (strstr(private_key_file, ".p8")) |
|||
obj_type = SSL_OBJ_PKCS8; |
|||
else if (strstr(private_key_file, ".p12")) |
|||
obj_type = SSL_OBJ_PKCS12; |
|||
|
|||
if (ssl_obj_load(ssl_ctx, obj_type, private_key_file, password)){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_server_ctx: load private key '%s' failed\n", private_key_file); |
|||
return NULL; |
|||
} |
|||
} |
|||
|
|||
if (cert){ |
|||
if (ssl_obj_load(ssl_ctx, SSL_OBJ_X509_CERT, cert, NULL)){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_server_ctx: load certificate '%s' failed\n", cert); |
|||
return NULL; |
|||
} |
|||
} |
|||
return ssl_ctx; |
|||
} |
|||
|
|||
struct tcp_ssl_pcb { |
|||
struct tcp_pcb *tcp; |
|||
int fd; |
|||
SSL_CTX* ssl_ctx; |
|||
SSL *ssl; |
|||
uint8_t type; |
|||
int handshake; |
|||
void * arg; |
|||
tcp_ssl_data_cb_t on_data; |
|||
tcp_ssl_handshake_cb_t on_handshake; |
|||
tcp_ssl_error_cb_t on_error; |
|||
int last_wr; |
|||
struct pbuf *tcp_pbuf; |
|||
int pbuf_offset; |
|||
struct tcp_ssl_pcb * next; |
|||
}; |
|||
|
|||
typedef struct tcp_ssl_pcb tcp_ssl_t; |
|||
|
|||
static tcp_ssl_t * tcp_ssl_array = NULL; |
|||
static int tcp_ssl_next_fd = 0; |
|||
|
|||
uint8_t tcp_ssl_has_client(){ |
|||
return _tcp_ssl_has_client; |
|||
} |
|||
|
|||
tcp_ssl_t * tcp_ssl_new(struct tcp_pcb *tcp) { |
|||
|
|||
if(tcp_ssl_next_fd < 0){ |
|||
tcp_ssl_next_fd = 0;//overflow
|
|||
} |
|||
|
|||
tcp_ssl_t * new_item = (tcp_ssl_t*)malloc(sizeof(tcp_ssl_t)); |
|||
if(!new_item){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new: failed to allocate tcp_ssl\n"); |
|||
return NULL; |
|||
} |
|||
|
|||
new_item->tcp = tcp; |
|||
new_item->handshake = SSL_NOT_OK; |
|||
new_item->arg = NULL; |
|||
new_item->on_data = NULL; |
|||
new_item->on_handshake = NULL; |
|||
new_item->on_error = NULL; |
|||
new_item->tcp_pbuf = NULL; |
|||
new_item->pbuf_offset = 0; |
|||
new_item->next = NULL; |
|||
new_item->ssl_ctx = NULL; |
|||
new_item->ssl = NULL; |
|||
new_item->type = TCP_SSL_TYPE_CLIENT; |
|||
new_item->fd = tcp_ssl_next_fd++; |
|||
|
|||
if(tcp_ssl_array == NULL){ |
|||
tcp_ssl_array = new_item; |
|||
} else { |
|||
tcp_ssl_t * item = tcp_ssl_array; |
|||
while(item->next != NULL) |
|||
item = item->next; |
|||
item->next = new_item; |
|||
} |
|||
|
|||
TCP_SSL_DEBUG("tcp_ssl_new: %d\n", new_item->fd); |
|||
return new_item; |
|||
} |
|||
|
|||
tcp_ssl_t* tcp_ssl_get(struct tcp_pcb *tcp) { |
|||
if(tcp == NULL) { |
|||
return NULL; |
|||
} |
|||
tcp_ssl_t * item = tcp_ssl_array; |
|||
while(item && item->tcp != tcp){ |
|||
item = item->next; |
|||
} |
|||
return item; |
|||
} |
|||
|
|||
int tcp_ssl_new_client(struct tcp_pcb *tcp){ |
|||
SSL_CTX* ssl_ctx; |
|||
tcp_ssl_t * tcp_ssl; |
|||
|
|||
if(tcp == NULL) { |
|||
return -1; |
|||
} |
|||
|
|||
if(tcp_ssl_get(tcp) != NULL){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_client: tcp_ssl already exists\n"); |
|||
return -1; |
|||
} |
|||
|
|||
ssl_ctx = ssl_ctx_new(SSL_CONNECT_IN_PARTS | SSL_SERVER_VERIFY_LATER, 1); |
|||
if(ssl_ctx == NULL){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_client: failed to allocate ssl context\n"); |
|||
return -1; |
|||
} |
|||
|
|||
tcp_ssl = tcp_ssl_new(tcp); |
|||
if(tcp_ssl == NULL){ |
|||
ssl_ctx_free(ssl_ctx); |
|||
return -1; |
|||
} |
|||
|
|||
tcp_ssl->ssl_ctx = ssl_ctx; |
|||
|
|||
tcp_ssl->ssl = ssl_client_new(ssl_ctx, tcp_ssl->fd, NULL, 0, NULL); |
|||
if(tcp_ssl->ssl == NULL){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_client: failed to allocate ssl\n"); |
|||
tcp_ssl_free(tcp); |
|||
return -1; |
|||
} |
|||
|
|||
return tcp_ssl->fd; |
|||
} |
|||
|
|||
int tcp_ssl_new_server(struct tcp_pcb *tcp, SSL_CTX* ssl_ctx){ |
|||
tcp_ssl_t * tcp_ssl; |
|||
|
|||
if(tcp == NULL) { |
|||
return -1; |
|||
} |
|||
|
|||
if(ssl_ctx == NULL){ |
|||
return -1; |
|||
} |
|||
|
|||
if(tcp_ssl_get(tcp) != NULL){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_server: tcp_ssl already exists\n"); |
|||
return -1; |
|||
} |
|||
|
|||
tcp_ssl = tcp_ssl_new(tcp); |
|||
if(tcp_ssl == NULL){ |
|||
return -1; |
|||
} |
|||
|
|||
tcp_ssl->type = TCP_SSL_TYPE_SERVER; |
|||
tcp_ssl->ssl_ctx = ssl_ctx; |
|||
|
|||
_tcp_ssl_has_client = 1; |
|||
tcp_ssl->ssl = ssl_server_new(ssl_ctx, tcp_ssl->fd); |
|||
if(tcp_ssl->ssl == NULL){ |
|||
TCP_SSL_DEBUG("tcp_ssl_new_server: failed to allocate ssl\n"); |
|||
tcp_ssl_free(tcp); |
|||
return -1; |
|||
} |
|||
|
|||
return tcp_ssl->fd; |
|||
} |
|||
|
|||
int tcp_ssl_free(struct tcp_pcb *tcp) { |
|||
|
|||
if(tcp == NULL) { |
|||
return -1; |
|||
} |
|||
|
|||
tcp_ssl_t * item = tcp_ssl_array; |
|||
|
|||
if(item->tcp == tcp){ |
|||
tcp_ssl_array = tcp_ssl_array->next; |
|||
if(item->tcp_pbuf != NULL){ |
|||
pbuf_free(item->tcp_pbuf); |
|||
} |
|||
TCP_SSL_DEBUG("tcp_ssl_free: %d\n", item->fd); |
|||
if(item->ssl) |
|||
ssl_free(item->ssl); |
|||
if(item->type == TCP_SSL_TYPE_CLIENT && item->ssl_ctx) |
|||
ssl_ctx_free(item->ssl_ctx); |
|||
if(item->type == TCP_SSL_TYPE_SERVER) |
|||
_tcp_ssl_has_client = 0; |
|||
free(item); |
|||
return 0; |
|||
} |
|||
|
|||
while(item->next && item->next->tcp != tcp) |
|||
item = item->next; |
|||
|
|||
if(item->next == NULL){ |
|||
return ERR_TCP_SSL_INVALID_CLIENTFD_DATA;//item not found
|
|||
} |
|||
|
|||
tcp_ssl_t * i = item->next; |
|||
item->next = i->next; |
|||
if(i->tcp_pbuf != NULL){ |
|||
pbuf_free(i->tcp_pbuf); |
|||
} |
|||
TCP_SSL_DEBUG("tcp_ssl_free: %d\n", i->fd); |
|||
if(i->ssl) |
|||
ssl_free(i->ssl); |
|||
if(i->type == TCP_SSL_TYPE_CLIENT && i->ssl_ctx) |
|||
ssl_ctx_free(i->ssl_ctx); |
|||
if(i->type == TCP_SSL_TYPE_SERVER) |
|||
_tcp_ssl_has_client = 0; |
|||
free(i); |
|||
return 0; |
|||
} |
|||
|
|||
#ifdef AXTLS_2_0_0_SNDBUF |
|||
int tcp_ssl_sndbuf(struct tcp_pcb *tcp){ |
|||
int expected; |
|||
int available; |
|||
int result = -1; |
|||
|
|||
if(tcp == NULL) { |
|||
return result; |
|||
} |
|||
tcp_ssl_t * tcp_ssl = tcp_ssl_get(tcp); |
|||
if(!tcp_ssl){ |
|||
TCP_SSL_DEBUG("tcp_ssl_sndbuf: tcp_ssl is NULL\n"); |
|||
return result; |
|||
} |
|||
available = tcp_sndbuf(tcp); |
|||
if(!available){ |
|||
TCP_SSL_DEBUG("tcp_ssl_sndbuf: tcp_sndbuf is zero\n"); |
|||
return 0; |
|||
} |
|||
result = available; |
|||
while((expected = ssl_calculate_write_length(tcp_ssl->ssl, result)) > available){ |
|||
result -= (expected - available) + 4; |
|||
} |
|||
|
|||
if(expected > 0){ |
|||
//TCP_SSL_DEBUG("tcp_ssl_sndbuf: tcp_sndbuf is %d from %d\n", result, available);
|
|||
return result; |
|||
} |
|||
|
|||
return 0; |
|||
} |
|||
#endif |
|||
|
|||
int tcp_ssl_write(struct tcp_pcb *tcp, uint8_t *data, size_t len) { |
|||
if(tcp == NULL) { |
|||
return -1; |
|||
} |
|||
tcp_ssl_t * tcp_ssl = tcp_ssl_get(tcp); |
|||
if(!tcp_ssl){ |
|||
TCP_SSL_DEBUG("tcp_ssl_write: tcp_ssl is NULL\n"); |
|||
return 0; |
|||
} |
|||
tcp_ssl->last_wr = 0; |
|||
|
|||
#ifdef AXTLS_2_0_0_SNDBUF |
|||
int expected_len = ssl_calculate_write_length(tcp_ssl->ssl, len); |
|||
int available_len = tcp_sndbuf(tcp); |
|||
if(expected_len < 0 || expected_len > available_len){ |
|||
TCP_SSL_DEBUG("tcp_ssl_write: data will not fit! %u < %d(%u)\r\n", available_len, expected_len, len); |
|||
return -1; |
|||
} |
|||
#endif |
|||
|
|||
int rc = ssl_write(tcp_ssl->ssl, data, len); |
|||
|
|||
//TCP_SSL_DEBUG("tcp_ssl_write: %u -> %d (%d)\r\n", len, tcp_ssl->last_wr, rc);
|
|||
|
|||
if (rc < 0){ |
|||
if(rc != SSL_CLOSE_NOTIFY) { |
|||
TCP_SSL_DEBUG("tcp_ssl_write error: %d\r\n", rc); |
|||
} |
|||
return rc; |
|||
} |
|||
|
|||
return tcp_ssl->last_wr; |
|||
} |
|||
|
|||
/**
|
|||
* Reads data from the SSL over TCP stream. Returns decrypted data. |
|||
* @param tcp_pcb *tcp - pointer to the raw tcp object |
|||
* @param pbuf *p - pointer to the buffer with the TCP packet data |
|||
* |
|||
* @return int |
|||
* 0 - when everything is fine but there are no symbols to process yet |
|||
* < 0 - when there is an error |
|||
* > 0 - the length of the clear text characters that were read |
|||
*/ |
|||
int tcp_ssl_read(struct tcp_pcb *tcp, struct pbuf *p) { |
|||
if(tcp == NULL) { |
|||
return -1; |
|||
} |
|||
tcp_ssl_t* fd_data = NULL; |
|||
|
|||
int read_bytes = 0; |
|||
int total_bytes = 0; |
|||
uint8_t *read_buf; |
|||
|
|||
fd_data = tcp_ssl_get(tcp); |
|||
if(fd_data == NULL) { |
|||
TCP_SSL_DEBUG("tcp_ssl_read: tcp_ssl is NULL\n"); |
|||
return ERR_TCP_SSL_INVALID_CLIENTFD_DATA; |
|||
} |
|||
|
|||
if(p == NULL) { |
|||
TCP_SSL_DEBUG("tcp_ssl_read:p == NULL\n"); |
|||
return ERR_TCP_SSL_INVALID_DATA; |
|||
} |
|||
|
|||
//TCP_SSL_DEBUG("READY TO READ SOME DATA\n");
|
|||
|
|||
fd_data->tcp_pbuf = p; |
|||
fd_data->pbuf_offset = 0; |
|||
|
|||
do { |
|||
read_bytes = ssl_read(fd_data->ssl, &read_buf); |
|||
//TCP_SSL_DEBUG("tcp_ssl_ssl_read: %d\n", read_bytes);
|
|||
if(read_bytes < SSL_OK) { |
|||
if(read_bytes != SSL_CLOSE_NOTIFY) { |
|||
TCP_SSL_DEBUG("tcp_ssl_read: read error: %d\n", read_bytes); |
|||
} |
|||
total_bytes = read_bytes; |
|||
break; |
|||
} else if(read_bytes > 0){ |
|||
if(fd_data->on_data){ |
|||
fd_data->on_data(fd_data->arg, tcp, read_buf, read_bytes); |
|||
} |
|||
total_bytes+= read_bytes; |
|||
} else { |
|||
if(fd_data->handshake != SSL_OK) { |
|||
fd_data->handshake = ssl_handshake_status(fd_data->ssl); |
|||
if(fd_data->handshake == SSL_OK){ |
|||
//TCP_SSL_DEBUG("tcp_ssl_read: handshake OK\n");
|
|||
if(fd_data->on_handshake) |
|||
fd_data->on_handshake(fd_data->arg, fd_data->tcp, fd_data->ssl); |
|||
} else if(fd_data->handshake != SSL_NOT_OK){ |
|||
TCP_SSL_DEBUG("tcp_ssl_read: handshake error: %d\n", fd_data->handshake); |
|||
if(fd_data->on_error) |
|||
fd_data->on_error(fd_data->arg, fd_data->tcp, fd_data->handshake); |
|||
return fd_data->handshake; |
|||
} |
|||
} |
|||
} |
|||
} while (p->tot_len - fd_data->pbuf_offset > 0); |
|||
|
|||
tcp_recved(tcp, p->tot_len); |
|||
fd_data->tcp_pbuf = NULL; |
|||
pbuf_free(p); |
|||
|
|||
return total_bytes; |
|||
} |
|||
|
|||
SSL * tcp_ssl_get_ssl(struct tcp_pcb *tcp){ |
|||
tcp_ssl_t * tcp_ssl = tcp_ssl_get(tcp); |
|||
if(tcp_ssl){ |
|||
return tcp_ssl->ssl; |
|||
} |
|||
return NULL; |
|||
} |
|||
|
|||
bool tcp_ssl_has(struct tcp_pcb *tcp){ |
|||
return tcp_ssl_get(tcp) != NULL; |
|||
} |
|||
|
|||
int tcp_ssl_is_server(struct tcp_pcb *tcp){ |
|||
tcp_ssl_t * tcp_ssl = tcp_ssl_get(tcp); |
|||
if(tcp_ssl){ |
|||
return tcp_ssl->type; |
|||
} |
|||
return -1; |
|||
} |
|||
|
|||
void tcp_ssl_arg(struct tcp_pcb *tcp, void * arg){ |
|||
tcp_ssl_t * item = tcp_ssl_get(tcp); |
|||
if(item) { |
|||
item->arg = arg; |
|||
} |
|||
} |
|||
|
|||
void tcp_ssl_data(struct tcp_pcb *tcp, tcp_ssl_data_cb_t arg){ |
|||
tcp_ssl_t * item = tcp_ssl_get(tcp); |
|||
if(item) { |
|||
item->on_data = arg; |
|||
} |
|||
} |
|||
|
|||
void tcp_ssl_handshake(struct tcp_pcb *tcp, tcp_ssl_handshake_cb_t arg){ |
|||
tcp_ssl_t * item = tcp_ssl_get(tcp); |
|||
if(item) { |
|||
item->on_handshake = arg; |
|||
} |
|||
} |
|||
|
|||
void tcp_ssl_err(struct tcp_pcb *tcp, tcp_ssl_error_cb_t arg){ |
|||
tcp_ssl_t * item = tcp_ssl_get(tcp); |
|||
if(item) { |
|||
item->on_error = arg; |
|||
} |
|||
} |
|||
|
|||
static tcp_ssl_file_cb_t _tcp_ssl_file_cb = NULL; |
|||
static void * _tcp_ssl_file_arg = NULL; |
|||
|
|||
void tcp_ssl_file(tcp_ssl_file_cb_t cb, void * arg){ |
|||
_tcp_ssl_file_cb = cb; |
|||
_tcp_ssl_file_arg = arg; |
|||
} |
|||
|
|||
int ax_get_file(const char *filename, uint8_t **buf) { |
|||
//TCP_SSL_DEBUG("ax_get_file: %s\n", filename);
|
|||
if(_tcp_ssl_file_cb){ |
|||
return _tcp_ssl_file_cb(_tcp_ssl_file_arg, filename, buf); |
|||
} |
|||
*buf = 0; |
|||
return 0; |
|||
} |
|||
|
|||
tcp_ssl_t* tcp_ssl_get_by_fd(int fd) { |
|||
tcp_ssl_t * item = tcp_ssl_array; |
|||
while(item && item->fd != fd){ |
|||
item = item->next; |
|||
} |
|||
return item; |
|||
} |
|||
/*
|
|||
* The LWIP tcp raw version of the SOCKET_WRITE(A, B, C) |
|||
*/ |
|||
int ax_port_write(int fd, uint8_t *data, uint16_t len) { |
|||
tcp_ssl_t *fd_data = NULL; |
|||
int tcp_len = 0; |
|||
err_t err = ERR_OK; |
|||
|
|||
//TCP_SSL_DEBUG("ax_port_write: %d, %d\n", fd, len);
|
|||
|
|||
fd_data = tcp_ssl_get_by_fd(fd); |
|||
if(fd_data == NULL) { |
|||
//TCP_SSL_DEBUG("ax_port_write: tcp_ssl[%d] is NULL\n", fd);
|
|||
return ERR_MEM; |
|||
} |
|||
|
|||
if (data == NULL || len == 0) { |
|||
return 0; |
|||
} |
|||
|
|||
if (tcp_sndbuf(fd_data->tcp) < len) { |
|||
tcp_len = tcp_sndbuf(fd_data->tcp); |
|||
if(tcp_len == 0) { |
|||
TCP_SSL_DEBUG("ax_port_write: tcp_sndbuf is zero: %d\n", len); |
|||
return ERR_MEM; |
|||
} |
|||
} else { |
|||
tcp_len = len; |
|||
} |
|||
|
|||
if (tcp_len > 2 * fd_data->tcp->mss) { |
|||
tcp_len = 2 * fd_data->tcp->mss; |
|||
} |
|||
|
|||
err = tcp_write(fd_data->tcp, data, tcp_len, TCP_WRITE_FLAG_COPY); |
|||
if(err < ERR_OK) { |
|||
if (err == ERR_MEM) { |
|||
TCP_SSL_DEBUG("ax_port_write: No memory %d (%d)\n", tcp_len, len); |
|||
return err; |
|||
} |
|||
TCP_SSL_DEBUG("ax_port_write: tcp_write error: %d\n", err); |
|||
return err; |
|||
} else if (err == ERR_OK) { |
|||
//TCP_SSL_DEBUG("ax_port_write: tcp_output: %d / %d\n", tcp_len, len);
|
|||
err = tcp_output(fd_data->tcp); |
|||
if(err != ERR_OK) { |
|||
TCP_SSL_DEBUG("ax_port_write: tcp_output err: %d\n", err); |
|||
return err; |
|||
} |
|||
} |
|||
|
|||
fd_data->last_wr += tcp_len; |
|||
|
|||
return tcp_len; |
|||
} |
|||
|
|||
/*
|
|||
* The LWIP tcp raw version of the SOCKET_READ(A, B, C) |
|||
*/ |
|||
int ax_port_read(int fd, uint8_t *data, int len) { |
|||
tcp_ssl_t *fd_data = NULL; |
|||
uint8_t *read_buf = NULL; |
|||
uint8_t *pread_buf = NULL; |
|||
u16_t recv_len = 0; |
|||
|
|||
//TCP_SSL_DEBUG("ax_port_read: %d, %d\n", fd, len);
|
|||
|
|||
fd_data = tcp_ssl_get_by_fd(fd); |
|||
if (fd_data == NULL) { |
|||
TCP_SSL_DEBUG("ax_port_read: tcp_ssl[%d] is NULL\n", fd); |
|||
return ERR_TCP_SSL_INVALID_CLIENTFD_DATA; |
|||
} |
|||
|
|||
if(fd_data->tcp_pbuf == NULL || fd_data->tcp_pbuf->tot_len == 0) { |
|||
return 0; |
|||
} |
|||
|
|||
read_buf =(uint8_t*)calloc(fd_data->tcp_pbuf->len + 1, sizeof(uint8_t)); |
|||
pread_buf = read_buf; |
|||
if (pread_buf != NULL){ |
|||
recv_len = pbuf_copy_partial(fd_data->tcp_pbuf, read_buf, len, fd_data->pbuf_offset); |
|||
fd_data->pbuf_offset += recv_len; |
|||
} |
|||
|
|||
if (recv_len != 0) { |
|||
memcpy(data, read_buf, recv_len); |
|||
} |
|||
|
|||
if(len < recv_len) { |
|||
TCP_SSL_DEBUG("ax_port_read: got %d bytes more than expected\n", recv_len - len); |
|||
} |
|||
|
|||
free(pread_buf); |
|||
pread_buf = NULL; |
|||
|
|||
return recv_len; |
|||
} |
|||
|
|||
void ax_wdt_feed() {} |
|||
|
|||
#endif |
|||
@ -0,0 +1,98 @@ |
|||
/*
|
|||
Asynchronous TCP library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
/*
|
|||
* Compatibility for AxTLS with LWIP raw tcp mode (http://lwip.wikia.com/wiki/Raw/TCP)
|
|||
* Original Code and Inspiration: Slavey Karadzhov |
|||
*/ |
|||
|
|||
#ifndef LWIPR_COMPAT_H |
|||
#define LWIPR_COMPAT_H |
|||
|
|||
#include <async_config.h> |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
|
|||
#include "lwipopts.h" |
|||
/*
|
|||
* All those functions will run only if LWIP tcp raw mode is used |
|||
*/ |
|||
#if LWIP_RAW==1 |
|||
|
|||
#ifdef __cplusplus |
|||
extern "C" { |
|||
#endif |
|||
|
|||
#include <stdbool.h> |
|||
#include "include/ssl.h" |
|||
|
|||
#define ERR_TCP_SSL_INVALID_SSL -101 |
|||
#define ERR_TCP_SSL_INVALID_TCP -102 |
|||
#define ERR_TCP_SSL_INVALID_CLIENTFD -103 |
|||
#define ERR_TCP_SSL_INVALID_CLIENTFD_DATA -104 |
|||
#define ERR_TCP_SSL_INVALID_DATA -105 |
|||
|
|||
#define TCP_SSL_TYPE_CLIENT 0 |
|||
#define TCP_SSL_TYPE_SERVER 1 |
|||
|
|||
#define tcp_ssl_ssl_write(A, B, C) tcp_ssl_write(A, B, C) |
|||
#define tcp_ssl_ssl_read(A, B) tcp_ssl_read(A, B) |
|||
|
|||
typedef void (* tcp_ssl_data_cb_t)(void *arg, struct tcp_pcb *tcp, uint8_t * data, size_t len); |
|||
typedef void (* tcp_ssl_handshake_cb_t)(void *arg, struct tcp_pcb *tcp, SSL *ssl); |
|||
typedef void (* tcp_ssl_error_cb_t)(void *arg, struct tcp_pcb *tcp, int8_t error); |
|||
typedef int (* tcp_ssl_file_cb_t)(void *arg, const char *filename, uint8_t **buf); |
|||
|
|||
uint8_t tcp_ssl_has_client(); |
|||
|
|||
int tcp_ssl_new_client(struct tcp_pcb *tcp); |
|||
|
|||
SSL_CTX * tcp_ssl_new_server_ctx(const char *cert, const char *private_key_file, const char *password); |
|||
int tcp_ssl_new_server(struct tcp_pcb *tcp, SSL_CTX* ssl_ctx); |
|||
int tcp_ssl_is_server(struct tcp_pcb *tcp); |
|||
|
|||
int tcp_ssl_free(struct tcp_pcb *tcp); |
|||
int tcp_ssl_read(struct tcp_pcb *tcp, struct pbuf *p); |
|||
|
|||
#ifdef AXTLS_2_0_0_SNDBUF |
|||
int tcp_ssl_sndbuf(struct tcp_pcb *tcp); |
|||
#endif |
|||
|
|||
int tcp_ssl_write(struct tcp_pcb *tcp, uint8_t *data, size_t len); |
|||
|
|||
void tcp_ssl_file(tcp_ssl_file_cb_t cb, void * arg); |
|||
|
|||
void tcp_ssl_arg(struct tcp_pcb *tcp, void * arg); |
|||
void tcp_ssl_data(struct tcp_pcb *tcp, tcp_ssl_data_cb_t arg); |
|||
void tcp_ssl_handshake(struct tcp_pcb *tcp, tcp_ssl_handshake_cb_t arg); |
|||
void tcp_ssl_err(struct tcp_pcb *tcp, tcp_ssl_error_cb_t arg); |
|||
|
|||
SSL * tcp_ssl_get_ssl(struct tcp_pcb *tcp); |
|||
bool tcp_ssl_has(struct tcp_pcb *tcp); |
|||
|
|||
#ifdef __cplusplus |
|||
} |
|||
#endif |
|||
|
|||
#endif /* LWIP_RAW==1 */ |
|||
|
|||
#endif /* ASYNC_TCP_SSL_ENABLED */ |
|||
|
|||
#endif /* LWIPR_COMPAT_H */ |
|||
@ -0,0 +1,36 @@ |
|||
#!/bin/bash |
|||
|
|||
cat > ca_cert.conf << EOF |
|||
[ req ] |
|||
distinguished_name = req_distinguished_name |
|||
prompt = no |
|||
|
|||
[ req_distinguished_name ] |
|||
O = Espressif Systems |
|||
EOF |
|||
|
|||
openssl genrsa -out axTLS.ca_key.pem 2048 |
|||
openssl req -new -config ./ca_cert.conf -key axTLS.ca_key.pem -out axTLS.ca_x509.req |
|||
openssl x509 -req -sha1 -days 5000 -signkey axTLS.ca_key.pem -CAkey axTLS.ca_key.pem -in axTLS.ca_x509.req -out axTLS.ca_x509.pem |
|||
|
|||
cat > certs.conf << EOF |
|||
[ req ] |
|||
distinguished_name = req_distinguished_name |
|||
prompt = no |
|||
|
|||
[ req_distinguished_name ] |
|||
O = axTLS on ESP8266 |
|||
CN = esp8266.local |
|||
EOF |
|||
|
|||
openssl genrsa -out axTLS.key_1024.pem 1024 |
|||
openssl req -new -config ./certs.conf -key axTLS.key_1024.pem -out axTLS.x509_1024.req |
|||
openssl x509 -req -sha1 -CAcreateserial -days 5000 -CA axTLS.ca_x509.pem -CAkey axTLS.ca_key.pem -in axTLS.x509_1024.req -out axTLS.x509_1024.pem |
|||
|
|||
openssl rsa -outform DER -in axTLS.key_1024.pem -out axTLS.key_1024 |
|||
openssl x509 -outform DER -in axTLS.x509_1024.pem -out axTLS.x509_1024.cer |
|||
|
|||
cat axTLS.key_1024 > server.key |
|||
cat axTLS.x509_1024.cer > server.cer |
|||
|
|||
rm axTLS.* ca_cert.conf certs.conf |
|||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,17 @@ |
|||
set(COMPONENT_SRCDIRS |
|||
"src" |
|||
) |
|||
|
|||
set(COMPONENT_ADD_INCLUDEDIRS |
|||
"src" |
|||
) |
|||
|
|||
set(COMPONENT_REQUIRES |
|||
"arduino-esp32" |
|||
"AsyncTCP" |
|||
) |
|||
|
|||
register_component() |
|||
|
|||
target_compile_definitions(${COMPONENT_TARGET} PUBLIC -DESP32) |
|||
target_compile_options(${COMPONENT_TARGET} PRIVATE -fno-rtti) |
|||
File diff suppressed because it is too large
@ -0,0 +1 @@ |
|||
theme: jekyll-theme-cayman |
|||
@ -0,0 +1,3 @@ |
|||
COMPONENT_ADD_INCLUDEDIRS := src |
|||
COMPONENT_SRCDIRS := src |
|||
CXXFLAGS += -fno-rtti |
|||
@ -0,0 +1,47 @@ |
|||
#include <DNSServer.h> |
|||
#ifdef ESP32 |
|||
#include <WiFi.h> |
|||
#include <AsyncTCP.h> |
|||
#elif defined(ESP8266) |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#endif |
|||
#include "ESPAsyncWebServer.h" |
|||
|
|||
DNSServer dnsServer; |
|||
AsyncWebServer server(80); |
|||
|
|||
class CaptiveRequestHandler : public AsyncWebHandler { |
|||
public: |
|||
CaptiveRequestHandler() {} |
|||
virtual ~CaptiveRequestHandler() {} |
|||
|
|||
bool canHandle(AsyncWebServerRequest *request){ |
|||
//request->addInterestingHeader("ANY");
|
|||
return true; |
|||
} |
|||
|
|||
void handleRequest(AsyncWebServerRequest *request) { |
|||
AsyncResponseStream *response = request->beginResponseStream("text/html"); |
|||
response->print("<!DOCTYPE html><html><head><title>Captive Portal</title></head><body>"); |
|||
response->print("<p>This is out captive portal front page.</p>"); |
|||
response->printf("<p>You were trying to reach: http://%s%s</p>", request->host().c_str(), request->url().c_str()); |
|||
response->printf("<p>Try opening <a href='http://%s'>this link</a> instead</p>", WiFi.softAPIP().toString().c_str()); |
|||
response->print("</body></html>"); |
|||
request->send(response); |
|||
} |
|||
}; |
|||
|
|||
|
|||
void setup(){ |
|||
//your other setup stuff...
|
|||
WiFi.softAP("esp-captive"); |
|||
dnsServer.start(53, "*", WiFi.softAPIP()); |
|||
server.addHandler(new CaptiveRequestHandler()).setFilter(ON_AP_FILTER);//only when requested from AP
|
|||
//more handlers...
|
|||
server.begin(); |
|||
} |
|||
|
|||
void loop(){ |
|||
dnsServer.processNextRequest(); |
|||
} |
|||
@ -0,0 +1,221 @@ |
|||
#include <ArduinoOTA.h> |
|||
#ifdef ESP32 |
|||
#include <FS.h> |
|||
#include <SPIFFS.h> |
|||
#include <ESPmDNS.h> |
|||
#include <WiFi.h> |
|||
#include <AsyncTCP.h> |
|||
#elif defined(ESP8266) |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#include <ESP8266mDNS.h> |
|||
#endif |
|||
#include <ESPAsyncWebServer.h> |
|||
#include <SPIFFSEditor.h> |
|||
|
|||
// SKETCH BEGIN
|
|||
AsyncWebServer server(80); |
|||
AsyncWebSocket ws("/ws"); |
|||
AsyncEventSource events("/events"); |
|||
|
|||
void onWsEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len){ |
|||
if(type == WS_EVT_CONNECT){ |
|||
Serial.printf("ws[%s][%u] connect\n", server->url(), client->id()); |
|||
client->printf("Hello Client %u :)", client->id()); |
|||
client->ping(); |
|||
} else if(type == WS_EVT_DISCONNECT){ |
|||
Serial.printf("ws[%s][%u] disconnect\n", server->url(), client->id()); |
|||
} else if(type == WS_EVT_ERROR){ |
|||
Serial.printf("ws[%s][%u] error(%u): %s\n", server->url(), client->id(), *((uint16_t*)arg), (char*)data); |
|||
} else if(type == WS_EVT_PONG){ |
|||
Serial.printf("ws[%s][%u] pong[%u]: %s\n", server->url(), client->id(), len, (len)?(char*)data:""); |
|||
} else if(type == WS_EVT_DATA){ |
|||
AwsFrameInfo * info = (AwsFrameInfo*)arg; |
|||
String msg = ""; |
|||
if(info->final && info->index == 0 && info->len == len){ |
|||
//the whole message is in a single frame and we got all of it's data
|
|||
Serial.printf("ws[%s][%u] %s-message[%llu]: ", server->url(), client->id(), (info->opcode == WS_TEXT)?"text":"binary", info->len); |
|||
|
|||
if(info->opcode == WS_TEXT){ |
|||
for(size_t i=0; i < info->len; i++) { |
|||
msg += (char) data[i]; |
|||
} |
|||
} else { |
|||
char buff[3]; |
|||
for(size_t i=0; i < info->len; i++) { |
|||
sprintf(buff, "%02x ", (uint8_t) data[i]); |
|||
msg += buff ; |
|||
} |
|||
} |
|||
Serial.printf("%s\n",msg.c_str()); |
|||
|
|||
if(info->opcode == WS_TEXT) |
|||
client->text("I got your text message"); |
|||
else |
|||
client->binary("I got your binary message"); |
|||
} else { |
|||
//message is comprised of multiple frames or the frame is split into multiple packets
|
|||
if(info->index == 0){ |
|||
if(info->num == 0) |
|||
Serial.printf("ws[%s][%u] %s-message start\n", server->url(), client->id(), (info->message_opcode == WS_TEXT)?"text":"binary"); |
|||
Serial.printf("ws[%s][%u] frame[%u] start[%llu]\n", server->url(), client->id(), info->num, info->len); |
|||
} |
|||
|
|||
Serial.printf("ws[%s][%u] frame[%u] %s[%llu - %llu]: ", server->url(), client->id(), info->num, (info->message_opcode == WS_TEXT)?"text":"binary", info->index, info->index + len); |
|||
|
|||
if(info->opcode == WS_TEXT){ |
|||
for(size_t i=0; i < len; i++) { |
|||
msg += (char) data[i]; |
|||
} |
|||
} else { |
|||
char buff[3]; |
|||
for(size_t i=0; i < len; i++) { |
|||
sprintf(buff, "%02x ", (uint8_t) data[i]); |
|||
msg += buff ; |
|||
} |
|||
} |
|||
Serial.printf("%s\n",msg.c_str()); |
|||
|
|||
if((info->index + len) == info->len){ |
|||
Serial.printf("ws[%s][%u] frame[%u] end[%llu]\n", server->url(), client->id(), info->num, info->len); |
|||
if(info->final){ |
|||
Serial.printf("ws[%s][%u] %s-message end\n", server->url(), client->id(), (info->message_opcode == WS_TEXT)?"text":"binary"); |
|||
if(info->message_opcode == WS_TEXT) |
|||
client->text("I got your text message"); |
|||
else |
|||
client->binary("I got your binary message"); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
} |
|||
|
|||
|
|||
const char* ssid = "*******"; |
|||
const char* password = "*******"; |
|||
const char * hostName = "esp-async"; |
|||
const char* http_username = "admin"; |
|||
const char* http_password = "admin"; |
|||
|
|||
void setup(){ |
|||
Serial.begin(115200); |
|||
Serial.setDebugOutput(true); |
|||
WiFi.mode(WIFI_AP_STA); |
|||
WiFi.softAP(hostName); |
|||
WiFi.begin(ssid, password); |
|||
if (WiFi.waitForConnectResult() != WL_CONNECTED) { |
|||
Serial.printf("STA: Failed!\n"); |
|||
WiFi.disconnect(false); |
|||
delay(1000); |
|||
WiFi.begin(ssid, password); |
|||
} |
|||
|
|||
//Send OTA events to the browser
|
|||
ArduinoOTA.onStart([]() { events.send("Update Start", "ota"); }); |
|||
ArduinoOTA.onEnd([]() { events.send("Update End", "ota"); }); |
|||
ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) { |
|||
char p[32]; |
|||
sprintf(p, "Progress: %u%%\n", (progress/(total/100))); |
|||
events.send(p, "ota"); |
|||
}); |
|||
ArduinoOTA.onError([](ota_error_t error) { |
|||
if(error == OTA_AUTH_ERROR) events.send("Auth Failed", "ota"); |
|||
else if(error == OTA_BEGIN_ERROR) events.send("Begin Failed", "ota"); |
|||
else if(error == OTA_CONNECT_ERROR) events.send("Connect Failed", "ota"); |
|||
else if(error == OTA_RECEIVE_ERROR) events.send("Recieve Failed", "ota"); |
|||
else if(error == OTA_END_ERROR) events.send("End Failed", "ota"); |
|||
}); |
|||
ArduinoOTA.setHostname(hostName); |
|||
ArduinoOTA.begin(); |
|||
|
|||
MDNS.addService("http","tcp",80); |
|||
|
|||
SPIFFS.begin(); |
|||
|
|||
ws.onEvent(onWsEvent); |
|||
server.addHandler(&ws); |
|||
|
|||
events.onConnect([](AsyncEventSourceClient *client){ |
|||
client->send("hello!",NULL,millis(),1000); |
|||
}); |
|||
server.addHandler(&events); |
|||
|
|||
#ifdef ESP32 |
|||
server.addHandler(new SPIFFSEditor(SPIFFS, http_username,http_password)); |
|||
#elif defined(ESP8266) |
|||
server.addHandler(new SPIFFSEditor(http_username,http_password)); |
|||
#endif |
|||
|
|||
server.on("/heap", HTTP_GET, [](AsyncWebServerRequest *request){ |
|||
request->send(200, "text/plain", String(ESP.getFreeHeap())); |
|||
}); |
|||
|
|||
server.serveStatic("/", SPIFFS, "/").setDefaultFile("index.htm"); |
|||
|
|||
server.onNotFound([](AsyncWebServerRequest *request){ |
|||
Serial.printf("NOT_FOUND: "); |
|||
if(request->method() == HTTP_GET) |
|||
Serial.printf("GET"); |
|||
else if(request->method() == HTTP_POST) |
|||
Serial.printf("POST"); |
|||
else if(request->method() == HTTP_DELETE) |
|||
Serial.printf("DELETE"); |
|||
else if(request->method() == HTTP_PUT) |
|||
Serial.printf("PUT"); |
|||
else if(request->method() == HTTP_PATCH) |
|||
Serial.printf("PATCH"); |
|||
else if(request->method() == HTTP_HEAD) |
|||
Serial.printf("HEAD"); |
|||
else if(request->method() == HTTP_OPTIONS) |
|||
Serial.printf("OPTIONS"); |
|||
else |
|||
Serial.printf("UNKNOWN"); |
|||
Serial.printf(" http://%s%s\n", request->host().c_str(), request->url().c_str()); |
|||
|
|||
if(request->contentLength()){ |
|||
Serial.printf("_CONTENT_TYPE: %s\n", request->contentType().c_str()); |
|||
Serial.printf("_CONTENT_LENGTH: %u\n", request->contentLength()); |
|||
} |
|||
|
|||
int headers = request->headers(); |
|||
int i; |
|||
for(i=0;i<headers;i++){ |
|||
AsyncWebHeader* h = request->getHeader(i); |
|||
Serial.printf("_HEADER[%s]: %s\n", h->name().c_str(), h->value().c_str()); |
|||
} |
|||
|
|||
int params = request->params(); |
|||
for(i=0;i<params;i++){ |
|||
AsyncWebParameter* p = request->getParam(i); |
|||
if(p->isFile()){ |
|||
Serial.printf("_FILE[%s]: %s, size: %u\n", p->name().c_str(), p->value().c_str(), p->size()); |
|||
} else if(p->isPost()){ |
|||
Serial.printf("_POST[%s]: %s\n", p->name().c_str(), p->value().c_str()); |
|||
} else { |
|||
Serial.printf("_GET[%s]: %s\n", p->name().c_str(), p->value().c_str()); |
|||
} |
|||
} |
|||
|
|||
request->send(404); |
|||
}); |
|||
server.onFileUpload([](AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final){ |
|||
if(!index) |
|||
Serial.printf("UploadStart: %s\n", filename.c_str()); |
|||
Serial.printf("%s", (const char*)data); |
|||
if(final) |
|||
Serial.printf("UploadEnd: %s (%u)\n", filename.c_str(), index+len); |
|||
}); |
|||
server.onRequestBody([](AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total){ |
|||
if(!index) |
|||
Serial.printf("BodyStart: %u\n", total); |
|||
Serial.printf("%s", (const char*)data); |
|||
if(index + len == total) |
|||
Serial.printf("BodyEnd: %u\n", total); |
|||
}); |
|||
server.begin(); |
|||
} |
|||
|
|||
void loop(){ |
|||
ArduinoOTA.handle(); |
|||
ws.cleanupClients(); |
|||
} |
|||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
@ -0,0 +1,131 @@ |
|||
<!-- |
|||
FSWebServer - Example Index Page |
|||
Copyright (c) 2015 Hristo Gochkov. All rights reserved. |
|||
This file is part of the ESP8266WebServer library for Arduino environment. |
|||
|
|||
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. |
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
--> |
|||
<!DOCTYPE html> |
|||
<html> |
|||
<head> |
|||
<meta http-equiv="Content-type" content="text/html; charset=utf-8"> |
|||
<title>WebSocketTester</title> |
|||
<style type="text/css" media="screen"> |
|||
body { |
|||
margin:0; |
|||
padding:0; |
|||
background-color: black; |
|||
} |
|||
|
|||
#dbg, #input_div, #input_el { |
|||
font-family: monaco; |
|||
font-size: 12px; |
|||
line-height: 13px; |
|||
color: #AAA; |
|||
} |
|||
|
|||
#dbg, #input_div { |
|||
margin:0; |
|||
padding:0; |
|||
padding-left:4px; |
|||
} |
|||
|
|||
#input_el { |
|||
width:98%; |
|||
background-color: rgba(0,0,0,0); |
|||
border: 0px; |
|||
} |
|||
#input_el:focus { |
|||
outline: none; |
|||
} |
|||
</style> |
|||
<script type="text/javascript"> |
|||
var ws = null; |
|||
function ge(s){ return document.getElementById(s);} |
|||
function ce(s){ return document.createElement(s);} |
|||
function stb(){ window.scrollTo(0, document.body.scrollHeight || document.documentElement.scrollHeight); } |
|||
function sendBlob(str){ |
|||
var buf = new Uint8Array(str.length); |
|||
for (var i = 0; i < str.length; ++i) buf[i] = str.charCodeAt(i); |
|||
ws.send(buf); |
|||
} |
|||
function addMessage(m){ |
|||
var msg = ce("div"); |
|||
msg.innerText = m; |
|||
ge("dbg").appendChild(msg); |
|||
stb(); |
|||
} |
|||
function startSocket(){ |
|||
ws = new WebSocket('ws://'+document.location.host+'/ws',['arduino']); |
|||
ws.binaryType = "arraybuffer"; |
|||
ws.onopen = function(e){ |
|||
addMessage("Connected"); |
|||
}; |
|||
ws.onclose = function(e){ |
|||
addMessage("Disconnected"); |
|||
}; |
|||
ws.onerror = function(e){ |
|||
console.log("ws error", e); |
|||
addMessage("Error"); |
|||
}; |
|||
ws.onmessage = function(e){ |
|||
var msg = ""; |
|||
if(e.data instanceof ArrayBuffer){ |
|||
msg = "BIN:"; |
|||
var bytes = new Uint8Array(e.data); |
|||
for (var i = 0; i < bytes.length; i++) { |
|||
msg += String.fromCharCode(bytes[i]); |
|||
} |
|||
} else { |
|||
msg = "TXT:"+e.data; |
|||
} |
|||
addMessage(msg); |
|||
}; |
|||
ge("input_el").onkeydown = function(e){ |
|||
stb(); |
|||
if(e.keyCode == 13 && ge("input_el").value != ""){ |
|||
ws.send(ge("input_el").value); |
|||
ge("input_el").value = ""; |
|||
} |
|||
} |
|||
} |
|||
function startEvents(){ |
|||
var es = new EventSource('/events'); |
|||
es.onopen = function(e) { |
|||
addMessage("Events Opened"); |
|||
}; |
|||
es.onerror = function(e) { |
|||
if (e.target.readyState != EventSource.OPEN) { |
|||
addMessage("Events Closed"); |
|||
} |
|||
}; |
|||
es.onmessage = function(e) { |
|||
addMessage("Event: " + e.data); |
|||
}; |
|||
es.addEventListener('ota', function(e) { |
|||
addMessage("Event[ota]: " + e.data); |
|||
}, false); |
|||
} |
|||
function onBodyLoad(){ |
|||
startSocket(); |
|||
startEvents(); |
|||
} |
|||
</script> |
|||
</head> |
|||
<body id="body" onload="onBodyLoad()"> |
|||
<pre id="dbg"></pre> |
|||
<div id="input_div"> |
|||
$<input type="text" value="" id="input_el"> |
|||
</div> |
|||
</body> |
|||
</html> |
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,77 @@ |
|||
//
|
|||
// A simple server implementation with regex routes:
|
|||
// * serve static messages
|
|||
// * read GET and POST parameters
|
|||
// * handle missing pages / 404s
|
|||
//
|
|||
|
|||
// Add buildflag ASYNCWEBSERVER_REGEX to enable the regex support
|
|||
|
|||
// For platformio: platformio.ini:
|
|||
// build_flags =
|
|||
// -DASYNCWEBSERVER_REGEX
|
|||
|
|||
// For arduino IDE: create/update platform.local.txt
|
|||
// Windows: C:\Users\(username)\AppData\Local\Arduino15\packages\espxxxx\hardware\espxxxx\{version}\platform.local.txt
|
|||
// Linux: ~/.arduino15/packages/espxxxx/hardware/espxxxx/{version}/platform.local.txt
|
|||
//
|
|||
// compiler.cpp.extra_flags=-DASYNCWEBSERVER_REGEX=1
|
|||
|
|||
#include <Arduino.h> |
|||
#ifdef ESP32 |
|||
#include <WiFi.h> |
|||
#include <AsyncTCP.h> |
|||
#elif defined(ESP8266) |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#endif |
|||
#include <ESPAsyncWebServer.h> |
|||
|
|||
AsyncWebServer server(80); |
|||
|
|||
const char* ssid = "YOUR_SSID"; |
|||
const char* password = "YOUR_PASSWORD"; |
|||
|
|||
const char* PARAM_MESSAGE = "message"; |
|||
|
|||
void notFound(AsyncWebServerRequest *request) { |
|||
request->send(404, "text/plain", "Not found"); |
|||
} |
|||
|
|||
void setup() { |
|||
|
|||
Serial.begin(115200); |
|||
WiFi.mode(WIFI_STA); |
|||
WiFi.begin(ssid, password); |
|||
if (WiFi.waitForConnectResult() != WL_CONNECTED) { |
|||
Serial.printf("WiFi Failed!\n"); |
|||
return; |
|||
} |
|||
|
|||
Serial.print("IP Address: "); |
|||
Serial.println(WiFi.localIP()); |
|||
|
|||
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){ |
|||
request->send(200, "text/plain", "Hello, world"); |
|||
}); |
|||
|
|||
// Send a GET request to <IP>/sensor/<number>
|
|||
server.on("^\\/sensor\\/([0-9]+)$", HTTP_GET, [] (AsyncWebServerRequest *request) { |
|||
String sensorNumber = request->pathArg(0); |
|||
request->send(200, "text/plain", "Hello, sensor: " + sensorNumber); |
|||
}); |
|||
|
|||
// Send a GET request to <IP>/sensor/<number>/action/<action>
|
|||
server.on("^\\/sensor\\/([0-9]+)\\/action\\/([a-zA-Z0-9]+)$", HTTP_GET, [] (AsyncWebServerRequest *request) { |
|||
String sensorNumber = request->pathArg(0); |
|||
String action = request->pathArg(1); |
|||
request->send(200, "text/plain", "Hello, sensor: " + sensorNumber + ", with action: " + action); |
|||
}); |
|||
|
|||
server.onNotFound(notFound); |
|||
|
|||
server.begin(); |
|||
} |
|||
|
|||
void loop() { |
|||
} |
|||
@ -0,0 +1,74 @@ |
|||
//
|
|||
// A simple server implementation showing how to:
|
|||
// * serve static messages
|
|||
// * read GET and POST parameters
|
|||
// * handle missing pages / 404s
|
|||
//
|
|||
|
|||
#include <Arduino.h> |
|||
#ifdef ESP32 |
|||
#include <WiFi.h> |
|||
#include <AsyncTCP.h> |
|||
#elif defined(ESP8266) |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#endif |
|||
#include <ESPAsyncWebServer.h> |
|||
|
|||
AsyncWebServer server(80); |
|||
|
|||
const char* ssid = "YOUR_SSID"; |
|||
const char* password = "YOUR_PASSWORD"; |
|||
|
|||
const char* PARAM_MESSAGE = "message"; |
|||
|
|||
void notFound(AsyncWebServerRequest *request) { |
|||
request->send(404, "text/plain", "Not found"); |
|||
} |
|||
|
|||
void setup() { |
|||
|
|||
Serial.begin(115200); |
|||
WiFi.mode(WIFI_STA); |
|||
WiFi.begin(ssid, password); |
|||
if (WiFi.waitForConnectResult() != WL_CONNECTED) { |
|||
Serial.printf("WiFi Failed!\n"); |
|||
return; |
|||
} |
|||
|
|||
Serial.print("IP Address: "); |
|||
Serial.println(WiFi.localIP()); |
|||
|
|||
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){ |
|||
request->send(200, "text/plain", "Hello, world"); |
|||
}); |
|||
|
|||
// Send a GET request to <IP>/get?message=<message>
|
|||
server.on("/get", HTTP_GET, [] (AsyncWebServerRequest *request) { |
|||
String message; |
|||
if (request->hasParam(PARAM_MESSAGE)) { |
|||
message = request->getParam(PARAM_MESSAGE)->value(); |
|||
} else { |
|||
message = "No message sent"; |
|||
} |
|||
request->send(200, "text/plain", "Hello, GET: " + message); |
|||
}); |
|||
|
|||
// Send a POST request to <IP>/post with a form field message set to <message>
|
|||
server.on("/post", HTTP_POST, [](AsyncWebServerRequest *request){ |
|||
String message; |
|||
if (request->hasParam(PARAM_MESSAGE, true)) { |
|||
message = request->getParam(PARAM_MESSAGE, true)->value(); |
|||
} else { |
|||
message = "No message sent"; |
|||
} |
|||
request->send(200, "text/plain", "Hello, POST: " + message); |
|||
}); |
|||
|
|||
server.onNotFound(notFound); |
|||
|
|||
server.begin(); |
|||
} |
|||
|
|||
void loop() { |
|||
} |
|||
@ -0,0 +1,3 @@ |
|||
JsonArray KEYWORD1 |
|||
add KEYWORD2 |
|||
createArray KEYWORD3 |
|||
@ -0,0 +1,33 @@ |
|||
{ |
|||
"name":"ESP Async WebServer", |
|||
"description":"Asynchronous HTTP and WebSocket Server Library for ESP8266 and ESP32", |
|||
"keywords":"http,async,websocket,webserver", |
|||
"authors": |
|||
{ |
|||
"name": "Hristo Gochkov", |
|||
"maintainer": true |
|||
}, |
|||
"repository": |
|||
{ |
|||
"type": "git", |
|||
"url": "https://github.com/me-no-dev/ESPAsyncWebServer.git" |
|||
}, |
|||
"version": "1.2.3", |
|||
"license": "LGPL-3.0", |
|||
"frameworks": "arduino", |
|||
"platforms": ["espressif8266", "espressif32"], |
|||
"dependencies": [ |
|||
{ |
|||
"name": "ESPAsyncTCP", |
|||
"platforms": "espressif8266" |
|||
}, |
|||
{ |
|||
"name": "AsyncTCP", |
|||
"platforms": "espressif32" |
|||
}, |
|||
{ |
|||
"name": "Hash", |
|||
"platforms": "espressif8266" |
|||
} |
|||
] |
|||
} |
|||
@ -0,0 +1,9 @@ |
|||
name=ESP Async WebServer |
|||
version=1.2.3 |
|||
author=Me-No-Dev |
|||
maintainer=Me-No-Dev |
|||
sentence=Async Web Server for ESP8266 and ESP31B |
|||
paragraph=Async Web Server for ESP8266 and ESP31B |
|||
category=Other |
|||
url=https://github.com/me-no-dev/ESPAsyncWebServer |
|||
architectures=* |
|||
@ -0,0 +1,368 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. 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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#include "Arduino.h" |
|||
#include "AsyncEventSource.h" |
|||
|
|||
static String generateEventMessage(const char *message, const char *event, uint32_t id, uint32_t reconnect){ |
|||
String ev = ""; |
|||
|
|||
if(reconnect){ |
|||
ev += "retry: "; |
|||
ev += String(reconnect); |
|||
ev += "\r\n"; |
|||
} |
|||
|
|||
if(id){ |
|||
ev += "id: "; |
|||
ev += String(id); |
|||
ev += "\r\n"; |
|||
} |
|||
|
|||
if(event != NULL){ |
|||
ev += "event: "; |
|||
ev += String(event); |
|||
ev += "\r\n"; |
|||
} |
|||
|
|||
if(message != NULL){ |
|||
size_t messageLen = strlen(message); |
|||
char * lineStart = (char *)message; |
|||
char * lineEnd; |
|||
do { |
|||
char * nextN = strchr(lineStart, '\n'); |
|||
char * nextR = strchr(lineStart, '\r'); |
|||
if(nextN == NULL && nextR == NULL){ |
|||
size_t llen = ((char *)message + messageLen) - lineStart; |
|||
char * ldata = (char *)malloc(llen+1); |
|||
if(ldata != NULL){ |
|||
memcpy(ldata, lineStart, llen); |
|||
ldata[llen] = 0; |
|||
ev += "data: "; |
|||
ev += ldata; |
|||
ev += "\r\n\r\n"; |
|||
free(ldata); |
|||
} |
|||
lineStart = (char *)message + messageLen; |
|||
} else { |
|||
char * nextLine = NULL; |
|||
if(nextN != NULL && nextR != NULL){ |
|||
if(nextR < nextN){ |
|||
lineEnd = nextR; |
|||
if(nextN == (nextR + 1)) |
|||
nextLine = nextN + 1; |
|||
else |
|||
nextLine = nextR + 1; |
|||
} else { |
|||
lineEnd = nextN; |
|||
if(nextR == (nextN + 1)) |
|||
nextLine = nextR + 1; |
|||
else |
|||
nextLine = nextN + 1; |
|||
} |
|||
} else if(nextN != NULL){ |
|||
lineEnd = nextN; |
|||
nextLine = nextN + 1; |
|||
} else { |
|||
lineEnd = nextR; |
|||
nextLine = nextR + 1; |
|||
} |
|||
|
|||
size_t llen = lineEnd - lineStart; |
|||
char * ldata = (char *)malloc(llen+1); |
|||
if(ldata != NULL){ |
|||
memcpy(ldata, lineStart, llen); |
|||
ldata[llen] = 0; |
|||
ev += "data: "; |
|||
ev += ldata; |
|||
ev += "\r\n"; |
|||
free(ldata); |
|||
} |
|||
lineStart = nextLine; |
|||
if(lineStart == ((char *)message + messageLen)) |
|||
ev += "\r\n"; |
|||
} |
|||
} while(lineStart < ((char *)message + messageLen)); |
|||
} |
|||
|
|||
return ev; |
|||
} |
|||
|
|||
// Message
|
|||
|
|||
AsyncEventSourceMessage::AsyncEventSourceMessage(const char * data, size_t len) |
|||
: _data(nullptr), _len(len), _sent(0), _acked(0) |
|||
{ |
|||
_data = (uint8_t*)malloc(_len+1); |
|||
if(_data == nullptr){ |
|||
_len = 0; |
|||
} else { |
|||
memcpy(_data, data, len); |
|||
_data[_len] = 0; |
|||
} |
|||
} |
|||
|
|||
AsyncEventSourceMessage::~AsyncEventSourceMessage() { |
|||
if(_data != NULL) |
|||
free(_data); |
|||
} |
|||
|
|||
size_t AsyncEventSourceMessage::ack(size_t len, uint32_t time) { |
|||
(void)time; |
|||
// If the whole message is now acked...
|
|||
if(_acked + len > _len){ |
|||
// Return the number of extra bytes acked (they will be carried on to the next message)
|
|||
const size_t extra = _acked + len - _len; |
|||
_acked = _len; |
|||
return extra; |
|||
} |
|||
// Return that no extra bytes left.
|
|||
_acked += len; |
|||
return 0; |
|||
} |
|||
|
|||
size_t AsyncEventSourceMessage::send(AsyncClient *client) { |
|||
const size_t len = _len - _sent; |
|||
if(client->space() < len){ |
|||
return 0; |
|||
} |
|||
size_t sent = client->add((const char *)_data, len); |
|||
if(client->canSend()) |
|||
client->send(); |
|||
_sent += sent; |
|||
return sent; |
|||
} |
|||
|
|||
// Client
|
|||
|
|||
AsyncEventSourceClient::AsyncEventSourceClient(AsyncWebServerRequest *request, AsyncEventSource *server) |
|||
: _messageQueue(LinkedList<AsyncEventSourceMessage *>([](AsyncEventSourceMessage *m){ delete m; })) |
|||
{ |
|||
_client = request->client(); |
|||
_server = server; |
|||
_lastId = 0; |
|||
if(request->hasHeader("Last-Event-ID")) |
|||
_lastId = atoi(request->getHeader("Last-Event-ID")->value().c_str()); |
|||
|
|||
_client->setRxTimeout(0); |
|||
_client->onError(NULL, NULL); |
|||
_client->onAck([](void *r, AsyncClient* c, size_t len, uint32_t time){ (void)c; ((AsyncEventSourceClient*)(r))->_onAck(len, time); }, this); |
|||
_client->onPoll([](void *r, AsyncClient* c){ (void)c; ((AsyncEventSourceClient*)(r))->_onPoll(); }, this); |
|||
_client->onData(NULL, NULL); |
|||
_client->onTimeout([this](void *r, AsyncClient* c __attribute__((unused)), uint32_t time){ ((AsyncEventSourceClient*)(r))->_onTimeout(time); }, this); |
|||
_client->onDisconnect([this](void *r, AsyncClient* c){ ((AsyncEventSourceClient*)(r))->_onDisconnect(); delete c; }, this); |
|||
|
|||
_server->_addClient(this); |
|||
delete request; |
|||
} |
|||
|
|||
AsyncEventSourceClient::~AsyncEventSourceClient(){ |
|||
_messageQueue.free(); |
|||
close(); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::_queueMessage(AsyncEventSourceMessage *dataMessage){ |
|||
if(dataMessage == NULL) |
|||
return; |
|||
if(!connected()){ |
|||
delete dataMessage; |
|||
return; |
|||
} |
|||
if(_messageQueue.length() >= SSE_MAX_QUEUED_MESSAGES){ |
|||
ets_printf("ERROR: Too many messages queued\n"); |
|||
delete dataMessage; |
|||
} else { |
|||
_messageQueue.add(dataMessage); |
|||
} |
|||
if(_client->canSend()) |
|||
_runQueue(); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::_onAck(size_t len, uint32_t time){ |
|||
while(len && !_messageQueue.isEmpty()){ |
|||
len = _messageQueue.front()->ack(len, time); |
|||
if(_messageQueue.front()->finished()) |
|||
_messageQueue.remove(_messageQueue.front()); |
|||
} |
|||
|
|||
_runQueue(); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::_onPoll(){ |
|||
if(!_messageQueue.isEmpty()){ |
|||
_runQueue(); |
|||
} |
|||
} |
|||
|
|||
|
|||
void AsyncEventSourceClient::_onTimeout(uint32_t time __attribute__((unused))){ |
|||
_client->close(true); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::_onDisconnect(){ |
|||
_client = NULL; |
|||
_server->_handleDisconnect(this); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::close(){ |
|||
if(_client != NULL) |
|||
_client->close(); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::write(const char * message, size_t len){ |
|||
_queueMessage(new AsyncEventSourceMessage(message, len)); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::send(const char *message, const char *event, uint32_t id, uint32_t reconnect){ |
|||
String ev = generateEventMessage(message, event, id, reconnect); |
|||
_queueMessage(new AsyncEventSourceMessage(ev.c_str(), ev.length())); |
|||
} |
|||
|
|||
void AsyncEventSourceClient::_runQueue(){ |
|||
while(!_messageQueue.isEmpty() && _messageQueue.front()->finished()){ |
|||
_messageQueue.remove(_messageQueue.front()); |
|||
} |
|||
|
|||
for(auto i = _messageQueue.begin(); i != _messageQueue.end(); ++i) |
|||
{ |
|||
if(!(*i)->sent()) |
|||
(*i)->send(_client); |
|||
} |
|||
} |
|||
|
|||
|
|||
// Handler
|
|||
|
|||
AsyncEventSource::AsyncEventSource(const String& url) |
|||
: _url(url) |
|||
, _clients(LinkedList<AsyncEventSourceClient *>([](AsyncEventSourceClient *c){ delete c; })) |
|||
, _connectcb(NULL) |
|||
{} |
|||
|
|||
AsyncEventSource::~AsyncEventSource(){ |
|||
close(); |
|||
} |
|||
|
|||
void AsyncEventSource::onConnect(ArEventHandlerFunction cb){ |
|||
_connectcb = cb; |
|||
} |
|||
|
|||
void AsyncEventSource::_addClient(AsyncEventSourceClient * client){ |
|||
/*char * temp = (char *)malloc(2054);
|
|||
if(temp != NULL){ |
|||
memset(temp+1,' ',2048); |
|||
temp[0] = ':'; |
|||
temp[2049] = '\r'; |
|||
temp[2050] = '\n'; |
|||
temp[2051] = '\r'; |
|||
temp[2052] = '\n'; |
|||
temp[2053] = 0; |
|||
client->write((const char *)temp, 2053); |
|||
free(temp); |
|||
}*/ |
|||
|
|||
_clients.add(client); |
|||
if(_connectcb) |
|||
_connectcb(client); |
|||
} |
|||
|
|||
void AsyncEventSource::_handleDisconnect(AsyncEventSourceClient * client){ |
|||
_clients.remove(client); |
|||
} |
|||
|
|||
void AsyncEventSource::close(){ |
|||
for(const auto &c: _clients){ |
|||
if(c->connected()) |
|||
c->close(); |
|||
} |
|||
} |
|||
|
|||
// pmb fix
|
|||
size_t AsyncEventSource::avgPacketsWaiting() const { |
|||
if(_clients.isEmpty()) |
|||
return 0; |
|||
|
|||
size_t aql=0; |
|||
uint32_t nConnectedClients=0; |
|||
|
|||
for(const auto &c: _clients){ |
|||
if(c->connected()) { |
|||
aql+=c->packetsWaiting(); |
|||
++nConnectedClients; |
|||
} |
|||
} |
|||
// return aql / nConnectedClients;
|
|||
return ((aql) + (nConnectedClients/2))/(nConnectedClients); // round up
|
|||
} |
|||
|
|||
void AsyncEventSource::send(const char *message, const char *event, uint32_t id, uint32_t reconnect){ |
|||
|
|||
|
|||
String ev = generateEventMessage(message, event, id, reconnect); |
|||
for(const auto &c: _clients){ |
|||
if(c->connected()) { |
|||
c->write(ev.c_str(), ev.length()); |
|||
} |
|||
} |
|||
} |
|||
|
|||
size_t AsyncEventSource::count() const { |
|||
return _clients.count_if([](AsyncEventSourceClient *c){ |
|||
return c->connected(); |
|||
}); |
|||
} |
|||
|
|||
bool AsyncEventSource::canHandle(AsyncWebServerRequest *request){ |
|||
if(request->method() != HTTP_GET || !request->url().equals(_url)) { |
|||
return false; |
|||
} |
|||
request->addInterestingHeader("Last-Event-ID"); |
|||
return true; |
|||
} |
|||
|
|||
void AsyncEventSource::handleRequest(AsyncWebServerRequest *request){ |
|||
if((_username != "" && _password != "") && !request->authenticate(_username.c_str(), _password.c_str())) |
|||
return request->requestAuthentication(); |
|||
request->send(new AsyncEventSourceResponse(this)); |
|||
} |
|||
|
|||
// Response
|
|||
|
|||
AsyncEventSourceResponse::AsyncEventSourceResponse(AsyncEventSource *server){ |
|||
_server = server; |
|||
_code = 200; |
|||
_contentType = "text/event-stream"; |
|||
_sendContentLength = false; |
|||
addHeader("Cache-Control", "no-cache"); |
|||
addHeader("Connection","keep-alive"); |
|||
} |
|||
|
|||
void AsyncEventSourceResponse::_respond(AsyncWebServerRequest *request){ |
|||
String out = _assembleHead(request->version()); |
|||
request->client()->write(out.c_str(), _headLength); |
|||
_state = RESPONSE_WAIT_ACK; |
|||
} |
|||
|
|||
size_t AsyncEventSourceResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time __attribute__((unused))){ |
|||
if(len){ |
|||
new AsyncEventSourceClient(request, _server); |
|||
} |
|||
return 0; |
|||
} |
|||
|
|||
@ -0,0 +1,133 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. 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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#ifndef ASYNCEVENTSOURCE_H_ |
|||
#define ASYNCEVENTSOURCE_H_ |
|||
|
|||
#include <Arduino.h> |
|||
#ifdef ESP32 |
|||
#include <AsyncTCP.h> |
|||
#define SSE_MAX_QUEUED_MESSAGES 32 |
|||
#else |
|||
#include <ESPAsyncTCP.h> |
|||
#define SSE_MAX_QUEUED_MESSAGES 8 |
|||
#endif |
|||
#include <ESPAsyncWebServer.h> |
|||
|
|||
#include "AsyncWebSynchronization.h" |
|||
|
|||
#ifdef ESP8266 |
|||
#include <Hash.h> |
|||
#ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library
|
|||
#include <../src/Hash.h> |
|||
#endif |
|||
#endif |
|||
|
|||
#ifdef ESP32 |
|||
#define DEFAULT_MAX_SSE_CLIENTS 8 |
|||
#else |
|||
#define DEFAULT_MAX_SSE_CLIENTS 4 |
|||
#endif |
|||
|
|||
class AsyncEventSource; |
|||
class AsyncEventSourceResponse; |
|||
class AsyncEventSourceClient; |
|||
typedef std::function<void(AsyncEventSourceClient *client)> ArEventHandlerFunction; |
|||
|
|||
class AsyncEventSourceMessage { |
|||
private: |
|||
uint8_t * _data; |
|||
size_t _len; |
|||
size_t _sent; |
|||
//size_t _ack;
|
|||
size_t _acked; |
|||
public: |
|||
AsyncEventSourceMessage(const char * data, size_t len); |
|||
~AsyncEventSourceMessage(); |
|||
size_t ack(size_t len, uint32_t time __attribute__((unused))); |
|||
size_t send(AsyncClient *client); |
|||
bool finished(){ return _acked == _len; } |
|||
bool sent() { return _sent == _len; } |
|||
}; |
|||
|
|||
class AsyncEventSourceClient { |
|||
private: |
|||
AsyncClient *_client; |
|||
AsyncEventSource *_server; |
|||
uint32_t _lastId; |
|||
LinkedList<AsyncEventSourceMessage *> _messageQueue; |
|||
void _queueMessage(AsyncEventSourceMessage *dataMessage); |
|||
void _runQueue(); |
|||
|
|||
public: |
|||
|
|||
AsyncEventSourceClient(AsyncWebServerRequest *request, AsyncEventSource *server); |
|||
~AsyncEventSourceClient(); |
|||
|
|||
AsyncClient* client(){ return _client; } |
|||
void close(); |
|||
void write(const char * message, size_t len); |
|||
void send(const char *message, const char *event=NULL, uint32_t id=0, uint32_t reconnect=0); |
|||
bool connected() const { return (_client != NULL) && _client->connected(); } |
|||
uint32_t lastId() const { return _lastId; } |
|||
size_t packetsWaiting() const { return _messageQueue.length(); } |
|||
|
|||
//system callbacks (do not call)
|
|||
void _onAck(size_t len, uint32_t time); |
|||
void _onPoll(); |
|||
void _onTimeout(uint32_t time); |
|||
void _onDisconnect(); |
|||
}; |
|||
|
|||
class AsyncEventSource: public AsyncWebHandler { |
|||
private: |
|||
String _url; |
|||
LinkedList<AsyncEventSourceClient *> _clients; |
|||
ArEventHandlerFunction _connectcb; |
|||
public: |
|||
AsyncEventSource(const String& url); |
|||
~AsyncEventSource(); |
|||
|
|||
const char * url() const { return _url.c_str(); } |
|||
void close(); |
|||
void onConnect(ArEventHandlerFunction cb); |
|||
void send(const char *message, const char *event=NULL, uint32_t id=0, uint32_t reconnect=0); |
|||
size_t count() const; //number clinets connected
|
|||
size_t avgPacketsWaiting() const; |
|||
|
|||
//system callbacks (do not call)
|
|||
void _addClient(AsyncEventSourceClient * client); |
|||
void _handleDisconnect(AsyncEventSourceClient * client); |
|||
virtual bool canHandle(AsyncWebServerRequest *request) override final; |
|||
virtual void handleRequest(AsyncWebServerRequest *request) override final; |
|||
}; |
|||
|
|||
class AsyncEventSourceResponse: public AsyncWebServerResponse { |
|||
private: |
|||
String _content; |
|||
AsyncEventSource *_server; |
|||
public: |
|||
AsyncEventSourceResponse(AsyncEventSource *server); |
|||
void _respond(AsyncWebServerRequest *request); |
|||
size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); |
|||
bool _sourceValid() const { return true; } |
|||
}; |
|||
|
|||
|
|||
#endif /* ASYNCEVENTSOURCE_H_ */ |
|||
@ -0,0 +1,252 @@ |
|||
// AsyncJson.h
|
|||
/*
|
|||
Async Response to use with ArduinoJson and AsyncWebServer |
|||
Written by Andrew Melvin (SticilFace) with help from me-no-dev and BBlanchon. |
|||
|
|||
Example of callback in use |
|||
|
|||
server.on("/json", HTTP_ANY, [](AsyncWebServerRequest * request) { |
|||
|
|||
AsyncJsonResponse * response = new AsyncJsonResponse(); |
|||
JsonObject& root = response->getRoot(); |
|||
root["key1"] = "key number one"; |
|||
JsonObject& nested = root.createNestedObject("nested"); |
|||
nested["key1"] = "key number one"; |
|||
|
|||
response->setLength(); |
|||
request->send(response); |
|||
}); |
|||
|
|||
-------------------- |
|||
|
|||
Async Request to use with ArduinoJson and AsyncWebServer |
|||
Written by Arsène von Wyss (avonwyss) |
|||
|
|||
Example |
|||
|
|||
AsyncCallbackJsonWebHandler* handler = new AsyncCallbackJsonWebHandler("/rest/endpoint"); |
|||
handler->onRequest([](AsyncWebServerRequest *request, JsonVariant &json) { |
|||
JsonObject& jsonObj = json.as<JsonObject>(); |
|||
// ...
|
|||
}); |
|||
server.addHandler(handler); |
|||
|
|||
*/ |
|||
#ifndef ASYNC_JSON_H_ |
|||
#define ASYNC_JSON_H_ |
|||
#include <ArduinoJson.h> |
|||
#include <ESPAsyncWebServer.h> |
|||
#include <Print.h> |
|||
|
|||
#if ARDUINOJSON_VERSION_MAJOR == 5 |
|||
#define ARDUINOJSON_5_COMPATIBILITY |
|||
#else |
|||
#define DYNAMIC_JSON_DOCUMENT_SIZE 1024 |
|||
#endif |
|||
|
|||
constexpr const char* JSON_MIMETYPE = "application/json"; |
|||
|
|||
/*
|
|||
* Json Response |
|||
* */ |
|||
|
|||
class ChunkPrint : public Print { |
|||
private: |
|||
uint8_t* _destination; |
|||
size_t _to_skip; |
|||
size_t _to_write; |
|||
size_t _pos; |
|||
public: |
|||
ChunkPrint(uint8_t* destination, size_t from, size_t len) |
|||
: _destination(destination), _to_skip(from), _to_write(len), _pos{0} {} |
|||
virtual ~ChunkPrint(){} |
|||
size_t write(uint8_t c){ |
|||
if (_to_skip > 0) { |
|||
_to_skip--; |
|||
return 1; |
|||
} else if (_to_write > 0) { |
|||
_to_write--; |
|||
_destination[_pos++] = c; |
|||
return 1; |
|||
} |
|||
return 0; |
|||
} |
|||
size_t write(const uint8_t *buffer, size_t size) |
|||
{ |
|||
return this->Print::write(buffer, size); |
|||
} |
|||
}; |
|||
|
|||
class AsyncJsonResponse: public AsyncAbstractResponse { |
|||
protected: |
|||
|
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
DynamicJsonBuffer _jsonBuffer; |
|||
#else |
|||
DynamicJsonDocument _jsonBuffer; |
|||
#endif |
|||
|
|||
JsonVariant _root; |
|||
bool _isValid; |
|||
|
|||
public: |
|||
|
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
AsyncJsonResponse(bool isArray=false): _isValid{false} { |
|||
_code = 200; |
|||
_contentType = JSON_MIMETYPE; |
|||
if(isArray) |
|||
_root = _jsonBuffer.createArray(); |
|||
else |
|||
_root = _jsonBuffer.createObject(); |
|||
} |
|||
#else |
|||
AsyncJsonResponse(bool isArray=false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE) : _jsonBuffer(maxJsonBufferSize), _isValid{false} { |
|||
_code = 200; |
|||
_contentType = JSON_MIMETYPE; |
|||
if(isArray) |
|||
_root = _jsonBuffer.createNestedArray(); |
|||
else |
|||
_root = _jsonBuffer.createNestedObject(); |
|||
} |
|||
#endif |
|||
|
|||
~AsyncJsonResponse() {} |
|||
JsonVariant & getRoot() { return _root; } |
|||
bool _sourceValid() const { return _isValid; } |
|||
size_t setLength() { |
|||
|
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
_contentLength = _root.measureLength(); |
|||
#else |
|||
_contentLength = measureJson(_root); |
|||
#endif |
|||
|
|||
if (_contentLength) { _isValid = true; } |
|||
return _contentLength; |
|||
} |
|||
|
|||
size_t getSize() { return _jsonBuffer.size(); } |
|||
|
|||
size_t _fillBuffer(uint8_t *data, size_t len){ |
|||
ChunkPrint dest(data, _sentLength, len); |
|||
|
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
_root.printTo( dest ) ; |
|||
#else |
|||
serializeJson(_root, dest); |
|||
#endif |
|||
return len; |
|||
} |
|||
}; |
|||
|
|||
class PrettyAsyncJsonResponse: public AsyncJsonResponse { |
|||
public: |
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
PrettyAsyncJsonResponse (bool isArray=false) : AsyncJsonResponse{isArray} {} |
|||
#else |
|||
PrettyAsyncJsonResponse (bool isArray=false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE) : AsyncJsonResponse{isArray, maxJsonBufferSize} {} |
|||
#endif |
|||
size_t setLength () { |
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
_contentLength = _root.measurePrettyLength (); |
|||
#else |
|||
_contentLength = measureJsonPretty(_root); |
|||
#endif |
|||
if (_contentLength) {_isValid = true;} |
|||
return _contentLength; |
|||
} |
|||
size_t _fillBuffer (uint8_t *data, size_t len) { |
|||
ChunkPrint dest (data, _sentLength, len); |
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
_root.prettyPrintTo (dest); |
|||
#else |
|||
serializeJsonPretty(_root, dest); |
|||
#endif |
|||
return len; |
|||
} |
|||
}; |
|||
|
|||
typedef std::function<void(AsyncWebServerRequest *request, JsonVariant &json)> ArJsonRequestHandlerFunction; |
|||
|
|||
class AsyncCallbackJsonWebHandler: public AsyncWebHandler { |
|||
private: |
|||
protected: |
|||
const String _uri; |
|||
WebRequestMethodComposite _method; |
|||
ArJsonRequestHandlerFunction _onRequest; |
|||
size_t _contentLength; |
|||
#ifndef ARDUINOJSON_5_COMPATIBILITY |
|||
const size_t maxJsonBufferSize; |
|||
#endif |
|||
size_t _maxContentLength; |
|||
public: |
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest) |
|||
: _uri(uri), _method(HTTP_POST|HTTP_PUT|HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} |
|||
#else |
|||
AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest, size_t maxJsonBufferSize=DYNAMIC_JSON_DOCUMENT_SIZE) |
|||
: _uri(uri), _method(HTTP_POST|HTTP_PUT|HTTP_PATCH), _onRequest(onRequest), maxJsonBufferSize(maxJsonBufferSize), _maxContentLength(16384) {} |
|||
#endif |
|||
|
|||
void setMethod(WebRequestMethodComposite method){ _method = method; } |
|||
void setMaxContentLength(int maxContentLength){ _maxContentLength = maxContentLength; } |
|||
void onRequest(ArJsonRequestHandlerFunction fn){ _onRequest = fn; } |
|||
|
|||
virtual bool canHandle(AsyncWebServerRequest *request) override final{ |
|||
if(!_onRequest) |
|||
return false; |
|||
|
|||
if(!(_method & request->method())) |
|||
return false; |
|||
|
|||
if(_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri+"/"))) |
|||
return false; |
|||
|
|||
if ( !request->contentType().equalsIgnoreCase(JSON_MIMETYPE) ) |
|||
return false; |
|||
|
|||
request->addInterestingHeader("ANY"); |
|||
return true; |
|||
} |
|||
|
|||
virtual void handleRequest(AsyncWebServerRequest *request) override final { |
|||
if(_onRequest) { |
|||
if (request->_tempObject != NULL) { |
|||
|
|||
#ifdef ARDUINOJSON_5_COMPATIBILITY |
|||
DynamicJsonBuffer jsonBuffer; |
|||
JsonVariant json = jsonBuffer.parse((uint8_t*)(request->_tempObject)); |
|||
if (json.success()) { |
|||
#else |
|||
DynamicJsonDocument jsonBuffer(this->maxJsonBufferSize); |
|||
DeserializationError error = deserializeJson(jsonBuffer, (uint8_t*)(request->_tempObject)); |
|||
if(!error) { |
|||
JsonVariant json = jsonBuffer.as<JsonVariant>(); |
|||
#endif |
|||
|
|||
_onRequest(request, json); |
|||
return; |
|||
} |
|||
} |
|||
request->send(_contentLength > _maxContentLength ? 413 : 400); |
|||
} else { |
|||
request->send(500); |
|||
} |
|||
} |
|||
virtual void handleUpload(AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final) override final { |
|||
} |
|||
virtual void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) override final { |
|||
if (_onRequest) { |
|||
_contentLength = total; |
|||
if (total > 0 && request->_tempObject == NULL && total < _maxContentLength) { |
|||
request->_tempObject = malloc(total); |
|||
} |
|||
if (request->_tempObject != NULL) { |
|||
memcpy((uint8_t*)(request->_tempObject) + index, data, len); |
|||
} |
|||
} |
|||
} |
|||
virtual bool isRequestHandlerTrivial() override final {return _onRequest ? false : true;} |
|||
}; |
|||
#endif |
|||
File diff suppressed because it is too large
@ -0,0 +1,350 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#ifndef ASYNCWEBSOCKET_H_ |
|||
#define ASYNCWEBSOCKET_H_ |
|||
|
|||
#include <Arduino.h> |
|||
#ifdef ESP32 |
|||
#include <AsyncTCP.h> |
|||
#define WS_MAX_QUEUED_MESSAGES 32 |
|||
#else |
|||
#include <ESPAsyncTCP.h> |
|||
#define WS_MAX_QUEUED_MESSAGES 8 |
|||
#endif |
|||
#include <ESPAsyncWebServer.h> |
|||
|
|||
#include "AsyncWebSynchronization.h" |
|||
|
|||
#ifdef ESP8266 |
|||
#include <Hash.h> |
|||
#ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library
|
|||
#include <../src/Hash.h> |
|||
#endif |
|||
#endif |
|||
|
|||
#ifdef ESP32 |
|||
#define DEFAULT_MAX_WS_CLIENTS 8 |
|||
#else |
|||
#define DEFAULT_MAX_WS_CLIENTS 4 |
|||
#endif |
|||
|
|||
class AsyncWebSocket; |
|||
class AsyncWebSocketResponse; |
|||
class AsyncWebSocketClient; |
|||
class AsyncWebSocketControl; |
|||
|
|||
typedef struct { |
|||
/** Message type as defined by enum AwsFrameType.
|
|||
* Note: Applications will only see WS_TEXT and WS_BINARY. |
|||
* All other types are handled by the library. */ |
|||
uint8_t message_opcode; |
|||
/** Frame number of a fragmented message. */ |
|||
uint32_t num; |
|||
/** Is this the last frame in a fragmented message ?*/ |
|||
uint8_t final; |
|||
/** Is this frame masked? */ |
|||
uint8_t masked; |
|||
/** Message type as defined by enum AwsFrameType.
|
|||
* This value is the same as message_opcode for non-fragmented |
|||
* messages, but may also be WS_CONTINUATION in a fragmented message. */ |
|||
uint8_t opcode; |
|||
/** Length of the current frame.
|
|||
* This equals the total length of the message if num == 0 && final == true */ |
|||
uint64_t len; |
|||
/** Mask key */ |
|||
uint8_t mask[4]; |
|||
/** Offset of the data inside the current frame. */ |
|||
uint64_t index; |
|||
} AwsFrameInfo; |
|||
|
|||
typedef enum { WS_DISCONNECTED, WS_CONNECTED, WS_DISCONNECTING } AwsClientStatus; |
|||
typedef enum { WS_CONTINUATION, WS_TEXT, WS_BINARY, WS_DISCONNECT = 0x08, WS_PING, WS_PONG } AwsFrameType; |
|||
typedef enum { WS_MSG_SENDING, WS_MSG_SENT, WS_MSG_ERROR } AwsMessageStatus; |
|||
typedef enum { WS_EVT_CONNECT, WS_EVT_DISCONNECT, WS_EVT_PONG, WS_EVT_ERROR, WS_EVT_DATA } AwsEventType; |
|||
|
|||
class AsyncWebSocketMessageBuffer { |
|||
private: |
|||
uint8_t * _data; |
|||
size_t _len; |
|||
bool _lock; |
|||
uint32_t _count; |
|||
|
|||
public: |
|||
AsyncWebSocketMessageBuffer(); |
|||
AsyncWebSocketMessageBuffer(size_t size); |
|||
AsyncWebSocketMessageBuffer(uint8_t * data, size_t size); |
|||
AsyncWebSocketMessageBuffer(const AsyncWebSocketMessageBuffer &); |
|||
AsyncWebSocketMessageBuffer(AsyncWebSocketMessageBuffer &&); |
|||
~AsyncWebSocketMessageBuffer(); |
|||
void operator ++(int i) { (void)i; _count++; } |
|||
void operator --(int i) { (void)i; if (_count > 0) { _count--; } ; } |
|||
bool reserve(size_t size); |
|||
void lock() { _lock = true; } |
|||
void unlock() { _lock = false; } |
|||
uint8_t * get() { return _data; } |
|||
size_t length() { return _len; } |
|||
uint32_t count() { return _count; } |
|||
bool canDelete() { return (!_count && !_lock); } |
|||
|
|||
friend AsyncWebSocket; |
|||
|
|||
}; |
|||
|
|||
class AsyncWebSocketMessage { |
|||
protected: |
|||
uint8_t _opcode; |
|||
bool _mask; |
|||
AwsMessageStatus _status; |
|||
public: |
|||
AsyncWebSocketMessage():_opcode(WS_TEXT),_mask(false),_status(WS_MSG_ERROR){} |
|||
virtual ~AsyncWebSocketMessage(){} |
|||
virtual void ack(size_t len __attribute__((unused)), uint32_t time __attribute__((unused))){} |
|||
virtual size_t send(AsyncClient *client __attribute__((unused))){ return 0; } |
|||
virtual bool finished(){ return _status != WS_MSG_SENDING; } |
|||
virtual bool betweenFrames() const { return false; } |
|||
}; |
|||
|
|||
class AsyncWebSocketBasicMessage: public AsyncWebSocketMessage { |
|||
private: |
|||
size_t _len; |
|||
size_t _sent; |
|||
size_t _ack; |
|||
size_t _acked; |
|||
uint8_t * _data; |
|||
public: |
|||
AsyncWebSocketBasicMessage(const char * data, size_t len, uint8_t opcode=WS_TEXT, bool mask=false); |
|||
AsyncWebSocketBasicMessage(uint8_t opcode=WS_TEXT, bool mask=false); |
|||
virtual ~AsyncWebSocketBasicMessage() override; |
|||
virtual bool betweenFrames() const override { return _acked == _ack; } |
|||
virtual void ack(size_t len, uint32_t time) override ; |
|||
virtual size_t send(AsyncClient *client) override ; |
|||
}; |
|||
|
|||
class AsyncWebSocketMultiMessage: public AsyncWebSocketMessage { |
|||
private: |
|||
uint8_t * _data; |
|||
size_t _len; |
|||
size_t _sent; |
|||
size_t _ack; |
|||
size_t _acked; |
|||
AsyncWebSocketMessageBuffer * _WSbuffer; |
|||
public: |
|||
AsyncWebSocketMultiMessage(AsyncWebSocketMessageBuffer * buffer, uint8_t opcode=WS_TEXT, bool mask=false); |
|||
virtual ~AsyncWebSocketMultiMessage() override; |
|||
virtual bool betweenFrames() const override { return _acked == _ack; } |
|||
virtual void ack(size_t len, uint32_t time) override ; |
|||
virtual size_t send(AsyncClient *client) override ; |
|||
}; |
|||
|
|||
class AsyncWebSocketClient { |
|||
private: |
|||
AsyncClient *_client; |
|||
AsyncWebSocket *_server; |
|||
uint32_t _clientId; |
|||
AwsClientStatus _status; |
|||
|
|||
LinkedList<AsyncWebSocketControl *> _controlQueue; |
|||
LinkedList<AsyncWebSocketMessage *> _messageQueue; |
|||
|
|||
uint8_t _pstate; |
|||
AwsFrameInfo _pinfo; |
|||
|
|||
uint32_t _lastMessageTime; |
|||
uint32_t _keepAlivePeriod; |
|||
|
|||
void _queueMessage(AsyncWebSocketMessage *dataMessage); |
|||
void _queueControl(AsyncWebSocketControl *controlMessage); |
|||
void _runQueue(); |
|||
|
|||
public: |
|||
void *_tempObject; |
|||
|
|||
AsyncWebSocketClient(AsyncWebServerRequest *request, AsyncWebSocket *server); |
|||
~AsyncWebSocketClient(); |
|||
|
|||
//client id increments for the given server
|
|||
uint32_t id(){ return _clientId; } |
|||
AwsClientStatus status(){ return _status; } |
|||
AsyncClient* client(){ return _client; } |
|||
AsyncWebSocket *server(){ return _server; } |
|||
AwsFrameInfo const &pinfo() const { return _pinfo; } |
|||
|
|||
IPAddress remoteIP(); |
|||
uint16_t remotePort(); |
|||
|
|||
//control frames
|
|||
void close(uint16_t code=0, const char * message=NULL); |
|||
void ping(uint8_t *data=NULL, size_t len=0); |
|||
|
|||
//set auto-ping period in seconds. disabled if zero (default)
|
|||
void keepAlivePeriod(uint16_t seconds){ |
|||
_keepAlivePeriod = seconds * 1000; |
|||
} |
|||
uint16_t keepAlivePeriod(){ |
|||
return (uint16_t)(_keepAlivePeriod / 1000); |
|||
} |
|||
|
|||
//data packets
|
|||
void message(AsyncWebSocketMessage *message){ _queueMessage(message); } |
|||
bool queueIsFull(); |
|||
|
|||
size_t printf(const char *format, ...) __attribute__ ((format (printf, 2, 3))); |
|||
#ifndef ESP32 |
|||
size_t printf_P(PGM_P formatP, ...) __attribute__ ((format (printf, 2, 3))); |
|||
#endif |
|||
void text(const char * message, size_t len); |
|||
void text(const char * message); |
|||
void text(uint8_t * message, size_t len); |
|||
void text(char * message); |
|||
void text(const String &message); |
|||
void text(const __FlashStringHelper *data); |
|||
void text(AsyncWebSocketMessageBuffer *buffer); |
|||
|
|||
void binary(const char * message, size_t len); |
|||
void binary(const char * message); |
|||
void binary(uint8_t * message, size_t len); |
|||
void binary(char * message); |
|||
void binary(const String &message); |
|||
void binary(const __FlashStringHelper *data, size_t len); |
|||
void binary(AsyncWebSocketMessageBuffer *buffer); |
|||
|
|||
bool canSend() { return _messageQueue.length() < WS_MAX_QUEUED_MESSAGES; } |
|||
|
|||
//system callbacks (do not call)
|
|||
void _onAck(size_t len, uint32_t time); |
|||
void _onError(int8_t); |
|||
void _onPoll(); |
|||
void _onTimeout(uint32_t time); |
|||
void _onDisconnect(); |
|||
void _onData(void *pbuf, size_t plen); |
|||
}; |
|||
|
|||
typedef std::function<void(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len)> AwsEventHandler; |
|||
|
|||
//WebServer Handler implementation that plays the role of a socket server
|
|||
class AsyncWebSocket: public AsyncWebHandler { |
|||
public: |
|||
typedef LinkedList<AsyncWebSocketClient *> AsyncWebSocketClientLinkedList; |
|||
private: |
|||
String _url; |
|||
AsyncWebSocketClientLinkedList _clients; |
|||
uint32_t _cNextId; |
|||
AwsEventHandler _eventHandler; |
|||
bool _enabled; |
|||
AsyncWebLock _lock; |
|||
|
|||
public: |
|||
AsyncWebSocket(const String& url); |
|||
~AsyncWebSocket(); |
|||
const char * url() const { return _url.c_str(); } |
|||
void enable(bool e){ _enabled = e; } |
|||
bool enabled() const { return _enabled; } |
|||
bool availableForWriteAll(); |
|||
bool availableForWrite(uint32_t id); |
|||
|
|||
size_t count() const; |
|||
AsyncWebSocketClient * client(uint32_t id); |
|||
bool hasClient(uint32_t id){ return client(id) != NULL; } |
|||
|
|||
void close(uint32_t id, uint16_t code=0, const char * message=NULL); |
|||
void closeAll(uint16_t code=0, const char * message=NULL); |
|||
void cleanupClients(uint16_t maxClients = DEFAULT_MAX_WS_CLIENTS); |
|||
|
|||
void ping(uint32_t id, uint8_t *data=NULL, size_t len=0); |
|||
void pingAll(uint8_t *data=NULL, size_t len=0); // done
|
|||
|
|||
void text(uint32_t id, const char * message, size_t len); |
|||
void text(uint32_t id, const char * message); |
|||
void text(uint32_t id, uint8_t * message, size_t len); |
|||
void text(uint32_t id, char * message); |
|||
void text(uint32_t id, const String &message); |
|||
void text(uint32_t id, const __FlashStringHelper *message); |
|||
|
|||
void textAll(const char * message, size_t len); |
|||
void textAll(const char * message); |
|||
void textAll(uint8_t * message, size_t len); |
|||
void textAll(char * message); |
|||
void textAll(const String &message); |
|||
void textAll(const __FlashStringHelper *message); // need to convert
|
|||
void textAll(AsyncWebSocketMessageBuffer * buffer); |
|||
|
|||
void binary(uint32_t id, const char * message, size_t len); |
|||
void binary(uint32_t id, const char * message); |
|||
void binary(uint32_t id, uint8_t * message, size_t len); |
|||
void binary(uint32_t id, char * message); |
|||
void binary(uint32_t id, const String &message); |
|||
void binary(uint32_t id, const __FlashStringHelper *message, size_t len); |
|||
|
|||
void binaryAll(const char * message, size_t len); |
|||
void binaryAll(const char * message); |
|||
void binaryAll(uint8_t * message, size_t len); |
|||
void binaryAll(char * message); |
|||
void binaryAll(const String &message); |
|||
void binaryAll(const __FlashStringHelper *message, size_t len); |
|||
void binaryAll(AsyncWebSocketMessageBuffer * buffer); |
|||
|
|||
void message(uint32_t id, AsyncWebSocketMessage *message); |
|||
void messageAll(AsyncWebSocketMultiMessage *message); |
|||
|
|||
size_t printf(uint32_t id, const char *format, ...) __attribute__ ((format (printf, 3, 4))); |
|||
size_t printfAll(const char *format, ...) __attribute__ ((format (printf, 2, 3))); |
|||
#ifndef ESP32 |
|||
size_t printf_P(uint32_t id, PGM_P formatP, ...) __attribute__ ((format (printf, 3, 4))); |
|||
#endif |
|||
size_t printfAll_P(PGM_P formatP, ...) __attribute__ ((format (printf, 2, 3))); |
|||
|
|||
//event listener
|
|||
void onEvent(AwsEventHandler handler){ |
|||
_eventHandler = handler; |
|||
} |
|||
|
|||
//system callbacks (do not call)
|
|||
uint32_t _getNextId(){ return _cNextId++; } |
|||
void _addClient(AsyncWebSocketClient * client); |
|||
void _handleDisconnect(AsyncWebSocketClient * client); |
|||
void _handleEvent(AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len); |
|||
virtual bool canHandle(AsyncWebServerRequest *request) override final; |
|||
virtual void handleRequest(AsyncWebServerRequest *request) override final; |
|||
|
|||
|
|||
// messagebuffer functions/objects.
|
|||
AsyncWebSocketMessageBuffer * makeBuffer(size_t size = 0); |
|||
AsyncWebSocketMessageBuffer * makeBuffer(uint8_t * data, size_t size); |
|||
LinkedList<AsyncWebSocketMessageBuffer *> _buffers; |
|||
void _cleanBuffers(); |
|||
|
|||
AsyncWebSocketClientLinkedList getClients() const; |
|||
}; |
|||
|
|||
//WebServer response to authenticate the socket and detach the tcp client from the web server request
|
|||
class AsyncWebSocketResponse: public AsyncWebServerResponse { |
|||
private: |
|||
String _content; |
|||
AsyncWebSocket *_server; |
|||
public: |
|||
AsyncWebSocketResponse(const String& key, AsyncWebSocket *server); |
|||
void _respond(AsyncWebServerRequest *request); |
|||
size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); |
|||
bool _sourceValid() const { return true; } |
|||
}; |
|||
|
|||
|
|||
#endif /* ASYNCWEBSOCKET_H_ */ |
|||
@ -0,0 +1,87 @@ |
|||
#ifndef ASYNCWEBSYNCHRONIZATION_H_ |
|||
#define ASYNCWEBSYNCHRONIZATION_H_ |
|||
|
|||
// Synchronisation is only available on ESP32, as the ESP8266 isn't using FreeRTOS by default
|
|||
|
|||
#include <ESPAsyncWebServer.h> |
|||
|
|||
#ifdef ESP32 |
|||
|
|||
// This is the ESP32 version of the Sync Lock, using the FreeRTOS Semaphore
|
|||
class AsyncWebLock |
|||
{ |
|||
private: |
|||
SemaphoreHandle_t _lock; |
|||
mutable void *_lockedBy; |
|||
|
|||
public: |
|||
AsyncWebLock() { |
|||
_lock = xSemaphoreCreateBinary(); |
|||
_lockedBy = NULL; |
|||
xSemaphoreGive(_lock); |
|||
} |
|||
|
|||
~AsyncWebLock() { |
|||
vSemaphoreDelete(_lock); |
|||
} |
|||
|
|||
bool lock() const { |
|||
extern void *pxCurrentTCB; |
|||
if (_lockedBy != pxCurrentTCB) { |
|||
xSemaphoreTake(_lock, portMAX_DELAY); |
|||
_lockedBy = pxCurrentTCB; |
|||
return true; |
|||
} |
|||
return false; |
|||
} |
|||
|
|||
void unlock() const { |
|||
_lockedBy = NULL; |
|||
xSemaphoreGive(_lock); |
|||
} |
|||
}; |
|||
|
|||
#else |
|||
|
|||
// This is the 8266 version of the Sync Lock which is currently unimplemented
|
|||
class AsyncWebLock |
|||
{ |
|||
|
|||
public: |
|||
AsyncWebLock() { |
|||
} |
|||
|
|||
~AsyncWebLock() { |
|||
} |
|||
|
|||
bool lock() const { |
|||
return false; |
|||
} |
|||
|
|||
void unlock() const { |
|||
} |
|||
}; |
|||
#endif |
|||
|
|||
class AsyncWebLockGuard |
|||
{ |
|||
private: |
|||
const AsyncWebLock *_lock; |
|||
|
|||
public: |
|||
AsyncWebLockGuard(const AsyncWebLock &l) { |
|||
if (l.lock()) { |
|||
_lock = &l; |
|||
} else { |
|||
_lock = NULL; |
|||
} |
|||
} |
|||
|
|||
~AsyncWebLockGuard() { |
|||
if (_lock) { |
|||
_lock->unlock(); |
|||
} |
|||
} |
|||
}; |
|||
|
|||
#endif // ASYNCWEBSYNCHRONIZATION_H_
|
|||
@ -0,0 +1,471 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#ifndef _ESPAsyncWebServer_H_ |
|||
#define _ESPAsyncWebServer_H_ |
|||
|
|||
#include "Arduino.h" |
|||
|
|||
#include <functional> |
|||
#include "FS.h" |
|||
|
|||
#include "StringArray.h" |
|||
|
|||
#ifdef ESP32 |
|||
#include <WiFi.h> |
|||
#include <AsyncTCP.h> |
|||
#elif defined(ESP8266) |
|||
#include <ESP8266WiFi.h> |
|||
#include <ESPAsyncTCP.h> |
|||
#else |
|||
#error Platform not supported |
|||
#endif |
|||
|
|||
#ifdef ASYNCWEBSERVER_REGEX |
|||
#define ASYNCWEBSERVER_REGEX_ATTRIBUTE |
|||
#else |
|||
#define ASYNCWEBSERVER_REGEX_ATTRIBUTE __attribute__((warning("ASYNCWEBSERVER_REGEX not defined"))) |
|||
#endif |
|||
|
|||
#define DEBUGF(...) //Serial.printf(__VA_ARGS__)
|
|||
|
|||
class AsyncWebServer; |
|||
class AsyncWebServerRequest; |
|||
class AsyncWebServerResponse; |
|||
class AsyncWebHeader; |
|||
class AsyncWebParameter; |
|||
class AsyncWebRewrite; |
|||
class AsyncWebHandler; |
|||
class AsyncStaticWebHandler; |
|||
class AsyncCallbackWebHandler; |
|||
class AsyncResponseStream; |
|||
|
|||
#ifndef WEBSERVER_H |
|||
typedef enum { |
|||
HTTP_GET = 0b00000001, |
|||
HTTP_POST = 0b00000010, |
|||
HTTP_DELETE = 0b00000100, |
|||
HTTP_PUT = 0b00001000, |
|||
HTTP_PATCH = 0b00010000, |
|||
HTTP_HEAD = 0b00100000, |
|||
HTTP_OPTIONS = 0b01000000, |
|||
HTTP_ANY = 0b01111111, |
|||
} WebRequestMethod; |
|||
#endif |
|||
|
|||
//if this value is returned when asked for data, packet will not be sent and you will be asked for data again
|
|||
#define RESPONSE_TRY_AGAIN 0xFFFFFFFF |
|||
|
|||
typedef uint8_t WebRequestMethodComposite; |
|||
typedef std::function<void(void)> ArDisconnectHandler; |
|||
|
|||
/*
|
|||
* PARAMETER :: Chainable object to hold GET/POST and FILE parameters |
|||
* */ |
|||
|
|||
class AsyncWebParameter { |
|||
private: |
|||
String _name; |
|||
String _value; |
|||
size_t _size; |
|||
bool _isForm; |
|||
bool _isFile; |
|||
|
|||
public: |
|||
|
|||
AsyncWebParameter(const String& name, const String& value, bool form=false, bool file=false, size_t size=0): _name(name), _value(value), _size(size), _isForm(form), _isFile(file){} |
|||
const String& name() const { return _name; } |
|||
const String& value() const { return _value; } |
|||
size_t size() const { return _size; } |
|||
bool isPost() const { return _isForm; } |
|||
bool isFile() const { return _isFile; } |
|||
}; |
|||
|
|||
/*
|
|||
* HEADER :: Chainable object to hold the headers |
|||
* */ |
|||
|
|||
class AsyncWebHeader { |
|||
private: |
|||
String _name; |
|||
String _value; |
|||
|
|||
public: |
|||
AsyncWebHeader(const String& name, const String& value): _name(name), _value(value){} |
|||
AsyncWebHeader(const String& data): _name(), _value(){ |
|||
if(!data) return; |
|||
int index = data.indexOf(':'); |
|||
if (index < 0) return; |
|||
_name = data.substring(0, index); |
|||
_value = data.substring(index + 2); |
|||
} |
|||
~AsyncWebHeader(){} |
|||
const String& name() const { return _name; } |
|||
const String& value() const { return _value; } |
|||
String toString() const { return String(_name+": "+_value+"\r\n"); } |
|||
}; |
|||
|
|||
/*
|
|||
* REQUEST :: Each incoming Client is wrapped inside a Request and both live together until disconnect |
|||
* */ |
|||
|
|||
typedef enum { RCT_NOT_USED = -1, RCT_DEFAULT = 0, RCT_HTTP, RCT_WS, RCT_EVENT, RCT_MAX } RequestedConnectionType; |
|||
|
|||
typedef std::function<size_t(uint8_t*, size_t, size_t)> AwsResponseFiller; |
|||
typedef std::function<String(const String&)> AwsTemplateProcessor; |
|||
|
|||
class AsyncWebServerRequest { |
|||
using File = fs::File; |
|||
using FS = fs::FS; |
|||
friend class AsyncWebServer; |
|||
friend class AsyncCallbackWebHandler; |
|||
private: |
|||
AsyncClient* _client; |
|||
AsyncWebServer* _server; |
|||
AsyncWebHandler* _handler; |
|||
AsyncWebServerResponse* _response; |
|||
StringArray _interestingHeaders; |
|||
ArDisconnectHandler _onDisconnectfn; |
|||
|
|||
String _temp; |
|||
uint8_t _parseState; |
|||
|
|||
uint8_t _version; |
|||
WebRequestMethodComposite _method; |
|||
String _url; |
|||
String _host; |
|||
String _contentType; |
|||
String _boundary; |
|||
String _authorization; |
|||
RequestedConnectionType _reqconntype; |
|||
void _removeNotInterestingHeaders(); |
|||
bool _isDigest; |
|||
bool _isMultipart; |
|||
bool _isPlainPost; |
|||
bool _expectingContinue; |
|||
size_t _contentLength; |
|||
size_t _parsedLength; |
|||
|
|||
LinkedList<AsyncWebHeader *> _headers; |
|||
LinkedList<AsyncWebParameter *> _params; |
|||
LinkedList<String *> _pathParams; |
|||
|
|||
uint8_t _multiParseState; |
|||
uint8_t _boundaryPosition; |
|||
size_t _itemStartIndex; |
|||
size_t _itemSize; |
|||
String _itemName; |
|||
String _itemFilename; |
|||
String _itemType; |
|||
String _itemValue; |
|||
uint8_t *_itemBuffer; |
|||
size_t _itemBufferIndex; |
|||
bool _itemIsFile; |
|||
|
|||
void _onPoll(); |
|||
void _onAck(size_t len, uint32_t time); |
|||
void _onError(int8_t error); |
|||
void _onTimeout(uint32_t time); |
|||
void _onDisconnect(); |
|||
void _onData(void *buf, size_t len); |
|||
|
|||
void _addParam(AsyncWebParameter*); |
|||
void _addPathParam(const char *param); |
|||
|
|||
bool _parseReqHead(); |
|||
bool _parseReqHeader(); |
|||
void _parseLine(); |
|||
void _parsePlainPostChar(uint8_t data); |
|||
void _parseMultipartPostByte(uint8_t data, bool last); |
|||
void _addGetParams(const String& params); |
|||
|
|||
void _handleUploadStart(); |
|||
void _handleUploadByte(uint8_t data, bool last); |
|||
void _handleUploadEnd(); |
|||
|
|||
public: |
|||
File _tempFile; |
|||
void *_tempObject; |
|||
|
|||
AsyncWebServerRequest(AsyncWebServer*, AsyncClient*); |
|||
~AsyncWebServerRequest(); |
|||
|
|||
AsyncClient* client(){ return _client; } |
|||
uint8_t version() const { return _version; } |
|||
WebRequestMethodComposite method() const { return _method; } |
|||
const String& url() const { return _url; } |
|||
const String& host() const { return _host; } |
|||
const String& contentType() const { return _contentType; } |
|||
size_t contentLength() const { return _contentLength; } |
|||
bool multipart() const { return _isMultipart; } |
|||
const char * methodToString() const; |
|||
const char * requestedConnTypeToString() const; |
|||
RequestedConnectionType requestedConnType() const { return _reqconntype; } |
|||
bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED); |
|||
void onDisconnect (ArDisconnectHandler fn); |
|||
|
|||
//hash is the string representation of:
|
|||
// base64(user:pass) for basic or
|
|||
// user:realm:md5(user:realm:pass) for digest
|
|||
bool authenticate(const char * hash); |
|||
bool authenticate(const char * username, const char * password, const char * realm = NULL, bool passwordIsHash = false); |
|||
void requestAuthentication(const char * realm = NULL, bool isDigest = true); |
|||
|
|||
void setHandler(AsyncWebHandler *handler){ _handler = handler; } |
|||
void addInterestingHeader(const String& name); |
|||
|
|||
void redirect(const String& url); |
|||
|
|||
void send(AsyncWebServerResponse *response); |
|||
void send(int code, const String& contentType=String(), const String& content=String()); |
|||
void send(FS &fs, const String& path, const String& contentType=String(), bool download=false, AwsTemplateProcessor callback=nullptr); |
|||
void send(File content, const String& path, const String& contentType=String(), bool download=false, AwsTemplateProcessor callback=nullptr); |
|||
void send(Stream &stream, const String& contentType, size_t len, AwsTemplateProcessor callback=nullptr); |
|||
void send(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback=nullptr); |
|||
void sendChunked(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback=nullptr); |
|||
void send_P(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback=nullptr); |
|||
void send_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback=nullptr); |
|||
|
|||
AsyncWebServerResponse *beginResponse(int code, const String& contentType=String(), const String& content=String()); |
|||
AsyncWebServerResponse *beginResponse(FS &fs, const String& path, const String& contentType=String(), bool download=false, AwsTemplateProcessor callback=nullptr); |
|||
AsyncWebServerResponse *beginResponse(File content, const String& path, const String& contentType=String(), bool download=false, AwsTemplateProcessor callback=nullptr); |
|||
AsyncWebServerResponse *beginResponse(Stream &stream, const String& contentType, size_t len, AwsTemplateProcessor callback=nullptr); |
|||
AsyncWebServerResponse *beginResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback=nullptr); |
|||
AsyncWebServerResponse *beginChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback=nullptr); |
|||
AsyncResponseStream *beginResponseStream(const String& contentType, size_t bufferSize=1460); |
|||
AsyncWebServerResponse *beginResponse_P(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback=nullptr); |
|||
AsyncWebServerResponse *beginResponse_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback=nullptr); |
|||
|
|||
size_t headers() const; // get header count
|
|||
bool hasHeader(const String& name) const; // check if header exists
|
|||
bool hasHeader(const __FlashStringHelper * data) const; // check if header exists
|
|||
|
|||
AsyncWebHeader* getHeader(const String& name) const; |
|||
AsyncWebHeader* getHeader(const __FlashStringHelper * data) const; |
|||
AsyncWebHeader* getHeader(size_t num) const; |
|||
|
|||
size_t params() const; // get arguments count
|
|||
bool hasParam(const String& name, bool post=false, bool file=false) const; |
|||
bool hasParam(const __FlashStringHelper * data, bool post=false, bool file=false) const; |
|||
|
|||
AsyncWebParameter* getParam(const String& name, bool post=false, bool file=false) const; |
|||
AsyncWebParameter* getParam(const __FlashStringHelper * data, bool post, bool file) const; |
|||
AsyncWebParameter* getParam(size_t num) const; |
|||
|
|||
size_t args() const { return params(); } // get arguments count
|
|||
const String& arg(const String& name) const; // get request argument value by name
|
|||
const String& arg(const __FlashStringHelper * data) const; // get request argument value by F(name)
|
|||
const String& arg(size_t i) const; // get request argument value by number
|
|||
const String& argName(size_t i) const; // get request argument name by number
|
|||
bool hasArg(const char* name) const; // check if argument exists
|
|||
bool hasArg(const __FlashStringHelper * data) const; // check if F(argument) exists
|
|||
|
|||
const String& ASYNCWEBSERVER_REGEX_ATTRIBUTE pathArg(size_t i) const; |
|||
|
|||
const String& header(const char* name) const;// get request header value by name
|
|||
const String& header(const __FlashStringHelper * data) const;// get request header value by F(name)
|
|||
const String& header(size_t i) const; // get request header value by number
|
|||
const String& headerName(size_t i) const; // get request header name by number
|
|||
String urlDecode(const String& text) const; |
|||
}; |
|||
|
|||
/*
|
|||
* FILTER :: Callback to filter AsyncWebRewrite and AsyncWebHandler (done by the Server) |
|||
* */ |
|||
|
|||
typedef std::function<bool(AsyncWebServerRequest *request)> ArRequestFilterFunction; |
|||
|
|||
bool ON_STA_FILTER(AsyncWebServerRequest *request); |
|||
|
|||
bool ON_AP_FILTER(AsyncWebServerRequest *request); |
|||
|
|||
/*
|
|||
* REWRITE :: One instance can be handle any Request (done by the Server) |
|||
* */ |
|||
|
|||
class AsyncWebRewrite { |
|||
protected: |
|||
String _from; |
|||
String _toUrl; |
|||
String _params; |
|||
ArRequestFilterFunction _filter; |
|||
public: |
|||
AsyncWebRewrite(const char* from, const char* to): _from(from), _toUrl(to), _params(String()), _filter(NULL){ |
|||
int index = _toUrl.indexOf('?'); |
|||
if (index > 0) { |
|||
_params = _toUrl.substring(index +1); |
|||
_toUrl = _toUrl.substring(0, index); |
|||
} |
|||
} |
|||
virtual ~AsyncWebRewrite(){} |
|||
AsyncWebRewrite& setFilter(ArRequestFilterFunction fn) { _filter = fn; return *this; } |
|||
bool filter(AsyncWebServerRequest *request) const { return _filter == NULL || _filter(request); } |
|||
const String& from(void) const { return _from; } |
|||
const String& toUrl(void) const { return _toUrl; } |
|||
const String& params(void) const { return _params; } |
|||
virtual bool match(AsyncWebServerRequest *request) { return from() == request->url() && filter(request); } |
|||
}; |
|||
|
|||
/*
|
|||
* HANDLER :: One instance can be attached to any Request (done by the Server) |
|||
* */ |
|||
|
|||
class AsyncWebHandler { |
|||
protected: |
|||
ArRequestFilterFunction _filter; |
|||
String _username; |
|||
String _password; |
|||
public: |
|||
AsyncWebHandler():_username(""), _password(""){} |
|||
AsyncWebHandler& setFilter(ArRequestFilterFunction fn) { _filter = fn; return *this; } |
|||
AsyncWebHandler& setAuthentication(const char *username, const char *password){ _username = String(username);_password = String(password); return *this; }; |
|||
bool filter(AsyncWebServerRequest *request){ return _filter == NULL || _filter(request); } |
|||
virtual ~AsyncWebHandler(){} |
|||
virtual bool canHandle(AsyncWebServerRequest *request __attribute__((unused))){ |
|||
return false; |
|||
} |
|||
virtual void handleRequest(AsyncWebServerRequest *request __attribute__((unused))){} |
|||
virtual void handleUpload(AsyncWebServerRequest *request __attribute__((unused)), const String& filename __attribute__((unused)), size_t index __attribute__((unused)), uint8_t *data __attribute__((unused)), size_t len __attribute__((unused)), bool final __attribute__((unused))){} |
|||
virtual void handleBody(AsyncWebServerRequest *request __attribute__((unused)), uint8_t *data __attribute__((unused)), size_t len __attribute__((unused)), size_t index __attribute__((unused)), size_t total __attribute__((unused))){} |
|||
virtual bool isRequestHandlerTrivial(){return true;} |
|||
}; |
|||
|
|||
/*
|
|||
* RESPONSE :: One instance is created for each Request (attached by the Handler) |
|||
* */ |
|||
|
|||
typedef enum { |
|||
RESPONSE_SETUP, RESPONSE_HEADERS, RESPONSE_CONTENT, RESPONSE_WAIT_ACK, RESPONSE_END, RESPONSE_FAILED |
|||
} WebResponseState; |
|||
|
|||
class AsyncWebServerResponse { |
|||
protected: |
|||
int _code; |
|||
LinkedList<AsyncWebHeader *> _headers; |
|||
String _contentType; |
|||
size_t _contentLength; |
|||
bool _sendContentLength; |
|||
bool _chunked; |
|||
size_t _headLength; |
|||
size_t _sentLength; |
|||
size_t _ackedLength; |
|||
size_t _writtenLength; |
|||
WebResponseState _state; |
|||
const char* _responseCodeToString(int code); |
|||
|
|||
public: |
|||
AsyncWebServerResponse(); |
|||
virtual ~AsyncWebServerResponse(); |
|||
virtual void setCode(int code); |
|||
virtual void setContentLength(size_t len); |
|||
virtual void setContentType(const String& type); |
|||
virtual void addHeader(const String& name, const String& value); |
|||
virtual String _assembleHead(uint8_t version); |
|||
virtual bool _started() const; |
|||
virtual bool _finished() const; |
|||
virtual bool _failed() const; |
|||
virtual bool _sourceValid() const; |
|||
virtual void _respond(AsyncWebServerRequest *request); |
|||
virtual size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); |
|||
}; |
|||
|
|||
/*
|
|||
* SERVER :: One instance |
|||
* */ |
|||
|
|||
typedef std::function<void(AsyncWebServerRequest *request)> ArRequestHandlerFunction; |
|||
typedef std::function<void(AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final)> ArUploadHandlerFunction; |
|||
typedef std::function<void(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total)> ArBodyHandlerFunction; |
|||
|
|||
class AsyncWebServer { |
|||
protected: |
|||
AsyncServer _server; |
|||
LinkedList<AsyncWebRewrite*> _rewrites; |
|||
LinkedList<AsyncWebHandler*> _handlers; |
|||
AsyncCallbackWebHandler* _catchAllHandler; |
|||
|
|||
public: |
|||
AsyncWebServer(uint16_t port); |
|||
~AsyncWebServer(); |
|||
|
|||
void begin(); |
|||
void end(); |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
void onSslFileRequest(AcSSlFileHandler cb, void* arg); |
|||
void beginSecure(const char *cert, const char *private_key_file, const char *password); |
|||
#endif |
|||
|
|||
AsyncWebRewrite& addRewrite(AsyncWebRewrite* rewrite); |
|||
bool removeRewrite(AsyncWebRewrite* rewrite); |
|||
AsyncWebRewrite& rewrite(const char* from, const char* to); |
|||
|
|||
AsyncWebHandler& addHandler(AsyncWebHandler* handler); |
|||
bool removeHandler(AsyncWebHandler* handler); |
|||
|
|||
AsyncCallbackWebHandler& on(const char* uri, ArRequestHandlerFunction onRequest); |
|||
AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest); |
|||
AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload); |
|||
AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload, ArBodyHandlerFunction onBody); |
|||
|
|||
AsyncStaticWebHandler& serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_control = NULL); |
|||
|
|||
void onNotFound(ArRequestHandlerFunction fn); //called when handler is not assigned
|
|||
void onFileUpload(ArUploadHandlerFunction fn); //handle file uploads
|
|||
void onRequestBody(ArBodyHandlerFunction fn); //handle posts with plain body content (JSON often transmitted this way as a request)
|
|||
|
|||
void reset(); //remove all writers and handlers, with onNotFound/onFileUpload/onRequestBody
|
|||
|
|||
void _handleDisconnect(AsyncWebServerRequest *request); |
|||
void _attachHandler(AsyncWebServerRequest *request); |
|||
void _rewriteRequest(AsyncWebServerRequest *request); |
|||
}; |
|||
|
|||
class DefaultHeaders { |
|||
using headers_t = LinkedList<AsyncWebHeader *>; |
|||
headers_t _headers; |
|||
|
|||
DefaultHeaders() |
|||
:_headers(headers_t([](AsyncWebHeader *h){ delete h; })) |
|||
{} |
|||
public: |
|||
using ConstIterator = headers_t::ConstIterator; |
|||
|
|||
void addHeader(const String& name, const String& value){ |
|||
_headers.add(new AsyncWebHeader(name, value)); |
|||
} |
|||
|
|||
ConstIterator begin() const { return _headers.begin(); } |
|||
ConstIterator end() const { return _headers.end(); } |
|||
|
|||
DefaultHeaders(DefaultHeaders const &) = delete; |
|||
DefaultHeaders &operator=(DefaultHeaders const &) = delete; |
|||
static DefaultHeaders &Instance() { |
|||
static DefaultHeaders instance; |
|||
return instance; |
|||
} |
|||
}; |
|||
|
|||
#include "WebResponseImpl.h" |
|||
#include "WebHandlerImpl.h" |
|||
#include "AsyncWebSocket.h" |
|||
#include "AsyncEventSource.h" |
|||
|
|||
#endif /* _AsyncWebServer_H_ */ |
|||
@ -0,0 +1,544 @@ |
|||
#include "SPIFFSEditor.h" |
|||
#include <FS.h> |
|||
|
|||
//File: edit.htm.gz, Size: 4151
|
|||
#define edit_htm_gz_len 4151 |
|||
const uint8_t edit_htm_gz[] PROGMEM = { |
|||
0x1F, 0x8B, 0x08, 0x08, 0xB8, 0x94, 0xB1, 0x59, 0x00, 0x03, 0x65, 0x64, 0x69, 0x74, 0x2E, 0x68, |
|||
0x74, 0x6D, 0x00, 0xB5, 0x3A, 0x0B, 0x7B, 0xDA, 0xB8, 0xB2, 0x7F, 0xC5, 0x71, 0xCF, 0x66, 0xED, |
|||
0x83, 0x31, 0x90, 0xA4, 0xD9, 0xD6, 0xC4, 0xC9, 0x42, 0x92, 0x36, 0x6D, 0xF3, 0x6A, 0x80, 0xB6, |
|||
0x69, 0x4F, 0xEE, 0x7E, 0xC2, 0x16, 0xA0, 0xC6, 0x96, 0x5D, 0x5B, 0x0E, 0x49, 0x59, 0xFE, 0xFB, |
|||
0x9D, 0x91, 0x6C, 0xB0, 0x09, 0x69, 0x77, 0xCF, 0xBD, 0xBB, 0xDD, 0x2D, 0x92, 0x46, 0x33, 0x9A, |
|||
0x19, 0xCD, 0x53, 0xDE, 0xBD, 0x8D, 0xA3, 0x8B, 0xC3, 0xFE, 0xF5, 0xE5, 0xB1, 0x36, 0x11, 0x61, |
|||
0xB0, 0xBF, 0x87, 0x7F, 0x6B, 0x01, 0xE1, 0x63, 0x97, 0xF2, 0xFD, 0x3D, 0xC1, 0x44, 0x40, 0xF7, |
|||
0x8F, 0x7B, 0x97, 0xDA, 0xB1, 0xCF, 0x44, 0x94, 0xEC, 0x35, 0xD4, 0xCA, 0x5E, 0x2A, 0x1E, 0x02, |
|||
0xAA, 0x85, 0xD4, 0x67, 0xC4, 0x4D, 0xBD, 0x84, 0xC2, 0x66, 0xDB, 0x0B, 0x67, 0xDF, 0xEB, 0x8C, |
|||
0xFB, 0xF4, 0xDE, 0xD9, 0x6E, 0x36, 0xDB, 0x71, 0x94, 0x32, 0xC1, 0x22, 0xEE, 0x90, 0x61, 0x1A, |
|||
0x05, 0x99, 0xA0, 0xED, 0x80, 0x8E, 0x84, 0xF3, 0x3C, 0xBE, 0x6F, 0x0F, 0xA3, 0xC4, 0xA7, 0x89, |
|||
0xD3, 0x8A, 0xEF, 0x35, 0x00, 0x31, 0x5F, 0x7B, 0xB6, 0xB3, 0xB3, 0xD3, 0x1E, 0x12, 0xEF, 0x76, |
|||
0x9C, 0x44, 0x19, 0xF7, 0xEB, 0x5E, 0x14, 0x44, 0x89, 0xF3, 0x6C, 0xF4, 0x1C, 0xFF, 0xB4, 0x7D, |
|||
0x96, 0xC6, 0x01, 0x79, 0x70, 0x78, 0xC4, 0x29, 0xE0, 0xDE, 0xD7, 0xD3, 0x09, 0xF1, 0xA3, 0xA9, |
|||
0xD3, 0xD4, 0x9A, 0x5A, 0xAB, 0x09, 0x44, 0x92, 0xF1, 0x90, 0x18, 0x4D, 0x0B, 0xFF, 0xD8, 0x3B, |
|||
0x66, 0x7B, 0x14, 0x71, 0x51, 0x4F, 0xD9, 0x77, 0xEA, 0xB4, 0xB6, 0xE0, 0x34, 0x39, 0x1D, 0x91, |
|||
0x90, 0x05, 0x0F, 0x4E, 0x4A, 0x78, 0x5A, 0x4F, 0x69, 0xC2, 0x46, 0x6A, 0x79, 0x4A, 0xD9, 0x78, |
|||
0x22, 0x9C, 0xDF, 0x9A, 0xCD, 0x39, 0xF0, 0xAF, 0x65, 0xC1, 0x2C, 0x60, 0x29, 0x20, 0xA3, 0x78, |
|||
0xEA, 0x3C, 0x11, 0xC5, 0x4E, 0x53, 0xB1, 0xDE, 0x6C, 0x87, 0x24, 0x19, 0x33, 0x0E, 0x83, 0x98, |
|||
0xF8, 0x3E, 0xE3, 0x63, 0x47, 0xA1, 0x05, 0x6C, 0xB6, 0x90, 0x36, 0xA1, 0x01, 0x11, 0xEC, 0x8E, |
|||
0xB6, 0x43, 0xC6, 0xEB, 0x53, 0xE6, 0x8B, 0x89, 0xB3, 0x0B, 0x3C, 0xB6, 0xBD, 0x2C, 0x49, 0x41, |
|||
0xA6, 0x38, 0x62, 0x5C, 0xD0, 0x44, 0xA2, 0xA5, 0x31, 0xE1, 0xB3, 0x5C, 0x54, 0x54, 0x40, 0x21, |
|||
0x27, 0xE3, 0x01, 0xE3, 0xB4, 0x3E, 0x0C, 0x22, 0xEF, 0x76, 0x71, 0xD2, 0x6E, 0x7C, 0x9F, 0x9F, |
|||
0xE5, 0x4C, 0xA2, 0x3B, 0x9A, 0xCC, 0x96, 0xEA, 0x92, 0xD8, 0x15, 0x60, 0x85, 0x34, 0xA5, 0x74, |
|||
0x6E, 0x8B, 0xBB, 0x0C, 0xA0, 0x96, 0xFC, 0x05, 0x29, 0x17, 0xFC, 0x2F, 0x45, 0x5A, 0x11, 0x5C, |
|||
0xA1, 0x30, 0x1E, 0x67, 0x62, 0xF6, 0xF8, 0x2A, 0xA3, 0x98, 0x78, 0x4C, 0x3C, 0xA0, 0xFC, 0xB0, |
|||
0x6D, 0x86, 0xBA, 0x04, 0xAC, 0x24, 0x24, 0x81, 0x86, 0x3A, 0xD7, 0x3E, 0xD0, 0xC4, 0x27, 0x9C, |
|||
0x58, 0x9D, 0x84, 0x91, 0xC0, 0xEA, 0x2D, 0xB5, 0x5E, 0x0F, 0xA3, 0xEF, 0xF5, 0x0C, 0xC6, 0x30, |
|||
0x0F, 0xA8, 0x27, 0x94, 0x92, 0xE1, 0x1E, 0x86, 0xB7, 0x4C, 0x3C, 0x06, 0x3C, 0x5A, 0x28, 0xA9, |
|||
0x4B, 0x2A, 0x69, 0xA2, 0x2E, 0xB0, 0x25, 0xD5, 0x83, 0x1C, 0x4B, 0xC9, 0x95, 0x50, 0xF5, 0x61, |
|||
0x24, 0x44, 0x14, 0x4A, 0x93, 0x5B, 0x08, 0xAC, 0x49, 0xAB, 0x79, 0xF1, 0xE8, 0x46, 0xD6, 0x6B, |
|||
0xBF, 0x44, 0xBE, 0x0D, 0x7A, 0x15, 0xCC, 0x23, 0x41, 0x9D, 0x04, 0x6C, 0xCC, 0x9D, 0x90, 0xF9, |
|||
0x7E, 0x40, 0x4B, 0x56, 0xEB, 0x64, 0x49, 0x60, 0xF8, 0x44, 0x10, 0x87, 0x85, 0x64, 0x4C, 0x1B, |
|||
0x31, 0x1F, 0x03, 0x34, 0xA5, 0xBB, 0x3B, 0x16, 0xFB, 0xD0, 0xBD, 0xB8, 0x9A, 0x36, 0xDF, 0xBD, |
|||
0x1E, 0x47, 0x1D, 0xF8, 0xE7, 0xBC, 0x37, 0x98, 0x1C, 0x0F, 0xC6, 0x30, 0xEA, 0xE2, 0xB4, 0xF3, |
|||
0xFE, 0xB0, 0xF3, 0x1E, 0x7E, 0x0E, 0x5B, 0xB5, 0xAF, 0xA3, 0x6F, 0xB8, 0xD0, 0x7D, 0xED, 0x77, |
|||
0xFB, 0x83, 0xE3, 0x4E, 0xE7, 0x5D, 0xE3, 0xCD, 0xF9, 0xF4, 0xE3, 0xBB, 0x5D, 0x04, 0x77, 0x83, |
|||
0xE6, 0xD5, 0x87, 0x49, 0x73, 0xB0, 0xF5, 0x32, 0xF4, 0x4F, 0xFC, 0x89, 0x17, 0x0E, 0x3A, 0xEF, |
|||
0x3F, 0x5E, 0xDD, 0x5D, 0x87, 0x83, 0x71, 0xEF, 0x63, 0x6B, 0xF2, 0x79, 0xEB, 0x43, 0xEF, 0xF3, |
|||
0xC7, 0x57, 0xB7, 0xF4, 0xD3, 0xC9, 0xDB, 0xCF, 0xFD, 0x29, 0x20, 0x1C, 0x45, 0xBD, 0xC1, 0x55, |
|||
0xF7, 0x43, 0x77, 0xFC, 0xB9, 0xEB, 0x1D, 0xDF, 0x0F, 0x83, 0xF3, 0xEE, 0xEB, 0xCE, 0xB0, 0xB3, |
|||
0xE5, 0x51, 0x3A, 0xEE, 0x5F, 0x75, 0xB3, 0x37, 0xEF, 0x2E, 0xC6, 0x8C, 0x4D, 0x7A, 0x9F, 0xCF, |
|||
0xFB, 0xDE, 0xE1, 0xF3, 0xD3, 0xC1, 0x49, 0x87, 0x4D, 0xCE, 0xDF, 0x5E, 0x35, 0x6F, 0x5F, 0xBF, |
|||
0x3B, 0x3C, 0xF2, 0xAE, 0xDF, 0x5E, 0xEF, 0x1E, 0x6D, 0x37, 0x7E, 0xFB, 0xED, 0xCC, 0xBF, 0x60, |
|||
0xBC, 0x7F, 0xF7, 0xBD, 0x33, 0x3E, 0x9C, 0xBE, 0x78, 0x48, 0xFB, 0x93, 0x37, 0x77, 0xBC, 0xF1, |
|||
0x21, 0xFA, 0xFA, 0xE6, 0xE1, 0x0C, 0xFE, 0xBB, 0xBC, 0xAC, 0x0D, 0x7B, 0xAD, 0x74, 0xF0, 0xFE, |
|||
0xCD, 0x87, 0xAD, 0xF4, 0xE5, 0xF3, 0xB8, 0x7B, 0x74, 0x74, 0x17, 0x0E, 0x2F, 0x1B, 0xA1, 0x7F, |
|||
0x3B, 0x12, 0x2F, 0xB6, 0x45, 0x7C, 0x3D, 0xCE, 0x3E, 0x7F, 0x7B, 0xFE, 0x76, 0xD2, 0xB8, 0xA0, |
|||
0xE4, 0x7A, 0x52, 0x7B, 0xF8, 0xFE, 0xF0, 0x62, 0xD2, 0x3F, 0xB9, 0x3B, 0x0F, 0xC8, 0xFD, 0xF9, |
|||
0xB9, 0xF7, 0x3D, 0xAC, 0x05, 0xE4, 0xE5, 0x45, 0x3F, 0x20, 0x49, 0x6B, 0xE0, 0x77, 0x1A, 0xB5, |
|||
0xC3, 0xAD, 0xCE, 0x8E, 0x48, 0xAE, 0x0E, 0xF9, 0xD1, 0xF6, 0xD7, 0xDE, 0x8B, 0x6E, 0xB7, 0x15, |
|||
0x0D, 0xBF, 0x6D, 0xBD, 0xBE, 0xDD, 0x7D, 0x3D, 0xD8, 0x7D, 0x3F, 0x7C, 0xDF, 0xE9, 0xED, 0x74, |
|||
0x07, 0xE4, 0xBA, 0xF7, 0xBE, 0x33, 0xDA, 0x19, 0x4E, 0x26, 0xEF, 0xDE, 0xF5, 0x5F, 0xF9, 0x9D, |
|||
0xEF, 0x49, 0xE7, 0x62, 0xDA, 0xB9, 0x3F, 0x1E, 0x74, 0x4E, 0x6A, 0xEF, 0x8E, 0xCF, 0x9A, 0xAD, |
|||
0xDE, 0xF5, 0xF6, 0xF8, 0x6C, 0x77, 0xDA, 0x4D, 0x8F, 0x3B, 0xEF, 0xBB, 0xCD, 0xF1, 0xDB, 0x5A, |
|||
0x48, 0x3E, 0x47, 0x87, 0xDB, 0xE3, 0x37, 0xBB, 0xEC, 0xF2, 0x9A, 0x74, 0xDE, 0x74, 0xDF, 0xA6, |
|||
0xEC, 0x2A, 0x3C, 0x19, 0x34, 0x3B, 0x9D, 0xD3, 0x0B, 0xFA, 0xEA, 0x70, 0x9B, 0xBC, 0xDB, 0xF2, |
|||
0x3E, 0x82, 0xFE, 0x07, 0x9F, 0xE8, 0x6F, 0xB5, 0xCE, 0xF4, 0xA2, 0x19, 0x78, 0x2F, 0x69, 0xFF, |
|||
0xE4, 0xBA, 0x2F, 0x6F, 0xE7, 0x38, 0x78, 0xD5, 0xBF, 0xED, 0x65, 0xEF, 0xC3, 0xC3, 0x43, 0x53, |
|||
0xE3, 0x51, 0x3D, 0xA1, 0x31, 0x25, 0xA2, 0x1C, 0xAE, 0x16, 0xFE, 0x01, 0xB6, 0xB5, 0xB4, 0xC2, |
|||
0xDC, 0x4F, 0x05, 0xBD, 0x17, 0x75, 0x9F, 0x7A, 0x51, 0x42, 0xE4, 0x1E, 0x40, 0xA0, 0x09, 0x9A, |
|||
0xD8, 0xFC, 0x77, 0x19, 0x3F, 0x35, 0x15, 0x3F, 0x35, 0xC2, 0x7D, 0xCD, 0x28, 0x1C, 0x01, 0x83, |
|||
0x87, 0x4F, 0xEF, 0x98, 0x47, 0xEB, 0x31, 0xBB, 0xA7, 0x41, 0x5D, 0x22, 0x3B, 0x4D, 0x73, 0x26, |
|||
0xFD, 0xAD, 0xD8, 0x46, 0x38, 0x98, 0x9A, 0xA4, 0x5A, 0x2C, 0xF8, 0x5F, 0x89, 0x47, 0x21, 0xB0, |
|||
0x81, 0xCB, 0x84, 0xF8, 0xAB, 0x7C, 0x27, 0x4A, 0xEA, 0xC3, 0x6C, 0x3C, 0x62, 0xF7, 0xE0, 0xD0, |
|||
0x23, 0xC6, 0x99, 0xA0, 0x5A, 0x2B, 0x9D, 0xFF, 0x5E, 0x90, 0xB9, 0xA5, 0x0F, 0xA3, 0x84, 0x84, |
|||
0x34, 0xD5, 0xFE, 0x22, 0x99, 0xD9, 0x28, 0x89, 0xC2, 0x65, 0x10, 0x99, 0x8B, 0xA8, 0x34, 0x99, |
|||
0xCF, 0x9F, 0x65, 0x71, 0x10, 0x11, 0x10, 0x73, 0x4D, 0xE4, 0x50, 0xF1, 0x34, 0x91, 0x6E, 0xB5, |
|||
0x88, 0xAB, 0xB9, 0x9B, 0x6D, 0xA1, 0x5B, 0x96, 0xDD, 0x7A, 0x6B, 0x67, 0xE9, 0xBA, 0x75, 0xB9, |
|||
0x17, 0xE3, 0xFD, 0x9A, 0x4C, 0x81, 0xF1, 0xA0, 0x14, 0xEE, 0x9E, 0x09, 0x50, 0xE9, 0x13, 0x87, |
|||
0xCB, 0x43, 0xF2, 0xC8, 0xB0, 0x60, 0x40, 0x05, 0xEA, 0x96, 0x8C, 0xD4, 0x85, 0x24, 0xB0, 0x6F, |
|||
0xFE, 0x8C, 0xCA, 0xBC, 0x67, 0x3D, 0x8B, 0x13, 0xB8, 0x0D, 0x3A, 0xFD, 0x11, 0xCD, 0x42, 0xA6, |
|||
0x2A, 0x6D, 0x45, 0x53, 0x65, 0xBC, 0x5C, 0x84, 0x65, 0xDA, 0x93, 0xBC, 0x16, 0xA4, 0x1F, 0x4B, |
|||
0x05, 0xE0, 0x05, 0x37, 0xCF, 0x91, 0x9B, 0x1F, 0x6A, 0x75, 0x7B, 0xF7, 0x97, 0x9C, 0x87, 0x9D, |
|||
0xE6, 0x2F, 0x73, 0x3B, 0xDF, 0x5B, 0xA4, 0xE4, 0x56, 0x13, 0xFE, 0x29, 0x32, 0xEF, 0x8B, 0x25, |
|||
0x0B, 0xC3, 0xE7, 0xF8, 0xA7, 0x60, 0x10, 0xE9, 0x94, 0x80, 0xDB, 0x3B, 0x2F, 0x5F, 0xF8, 0xC3, |
|||
0x02, 0x98, 0x0B, 0xF6, 0x24, 0x3C, 0x21, 0x3E, 0xCB, 0x52, 0xE7, 0x79, 0xF3, 0x97, 0x5C, 0x9F, |
|||
0x5B, 0x3B, 0x28, 0xFB, 0xE2, 0x2E, 0x71, 0xB2, 0xB4, 0xD8, 0x34, 0x66, 0x5C, 0xDB, 0x4A, 0x35, |
|||
0xBC, 0x6F, 0x92, 0x2C, 0x0C, 0xB3, 0x92, 0xED, 0xE7, 0xBF, 0x2F, 0x4D, 0x13, 0xF7, 0xCF, 0x9A, |
|||
0xBF, 0xCC, 0x44, 0x02, 0xD9, 0x64, 0x04, 0xB9, 0xC6, 0x49, 0x22, 0x41, 0x04, 0x35, 0x9A, 0xE6, |
|||
0x1C, 0x84, 0x5B, 0x03, 0xD8, 0xDE, 0x6D, 0xFA, 0x74, 0x6C, 0xCE, 0xE7, 0x7B, 0x0D, 0x99, 0xD7, |
|||
0xA0, 0x6C, 0xF1, 0x12, 0x16, 0x8B, 0xFD, 0x51, 0xC6, 0x3D, 0xE4, 0x41, 0x1B, 0x53, 0x83, 0x9A, |
|||
0xB3, 0x84, 0x8A, 0x2C, 0xE1, 0x9A, 0x1F, 0x79, 0x19, 0x1A, 0xBB, 0x3D, 0xA6, 0xE2, 0x58, 0xD9, |
|||
0x7D, 0xF7, 0xE1, 0x8D, 0x0F, 0x3B, 0xE6, 0x0B, 0x04, 0x6F, 0x2D, 0x02, 0x38, 0x30, 0x9C, 0x97, |
|||
0xE3, 0x54, 0xF6, 0x43, 0x82, 0x01, 0x22, 0xEF, 0xE8, 0x83, 0x41, 0x2D, 0xB1, 0x40, 0xA4, 0x36, |
|||
0xAE, 0x1B, 0xC5, 0x2E, 0x80, 0x71, 0x73, 0x76, 0x07, 0x4A, 0x20, 0x2E, 0xFD, 0x22, 0x6E, 0x2C, |
|||
0xE6, 0x72, 0xF8, 0x69, 0xE7, 0xBB, 0xC9, 0x1E, 0x3B, 0xA8, 0xB7, 0x1C, 0xB2, 0xCF, 0x0E, 0x5A, |
|||
0xE0, 0x5E, 0x65, 0x6E, 0xE4, 0xB9, 0xAF, 0x58, 0x40, 0x07, 0xB9, 0xC3, 0xE1, 0x31, 0x48, 0x6C, |
|||
0xB1, 0x85, 0x28, 0xE2, 0x5B, 0xCD, 0xE6, 0x86, 0x4B, 0x0F, 0x48, 0x00, 0x39, 0xCC, 0xD0, 0x8F, |
|||
0xAF, 0xAE, 0x2E, 0xAE, 0xBE, 0xE8, 0x35, 0x5A, 0xD3, 0x6F, 0x1C, 0x4D, 0xAF, 0x71, 0xD3, 0x11, |
|||
0x76, 0x42, 0x47, 0x09, 0x4D, 0x27, 0x97, 0x44, 0x4C, 0x8C, 0xD4, 0xBE, 0x23, 0x41, 0x56, 0x16, |
|||
0x84, 0xA1, 0xDC, 0xC8, 0xA2, 0x70, 0x39, 0x9D, 0x6A, 0xAF, 0x40, 0xCD, 0x47, 0x90, 0xEA, 0xDA, |
|||
0xC2, 0x26, 0x71, 0x4C, 0xB9, 0x6F, 0xE8, 0x31, 0x20, 0xEA, 0x16, 0x35, 0xAD, 0x84, 0x7E, 0xCB, |
|||
0x68, 0x2A, 0x52, 0x1B, 0x2C, 0xD7, 0xD0, 0x2F, 0x07, 0x7D, 0xDD, 0xD2, 0x1B, 0xE8, 0x47, 0x3A, |
|||
0xF0, 0x46, 0xCC, 0x39, 0x52, 0x89, 0x5C, 0xD0, 0xA4, 0x3E, 0xCC, 0xC0, 0xA0, 0xB8, 0x6E, 0xB6, |
|||
0x23, 0x9B, 0x71, 0x4E, 0x93, 0x93, 0xFE, 0xD9, 0xA9, 0xAB, 0x5F, 0x29, 0x46, 0xB4, 0x53, 0x28, |
|||
0x48, 0x74, 0x4B, 0x5E, 0x51, 0x7E, 0xC8, 0xE1, 0x84, 0x05, 0xBE, 0x11, 0x99, 0x6D, 0x24, 0xE1, |
|||
0x49, 0x12, 0xB2, 0x40, 0x01, 0x0A, 0x9E, 0x2D, 0x1E, 0x62, 0xEA, 0xEA, 0x23, 0x50, 0x86, 0x6E, |
|||
0x79, 0x76, 0x98, 0x05, 0x82, 0xC5, 0x01, 0x75, 0x37, 0x5A, 0x30, 0xE3, 0x60, 0x41, 0xAE, 0x8E, |
|||
0xB9, 0x19, 0x61, 0xCC, 0x77, 0x75, 0x15, 0xA1, 0xF2, 0xB8, 0xB6, 0xEE, 0x14, 0x4F, 0x9D, 0x92, |
|||
0x56, 0x4E, 0x49, 0xCB, 0xB8, 0x4A, 0xE0, 0x34, 0x3F, 0x18, 0xC3, 0x3C, 0xCE, 0xD4, 0x51, 0x05, |
|||
0xCC, 0xA7, 0x23, 0x02, 0x9C, 0x7C, 0x40, 0x6D, 0xBA, 0x7A, 0x63, 0xDD, 0x41, 0xA9, 0x3A, 0xC8, |
|||
0xAF, 0x6A, 0xC4, 0x2F, 0x6B, 0x44, 0xDD, 0xEE, 0x3A, 0x64, 0x5F, 0x21, 0x07, 0x55, 0xE4, 0xA0, |
|||
0x8C, 0x7C, 0x28, 0x8D, 0x64, 0x1D, 0x72, 0xA0, 0x90, 0x93, 0x8A, 0x88, 0x89, 0x14, 0x51, 0x85, |
|||
0xBD, 0x3A, 0x6A, 0x13, 0x05, 0xD2, 0xAD, 0xA4, 0x22, 0x66, 0x62, 0x83, 0x97, 0x92, 0x61, 0x40, |
|||
0x7D, 0x77, 0xA3, 0x09, 0x33, 0x2C, 0xB6, 0xDD, 0xAD, 0xE6, 0x9A, 0x33, 0x12, 0x75, 0x46, 0x56, |
|||
0x65, 0x30, 0x2B, 0x33, 0xA8, 0xF5, 0xC8, 0x1D, 0xD5, 0xD6, 0x31, 0x98, 0x99, 0x56, 0x60, 0x47, |
|||
0xDC, 0x0B, 0x98, 0x77, 0xEB, 0x2E, 0xBD, 0xC5, 0x9C, 0xB1, 0x85, 0x85, 0x5A, 0x5C, 0x06, 0xBA, |
|||
0x01, 0x94, 0x5E, 0x8B, 0xA5, 0x7C, 0x80, 0xFA, 0x9E, 0x5B, 0xD9, 0x5A, 0x02, 0xDC, 0xA6, 0xF7, |
|||
0xD4, 0x3B, 0x8C, 0xC2, 0x90, 0xA0, 0xED, 0xA6, 0xC0, 0x41, 0x3E, 0xD1, 0xCD, 0xB9, 0x15, 0xAD, |
|||
0xC5, 0x79, 0xC2, 0x45, 0x2C, 0x7F, 0x3D, 0x8B, 0x23, 0x03, 0x5C, 0xCE, 0xF5, 0x6C, 0xD4, 0x61, |
|||
0x6A, 0x83, 0x1E, 0xC7, 0x62, 0xF2, 0x13, 0x17, 0x2A, 0x0C, 0x54, 0xA2, 0x7C, 0x69, 0xDE, 0x58, |
|||
0x0B, 0x91, 0x56, 0x7C, 0xEA, 0xA2, 0xB7, 0xE2, 0x54, 0xA8, 0xBC, 0x8A, 0x5D, 0x9A, 0x4B, 0x1D, |
|||
0x94, 0x61, 0xB9, 0xBD, 0x2F, 0xA0, 0xFA, 0x7C, 0x0E, 0xE7, 0x01, 0xFF, 0x13, 0x68, 0xF9, 0xE8, |
|||
0x5F, 0x17, 0x60, 0xC9, 0xA3, 0x34, 0x78, 0x8B, 0xBB, 0x0D, 0xE3, 0xC0, 0xF9, 0x8F, 0x6D, 0x7C, |
|||
0xF9, 0x1F, 0xFB, 0xA6, 0x66, 0x9A, 0x07, 0xFF, 0x6A, 0x48, 0x0D, 0x1B, 0xC2, 0xFC, 0xD2, 0xBA, |
|||
0xB1, 0x08, 0x80, 0xED, 0x7F, 0x9B, 0xFF, 0xB1, 0x25, 0xB8, 0x02, 0x6B, 0xDF, 0x45, 0x90, 0x49, |
|||
0xF0, 0x24, 0x34, 0xB0, 0x68, 0xA4, 0x91, 0xCD, 0x4D, 0x43, 0xB8, 0xA4, 0x72, 0x8D, 0x35, 0x51, |
|||
0xD3, 0x6D, 0x88, 0x53, 0x50, 0x5B, 0xAC, 0x04, 0xBF, 0x3E, 0x24, 0x7A, 0x15, 0x5B, 0x17, 0x00, |
|||
0xC9, 0x3D, 0xCA, 0x0C, 0x3D, 0x22, 0x97, 0x52, 0xCB, 0x0C, 0x02, 0x42, 0xA7, 0x89, 0xE7, 0x2A, |
|||
0xAD, 0x1D, 0x14, 0x30, 0x17, 0xA2, 0xE0, 0xBC, 0x1C, 0x2D, 0x15, 0xEA, 0xAA, 0xFD, 0x17, 0x0A, |
|||
0xA3, 0xD6, 0x12, 0x8A, 0x04, 0x31, 0xAD, 0xD8, 0x79, 0xC6, 0x72, 0x75, 0x4C, 0x59, 0xBA, 0x35, |
|||
0x59, 0x5D, 0x96, 0xAD, 0x04, 0xAE, 0x2F, 0x8D, 0xFE, 0xD7, 0x3D, 0x16, 0x8E, 0xB5, 0x12, 0x3F, |
|||
0xF8, 0x97, 0xFB, 0x2B, 0x46, 0xE4, 0xCD, 0x3F, 0xBC, 0x21, 0x70, 0x05, 0xA6, 0x41, 0x6D, 0x1E, |
|||
0x4D, 0x0D, 0xB3, 0xF6, 0xAB, 0xAE, 0x49, 0x8A, 0xAE, 0x1E, 0x92, 0xFB, 0xBC, 0xA7, 0xC4, 0x8C, |
|||
0xD7, 0xD6, 0x70, 0x5E, 0xB4, 0x28, 0xF9, 0x82, 0xEC, 0xE6, 0x48, 0x26, 0xA2, 0xB6, 0x56, 0x64, |
|||
0x52, 0xD5, 0xCA, 0xE8, 0x5A, 0x63, 0xFF, 0xD7, 0x4A, 0x40, 0xB7, 0x98, 0xBA, 0x4E, 0x15, 0x8C, |
|||
0xB3, 0x00, 0x1C, 0x93, 0x3E, 0x1D, 0x69, 0x03, 0x26, 0x03, 0x75, 0x35, 0x46, 0x5A, 0x81, 0xC1, |
|||
0xCC, 0x03, 0xC3, 0x2B, 0xFB, 0xF3, 0x1E, 0x16, 0xBF, 0xFB, 0x97, 0xAA, 0xAA, 0x81, 0xD4, 0x8B, |
|||
0x33, 0x5D, 0x59, 0x59, 0xD5, 0x4B, 0xE0, 0xD2, 0x08, 0xA0, 0x5B, 0x8B, 0x3C, 0x3A, 0x8C, 0xFC, |
|||
0x87, 0x52, 0xF6, 0x4D, 0xBB, 0x0F, 0x87, 0x01, 0x49, 0xD3, 0x73, 0xB8, 0x01, 0x43, 0xF7, 0x42, |
|||
0x50, 0xB8, 0xB2, 0xC2, 0xFD, 0xE6, 0xE6, 0x66, 0x15, 0x29, 0xA1, 0x21, 0x14, 0xDB, 0x8A, 0x2B, |
|||
0xF0, 0x49, 0xD3, 0xF1, 0x81, 0x30, 0x18, 0xD2, 0x1A, 0xC6, 0xF0, 0x25, 0xE3, 0x47, 0x5C, 0x71, |
|||
0xF4, 0xF4, 0x22, 0xA6, 0xFC, 0x33, 0xDC, 0x95, 0x32, 0xCB, 0x1A, 0xAD, 0xA6, 0x68, 0xFA, 0x8F, |
|||
0xD8, 0x3E, 0xCA, 0x0D, 0x76, 0xC1, 0x7A, 0xBA, 0x56, 0xA1, 0xFC, 0x9F, 0x61, 0xB9, 0x94, 0x28, |
|||
0xD6, 0x70, 0x9C, 0x40, 0x80, 0x5A, 0xC3, 0x31, 0xC4, 0x1A, 0x41, 0x17, 0xFC, 0x26, 0x6B, 0xF9, |
|||
0xCD, 0xFE, 0x19, 0x7E, 0x97, 0x76, 0x1E, 0x15, 0x25, 0x91, 0xAA, 0xAF, 0x50, 0x02, 0x9F, 0xDD, |
|||
0xE9, 0xA6, 0x15, 0xB9, 0x55, 0x0A, 0x50, 0x1B, 0x46, 0x41, 0xD0, 0x8F, 0xE2, 0x83, 0x27, 0xD6, |
|||
0x9D, 0xC5, 0x7A, 0x31, 0xC8, 0xD9, 0x5C, 0x6E, 0xB1, 0xBC, 0xB5, 0x44, 0x4F, 0xA1, 0xEC, 0x5F, |
|||
0x4B, 0x15, 0x01, 0x3F, 0x23, 0x8B, 0x7B, 0xAC, 0xD4, 0xA5, 0x36, 0x28, 0x0F, 0x56, 0x3F, 0xD5, |
|||
0x3C, 0xCB, 0x5F, 0xCC, 0xAE, 0x6B, 0x51, 0x9B, 0xC0, 0x38, 0x57, 0x92, 0x8B, 0x4A, 0xB2, 0xC8, |
|||
0x13, 0x01, 0xA8, 0x58, 0xC7, 0x2E, 0xC4, 0x4D, 0x6B, 0x7A, 0x7C, 0xBF, 0x5C, 0x83, 0xC2, 0xDF, |
|||
0xF5, 0xD5, 0x12, 0x33, 0x08, 0xC4, 0xD3, 0x95, 0x4B, 0x29, 0x5F, 0x37, 0x29, 0x8A, 0x0E, 0x62, |
|||
0x47, 0xA3, 0x51, 0x4A, 0xC5, 0x47, 0x0C, 0x49, 0x56, 0xB2, 0x98, 0x9F, 0xC8, 0x90, 0x04, 0x8C, |
|||
0x45, 0x3C, 0x8C, 0xB2, 0x94, 0x46, 0x99, 0xA8, 0xA4, 0x16, 0x63, 0x21, 0xCC, 0x5E, 0xFA, 0xE7, |
|||
0x9F, 0x8B, 0xC9, 0x7E, 0x5A, 0x0B, 0x96, 0xD3, 0xEB, 0x3D, 0xBF, 0x34, 0xD9, 0xF7, 0x6B, 0x89, |
|||
0xB9, 0x7A, 0xE9, 0xFF, 0x67, 0x4B, 0x21, 0x65, 0x4B, 0xF1, 0xB0, 0x54, 0x2E, 0x62, 0x62, 0x29, |
|||
0xE6, 0xC9, 0x82, 0x91, 0x97, 0x7C, 0x16, 0x0D, 0x1A, 0x2B, 0x25, 0x55, 0x9E, 0x97, 0x7D, 0x95, |
|||
0x43, 0x40, 0x59, 0x71, 0xE5, 0x35, 0x11, 0x06, 0x34, 0xE0, 0x63, 0x64, 0xF2, 0x41, 0xEB, 0xA7, |
|||
0xD1, 0x94, 0x26, 0x87, 0x24, 0xA5, 0x06, 0x24, 0xCD, 0x65, 0xDC, 0x41, 0xA8, 0xE9, 0x04, 0xEB, |
|||
0x76, 0x6D, 0x6E, 0x12, 0x05, 0xCE, 0x33, 0x77, 0xC4, 0xB1, 0x26, 0x03, 0xF9, 0xB2, 0xCA, 0x09, |
|||
0xD4, 0xC6, 0xBE, 0x12, 0xA4, 0x3E, 0x52, 0x25, 0xA8, 0x61, 0x5A, 0xD0, 0x76, 0xC0, 0x35, 0x5F, |
|||
0x26, 0x51, 0x4C, 0xC6, 0xB2, 0x07, 0x83, 0x35, 0x74, 0x0F, 0xA4, 0x66, 0x6D, 0x34, 0x91, 0x60, |
|||
0xA9, 0x73, 0x29, 0xFC, 0x66, 0xD9, 0xC2, 0x70, 0x4B, 0x57, 0xC9, 0xB0, 0xBD, 0xF4, 0xA5, 0x35, |
|||
0x59, 0x83, 0xE0, 0x0B, 0x6C, 0x62, 0xE0, 0x1E, 0x68, 0x64, 0xF2, 0x7B, 0x00, 0x77, 0x6B, 0xB6, |
|||
0xA3, 0x3D, 0xD6, 0x8E, 0x6A, 0x35, 0x53, 0x55, 0xE9, 0xAE, 0x0B, 0x6D, 0x4E, 0x74, 0x23, 0x0B, |
|||
0x4B, 0x10, 0xAA, 0x9A, 0x59, 0x0C, 0x38, 0x1B, 0x81, 0xAA, 0xBA, 0xC0, 0x11, 0xD6, 0x98, 0x66, |
|||
0xA9, 0x23, 0xF1, 0x97, 0x1D, 0xC9, 0x13, 0xB5, 0x07, 0x95, 0xF5, 0x05, 0xD4, 0x31, 0xAB, 0x25, |
|||
0x86, 0x30, 0xD3, 0x29, 0x13, 0xDE, 0x04, 0x03, 0x90, 0x07, 0x5A, 0xD5, 0x05, 0x14, 0xB5, 0x8E, |
|||
0x1C, 0x4D, 0x44, 0xB8, 0x1C, 0x05, 0xF9, 0xF0, 0x6B, 0x9A, 0x0F, 0xBC, 0xB4, 0x18, 0xDD, 0x97, |
|||
0x80, 0x50, 0xD2, 0xE6, 0xE0, 0x88, 0x8F, 0xF2, 0x21, 0xF4, 0xB2, 0x05, 0x9D, 0x02, 0x58, 0xFC, |
|||
0xC6, 0x71, 0x3E, 0x8A, 0x27, 0xC5, 0x68, 0x42, 0xEF, 0x17, 0x78, 0x51, 0x01, 0xF5, 0xA9, 0xEE, |
|||
0x28, 0x1B, 0xDB, 0x68, 0xCE, 0xF3, 0x41, 0x6B, 0x29, 0x7F, 0xF0, 0xFF, 0x28, 0x7F, 0xCC, 0xC7, |
|||
0x85, 0x34, 0x71, 0x31, 0x1A, 0xB3, 0x42, 0x96, 0x61, 0x18, 0xFF, 0x90, 0x93, 0xA4, 0xD4, 0x13, |
|||
0x97, 0x7A, 0x5A, 0xF1, 0xB3, 0xB6, 0x53, 0x98, 0x8E, 0x31, 0xAA, 0xF8, 0xE3, 0xC8, 0xF6, 0xF0, |
|||
0xF7, 0x3C, 0xF2, 0x65, 0x6D, 0x69, 0x5A, 0xA1, 0x31, 0x82, 0x3A, 0x57, 0x37, 0xCB, 0x7E, 0x9A, |
|||
0xFD, 0xB7, 0xAD, 0xE8, 0xD1, 0xF1, 0xE9, 0x71, 0xFF, 0xB8, 0x5C, 0x38, 0x23, 0xE7, 0x25, 0x93, |
|||
0x8A, 0x2B, 0x5D, 0xFA, 0xB2, 0x22, 0x80, 0x02, 0x1B, 0x45, 0x01, 0x7B, 0xDD, 0xDC, 0x54, 0x7E, |
|||
0xF1, 0xB6, 0x77, 0x71, 0x6E, 0xC7, 0x24, 0x01, 0x8F, 0x24, 0x15, 0xE6, 0xC2, 0x82, 0x44, 0xF9, |
|||
0xE0, 0xD7, 0xC7, 0xA5, 0x72, 0x5D, 0x7E, 0x61, 0x70, 0xC4, 0xDC, 0x52, 0xA7, 0xA9, 0x7E, 0x78, |
|||
0xE2, 0x62, 0x5D, 0x99, 0xBF, 0x04, 0x41, 0x72, 0x1A, 0x2D, 0x13, 0x55, 0x11, 0x67, 0x46, 0xE5, |
|||
0x30, 0x2F, 0xEE, 0xB2, 0x75, 0x0D, 0xD3, 0xC8, 0xB4, 0xC4, 0x84, 0xA5, 0xE5, 0x46, 0xA5, 0x12, |
|||
0x14, 0xFE, 0xA2, 0xB6, 0xE7, 0x8B, 0x91, 0x24, 0xB7, 0x5A, 0x73, 0xAB, 0x6F, 0x41, 0x2A, 0x3E, |
|||
0x58, 0x04, 0x23, 0x66, 0x39, 0xDB, 0x16, 0x77, 0xA3, 0x43, 0xEE, 0x61, 0x5C, 0x7F, 0xBA, 0x35, |
|||
0x78, 0xD2, 0x3C, 0x79, 0x61, 0x9E, 0xFC, 0xB1, 0x7B, 0x2E, 0x1C, 0x45, 0xF9, 0xDA, 0xE2, 0x98, |
|||
0xF6, 0x10, 0x58, 0xBB, 0x6D, 0x2F, 0x7D, 0x18, 0x20, 0xD2, 0x83, 0xCB, 0x00, 0xF4, 0x63, 0x58, |
|||
0xFF, 0x4A, 0xEE, 0x88, 0x7A, 0x09, 0xAA, 0xA2, 0xAD, 0x73, 0x54, 0xD8, 0xEE, 0xFD, 0x81, 0xA3, |
|||
0xF2, 0xCE, 0x65, 0x18, 0x48, 0x97, 0xC3, 0x92, 0x37, 0x8B, 0x75, 0xC1, 0x61, 0x19, 0x31, 0x64, |
|||
0x6C, 0x00, 0xE3, 0xCD, 0x5D, 0x49, 0x13, 0xD5, 0x1C, 0xB4, 0xF0, 0x1B, 0x08, 0x8A, 0x4F, 0x39, |
|||
0xCE, 0x9A, 0x38, 0xAD, 0x62, 0x72, 0xC5, 0x23, 0xC8, 0x4A, 0x67, 0x89, 0xC0, 0x6E, 0x10, 0x0D, |
|||
0x0D, 0x7C, 0x64, 0x9A, 0xA1, 0xB6, 0x1D, 0x3E, 0x37, 0xD7, 0xBC, 0xD9, 0x54, 0xFA, 0x4B, 0x62, |
|||
0x79, 0xD5, 0xB0, 0x8B, 0x1C, 0x56, 0xCC, 0x75, 0x7D, 0x1F, 0xF4, 0xA3, 0x4E, 0x29, 0xAF, 0x48, |
|||
0xA4, 0x53, 0xD1, 0x83, 0xC4, 0x86, 0xA2, 0x41, 0xBE, 0x91, 0x40, 0x44, 0x72, 0x4A, 0x33, 0x5D, |
|||
0xC7, 0xCA, 0xD2, 0x0B, 0x28, 0x49, 0x7A, 0xB2, 0x73, 0x95, 0x49, 0x6B, 0x25, 0x06, 0xFE, 0xC8, |
|||
0xD7, 0xF0, 0xC7, 0xA1, 0xD0, 0xA3, 0x83, 0x9B, 0x49, 0x2B, 0x83, 0xA4, 0x23, 0x64, 0x83, 0xA9, |
|||
0x37, 0xE4, 0xBB, 0xA8, 0x2D, 0x2F, 0xCB, 0xB4, 0x16, 0x50, 0x70, 0x71, 0x83, 0xBB, 0x11, 0x30, |
|||
0x52, 0x5A, 0xC4, 0x9E, 0x94, 0xA8, 0xC7, 0x8F, 0x10, 0x1F, 0x53, 0x4A, 0x20, 0x06, 0x20, 0xA6, |
|||
0x40, 0xD0, 0xA7, 0x42, 0x8A, 0x54, 0xE6, 0x92, 0x53, 0x2A, 0x20, 0xCA, 0x48, 0xCD, 0xE2, 0xC1, |
|||
0x85, 0x78, 0xD4, 0x46, 0xD6, 0x80, 0xFD, 0xDC, 0xBD, 0x73, 0x33, 0xDE, 0x90, 0x68, 0x09, 0x56, |
|||
0x36, 0x3D, 0x9A, 0xA6, 0x52, 0x5C, 0x54, 0xC7, 0x19, 0xF8, 0xA8, 0xA1, 0x03, 0x5A, 0x23, 0x84, |
|||
0x11, 0x1E, 0x84, 0x8A, 0x01, 0x40, 0x7F, 0x42, 0xC3, 0x1C, 0x22, 0x70, 0x08, 0x20, 0x82, 0xA0, |
|||
0x7F, 0x49, 0x0D, 0xF7, 0x64, 0x05, 0xC9, 0xF8, 0xD8, 0x6D, 0x35, 0xF0, 0x9D, 0x66, 0x95, 0xEC, |
|||
0x20, 0xA5, 0xBD, 0x68, 0x24, 0xFA, 0x64, 0x98, 0x1A, 0x50, 0x00, 0xAC, 0xD9, 0x01, 0xA0, 0x1E, |
|||
0x24, 0x5E, 0x63, 0x2B, 0x3F, 0xEF, 0x04, 0x2A, 0xBB, 0x00, 0xAB, 0xBB, 0x8E, 0x87, 0x5F, 0x39, |
|||
0x4F, 0x19, 0xA7, 0x39, 0x26, 0x00, 0x7B, 0x93, 0x68, 0x7A, 0x99, 0x30, 0x2E, 0xCE, 0x64, 0x1B, |
|||
0x6A, 0x6C, 0xB4, 0xE4, 0xF5, 0xA9, 0x87, 0x15, 0x79, 0x3F, 0xC5, 0x8B, 0xCB, 0x0C, 0xF3, 0xBA, |
|||
0x53, 0x79, 0x77, 0xB1, 0x86, 0x70, 0x21, 0x50, 0x66, 0x38, 0xB3, 0x29, 0x74, 0xB0, 0xFA, 0xA1, |
|||
0x48, 0x82, 0x7A, 0x4F, 0xB7, 0x42, 0xE2, 0xC1, 0x44, 0xED, 0x81, 0xF9, 0xDC, 0xC2, 0xD8, 0xE1, |
|||
0x94, 0x83, 0x5A, 0x0A, 0xB5, 0x02, 0x45, 0xC6, 0x95, 0xCD, 0x98, 0x35, 0x1D, 0x6A, 0x58, 0x88, |
|||
0x61, 0xE0, 0xAF, 0xFE, 0x05, 0x0F, 0x1E, 0x1C, 0xC8, 0x55, 0x3F, 0xE1, 0x23, 0xE3, 0x7E, 0xF4, |
|||
0x23, 0x3E, 0x3E, 0xAF, 0xF0, 0xF1, 0x79, 0x1D, 0x1F, 0xB4, 0xAA, 0x3C, 0x98, 0x0C, 0x80, 0xEC, |
|||
0x19, 0xE1, 0x64, 0x4C, 0x13, 0x58, 0xC0, 0x43, 0x50, 0x25, 0x7F, 0x8B, 0xB3, 0x84, 0xFE, 0x98, |
|||
0xB3, 0xDE, 0x84, 0x8D, 0xC4, 0x23, 0xFE, 0x8A, 0xD5, 0xFF, 0x82, 0x4B, 0x3C, 0x70, 0x3D, 0x97, |
|||
0x79, 0x6D, 0x5A, 0x49, 0x28, 0x3F, 0x7E, 0x2B, 0x91, 0x7E, 0xE4, 0x42, 0x78, 0xA9, 0x38, 0xC8, |
|||
0xDF, 0xB7, 0xF4, 0x00, 0xBC, 0x11, 0xF8, 0x29, 0x35, 0x75, 0xBC, 0x0B, 0xA5, 0xFC, 0x29, 0x30, |
|||
0x64, 0xA8, 0xC0, 0x47, 0xDD, 0xD9, 0xDC, 0x12, 0xAE, 0x01, 0x8A, 0xF1, 0xA3, 0x29, 0xB0, 0xEA, |
|||
0xC9, 0x02, 0xD7, 0x9E, 0x40, 0x26, 0x04, 0x91, 0xE0, 0x48, 0xC8, 0xA7, 0x8D, 0x2F, 0x07, 0x9B, |
|||
0x37, 0x35, 0xC8, 0x43, 0x2E, 0xFC, 0x98, 0x2E, 0x0C, 0x36, 0x6F, 0xFE, 0x6D, 0x36, 0xC6, 0xCC, |
|||
0x5A, 0x76, 0xA4, 0x96, 0x4C, 0xF6, 0xF4, 0x0B, 0xBF, 0x71, 0x09, 0x48, 0x5D, 0x49, 0x78, 0x45, |
|||
0x34, 0x03, 0x6B, 0x43, 0x61, 0xE1, 0x07, 0xFF, 0x47, 0x09, 0xF8, 0x91, 0x9E, 0x07, 0xCE, 0xBD, |
|||
0xE6, 0x3D, 0x5E, 0x2F, 0x3E, 0x85, 0xE9, 0x56, 0xE9, 0xC1, 0x4A, 0xC7, 0xEF, 0x53, 0x3A, 0x76, |
|||
0x59, 0xA2, 0x14, 0x4A, 0x14, 0x59, 0x88, 0x1A, 0x6A, 0x50, 0x0E, 0x51, 0x98, 0x89, 0x17, 0xCD, |
|||
0x81, 0x02, 0x9B, 0x73, 0x34, 0x5B, 0x3A, 0x02, 0x0F, 0xF4, 0xF5, 0x45, 0xEE, 0xFC, 0x74, 0x76, |
|||
0x7A, 0x22, 0x44, 0x7C, 0xA5, 0x62, 0x22, 0xD0, 0xAA, 0x2E, 0x2C, 0x2F, 0xCF, 0x9C, 0x89, 0xE4, |
|||
0xA1, 0x28, 0x75, 0x30, 0x31, 0x28, 0x87, 0xFE, 0x74, 0x31, 0xFC, 0x0A, 0x71, 0xD6, 0xD0, 0xCF, |
|||
0x52, 0x48, 0x58, 0x5B, 0x36, 0xA2, 0xF7, 0xFB, 0x97, 0xF6, 0xAE, 0xDD, 0x84, 0xBA, 0x00, 0xB4, |
|||
0x0A, 0x69, 0x19, 0xEE, 0x7D, 0xFE, 0xB7, 0x90, 0xB7, 0xFF, 0x1E, 0x32, 0x83, 0xA8, 0x95, 0x42, |
|||
0x58, 0x2A, 0xF0, 0xAB, 0xB8, 0x93, 0x24, 0x9A, 0x4A, 0xB4, 0xE3, 0x24, 0xC1, 0x4B, 0xE9, 0x43, |
|||
0x85, 0xA2, 0x0D, 0x61, 0x31, 0xA5, 0x89, 0xE6, 0x47, 0x34, 0xD5, 0x78, 0x24, 0xB4, 0x34, 0x8B, |
|||
0x63, 0x68, 0x5C, 0x56, 0xF4, 0x61, 0xEB, 0xC5, 0xEB, 0xCB, 0xFB, 0x8C, 0x66, 0xD4, 0xCF, 0x97, |
|||
0x69, 0x52, 0xD1, 0x0B, 0x56, 0x50, 0xDF, 0x10, 0xEE, 0x7E, 0xB9, 0xC9, 0xEB, 0xA9, 0x8C, 0x73, |
|||
0x8C, 0xA2, 0x1B, 0x2D, 0x35, 0x07, 0xE9, 0x26, 0x40, 0xD5, 0xE5, 0x59, 0x10, 0xCC, 0xDB, 0x2B, |
|||
0xB4, 0xA0, 0xF1, 0x8A, 0x44, 0x24, 0x9F, 0xCB, 0x67, 0x7F, 0xE4, 0xC9, 0xA9, 0xE2, 0x82, 0x50, |
|||
0xF2, 0x54, 0xA9, 0x36, 0xAD, 0x0D, 0x63, 0x83, 0x6A, 0x8C, 0xA7, 0x82, 0x70, 0x0F, 0xAF, 0x51, |
|||
0xE9, 0xC2, 0x2C, 0x6A, 0x29, 0xDC, 0xDE, 0x46, 0x5F, 0xCB, 0x6D, 0xE9, 0x89, 0x7C, 0x2A, 0x25, |
|||
0xE3, 0xAE, 0xAE, 0x63, 0x55, 0x45, 0xB1, 0x3E, 0x25, 0x61, 0x5A, 0x26, 0x5B, 0x54, 0x06, 0x26, |
|||
0x77, 0x0B, 0x70, 0x9B, 0x06, 0x29, 0x1C, 0xBD, 0x7E, 0x7F, 0xCE, 0x46, 0xD1, 0xCE, 0x11, 0x80, |
|||
0x69, 0xC5, 0x3E, 0x93, 0xD7, 0xE0, 0x24, 0xCC, 0x73, 0x07, 0x32, 0xE9, 0x4A, 0x03, 0x0E, 0xA9, |
|||
0x98, 0x44, 0xFE, 0x81, 0x7E, 0xA0, 0x3B, 0x3A, 0xFC, 0xBB, 0x09, 0x35, 0x47, 0xCD, 0xA5, 0xD0, |
|||
0xA4, 0xFA, 0x74, 0x70, 0xF5, 0x06, 0xC2, 0x53, 0x0C, 0xA5, 0x01, 0x17, 0x50, 0x34, 0xD7, 0x74, |
|||
0x7C, 0x7A, 0x7D, 0x0C, 0x29, 0xC8, 0x7F, 0x21, 0x37, 0x66, 0xBB, 0xAA, 0x6C, 0xB8, 0xF3, 0xEA, |
|||
0x75, 0x56, 0x2E, 0x03, 0x7A, 0x61, 0x8C, 0x58, 0x0F, 0x29, 0x7E, 0xFB, 0x7B, 0xF4, 0x9E, 0x8D, |
|||
0x15, 0xD2, 0x6A, 0x5D, 0x6F, 0xCE, 0x76, 0x90, 0x67, 0x89, 0xD5, 0x43, 0x2C, 0x70, 0x97, 0x1F, |
|||
0x29, 0x59, 0x95, 0x35, 0xDC, 0xF6, 0x48, 0x10, 0xE0, 0xC7, 0x5A, 0x03, 0x1B, 0x6A, 0x22, 0xB2, |
|||
0xD4, 0x42, 0x22, 0x29, 0x08, 0x90, 0xD2, 0x3E, 0x84, 0x39, 0xD3, 0x92, 0x65, 0x86, 0xB2, 0xA1, |
|||
0xBC, 0xFF, 0xC5, 0x9A, 0xA3, 0x64, 0x46, 0xE8, 0xCE, 0xF9, 0x6C, 0x73, 0x53, 0xD8, 0x85, 0x99, |
|||
0x18, 0x05, 0x52, 0x8A, 0x01, 0x1C, 0x9A, 0x7D, 0x68, 0x2D, 0x8C, 0xB2, 0x90, 0x58, 0xAB, 0x3D, |
|||
0xD2, 0xB6, 0x51, 0x55, 0x03, 0x54, 0x7C, 0x46, 0x01, 0x03, 0xCE, 0xB2, 0x24, 0x80, 0xA8, 0x8B, |
|||
0x39, 0xBA, 0xB2, 0x2D, 0xC5, 0xBA, 0xD0, 0x84, 0x0E, 0xEC, 0x67, 0xC8, 0x12, 0x95, 0x97, 0xAD, |
|||
0xA2, 0x27, 0x12, 0xC5, 0x77, 0x95, 0x9E, 0xC8, 0x6F, 0xE5, 0x84, 0xAA, 0xC8, 0x77, 0x88, 0x2F, |
|||
0x13, 0x5C, 0xD4, 0xD1, 0x13, 0xA0, 0x24, 0x83, 0x52, 0x34, 0x60, 0x2A, 0x2C, 0x37, 0xEE, 0xEB, |
|||
0xD3, 0xE9, 0xB4, 0x8E, 0xDF, 0x6A, 0xEB, 0x70, 0x82, 0xB2, 0x02, 0x5F, 0x5F, 0xC7, 0x21, 0x47, |
|||
0x15, 0x58, 0xF8, 0x6E, 0xE1, 0xAC, 0xBA, 0xE8, 0x42, 0x7F, 0x2B, 0xDE, 0xD4, 0xAA, 0xD2, 0x59, |
|||
0xE1, 0x73, 0x79, 0xDB, 0x7B, 0x3B, 0x2B, 0x20, 0x32, 0xC4, 0xAF, 0xB2, 0x90, 0x69, 0x20, 0x0D, |
|||
0x3B, 0xE5, 0x46, 0x56, 0x25, 0x85, 0x65, 0x5C, 0xB0, 0xE3, 0x2C, 0x9D, 0x18, 0x33, 0x60, 0xDD, |
|||
0x11, 0x96, 0xD2, 0x95, 0x43, 0x2D, 0x65, 0xB7, 0x0E, 0xB7, 0x0A, 0xFB, 0x70, 0x30, 0x83, 0x94, |
|||
0x79, 0xFB, 0xF3, 0x4F, 0x39, 0x5B, 0xDE, 0xF6, 0x92, 0x62, 0x71, 0xE1, 0xF3, 0xFC, 0xA9, 0x35, |
|||
0xAF, 0x69, 0xA5, 0xD1, 0xAF, 0xC4, 0x97, 0xBD, 0x46, 0xFE, 0x19, 0x3B, 0xFF, 0x9C, 0xAD, 0x81, |
|||
0xB1, 0x43, 0x23, 0x2A, 0xDC, 0x4C, 0x8C, 0xEA, 0x2F, 0x34, 0xE6, 0x63, 0x79, 0x29, 0xBF, 0x2D, |
|||
0xA0, 0x54, 0xA9, 0xD3, 0x68, 0x78, 0x3E, 0xFF, 0x9A, 0x42, 0x19, 0x1D, 0x65, 0xFE, 0x28, 0x20, |
|||
0x09, 0xC5, 0x82, 0xA3, 0x41, 0xBE, 0x92, 0xFB, 0x46, 0xC0, 0x86, 0x69, 0x03, 0x93, 0x6D, 0xCB, |
|||
0xDE, 0xB2, 0x77, 0x71, 0x64, 0x7F, 0x4D, 0xF7, 0x57, 0x4F, 0xD8, 0x5F, 0x34, 0x69, 0x58, 0x0B, |
|||
0xE7, 0xB5, 0xAB, 0x8A, 0x4D, 0x6A, 0x83, 0xFB, 0xC4, 0xA7, 0x70, 0x3D, 0x6F, 0xB3, 0xCC, 0xB6, |
|||
0x1A, 0xE4, 0x5F, 0x60, 0xD4, 0x31, 0xBA, 0x95, 0x2F, 0x92, 0xF4, 0x81, 0x7B, 0x18, 0x5B, 0x17, |
|||
0x54, 0x26, 0x70, 0x49, 0xD5, 0x87, 0x34, 0xB9, 0xD3, 0x9C, 0x2F, 0x39, 0xC3, 0xB7, 0x3C, 0xA8, |
|||
0x03, 0xE4, 0x37, 0x9C, 0x72, 0x39, 0xB0, 0xBF, 0x07, 0x5D, 0x33, 0x2A, 0x41, 0x79, 0xB1, 0x26, |
|||
0x9B, 0xE6, 0x7C, 0x02, 0x82, 0x01, 0x70, 0xB1, 0xA3, 0x48, 0xCD, 0x2B, 0xCB, 0x98, 0x9B, 0x57, |
|||
0x96, 0x54, 0xE2, 0x5F, 0x59, 0xCC, 0xDB, 0x9F, 0xFC, 0xDB, 0x4C, 0xF9, 0x7F, 0x5B, 0x28, 0x36, |
|||
0x32, 0xF9, 0xE1, 0x09, 0xF7, 0x56, 0x3F, 0x45, 0xAD, 0x47, 0x51, 0xBB, 0xF7, 0xFF, 0x17, 0x53, |
|||
0xE8, 0x9D, 0x36, 0x92, 0x29, 0x00, 0x00 |
|||
}; |
|||
|
|||
#define SPIFFS_MAXLENGTH_FILEPATH 32 |
|||
const char *excludeListFile = "/.exclude.files"; |
|||
|
|||
typedef struct ExcludeListS { |
|||
char *item; |
|||
ExcludeListS *next; |
|||
} ExcludeList; |
|||
|
|||
static ExcludeList *excludes = NULL; |
|||
|
|||
static bool matchWild(const char *pattern, const char *testee) { |
|||
const char *nxPat = NULL, *nxTst = NULL; |
|||
|
|||
while (*testee) { |
|||
if (( *pattern == '?' ) || (*pattern == *testee)){ |
|||
pattern++;testee++; |
|||
continue; |
|||
} |
|||
if (*pattern=='*'){ |
|||
nxPat=pattern++; nxTst=testee; |
|||
continue; |
|||
} |
|||
if (nxPat){ |
|||
pattern = nxPat+1; testee=++nxTst; |
|||
continue; |
|||
} |
|||
return false; |
|||
} |
|||
while (*pattern=='*'){pattern++;} |
|||
return (*pattern == 0); |
|||
} |
|||
|
|||
static bool addExclude(const char *item){ |
|||
size_t len = strlen(item); |
|||
if(!len){ |
|||
return false; |
|||
} |
|||
ExcludeList *e = (ExcludeList *)malloc(sizeof(ExcludeList)); |
|||
if(!e){ |
|||
return false; |
|||
} |
|||
e->item = (char *)malloc(len+1); |
|||
if(!e->item){ |
|||
free(e); |
|||
return false; |
|||
} |
|||
memcpy(e->item, item, len+1); |
|||
e->next = excludes; |
|||
excludes = e; |
|||
return true; |
|||
} |
|||
|
|||
static void loadExcludeList(fs::FS &_fs, const char *filename){ |
|||
static char linebuf[SPIFFS_MAXLENGTH_FILEPATH]; |
|||
fs::File excludeFile=_fs.open(filename, "r"); |
|||
if(!excludeFile){ |
|||
//addExclude("/*.js.gz");
|
|||
return; |
|||
} |
|||
#ifdef ESP32 |
|||
if(excludeFile.isDirectory()){ |
|||
excludeFile.close(); |
|||
return; |
|||
} |
|||
#endif |
|||
if (excludeFile.size() > 0){ |
|||
uint8_t idx; |
|||
bool isOverflowed = false; |
|||
while (excludeFile.available()){ |
|||
linebuf[0] = '\0'; |
|||
idx = 0; |
|||
int lastChar; |
|||
do { |
|||
lastChar = excludeFile.read(); |
|||
if(lastChar != '\r'){ |
|||
linebuf[idx++] = (char) lastChar; |
|||
} |
|||
} while ((lastChar >= 0) && (lastChar != '\n') && (idx < SPIFFS_MAXLENGTH_FILEPATH)); |
|||
|
|||
if(isOverflowed){ |
|||
isOverflowed = (lastChar != '\n'); |
|||
continue; |
|||
} |
|||
isOverflowed = (idx >= SPIFFS_MAXLENGTH_FILEPATH); |
|||
linebuf[idx-1] = '\0'; |
|||
if(!addExclude(linebuf)){ |
|||
excludeFile.close(); |
|||
return; |
|||
} |
|||
} |
|||
} |
|||
excludeFile.close(); |
|||
} |
|||
|
|||
static bool isExcluded(fs::FS &_fs, const char *filename) { |
|||
if(excludes == NULL){ |
|||
loadExcludeList(_fs, excludeListFile); |
|||
} |
|||
ExcludeList *e = excludes; |
|||
while(e){ |
|||
if (matchWild(e->item, filename)){ |
|||
return true; |
|||
} |
|||
e = e->next; |
|||
} |
|||
return false; |
|||
} |
|||
|
|||
// WEB HANDLER IMPLEMENTATION
|
|||
|
|||
#ifdef ESP32 |
|||
SPIFFSEditor::SPIFFSEditor(const fs::FS& fs, const String& username, const String& password) |
|||
#else |
|||
SPIFFSEditor::SPIFFSEditor(const String& username, const String& password, const fs::FS& fs) |
|||
#endif |
|||
:_fs(fs) |
|||
,_username(username) |
|||
,_password(password) |
|||
,_authenticated(false) |
|||
,_startTime(0) |
|||
{} |
|||
|
|||
bool SPIFFSEditor::canHandle(AsyncWebServerRequest *request){ |
|||
if(request->url().equalsIgnoreCase("/edit")){ |
|||
if(request->method() == HTTP_GET){ |
|||
if(request->hasParam("list")) |
|||
return true; |
|||
if(request->hasParam("edit")){ |
|||
request->_tempFile = _fs.open(request->arg("edit"), "r"); |
|||
if(!request->_tempFile){ |
|||
return false; |
|||
} |
|||
#ifdef ESP32 |
|||
if(request->_tempFile.isDirectory()){ |
|||
request->_tempFile.close(); |
|||
return false; |
|||
} |
|||
#endif |
|||
} |
|||
if(request->hasParam("download")){ |
|||
request->_tempFile = _fs.open(request->arg("download"), "r"); |
|||
if(!request->_tempFile){ |
|||
return false; |
|||
} |
|||
#ifdef ESP32 |
|||
if(request->_tempFile.isDirectory()){ |
|||
request->_tempFile.close(); |
|||
return false; |
|||
} |
|||
#endif |
|||
} |
|||
request->addInterestingHeader("If-Modified-Since"); |
|||
return true; |
|||
} |
|||
else if(request->method() == HTTP_POST) |
|||
return true; |
|||
else if(request->method() == HTTP_DELETE) |
|||
return true; |
|||
else if(request->method() == HTTP_PUT) |
|||
return true; |
|||
|
|||
} |
|||
return false; |
|||
} |
|||
|
|||
|
|||
void SPIFFSEditor::handleRequest(AsyncWebServerRequest *request){ |
|||
if(_username.length() && _password.length() && !request->authenticate(_username.c_str(), _password.c_str())) |
|||
return request->requestAuthentication(); |
|||
|
|||
if(request->method() == HTTP_GET){ |
|||
if(request->hasParam("list")){ |
|||
String path = request->getParam("list")->value(); |
|||
#ifdef ESP32 |
|||
File dir = _fs.open(path); |
|||
#else |
|||
Dir dir = _fs.openDir(path); |
|||
#endif |
|||
path = String(); |
|||
String output = "["; |
|||
#ifdef ESP32 |
|||
File entry = dir.openNextFile(); |
|||
while(entry){ |
|||
#else |
|||
while(dir.next()){ |
|||
fs::File entry = dir.openFile("r"); |
|||
#endif |
|||
if (isExcluded(_fs, entry.name())) { |
|||
#ifdef ESP32 |
|||
entry = dir.openNextFile(); |
|||
#endif |
|||
continue; |
|||
} |
|||
if (output != "[") output += ','; |
|||
output += "{\"type\":\""; |
|||
output += "file"; |
|||
output += "\",\"name\":\""; |
|||
output += String(entry.name()); |
|||
output += "\",\"size\":"; |
|||
output += String(entry.size()); |
|||
output += "}"; |
|||
#ifdef ESP32 |
|||
entry = dir.openNextFile(); |
|||
#else |
|||
entry.close(); |
|||
#endif |
|||
} |
|||
#ifdef ESP32 |
|||
dir.close(); |
|||
#endif |
|||
output += "]"; |
|||
request->send(200, "application/json", output); |
|||
output = String(); |
|||
} |
|||
else if(request->hasParam("edit") || request->hasParam("download")){ |
|||
request->send(request->_tempFile, request->_tempFile.name(), String(), request->hasParam("download")); |
|||
} |
|||
else { |
|||
const char * buildTime = __DATE__ " " __TIME__ " GMT"; |
|||
if (request->header("If-Modified-Since").equals(buildTime)) { |
|||
request->send(304); |
|||
} else { |
|||
AsyncWebServerResponse *response = request->beginResponse_P(200, "text/html", edit_htm_gz, edit_htm_gz_len); |
|||
response->addHeader("Content-Encoding", "gzip"); |
|||
response->addHeader("Last-Modified", buildTime); |
|||
request->send(response); |
|||
} |
|||
} |
|||
} else if(request->method() == HTTP_DELETE){ |
|||
if(request->hasParam("path", true)){ |
|||
_fs.remove(request->getParam("path", true)->value()); |
|||
request->send(200, "", "DELETE: "+request->getParam("path", true)->value()); |
|||
} else |
|||
request->send(404); |
|||
} else if(request->method() == HTTP_POST){ |
|||
if(request->hasParam("data", true, true) && _fs.exists(request->getParam("data", true, true)->value())) |
|||
request->send(200, "", "UPLOADED: "+request->getParam("data", true, true)->value()); |
|||
else |
|||
request->send(500); |
|||
} else if(request->method() == HTTP_PUT){ |
|||
if(request->hasParam("path", true)){ |
|||
String filename = request->getParam("path", true)->value(); |
|||
if(_fs.exists(filename)){ |
|||
request->send(200); |
|||
} else { |
|||
fs::File f = _fs.open(filename, "w"); |
|||
if(f){ |
|||
f.write((uint8_t)0x00); |
|||
f.close(); |
|||
request->send(200, "", "CREATE: "+filename); |
|||
} else { |
|||
request->send(500); |
|||
} |
|||
} |
|||
} else |
|||
request->send(400); |
|||
} |
|||
} |
|||
|
|||
void SPIFFSEditor::handleUpload(AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final){ |
|||
if(!index){ |
|||
if(!_username.length() || request->authenticate(_username.c_str(),_password.c_str())){ |
|||
_authenticated = true; |
|||
request->_tempFile = _fs.open(filename, "w"); |
|||
_startTime = millis(); |
|||
} |
|||
} |
|||
if(_authenticated && request->_tempFile){ |
|||
if(len){ |
|||
request->_tempFile.write(data,len); |
|||
} |
|||
if(final){ |
|||
request->_tempFile.close(); |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,24 @@ |
|||
#ifndef SPIFFSEditor_H_ |
|||
#define SPIFFSEditor_H_ |
|||
#include <ESPAsyncWebServer.h> |
|||
|
|||
class SPIFFSEditor: public AsyncWebHandler { |
|||
private: |
|||
fs::FS _fs; |
|||
String _username; |
|||
String _password; |
|||
bool _authenticated; |
|||
uint32_t _startTime; |
|||
public: |
|||
#ifdef ESP32 |
|||
SPIFFSEditor(const fs::FS& fs, const String& username=String(), const String& password=String()); |
|||
#else |
|||
SPIFFSEditor(const String& username=String(), const String& password=String(), const fs::FS& fs=SPIFFS); |
|||
#endif |
|||
virtual bool canHandle(AsyncWebServerRequest *request) override final; |
|||
virtual void handleRequest(AsyncWebServerRequest *request) override final; |
|||
virtual void handleUpload(AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final) override final; |
|||
virtual bool isRequestHandlerTrivial() override final {return false;} |
|||
}; |
|||
|
|||
#endif |
|||
@ -0,0 +1,193 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#ifndef STRINGARRAY_H_ |
|||
#define STRINGARRAY_H_ |
|||
|
|||
#include "stddef.h" |
|||
#include "WString.h" |
|||
|
|||
template <typename T> |
|||
class LinkedListNode { |
|||
T _value; |
|||
public: |
|||
LinkedListNode<T>* next; |
|||
LinkedListNode(const T val): _value(val), next(nullptr) {} |
|||
~LinkedListNode(){} |
|||
const T& value() const { return _value; }; |
|||
T& value(){ return _value; } |
|||
}; |
|||
|
|||
template <typename T, template<typename> class Item = LinkedListNode> |
|||
class LinkedList { |
|||
public: |
|||
typedef Item<T> ItemType; |
|||
typedef std::function<void(const T&)> OnRemove; |
|||
typedef std::function<bool(const T&)> Predicate; |
|||
private: |
|||
ItemType* _root; |
|||
OnRemove _onRemove; |
|||
|
|||
class Iterator { |
|||
ItemType* _node; |
|||
public: |
|||
Iterator(ItemType* current = nullptr) : _node(current) {} |
|||
Iterator(const Iterator& i) : _node(i._node) {} |
|||
Iterator& operator ++() { _node = _node->next; return *this; } |
|||
bool operator != (const Iterator& i) const { return _node != i._node; } |
|||
const T& operator * () const { return _node->value(); } |
|||
const T* operator -> () const { return &_node->value(); } |
|||
}; |
|||
|
|||
public: |
|||
typedef const Iterator ConstIterator; |
|||
ConstIterator begin() const { return ConstIterator(_root); } |
|||
ConstIterator end() const { return ConstIterator(nullptr); } |
|||
|
|||
LinkedList(OnRemove onRemove) : _root(nullptr), _onRemove(onRemove) {} |
|||
~LinkedList(){} |
|||
void add(const T& t){ |
|||
auto it = new ItemType(t); |
|||
if(!_root){ |
|||
_root = it; |
|||
} else { |
|||
auto i = _root; |
|||
while(i->next) i = i->next; |
|||
i->next = it; |
|||
} |
|||
} |
|||
T& front() const { |
|||
return _root->value(); |
|||
} |
|||
|
|||
bool isEmpty() const { |
|||
return _root == nullptr; |
|||
} |
|||
size_t length() const { |
|||
size_t i = 0; |
|||
auto it = _root; |
|||
while(it){ |
|||
i++; |
|||
it = it->next; |
|||
} |
|||
return i; |
|||
} |
|||
size_t count_if(Predicate predicate) const { |
|||
size_t i = 0; |
|||
auto it = _root; |
|||
while(it){ |
|||
if (!predicate){ |
|||
i++; |
|||
} |
|||
else if (predicate(it->value())) { |
|||
i++; |
|||
} |
|||
it = it->next; |
|||
} |
|||
return i; |
|||
} |
|||
const T* nth(size_t N) const { |
|||
size_t i = 0; |
|||
auto it = _root; |
|||
while(it){ |
|||
if(i++ == N) |
|||
return &(it->value()); |
|||
it = it->next; |
|||
} |
|||
return nullptr; |
|||
} |
|||
bool remove(const T& t){ |
|||
auto it = _root; |
|||
auto pit = _root; |
|||
while(it){ |
|||
if(it->value() == t){ |
|||
if(it == _root){ |
|||
_root = _root->next; |
|||
} else { |
|||
pit->next = it->next; |
|||
} |
|||
|
|||
if (_onRemove) { |
|||
_onRemove(it->value()); |
|||
} |
|||
|
|||
delete it; |
|||
return true; |
|||
} |
|||
pit = it; |
|||
it = it->next; |
|||
} |
|||
return false; |
|||
} |
|||
bool remove_first(Predicate predicate){ |
|||
auto it = _root; |
|||
auto pit = _root; |
|||
while(it){ |
|||
if(predicate(it->value())){ |
|||
if(it == _root){ |
|||
_root = _root->next; |
|||
} else { |
|||
pit->next = it->next; |
|||
} |
|||
if (_onRemove) { |
|||
_onRemove(it->value()); |
|||
} |
|||
delete it; |
|||
return true; |
|||
} |
|||
pit = it; |
|||
it = it->next; |
|||
} |
|||
return false; |
|||
} |
|||
|
|||
void free(){ |
|||
while(_root != nullptr){ |
|||
auto it = _root; |
|||
_root = _root->next; |
|||
if (_onRemove) { |
|||
_onRemove(it->value()); |
|||
} |
|||
delete it; |
|||
} |
|||
_root = nullptr; |
|||
} |
|||
}; |
|||
|
|||
|
|||
class StringArray : public LinkedList<String> { |
|||
public: |
|||
|
|||
StringArray() : LinkedList(nullptr) {} |
|||
|
|||
bool containsIgnoreCase(const String& str){ |
|||
for (const auto& s : *this) { |
|||
if (str.equalsIgnoreCase(s)) { |
|||
return true; |
|||
} |
|||
} |
|||
return false; |
|||
} |
|||
}; |
|||
|
|||
|
|||
|
|||
|
|||
#endif /* STRINGARRAY_H_ */ |
|||
@ -0,0 +1,235 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#include "WebAuthentication.h" |
|||
#include <libb64/cencode.h> |
|||
#ifdef ESP32 |
|||
#include "mbedtls/md5.h" |
|||
#else |
|||
#include "md5.h" |
|||
#endif |
|||
|
|||
|
|||
// Basic Auth hash = base64("username:password")
|
|||
|
|||
bool checkBasicAuthentication(const char * hash, const char * username, const char * password){ |
|||
if(username == NULL || password == NULL || hash == NULL) |
|||
return false; |
|||
|
|||
size_t toencodeLen = strlen(username)+strlen(password)+1; |
|||
size_t encodedLen = base64_encode_expected_len(toencodeLen); |
|||
if(strlen(hash) != encodedLen) |
|||
return false; |
|||
|
|||
char *toencode = new char[toencodeLen+1]; |
|||
if(toencode == NULL){ |
|||
return false; |
|||
} |
|||
char *encoded = new char[base64_encode_expected_len(toencodeLen)+1]; |
|||
if(encoded == NULL){ |
|||
delete[] toencode; |
|||
return false; |
|||
} |
|||
sprintf(toencode, "%s:%s", username, password); |
|||
if(base64_encode_chars(toencode, toencodeLen, encoded) > 0 && memcmp(hash, encoded, encodedLen) == 0){ |
|||
delete[] toencode; |
|||
delete[] encoded; |
|||
return true; |
|||
} |
|||
delete[] toencode; |
|||
delete[] encoded; |
|||
return false; |
|||
} |
|||
|
|||
static bool getMD5(uint8_t * data, uint16_t len, char * output){//33 bytes or more
|
|||
#ifdef ESP32 |
|||
mbedtls_md5_context _ctx; |
|||
#else |
|||
md5_context_t _ctx; |
|||
#endif |
|||
uint8_t i; |
|||
uint8_t * _buf = (uint8_t*)malloc(16); |
|||
if(_buf == NULL) |
|||
return false; |
|||
memset(_buf, 0x00, 16); |
|||
#ifdef ESP32 |
|||
mbedtls_md5_init(&_ctx); |
|||
mbedtls_md5_starts(&_ctx); |
|||
mbedtls_md5_update(&_ctx, data, len); |
|||
mbedtls_md5_finish(&_ctx, _buf); |
|||
#else |
|||
MD5Init(&_ctx); |
|||
MD5Update(&_ctx, data, len); |
|||
MD5Final(_buf, &_ctx); |
|||
#endif |
|||
for(i = 0; i < 16; i++) { |
|||
sprintf(output + (i * 2), "%02x", _buf[i]); |
|||
} |
|||
free(_buf); |
|||
return true; |
|||
} |
|||
|
|||
static String genRandomMD5(){ |
|||
#ifdef ESP8266 |
|||
uint32_t r = RANDOM_REG32; |
|||
#else |
|||
uint32_t r = rand(); |
|||
#endif |
|||
char * out = (char*)malloc(33); |
|||
if(out == NULL || !getMD5((uint8_t*)(&r), 4, out)) |
|||
return ""; |
|||
String res = String(out); |
|||
free(out); |
|||
return res; |
|||
} |
|||
|
|||
static String stringMD5(const String& in){ |
|||
char * out = (char*)malloc(33); |
|||
if(out == NULL || !getMD5((uint8_t*)(in.c_str()), in.length(), out)) |
|||
return ""; |
|||
String res = String(out); |
|||
free(out); |
|||
return res; |
|||
} |
|||
|
|||
String generateDigestHash(const char * username, const char * password, const char * realm){ |
|||
if(username == NULL || password == NULL || realm == NULL){ |
|||
return ""; |
|||
} |
|||
char * out = (char*)malloc(33); |
|||
String res = String(username); |
|||
res.concat(":"); |
|||
res.concat(realm); |
|||
res.concat(":"); |
|||
String in = res; |
|||
in.concat(password); |
|||
if(out == NULL || !getMD5((uint8_t*)(in.c_str()), in.length(), out)) |
|||
return ""; |
|||
res.concat(out); |
|||
free(out); |
|||
return res; |
|||
} |
|||
|
|||
String requestDigestAuthentication(const char * realm){ |
|||
String header = "realm=\""; |
|||
if(realm == NULL) |
|||
header.concat("asyncesp"); |
|||
else |
|||
header.concat(realm); |
|||
header.concat( "\", qop=\"auth\", nonce=\""); |
|||
header.concat(genRandomMD5()); |
|||
header.concat("\", opaque=\""); |
|||
header.concat(genRandomMD5()); |
|||
header.concat("\""); |
|||
return header; |
|||
} |
|||
|
|||
bool checkDigestAuthentication(const char * header, const char * method, const char * username, const char * password, const char * realm, bool passwordIsHash, const char * nonce, const char * opaque, const char * uri){ |
|||
if(username == NULL || password == NULL || header == NULL || method == NULL){ |
|||
//os_printf("AUTH FAIL: missing requred fields\n");
|
|||
return false; |
|||
} |
|||
|
|||
String myHeader = String(header); |
|||
int nextBreak = myHeader.indexOf(","); |
|||
if(nextBreak < 0){ |
|||
//os_printf("AUTH FAIL: no variables\n");
|
|||
return false; |
|||
} |
|||
|
|||
String myUsername = String(); |
|||
String myRealm = String(); |
|||
String myNonce = String(); |
|||
String myUri = String(); |
|||
String myResponse = String(); |
|||
String myQop = String(); |
|||
String myNc = String(); |
|||
String myCnonce = String(); |
|||
|
|||
myHeader += ", "; |
|||
do { |
|||
String avLine = myHeader.substring(0, nextBreak); |
|||
avLine.trim(); |
|||
myHeader = myHeader.substring(nextBreak+1); |
|||
nextBreak = myHeader.indexOf(","); |
|||
|
|||
int eqSign = avLine.indexOf("="); |
|||
if(eqSign < 0){ |
|||
//os_printf("AUTH FAIL: no = sign\n");
|
|||
return false; |
|||
} |
|||
String varName = avLine.substring(0, eqSign); |
|||
avLine = avLine.substring(eqSign + 1); |
|||
if(avLine.startsWith("\"")){ |
|||
avLine = avLine.substring(1, avLine.length() - 1); |
|||
} |
|||
|
|||
if(varName.equals("username")){ |
|||
if(!avLine.equals(username)){ |
|||
//os_printf("AUTH FAIL: username\n");
|
|||
return false; |
|||
} |
|||
myUsername = avLine; |
|||
} else if(varName.equals("realm")){ |
|||
if(realm != NULL && !avLine.equals(realm)){ |
|||
//os_printf("AUTH FAIL: realm\n");
|
|||
return false; |
|||
} |
|||
myRealm = avLine; |
|||
} else if(varName.equals("nonce")){ |
|||
if(nonce != NULL && !avLine.equals(nonce)){ |
|||
//os_printf("AUTH FAIL: nonce\n");
|
|||
return false; |
|||
} |
|||
myNonce = avLine; |
|||
} else if(varName.equals("opaque")){ |
|||
if(opaque != NULL && !avLine.equals(opaque)){ |
|||
//os_printf("AUTH FAIL: opaque\n");
|
|||
return false; |
|||
} |
|||
} else if(varName.equals("uri")){ |
|||
if(uri != NULL && !avLine.equals(uri)){ |
|||
//os_printf("AUTH FAIL: uri\n");
|
|||
return false; |
|||
} |
|||
myUri = avLine; |
|||
} else if(varName.equals("response")){ |
|||
myResponse = avLine; |
|||
} else if(varName.equals("qop")){ |
|||
myQop = avLine; |
|||
} else if(varName.equals("nc")){ |
|||
myNc = avLine; |
|||
} else if(varName.equals("cnonce")){ |
|||
myCnonce = avLine; |
|||
} |
|||
} while(nextBreak > 0); |
|||
|
|||
String ha1 = (passwordIsHash) ? String(password) : stringMD5(myUsername + ":" + myRealm + ":" + String(password)); |
|||
String ha2 = String(method) + ":" + myUri; |
|||
String response = ha1 + ":" + myNonce + ":" + myNc + ":" + myCnonce + ":" + myQop + ":" + stringMD5(ha2); |
|||
|
|||
if(myResponse.equals(stringMD5(response))){ |
|||
//os_printf("AUTH SUCCESS\n");
|
|||
return true; |
|||
} |
|||
|
|||
//os_printf("AUTH FAIL: password\n");
|
|||
return false; |
|||
} |
|||
@ -0,0 +1,34 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
|
|||
#ifndef WEB_AUTHENTICATION_H_ |
|||
#define WEB_AUTHENTICATION_H_ |
|||
|
|||
#include "Arduino.h" |
|||
|
|||
bool checkBasicAuthentication(const char * header, const char * username, const char * password); |
|||
String requestDigestAuthentication(const char * realm); |
|||
bool checkDigestAuthentication(const char * header, const char * method, const char * username, const char * password, const char * realm, bool passwordIsHash, const char * nonce, const char * opaque, const char * uri); |
|||
|
|||
//for storing hashed versions on the device that can be authenticated against
|
|||
String generateDigestHash(const char * username, const char * password, const char * realm); |
|||
|
|||
#endif |
|||
@ -0,0 +1,138 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#ifndef ASYNCWEBSERVERHANDLERIMPL_H_ |
|||
#define ASYNCWEBSERVERHANDLERIMPL_H_ |
|||
|
|||
#include <string> |
|||
#ifdef ASYNCWEBSERVER_REGEX |
|||
#include <regex> |
|||
#endif |
|||
|
|||
#include "stddef.h" |
|||
#include <time.h> |
|||
|
|||
class AsyncStaticWebHandler: public AsyncWebHandler { |
|||
using File = fs::File; |
|||
using FS = fs::FS; |
|||
private: |
|||
bool _getFile(AsyncWebServerRequest *request); |
|||
bool _fileExists(AsyncWebServerRequest *request, const String& path); |
|||
uint8_t _countBits(const uint8_t value) const; |
|||
protected: |
|||
FS _fs; |
|||
String _uri; |
|||
String _path; |
|||
String _default_file; |
|||
String _cache_control; |
|||
String _last_modified; |
|||
AwsTemplateProcessor _callback; |
|||
bool _isDir; |
|||
bool _gzipFirst; |
|||
uint8_t _gzipStats; |
|||
public: |
|||
AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control); |
|||
virtual bool canHandle(AsyncWebServerRequest *request) override final; |
|||
virtual void handleRequest(AsyncWebServerRequest *request) override final; |
|||
AsyncStaticWebHandler& setIsDir(bool isDir); |
|||
AsyncStaticWebHandler& setDefaultFile(const char* filename); |
|||
AsyncStaticWebHandler& setCacheControl(const char* cache_control); |
|||
AsyncStaticWebHandler& setLastModified(const char* last_modified); |
|||
AsyncStaticWebHandler& setLastModified(struct tm* last_modified); |
|||
#ifdef ESP8266 |
|||
AsyncStaticWebHandler& setLastModified(time_t last_modified); |
|||
AsyncStaticWebHandler& setLastModified(); //sets to current time. Make sure sntp is runing and time is updated
|
|||
#endif |
|||
AsyncStaticWebHandler& setTemplateProcessor(AwsTemplateProcessor newCallback) {_callback = newCallback; return *this;} |
|||
}; |
|||
|
|||
class AsyncCallbackWebHandler: public AsyncWebHandler { |
|||
private: |
|||
protected: |
|||
String _uri; |
|||
WebRequestMethodComposite _method; |
|||
ArRequestHandlerFunction _onRequest; |
|||
ArUploadHandlerFunction _onUpload; |
|||
ArBodyHandlerFunction _onBody; |
|||
bool _isRegex; |
|||
public: |
|||
AsyncCallbackWebHandler() : _uri(), _method(HTTP_ANY), _onRequest(NULL), _onUpload(NULL), _onBody(NULL), _isRegex(false) {} |
|||
void setUri(const String& uri){ |
|||
_uri = uri; |
|||
_isRegex = uri.startsWith("^") && uri.endsWith("$"); |
|||
} |
|||
void setMethod(WebRequestMethodComposite method){ _method = method; } |
|||
void onRequest(ArRequestHandlerFunction fn){ _onRequest = fn; } |
|||
void onUpload(ArUploadHandlerFunction fn){ _onUpload = fn; } |
|||
void onBody(ArBodyHandlerFunction fn){ _onBody = fn; } |
|||
|
|||
virtual bool canHandle(AsyncWebServerRequest *request) override final{ |
|||
|
|||
if(!_onRequest) |
|||
return false; |
|||
|
|||
if(!(_method & request->method())) |
|||
return false; |
|||
|
|||
#ifdef ASYNCWEBSERVER_REGEX |
|||
if (_isRegex) { |
|||
std::regex pattern(_uri.c_str()); |
|||
std::smatch matches; |
|||
std::string s(request->url().c_str()); |
|||
if(std::regex_search(s, matches, pattern)) { |
|||
for (size_t i = 1; i < matches.size(); ++i) { // start from 1
|
|||
request->_addPathParam(matches[i].str().c_str()); |
|||
} |
|||
} else { |
|||
return false; |
|||
} |
|||
} else |
|||
#endif |
|||
if (_uri.length() && _uri.endsWith("*")) { |
|||
String uriTemplate = String(_uri); |
|||
uriTemplate = uriTemplate.substring(0, uriTemplate.length() - 1); |
|||
if (!request->url().startsWith(uriTemplate)) |
|||
return false; |
|||
} |
|||
else if(_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri+"/"))) |
|||
return false; |
|||
|
|||
request->addInterestingHeader("ANY"); |
|||
return true; |
|||
} |
|||
|
|||
virtual void handleRequest(AsyncWebServerRequest *request) override final { |
|||
if(_onRequest) |
|||
_onRequest(request); |
|||
else |
|||
request->send(500); |
|||
} |
|||
virtual void handleUpload(AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final) override final { |
|||
if(_onUpload) |
|||
_onUpload(request, filename, index, data, len, final); |
|||
} |
|||
virtual void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) override final { |
|||
if(_onBody) |
|||
_onBody(request, data, len, index, total); |
|||
} |
|||
virtual bool isRequestHandlerTrivial() override final {return _onRequest ? false : true;} |
|||
}; |
|||
|
|||
#endif /* ASYNCWEBSERVERHANDLERIMPL_H_ */ |
|||
@ -0,0 +1,220 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#include "ESPAsyncWebServer.h" |
|||
#include "WebHandlerImpl.h" |
|||
|
|||
AsyncStaticWebHandler::AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control) |
|||
: _fs(fs), _uri(uri), _path(path), _default_file("index.htm"), _cache_control(cache_control), _last_modified(""), _callback(nullptr) |
|||
{ |
|||
// Ensure leading '/'
|
|||
if (_uri.length() == 0 || _uri[0] != '/') _uri = "/" + _uri; |
|||
if (_path.length() == 0 || _path[0] != '/') _path = "/" + _path; |
|||
|
|||
// If path ends with '/' we assume a hint that this is a directory to improve performance.
|
|||
// However - if it does not end with '/' we, can't assume a file, path can still be a directory.
|
|||
_isDir = _path[_path.length()-1] == '/'; |
|||
|
|||
// Remove the trailing '/' so we can handle default file
|
|||
// Notice that root will be "" not "/"
|
|||
if (_uri[_uri.length()-1] == '/') _uri = _uri.substring(0, _uri.length()-1); |
|||
if (_path[_path.length()-1] == '/') _path = _path.substring(0, _path.length()-1); |
|||
|
|||
// Reset stats
|
|||
_gzipFirst = false; |
|||
_gzipStats = 0xF8; |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setIsDir(bool isDir){ |
|||
_isDir = isDir; |
|||
return *this; |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setDefaultFile(const char* filename){ |
|||
_default_file = String(filename); |
|||
return *this; |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setCacheControl(const char* cache_control){ |
|||
_cache_control = String(cache_control); |
|||
return *this; |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(const char* last_modified){ |
|||
_last_modified = String(last_modified); |
|||
return *this; |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(struct tm* last_modified){ |
|||
char result[30]; |
|||
strftime (result,30,"%a, %d %b %Y %H:%M:%S %Z", last_modified); |
|||
return setLastModified((const char *)result); |
|||
} |
|||
|
|||
#ifdef ESP8266 |
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(time_t last_modified){ |
|||
return setLastModified((struct tm *)gmtime(&last_modified)); |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(){ |
|||
time_t last_modified; |
|||
if(time(&last_modified) == 0) //time is not yet set
|
|||
return *this; |
|||
return setLastModified(last_modified); |
|||
} |
|||
#endif |
|||
bool AsyncStaticWebHandler::canHandle(AsyncWebServerRequest *request){ |
|||
if(request->method() != HTTP_GET |
|||
|| !request->url().startsWith(_uri) |
|||
|| !request->isExpectedRequestedConnType(RCT_DEFAULT, RCT_HTTP) |
|||
){ |
|||
return false; |
|||
} |
|||
if (_getFile(request)) { |
|||
// We interested in "If-Modified-Since" header to check if file was modified
|
|||
if (_last_modified.length()) |
|||
request->addInterestingHeader("If-Modified-Since"); |
|||
|
|||
if(_cache_control.length()) |
|||
request->addInterestingHeader("If-None-Match"); |
|||
|
|||
DEBUGF("[AsyncStaticWebHandler::canHandle] TRUE\n"); |
|||
return true; |
|||
} |
|||
|
|||
return false; |
|||
} |
|||
|
|||
bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest *request) |
|||
{ |
|||
// Remove the found uri
|
|||
String path = request->url().substring(_uri.length()); |
|||
|
|||
// We can skip the file check and look for default if request is to the root of a directory or that request path ends with '/'
|
|||
bool canSkipFileCheck = (_isDir && path.length() == 0) || (path.length() && path[path.length()-1] == '/'); |
|||
|
|||
path = _path + path; |
|||
|
|||
// Do we have a file or .gz file
|
|||
if (!canSkipFileCheck && _fileExists(request, path)) |
|||
return true; |
|||
|
|||
// Can't handle if not default file
|
|||
if (_default_file.length() == 0) |
|||
return false; |
|||
|
|||
// Try to add default file, ensure there is a trailing '/' ot the path.
|
|||
if (path.length() == 0 || path[path.length()-1] != '/') |
|||
path += "/"; |
|||
path += _default_file; |
|||
|
|||
return _fileExists(request, path); |
|||
} |
|||
|
|||
#ifdef ESP32 |
|||
#define FILE_IS_REAL(f) (f == true && !f.isDirectory()) |
|||
#else |
|||
#define FILE_IS_REAL(f) (f == true) |
|||
#endif |
|||
|
|||
bool AsyncStaticWebHandler::_fileExists(AsyncWebServerRequest *request, const String& path) |
|||
{ |
|||
bool fileFound = false; |
|||
bool gzipFound = false; |
|||
|
|||
String gzip = path + ".gz"; |
|||
|
|||
if (_gzipFirst) { |
|||
request->_tempFile = _fs.open(gzip, "r"); |
|||
gzipFound = FILE_IS_REAL(request->_tempFile); |
|||
if (!gzipFound){ |
|||
request->_tempFile = _fs.open(path, "r"); |
|||
fileFound = FILE_IS_REAL(request->_tempFile); |
|||
} |
|||
} else { |
|||
request->_tempFile = _fs.open(path, "r"); |
|||
fileFound = FILE_IS_REAL(request->_tempFile); |
|||
if (!fileFound){ |
|||
request->_tempFile = _fs.open(gzip, "r"); |
|||
gzipFound = FILE_IS_REAL(request->_tempFile); |
|||
} |
|||
} |
|||
|
|||
bool found = fileFound || gzipFound; |
|||
|
|||
if (found) { |
|||
// Extract the file name from the path and keep it in _tempObject
|
|||
size_t pathLen = path.length(); |
|||
char * _tempPath = (char*)malloc(pathLen+1); |
|||
snprintf(_tempPath, pathLen+1, "%s", path.c_str()); |
|||
request->_tempObject = (void*)_tempPath; |
|||
|
|||
// Calculate gzip statistic
|
|||
_gzipStats = (_gzipStats << 1) + (gzipFound ? 1 : 0); |
|||
if (_gzipStats == 0x00) _gzipFirst = false; // All files are not gzip
|
|||
else if (_gzipStats == 0xFF) _gzipFirst = true; // All files are gzip
|
|||
else _gzipFirst = _countBits(_gzipStats) > 4; // IF we have more gzip files - try gzip first
|
|||
} |
|||
|
|||
return found; |
|||
} |
|||
|
|||
uint8_t AsyncStaticWebHandler::_countBits(const uint8_t value) const |
|||
{ |
|||
uint8_t w = value; |
|||
uint8_t n; |
|||
for (n=0; w!=0; n++) w&=w-1; |
|||
return n; |
|||
} |
|||
|
|||
void AsyncStaticWebHandler::handleRequest(AsyncWebServerRequest *request) |
|||
{ |
|||
// Get the filename from request->_tempObject and free it
|
|||
String filename = String((char*)request->_tempObject); |
|||
free(request->_tempObject); |
|||
request->_tempObject = NULL; |
|||
if((_username != "" && _password != "") && !request->authenticate(_username.c_str(), _password.c_str())) |
|||
return request->requestAuthentication(); |
|||
|
|||
if (request->_tempFile == true) { |
|||
String etag = String(request->_tempFile.size()); |
|||
if (_last_modified.length() && _last_modified == request->header("If-Modified-Since")) { |
|||
request->_tempFile.close(); |
|||
request->send(304); // Not modified
|
|||
} else if (_cache_control.length() && request->hasHeader("If-None-Match") && request->header("If-None-Match").equals(etag)) { |
|||
request->_tempFile.close(); |
|||
AsyncWebServerResponse * response = new AsyncBasicResponse(304); // Not modified
|
|||
response->addHeader("Cache-Control", _cache_control); |
|||
response->addHeader("ETag", etag); |
|||
request->send(response); |
|||
} else { |
|||
AsyncWebServerResponse * response = new AsyncFileResponse(request->_tempFile, filename, String(), false, _callback); |
|||
if (_last_modified.length()) |
|||
response->addHeader("Last-Modified", _last_modified); |
|||
if (_cache_control.length()){ |
|||
response->addHeader("Cache-Control", _cache_control); |
|||
response->addHeader("ETag", etag); |
|||
} |
|||
request->send(response); |
|||
} |
|||
} else { |
|||
request->send(404); |
|||
} |
|||
} |
|||
File diff suppressed because it is too large
@ -0,0 +1,136 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#ifndef ASYNCWEBSERVERRESPONSEIMPL_H_ |
|||
#define ASYNCWEBSERVERRESPONSEIMPL_H_ |
|||
|
|||
#ifdef Arduino_h |
|||
// arduino is not compatible with std::vector
|
|||
#undef min |
|||
#undef max |
|||
#endif |
|||
#include <vector> |
|||
// It is possible to restore these defines, but one can use _min and _max instead. Or std::min, std::max.
|
|||
|
|||
class AsyncBasicResponse: public AsyncWebServerResponse { |
|||
private: |
|||
String _content; |
|||
public: |
|||
AsyncBasicResponse(int code, const String& contentType=String(), const String& content=String()); |
|||
void _respond(AsyncWebServerRequest *request); |
|||
size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); |
|||
bool _sourceValid() const { return true; } |
|||
}; |
|||
|
|||
class AsyncAbstractResponse: public AsyncWebServerResponse { |
|||
private: |
|||
String _head; |
|||
// Data is inserted into cache at begin().
|
|||
// This is inefficient with vector, but if we use some other container,
|
|||
// we won't be able to access it as contiguous array of bytes when reading from it,
|
|||
// so by gaining performance in one place, we'll lose it in another.
|
|||
std::vector<uint8_t> _cache; |
|||
size_t _readDataFromCacheOrContent(uint8_t* data, const size_t len); |
|||
size_t _fillBufferAndProcessTemplates(uint8_t* buf, size_t maxLen); |
|||
protected: |
|||
AwsTemplateProcessor _callback; |
|||
public: |
|||
AsyncAbstractResponse(AwsTemplateProcessor callback=nullptr); |
|||
void _respond(AsyncWebServerRequest *request); |
|||
size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); |
|||
bool _sourceValid() const { return false; } |
|||
virtual size_t _fillBuffer(uint8_t *buf __attribute__((unused)), size_t maxLen __attribute__((unused))) { return 0; } |
|||
}; |
|||
|
|||
#ifndef TEMPLATE_PLACEHOLDER |
|||
#define TEMPLATE_PLACEHOLDER '%' |
|||
#endif |
|||
|
|||
#define TEMPLATE_PARAM_NAME_LENGTH 32 |
|||
class AsyncFileResponse: public AsyncAbstractResponse { |
|||
using File = fs::File; |
|||
using FS = fs::FS; |
|||
private: |
|||
File _content; |
|||
String _path; |
|||
void _setContentType(const String& path); |
|||
public: |
|||
AsyncFileResponse(FS &fs, const String& path, const String& contentType=String(), bool download=false, AwsTemplateProcessor callback=nullptr); |
|||
AsyncFileResponse(File content, const String& path, const String& contentType=String(), bool download=false, AwsTemplateProcessor callback=nullptr); |
|||
~AsyncFileResponse(); |
|||
bool _sourceValid() const { return !!(_content); } |
|||
virtual size_t _fillBuffer(uint8_t *buf, size_t maxLen) override; |
|||
}; |
|||
|
|||
class AsyncStreamResponse: public AsyncAbstractResponse { |
|||
private: |
|||
Stream *_content; |
|||
public: |
|||
AsyncStreamResponse(Stream &stream, const String& contentType, size_t len, AwsTemplateProcessor callback=nullptr); |
|||
bool _sourceValid() const { return !!(_content); } |
|||
virtual size_t _fillBuffer(uint8_t *buf, size_t maxLen) override; |
|||
}; |
|||
|
|||
class AsyncCallbackResponse: public AsyncAbstractResponse { |
|||
private: |
|||
AwsResponseFiller _content; |
|||
size_t _filledLength; |
|||
public: |
|||
AsyncCallbackResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback=nullptr); |
|||
bool _sourceValid() const { return !!(_content); } |
|||
virtual size_t _fillBuffer(uint8_t *buf, size_t maxLen) override; |
|||
}; |
|||
|
|||
class AsyncChunkedResponse: public AsyncAbstractResponse { |
|||
private: |
|||
AwsResponseFiller _content; |
|||
size_t _filledLength; |
|||
public: |
|||
AsyncChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback=nullptr); |
|||
bool _sourceValid() const { return !!(_content); } |
|||
virtual size_t _fillBuffer(uint8_t *buf, size_t maxLen) override; |
|||
}; |
|||
|
|||
class AsyncProgmemResponse: public AsyncAbstractResponse { |
|||
private: |
|||
const uint8_t * _content; |
|||
size_t _readLength; |
|||
public: |
|||
AsyncProgmemResponse(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback=nullptr); |
|||
bool _sourceValid() const { return true; } |
|||
virtual size_t _fillBuffer(uint8_t *buf, size_t maxLen) override; |
|||
}; |
|||
|
|||
class cbuf; |
|||
|
|||
class AsyncResponseStream: public AsyncAbstractResponse, public Print { |
|||
private: |
|||
cbuf *_content; |
|||
public: |
|||
AsyncResponseStream(const String& contentType, size_t bufferSize); |
|||
~AsyncResponseStream(); |
|||
bool _sourceValid() const { return (_state < RESPONSE_END); } |
|||
virtual size_t _fillBuffer(uint8_t *buf, size_t maxLen) override; |
|||
size_t write(const uint8_t *data, size_t len); |
|||
size_t write(uint8_t data); |
|||
using Print::write; |
|||
}; |
|||
|
|||
#endif /* ASYNCWEBSERVERRESPONSEIMPL_H_ */ |
|||
@ -0,0 +1,699 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#include "ESPAsyncWebServer.h" |
|||
#include "WebResponseImpl.h" |
|||
#include "cbuf.h" |
|||
|
|||
// Since ESP8266 does not link memchr by default, here's its implementation.
|
|||
void* memchr(void* ptr, int ch, size_t count) |
|||
{ |
|||
unsigned char* p = static_cast<unsigned char*>(ptr); |
|||
while(count--) |
|||
if(*p++ == static_cast<unsigned char>(ch)) |
|||
return --p; |
|||
return nullptr; |
|||
} |
|||
|
|||
|
|||
/*
|
|||
* Abstract Response |
|||
* */ |
|||
const char* AsyncWebServerResponse::_responseCodeToString(int code) { |
|||
switch (code) { |
|||
case 100: return "Continue"; |
|||
case 101: return "Switching Protocols"; |
|||
case 200: return "OK"; |
|||
case 201: return "Created"; |
|||
case 202: return "Accepted"; |
|||
case 203: return "Non-Authoritative Information"; |
|||
case 204: return "No Content"; |
|||
case 205: return "Reset Content"; |
|||
case 206: return "Partial Content"; |
|||
case 300: return "Multiple Choices"; |
|||
case 301: return "Moved Permanently"; |
|||
case 302: return "Found"; |
|||
case 303: return "See Other"; |
|||
case 304: return "Not Modified"; |
|||
case 305: return "Use Proxy"; |
|||
case 307: return "Temporary Redirect"; |
|||
case 400: return "Bad Request"; |
|||
case 401: return "Unauthorized"; |
|||
case 402: return "Payment Required"; |
|||
case 403: return "Forbidden"; |
|||
case 404: return "Not Found"; |
|||
case 405: return "Method Not Allowed"; |
|||
case 406: return "Not Acceptable"; |
|||
case 407: return "Proxy Authentication Required"; |
|||
case 408: return "Request Time-out"; |
|||
case 409: return "Conflict"; |
|||
case 410: return "Gone"; |
|||
case 411: return "Length Required"; |
|||
case 412: return "Precondition Failed"; |
|||
case 413: return "Request Entity Too Large"; |
|||
case 414: return "Request-URI Too Large"; |
|||
case 415: return "Unsupported Media Type"; |
|||
case 416: return "Requested range not satisfiable"; |
|||
case 417: return "Expectation Failed"; |
|||
case 500: return "Internal Server Error"; |
|||
case 501: return "Not Implemented"; |
|||
case 502: return "Bad Gateway"; |
|||
case 503: return "Service Unavailable"; |
|||
case 504: return "Gateway Time-out"; |
|||
case 505: return "HTTP Version not supported"; |
|||
default: return ""; |
|||
} |
|||
} |
|||
|
|||
AsyncWebServerResponse::AsyncWebServerResponse() |
|||
: _code(0) |
|||
, _headers(LinkedList<AsyncWebHeader *>([](AsyncWebHeader *h){ delete h; })) |
|||
, _contentType() |
|||
, _contentLength(0) |
|||
, _sendContentLength(true) |
|||
, _chunked(false) |
|||
, _headLength(0) |
|||
, _sentLength(0) |
|||
, _ackedLength(0) |
|||
, _writtenLength(0) |
|||
, _state(RESPONSE_SETUP) |
|||
{ |
|||
for(auto header: DefaultHeaders::Instance()) { |
|||
_headers.add(new AsyncWebHeader(header->name(), header->value())); |
|||
} |
|||
} |
|||
|
|||
AsyncWebServerResponse::~AsyncWebServerResponse(){ |
|||
_headers.free(); |
|||
} |
|||
|
|||
void AsyncWebServerResponse::setCode(int code){ |
|||
if(_state == RESPONSE_SETUP) |
|||
_code = code; |
|||
} |
|||
|
|||
void AsyncWebServerResponse::setContentLength(size_t len){ |
|||
if(_state == RESPONSE_SETUP) |
|||
_contentLength = len; |
|||
} |
|||
|
|||
void AsyncWebServerResponse::setContentType(const String& type){ |
|||
if(_state == RESPONSE_SETUP) |
|||
_contentType = type; |
|||
} |
|||
|
|||
void AsyncWebServerResponse::addHeader(const String& name, const String& value){ |
|||
_headers.add(new AsyncWebHeader(name, value)); |
|||
} |
|||
|
|||
String AsyncWebServerResponse::_assembleHead(uint8_t version){ |
|||
if(version){ |
|||
addHeader("Accept-Ranges","none"); |
|||
if(_chunked) |
|||
addHeader("Transfer-Encoding","chunked"); |
|||
} |
|||
String out = String(); |
|||
int bufSize = 300; |
|||
char buf[bufSize]; |
|||
|
|||
snprintf(buf, bufSize, "HTTP/1.%d %d %s\r\n", version, _code, _responseCodeToString(_code)); |
|||
out.concat(buf); |
|||
|
|||
if(_sendContentLength) { |
|||
snprintf(buf, bufSize, "Content-Length: %d\r\n", _contentLength); |
|||
out.concat(buf); |
|||
} |
|||
if(_contentType.length()) { |
|||
snprintf(buf, bufSize, "Content-Type: %s\r\n", _contentType.c_str()); |
|||
out.concat(buf); |
|||
} |
|||
|
|||
for(const auto& header: _headers){ |
|||
snprintf(buf, bufSize, "%s: %s\r\n", header->name().c_str(), header->value().c_str()); |
|||
out.concat(buf); |
|||
} |
|||
_headers.free(); |
|||
|
|||
out.concat("\r\n"); |
|||
_headLength = out.length(); |
|||
return out; |
|||
} |
|||
|
|||
bool AsyncWebServerResponse::_started() const { return _state > RESPONSE_SETUP; } |
|||
bool AsyncWebServerResponse::_finished() const { return _state > RESPONSE_WAIT_ACK; } |
|||
bool AsyncWebServerResponse::_failed() const { return _state == RESPONSE_FAILED; } |
|||
bool AsyncWebServerResponse::_sourceValid() const { return false; } |
|||
void AsyncWebServerResponse::_respond(AsyncWebServerRequest *request){ _state = RESPONSE_END; request->client()->close(); } |
|||
size_t AsyncWebServerResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time){ (void)request; (void)len; (void)time; return 0; } |
|||
|
|||
/*
|
|||
* String/Code Response |
|||
* */ |
|||
AsyncBasicResponse::AsyncBasicResponse(int code, const String& contentType, const String& content){ |
|||
_code = code; |
|||
_content = content; |
|||
_contentType = contentType; |
|||
if(_content.length()){ |
|||
_contentLength = _content.length(); |
|||
if(!_contentType.length()) |
|||
_contentType = "text/plain"; |
|||
} |
|||
addHeader("Connection","close"); |
|||
} |
|||
|
|||
void AsyncBasicResponse::_respond(AsyncWebServerRequest *request){ |
|||
_state = RESPONSE_HEADERS; |
|||
String out = _assembleHead(request->version()); |
|||
size_t outLen = out.length(); |
|||
size_t space = request->client()->space(); |
|||
if(!_contentLength && space >= outLen){ |
|||
_writtenLength += request->client()->write(out.c_str(), outLen); |
|||
_state = RESPONSE_WAIT_ACK; |
|||
} else if(_contentLength && space >= outLen + _contentLength){ |
|||
out += _content; |
|||
outLen += _contentLength; |
|||
_writtenLength += request->client()->write(out.c_str(), outLen); |
|||
_state = RESPONSE_WAIT_ACK; |
|||
} else if(space && space < outLen){ |
|||
String partial = out.substring(0, space); |
|||
_content = out.substring(space) + _content; |
|||
_contentLength += outLen - space; |
|||
_writtenLength += request->client()->write(partial.c_str(), partial.length()); |
|||
_state = RESPONSE_CONTENT; |
|||
} else if(space > outLen && space < (outLen + _contentLength)){ |
|||
size_t shift = space - outLen; |
|||
outLen += shift; |
|||
_sentLength += shift; |
|||
out += _content.substring(0, shift); |
|||
_content = _content.substring(shift); |
|||
_writtenLength += request->client()->write(out.c_str(), outLen); |
|||
_state = RESPONSE_CONTENT; |
|||
} else { |
|||
_content = out + _content; |
|||
_contentLength += outLen; |
|||
_state = RESPONSE_CONTENT; |
|||
} |
|||
} |
|||
|
|||
size_t AsyncBasicResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time){ |
|||
(void)time; |
|||
_ackedLength += len; |
|||
if(_state == RESPONSE_CONTENT){ |
|||
size_t available = _contentLength - _sentLength; |
|||
size_t space = request->client()->space(); |
|||
//we can fit in this packet
|
|||
if(space > available){ |
|||
_writtenLength += request->client()->write(_content.c_str(), available); |
|||
_content = String(); |
|||
_state = RESPONSE_WAIT_ACK; |
|||
return available; |
|||
} |
|||
//send some data, the rest on ack
|
|||
String out = _content.substring(0, space); |
|||
_content = _content.substring(space); |
|||
_sentLength += space; |
|||
_writtenLength += request->client()->write(out.c_str(), space); |
|||
return space; |
|||
} else if(_state == RESPONSE_WAIT_ACK){ |
|||
if(_ackedLength >= _writtenLength){ |
|||
_state = RESPONSE_END; |
|||
} |
|||
} |
|||
return 0; |
|||
} |
|||
|
|||
|
|||
/*
|
|||
* Abstract Response |
|||
* */ |
|||
|
|||
AsyncAbstractResponse::AsyncAbstractResponse(AwsTemplateProcessor callback): _callback(callback) |
|||
{ |
|||
// In case of template processing, we're unable to determine real response size
|
|||
if(callback) { |
|||
_contentLength = 0; |
|||
_sendContentLength = false; |
|||
_chunked = true; |
|||
} |
|||
} |
|||
|
|||
void AsyncAbstractResponse::_respond(AsyncWebServerRequest *request){ |
|||
addHeader("Connection","close"); |
|||
_head = _assembleHead(request->version()); |
|||
_state = RESPONSE_HEADERS; |
|||
_ack(request, 0, 0); |
|||
} |
|||
|
|||
size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time){ |
|||
(void)time; |
|||
if(!_sourceValid()){ |
|||
_state = RESPONSE_FAILED; |
|||
request->client()->close(); |
|||
return 0; |
|||
} |
|||
_ackedLength += len; |
|||
size_t space = request->client()->space(); |
|||
|
|||
size_t headLen = _head.length(); |
|||
if(_state == RESPONSE_HEADERS){ |
|||
if(space >= headLen){ |
|||
_state = RESPONSE_CONTENT; |
|||
space -= headLen; |
|||
} else { |
|||
String out = _head.substring(0, space); |
|||
_head = _head.substring(space); |
|||
_writtenLength += request->client()->write(out.c_str(), out.length()); |
|||
return out.length(); |
|||
} |
|||
} |
|||
|
|||
if(_state == RESPONSE_CONTENT){ |
|||
size_t outLen; |
|||
if(_chunked){ |
|||
if(space <= 8){ |
|||
return 0; |
|||
} |
|||
outLen = space; |
|||
} else if(!_sendContentLength){ |
|||
outLen = space; |
|||
} else { |
|||
outLen = ((_contentLength - _sentLength) > space)?space:(_contentLength - _sentLength); |
|||
} |
|||
|
|||
uint8_t *buf = (uint8_t *)malloc(outLen+headLen); |
|||
if (!buf) { |
|||
// os_printf("_ack malloc %d failed\n", outLen+headLen);
|
|||
return 0; |
|||
} |
|||
|
|||
if(headLen){ |
|||
memcpy(buf, _head.c_str(), _head.length()); |
|||
} |
|||
|
|||
size_t readLen = 0; |
|||
|
|||
if(_chunked){ |
|||
// HTTP 1.1 allows leading zeros in chunk length. Or spaces may be added.
|
|||
// See RFC2616 sections 2, 3.6.1.
|
|||
readLen = _fillBufferAndProcessTemplates(buf+headLen+6, outLen - 8); |
|||
if(readLen == RESPONSE_TRY_AGAIN){ |
|||
free(buf); |
|||
return 0; |
|||
} |
|||
outLen = sprintf((char*)buf+headLen, "%x", readLen) + headLen; |
|||
while(outLen < headLen + 4) buf[outLen++] = ' '; |
|||
buf[outLen++] = '\r'; |
|||
buf[outLen++] = '\n'; |
|||
outLen += readLen; |
|||
buf[outLen++] = '\r'; |
|||
buf[outLen++] = '\n'; |
|||
} else { |
|||
readLen = _fillBufferAndProcessTemplates(buf+headLen, outLen); |
|||
if(readLen == RESPONSE_TRY_AGAIN){ |
|||
free(buf); |
|||
return 0; |
|||
} |
|||
outLen = readLen + headLen; |
|||
} |
|||
|
|||
if(headLen){ |
|||
_head = String(); |
|||
} |
|||
|
|||
if(outLen){ |
|||
_writtenLength += request->client()->write((const char*)buf, outLen); |
|||
} |
|||
|
|||
if(_chunked){ |
|||
_sentLength += readLen; |
|||
} else { |
|||
_sentLength += outLen - headLen; |
|||
} |
|||
|
|||
free(buf); |
|||
|
|||
if((_chunked && readLen == 0) || (!_sendContentLength && outLen == 0) || (!_chunked && _sentLength == _contentLength)){ |
|||
_state = RESPONSE_WAIT_ACK; |
|||
} |
|||
return outLen; |
|||
|
|||
} else if(_state == RESPONSE_WAIT_ACK){ |
|||
if(!_sendContentLength || _ackedLength >= _writtenLength){ |
|||
_state = RESPONSE_END; |
|||
if(!_chunked && !_sendContentLength) |
|||
request->client()->close(true); |
|||
} |
|||
} |
|||
return 0; |
|||
} |
|||
|
|||
size_t AsyncAbstractResponse::_readDataFromCacheOrContent(uint8_t* data, const size_t len) |
|||
{ |
|||
// If we have something in cache, copy it to buffer
|
|||
const size_t readFromCache = std::min(len, _cache.size()); |
|||
if(readFromCache) { |
|||
memcpy(data, _cache.data(), readFromCache); |
|||
_cache.erase(_cache.begin(), _cache.begin() + readFromCache); |
|||
} |
|||
// If we need to read more...
|
|||
const size_t needFromFile = len - readFromCache; |
|||
const size_t readFromContent = _fillBuffer(data + readFromCache, needFromFile); |
|||
return readFromCache + readFromContent; |
|||
} |
|||
|
|||
size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size_t len) |
|||
{ |
|||
if(!_callback) |
|||
return _fillBuffer(data, len); |
|||
|
|||
const size_t originalLen = len; |
|||
len = _readDataFromCacheOrContent(data, len); |
|||
// Now we've read 'len' bytes, either from cache or from file
|
|||
// Search for template placeholders
|
|||
uint8_t* pTemplateStart = data; |
|||
while((pTemplateStart < &data[len]) && (pTemplateStart = (uint8_t*)memchr(pTemplateStart, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart + 1))) { // data[0] ... data[len - 1]
|
|||
uint8_t* pTemplateEnd = (pTemplateStart < &data[len - 1]) ? (uint8_t*)memchr(pTemplateStart + 1, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart) : nullptr; |
|||
// temporary buffer to hold parameter name
|
|||
uint8_t buf[TEMPLATE_PARAM_NAME_LENGTH + 1]; |
|||
String paramName; |
|||
// If closing placeholder is found:
|
|||
if(pTemplateEnd) { |
|||
// prepare argument to callback
|
|||
const size_t paramNameLength = std::min(sizeof(buf) - 1, (unsigned int)(pTemplateEnd - pTemplateStart - 1)); |
|||
if(paramNameLength) { |
|||
memcpy(buf, pTemplateStart + 1, paramNameLength); |
|||
buf[paramNameLength] = 0; |
|||
paramName = String(reinterpret_cast<char*>(buf)); |
|||
} else { // double percent sign encountered, this is single percent sign escaped.
|
|||
// remove the 2nd percent sign
|
|||
memmove(pTemplateEnd, pTemplateEnd + 1, &data[len] - pTemplateEnd - 1); |
|||
len += _readDataFromCacheOrContent(&data[len - 1], 1) - 1; |
|||
++pTemplateStart; |
|||
} |
|||
} else if(&data[len - 1] - pTemplateStart + 1 < TEMPLATE_PARAM_NAME_LENGTH + 2) { // closing placeholder not found, check if it's in the remaining file data
|
|||
memcpy(buf, pTemplateStart + 1, &data[len - 1] - pTemplateStart); |
|||
const size_t readFromCacheOrContent = _readDataFromCacheOrContent(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PARAM_NAME_LENGTH + 2 - (&data[len - 1] - pTemplateStart + 1)); |
|||
if(readFromCacheOrContent) { |
|||
pTemplateEnd = (uint8_t*)memchr(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PLACEHOLDER, readFromCacheOrContent); |
|||
if(pTemplateEnd) { |
|||
// prepare argument to callback
|
|||
*pTemplateEnd = 0; |
|||
paramName = String(reinterpret_cast<char*>(buf)); |
|||
// Copy remaining read-ahead data into cache
|
|||
_cache.insert(_cache.begin(), pTemplateEnd + 1, buf + (&data[len - 1] - pTemplateStart) + readFromCacheOrContent); |
|||
pTemplateEnd = &data[len - 1]; |
|||
} |
|||
else // closing placeholder not found in file data, store found percent symbol as is and advance to the next position
|
|||
{ |
|||
// but first, store read file data in cache
|
|||
_cache.insert(_cache.begin(), buf + (&data[len - 1] - pTemplateStart), buf + (&data[len - 1] - pTemplateStart) + readFromCacheOrContent); |
|||
++pTemplateStart; |
|||
} |
|||
} |
|||
else // closing placeholder not found in content data, store found percent symbol as is and advance to the next position
|
|||
++pTemplateStart; |
|||
} |
|||
else // closing placeholder not found in content data, store found percent symbol as is and advance to the next position
|
|||
++pTemplateStart; |
|||
if(paramName.length()) { |
|||
// call callback and replace with result.
|
|||
// Everything in range [pTemplateStart, pTemplateEnd] can be safely replaced with parameter value.
|
|||
// Data after pTemplateEnd may need to be moved.
|
|||
// The first byte of data after placeholder is located at pTemplateEnd + 1.
|
|||
// It should be located at pTemplateStart + numBytesCopied (to begin right after inserted parameter value).
|
|||
const String paramValue(_callback(paramName)); |
|||
const char* pvstr = paramValue.c_str(); |
|||
const unsigned int pvlen = paramValue.length(); |
|||
const size_t numBytesCopied = std::min(pvlen, static_cast<unsigned int>(&data[originalLen - 1] - pTemplateStart + 1)); |
|||
// make room for param value
|
|||
// 1. move extra data to cache if parameter value is longer than placeholder AND if there is no room to store
|
|||
if((pTemplateEnd + 1 < pTemplateStart + numBytesCopied) && (originalLen - (pTemplateStart + numBytesCopied - pTemplateEnd - 1) < len)) { |
|||
_cache.insert(_cache.begin(), &data[originalLen - (pTemplateStart + numBytesCopied - pTemplateEnd - 1)], &data[len]); |
|||
//2. parameter value is longer than placeholder text, push the data after placeholder which not saved into cache further to the end
|
|||
memmove(pTemplateStart + numBytesCopied, pTemplateEnd + 1, &data[originalLen] - pTemplateStart - numBytesCopied); |
|||
len = originalLen; // fix issue with truncated data, not sure if it has any side effects
|
|||
} else if(pTemplateEnd + 1 != pTemplateStart + numBytesCopied) |
|||
//2. Either parameter value is shorter than placeholder text OR there is enough free space in buffer to fit.
|
|||
// Move the entire data after the placeholder
|
|||
memmove(pTemplateStart + numBytesCopied, pTemplateEnd + 1, &data[len] - pTemplateEnd - 1); |
|||
// 3. replace placeholder with actual value
|
|||
memcpy(pTemplateStart, pvstr, numBytesCopied); |
|||
// If result is longer than buffer, copy the remainder into cache (this could happen only if placeholder text itself did not fit entirely in buffer)
|
|||
if(numBytesCopied < pvlen) { |
|||
_cache.insert(_cache.begin(), pvstr + numBytesCopied, pvstr + pvlen); |
|||
} else if(pTemplateStart + numBytesCopied < pTemplateEnd + 1) { // result is copied fully; if result is shorter than placeholder text...
|
|||
// there is some free room, fill it from cache
|
|||
const size_t roomFreed = pTemplateEnd + 1 - pTemplateStart - numBytesCopied; |
|||
const size_t totalFreeRoom = originalLen - len + roomFreed; |
|||
len += _readDataFromCacheOrContent(&data[len - roomFreed], totalFreeRoom) - roomFreed; |
|||
} else { // result is copied fully; it is longer than placeholder text
|
|||
const size_t roomTaken = pTemplateStart + numBytesCopied - pTemplateEnd - 1; |
|||
len = std::min(len + roomTaken, originalLen); |
|||
} |
|||
} |
|||
} // while(pTemplateStart)
|
|||
return len; |
|||
} |
|||
|
|||
|
|||
/*
|
|||
* File Response |
|||
* */ |
|||
|
|||
AsyncFileResponse::~AsyncFileResponse(){ |
|||
if(_content) |
|||
_content.close(); |
|||
} |
|||
|
|||
void AsyncFileResponse::_setContentType(const String& path){ |
|||
if (path.endsWith(".html")) _contentType = "text/html"; |
|||
else if (path.endsWith(".htm")) _contentType = "text/html"; |
|||
else if (path.endsWith(".css")) _contentType = "text/css"; |
|||
else if (path.endsWith(".json")) _contentType = "application/json"; |
|||
else if (path.endsWith(".js")) _contentType = "application/javascript"; |
|||
else if (path.endsWith(".png")) _contentType = "image/png"; |
|||
else if (path.endsWith(".gif")) _contentType = "image/gif"; |
|||
else if (path.endsWith(".jpg")) _contentType = "image/jpeg"; |
|||
else if (path.endsWith(".ico")) _contentType = "image/x-icon"; |
|||
else if (path.endsWith(".svg")) _contentType = "image/svg+xml"; |
|||
else if (path.endsWith(".eot")) _contentType = "font/eot"; |
|||
else if (path.endsWith(".woff")) _contentType = "font/woff"; |
|||
else if (path.endsWith(".woff2")) _contentType = "font/woff2"; |
|||
else if (path.endsWith(".ttf")) _contentType = "font/ttf"; |
|||
else if (path.endsWith(".xml")) _contentType = "text/xml"; |
|||
else if (path.endsWith(".pdf")) _contentType = "application/pdf"; |
|||
else if (path.endsWith(".zip")) _contentType = "application/zip"; |
|||
else if(path.endsWith(".gz")) _contentType = "application/x-gzip"; |
|||
else _contentType = "text/plain"; |
|||
} |
|||
|
|||
AsyncFileResponse::AsyncFileResponse(FS &fs, const String& path, const String& contentType, bool download, AwsTemplateProcessor callback): AsyncAbstractResponse(callback){ |
|||
_code = 200; |
|||
_path = path; |
|||
|
|||
if(!download && !fs.exists(_path) && fs.exists(_path+".gz")){ |
|||
_path = _path+".gz"; |
|||
addHeader("Content-Encoding", "gzip"); |
|||
_callback = nullptr; // Unable to process zipped templates
|
|||
_sendContentLength = true; |
|||
_chunked = false; |
|||
} |
|||
|
|||
_content = fs.open(_path, "r"); |
|||
_contentLength = _content.size(); |
|||
|
|||
if(contentType == "") |
|||
_setContentType(path); |
|||
else |
|||
_contentType = contentType; |
|||
|
|||
int filenameStart = path.lastIndexOf('/') + 1; |
|||
char buf[26+path.length()-filenameStart]; |
|||
char* filename = (char*)path.c_str() + filenameStart; |
|||
|
|||
if(download) { |
|||
// set filename and force download
|
|||
snprintf(buf, sizeof (buf), "attachment; filename=\"%s\"", filename); |
|||
} else { |
|||
// set filename and force rendering
|
|||
snprintf(buf, sizeof (buf), "inline; filename=\"%s\"", filename); |
|||
} |
|||
addHeader("Content-Disposition", buf); |
|||
} |
|||
|
|||
AsyncFileResponse::AsyncFileResponse(File content, const String& path, const String& contentType, bool download, AwsTemplateProcessor callback): AsyncAbstractResponse(callback){ |
|||
_code = 200; |
|||
_path = path; |
|||
|
|||
if(!download && String(content.name()).endsWith(".gz") && !path.endsWith(".gz")){ |
|||
addHeader("Content-Encoding", "gzip"); |
|||
_callback = nullptr; // Unable to process gzipped templates
|
|||
_sendContentLength = true; |
|||
_chunked = false; |
|||
} |
|||
|
|||
_content = content; |
|||
_contentLength = _content.size(); |
|||
|
|||
if(contentType == "") |
|||
_setContentType(path); |
|||
else |
|||
_contentType = contentType; |
|||
|
|||
int filenameStart = path.lastIndexOf('/') + 1; |
|||
char buf[26+path.length()-filenameStart]; |
|||
char* filename = (char*)path.c_str() + filenameStart; |
|||
|
|||
if(download) { |
|||
snprintf(buf, sizeof (buf), "attachment; filename=\"%s\"", filename); |
|||
} else { |
|||
snprintf(buf, sizeof (buf), "inline; filename=\"%s\"", filename); |
|||
} |
|||
addHeader("Content-Disposition", buf); |
|||
} |
|||
|
|||
size_t AsyncFileResponse::_fillBuffer(uint8_t *data, size_t len){ |
|||
return _content.read(data, len); |
|||
} |
|||
|
|||
/*
|
|||
* Stream Response |
|||
* */ |
|||
|
|||
AsyncStreamResponse::AsyncStreamResponse(Stream &stream, const String& contentType, size_t len, AwsTemplateProcessor callback): AsyncAbstractResponse(callback) { |
|||
_code = 200; |
|||
_content = &stream; |
|||
_contentLength = len; |
|||
_contentType = contentType; |
|||
} |
|||
|
|||
size_t AsyncStreamResponse::_fillBuffer(uint8_t *data, size_t len){ |
|||
size_t available = _content->available(); |
|||
size_t outLen = (available > len)?len:available; |
|||
size_t i; |
|||
for(i=0;i<outLen;i++) |
|||
data[i] = _content->read(); |
|||
return outLen; |
|||
} |
|||
|
|||
/*
|
|||
* Callback Response |
|||
* */ |
|||
|
|||
AsyncCallbackResponse::AsyncCallbackResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback): AsyncAbstractResponse(templateCallback) { |
|||
_code = 200; |
|||
_content = callback; |
|||
_contentLength = len; |
|||
if(!len) |
|||
_sendContentLength = false; |
|||
_contentType = contentType; |
|||
_filledLength = 0; |
|||
} |
|||
|
|||
size_t AsyncCallbackResponse::_fillBuffer(uint8_t *data, size_t len){ |
|||
size_t ret = _content(data, len, _filledLength); |
|||
if(ret != RESPONSE_TRY_AGAIN){ |
|||
_filledLength += ret; |
|||
} |
|||
return ret; |
|||
} |
|||
|
|||
/*
|
|||
* Chunked Response |
|||
* */ |
|||
|
|||
AsyncChunkedResponse::AsyncChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor processorCallback): AsyncAbstractResponse(processorCallback) { |
|||
_code = 200; |
|||
_content = callback; |
|||
_contentLength = 0; |
|||
_contentType = contentType; |
|||
_sendContentLength = false; |
|||
_chunked = true; |
|||
_filledLength = 0; |
|||
} |
|||
|
|||
size_t AsyncChunkedResponse::_fillBuffer(uint8_t *data, size_t len){ |
|||
size_t ret = _content(data, len, _filledLength); |
|||
if(ret != RESPONSE_TRY_AGAIN){ |
|||
_filledLength += ret; |
|||
} |
|||
return ret; |
|||
} |
|||
|
|||
/*
|
|||
* Progmem Response |
|||
* */ |
|||
|
|||
AsyncProgmemResponse::AsyncProgmemResponse(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback): AsyncAbstractResponse(callback) { |
|||
_code = code; |
|||
_content = content; |
|||
_contentType = contentType; |
|||
_contentLength = len; |
|||
_readLength = 0; |
|||
} |
|||
|
|||
size_t AsyncProgmemResponse::_fillBuffer(uint8_t *data, size_t len){ |
|||
size_t left = _contentLength - _readLength; |
|||
if (left > len) { |
|||
memcpy_P(data, _content + _readLength, len); |
|||
_readLength += len; |
|||
return len; |
|||
} |
|||
memcpy_P(data, _content + _readLength, left); |
|||
_readLength += left; |
|||
return left; |
|||
} |
|||
|
|||
|
|||
/*
|
|||
* Response Stream (You can print/write/printf to it, up to the contentLen bytes) |
|||
* */ |
|||
|
|||
AsyncResponseStream::AsyncResponseStream(const String& contentType, size_t bufferSize){ |
|||
_code = 200; |
|||
_contentLength = 0; |
|||
_contentType = contentType; |
|||
_content = new cbuf(bufferSize); |
|||
} |
|||
|
|||
AsyncResponseStream::~AsyncResponseStream(){ |
|||
delete _content; |
|||
} |
|||
|
|||
size_t AsyncResponseStream::_fillBuffer(uint8_t *buf, size_t maxLen){ |
|||
return _content->read((char*)buf, maxLen); |
|||
} |
|||
|
|||
size_t AsyncResponseStream::write(const uint8_t *data, size_t len){ |
|||
if(_started()) |
|||
return 0; |
|||
|
|||
if(len > _content->room()){ |
|||
size_t needed = len - _content->room(); |
|||
_content->resizeAdd(needed); |
|||
} |
|||
size_t written = _content->write((const char*)data, len); |
|||
_contentLength += written; |
|||
return written; |
|||
} |
|||
|
|||
size_t AsyncResponseStream::write(uint8_t data){ |
|||
return write(&data, 1); |
|||
} |
|||
@ -0,0 +1,193 @@ |
|||
/*
|
|||
Asynchronous WebServer library for Espressif MCUs |
|||
|
|||
Copyright (c) 2016 Hristo Gochkov. All rights reserved. |
|||
This file is part of the esp8266 core for Arduino environment. |
|||
|
|||
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. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
Lesser General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Lesser General Public |
|||
License along with this library; if not, write to the Free Software |
|||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|||
*/ |
|||
#include "ESPAsyncWebServer.h" |
|||
#include "WebHandlerImpl.h" |
|||
|
|||
bool ON_STA_FILTER(AsyncWebServerRequest *request) { |
|||
return WiFi.localIP() == request->client()->localIP(); |
|||
} |
|||
|
|||
bool ON_AP_FILTER(AsyncWebServerRequest *request) { |
|||
return WiFi.localIP() != request->client()->localIP(); |
|||
} |
|||
|
|||
|
|||
AsyncWebServer::AsyncWebServer(uint16_t port) |
|||
: _server(port) |
|||
, _rewrites(LinkedList<AsyncWebRewrite*>([](AsyncWebRewrite* r){ delete r; })) |
|||
, _handlers(LinkedList<AsyncWebHandler*>([](AsyncWebHandler* h){ delete h; })) |
|||
{ |
|||
_catchAllHandler = new AsyncCallbackWebHandler(); |
|||
if(_catchAllHandler == NULL) |
|||
return; |
|||
_server.onClient([](void *s, AsyncClient* c){ |
|||
if(c == NULL) |
|||
return; |
|||
c->setRxTimeout(3); |
|||
AsyncWebServerRequest *r = new AsyncWebServerRequest((AsyncWebServer*)s, c); |
|||
if(r == NULL){ |
|||
c->close(true); |
|||
c->free(); |
|||
delete c; |
|||
} |
|||
}, this); |
|||
} |
|||
|
|||
AsyncWebServer::~AsyncWebServer(){ |
|||
reset(); |
|||
end(); |
|||
if(_catchAllHandler) delete _catchAllHandler; |
|||
} |
|||
|
|||
AsyncWebRewrite& AsyncWebServer::addRewrite(AsyncWebRewrite* rewrite){ |
|||
_rewrites.add(rewrite); |
|||
return *rewrite; |
|||
} |
|||
|
|||
bool AsyncWebServer::removeRewrite(AsyncWebRewrite *rewrite){ |
|||
return _rewrites.remove(rewrite); |
|||
} |
|||
|
|||
AsyncWebRewrite& AsyncWebServer::rewrite(const char* from, const char* to){ |
|||
return addRewrite(new AsyncWebRewrite(from, to)); |
|||
} |
|||
|
|||
AsyncWebHandler& AsyncWebServer::addHandler(AsyncWebHandler* handler){ |
|||
_handlers.add(handler); |
|||
return *handler; |
|||
} |
|||
|
|||
bool AsyncWebServer::removeHandler(AsyncWebHandler *handler){ |
|||
return _handlers.remove(handler); |
|||
} |
|||
|
|||
void AsyncWebServer::begin(){ |
|||
_server.setNoDelay(true); |
|||
_server.begin(); |
|||
} |
|||
|
|||
void AsyncWebServer::end(){ |
|||
_server.end(); |
|||
} |
|||
|
|||
#if ASYNC_TCP_SSL_ENABLED |
|||
void AsyncWebServer::onSslFileRequest(AcSSlFileHandler cb, void* arg){ |
|||
_server.onSslFileRequest(cb, arg); |
|||
} |
|||
|
|||
void AsyncWebServer::beginSecure(const char *cert, const char *key, const char *password){ |
|||
_server.beginSecure(cert, key, password); |
|||
} |
|||
#endif |
|||
|
|||
void AsyncWebServer::_handleDisconnect(AsyncWebServerRequest *request){ |
|||
delete request; |
|||
} |
|||
|
|||
void AsyncWebServer::_rewriteRequest(AsyncWebServerRequest *request){ |
|||
for(const auto& r: _rewrites){ |
|||
if (r->match(request)){ |
|||
request->_url = r->toUrl(); |
|||
request->_addGetParams(r->params()); |
|||
} |
|||
} |
|||
} |
|||
|
|||
void AsyncWebServer::_attachHandler(AsyncWebServerRequest *request){ |
|||
for(const auto& h: _handlers){ |
|||
if (h->filter(request) && h->canHandle(request)){ |
|||
request->setHandler(h); |
|||
return; |
|||
} |
|||
} |
|||
|
|||
request->addInterestingHeader("ANY"); |
|||
request->setHandler(_catchAllHandler); |
|||
} |
|||
|
|||
|
|||
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload, ArBodyHandlerFunction onBody){ |
|||
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler(); |
|||
handler->setUri(uri); |
|||
handler->setMethod(method); |
|||
handler->onRequest(onRequest); |
|||
handler->onUpload(onUpload); |
|||
handler->onBody(onBody); |
|||
addHandler(handler); |
|||
return *handler; |
|||
} |
|||
|
|||
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload){ |
|||
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler(); |
|||
handler->setUri(uri); |
|||
handler->setMethod(method); |
|||
handler->onRequest(onRequest); |
|||
handler->onUpload(onUpload); |
|||
addHandler(handler); |
|||
return *handler; |
|||
} |
|||
|
|||
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest){ |
|||
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler(); |
|||
handler->setUri(uri); |
|||
handler->setMethod(method); |
|||
handler->onRequest(onRequest); |
|||
addHandler(handler); |
|||
return *handler; |
|||
} |
|||
|
|||
AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, ArRequestHandlerFunction onRequest){ |
|||
AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler(); |
|||
handler->setUri(uri); |
|||
handler->onRequest(onRequest); |
|||
addHandler(handler); |
|||
return *handler; |
|||
} |
|||
|
|||
AsyncStaticWebHandler& AsyncWebServer::serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_control){ |
|||
AsyncStaticWebHandler* handler = new AsyncStaticWebHandler(uri, fs, path, cache_control); |
|||
addHandler(handler); |
|||
return *handler; |
|||
} |
|||
|
|||
void AsyncWebServer::onNotFound(ArRequestHandlerFunction fn){ |
|||
_catchAllHandler->onRequest(fn); |
|||
} |
|||
|
|||
void AsyncWebServer::onFileUpload(ArUploadHandlerFunction fn){ |
|||
_catchAllHandler->onUpload(fn); |
|||
} |
|||
|
|||
void AsyncWebServer::onRequestBody(ArBodyHandlerFunction fn){ |
|||
_catchAllHandler->onBody(fn); |
|||
} |
|||
|
|||
void AsyncWebServer::reset(){ |
|||
_rewrites.free(); |
|||
_handlers.free(); |
|||
|
|||
if (_catchAllHandler != NULL){ |
|||
_catchAllHandler->onRequest(NULL); |
|||
_catchAllHandler->onUpload(NULL); |
|||
_catchAllHandler->onBody(NULL); |
|||
} |
|||
} |
|||
|
|||
@ -0,0 +1,627 @@ |
|||
<!--This is the plain html source of the hex encoded Editor-Page embedded in SPIFFSEditor.cpp --> |
|||
<!DOCTYPE html> |
|||
<html lang="en"> |
|||
<head> |
|||
<title>ESP Editor</title> |
|||
<style type="text/css" media="screen"> |
|||
.cm { |
|||
z-index: 300; |
|||
position: absolute; |
|||
left: 5px; |
|||
border: 1px solid #444; |
|||
background-color: #F5F5F5; |
|||
display: none; |
|||
box-shadow: 0 0 10px rgba( 0, 0, 0, .4 ); |
|||
font-size: 12px; |
|||
font-family: sans-serif; |
|||
font-weight:bold; |
|||
} |
|||
.cm ul { |
|||
list-style: none; |
|||
top: 0; |
|||
left: 0; |
|||
margin: 0; |
|||
padding: 0; |
|||
} |
|||
.cm li { |
|||
position: relative; |
|||
min-width: 60px; |
|||
cursor: pointer; |
|||
} |
|||
.cm span { |
|||
color: #444; |
|||
display: inline-block; |
|||
padding: 6px; |
|||
} |
|||
.cm li:hover { background: #444; } |
|||
.cm li:hover span { color: #EEE; } |
|||
.tvu ul, .tvu li { |
|||
padding: 0; |
|||
margin: 0; |
|||
list-style: none; |
|||
} |
|||
.tvu input { |
|||
position: absolute; |
|||
opacity: 0; |
|||
} |
|||
.tvu { |
|||
font: normal 12px Verdana, Arial, Sans-serif; |
|||
-moz-user-select: none; |
|||
-webkit-user-select: none; |
|||
user-select: none; |
|||
color: #444; |
|||
line-height: 16px; |
|||
} |
|||
.tvu span { |
|||
margin-bottom:5px; |
|||
padding: 0 0 0 18px; |
|||
cursor: pointer; |
|||
display: inline-block; |
|||
height: 16px; |
|||
vertical-align: middle; |
|||
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAADoSURBVBgZBcExblNBGAbA2ceegTRBuIKOgiihSZNTcC5LUHAihNJR0kGKCDcYJY6D3/77MdOinTvzAgCw8ysThIvn/VojIyMjIyPP+bS1sUQIV2s95pBDDvmbP/mdkft83tpYguZq5Jh/OeaYh+yzy8hTHvNlaxNNczm+la9OTlar1UdA/+C2A4trRCnD3jS8BB1obq2Gk6GU6QbQAS4BUaYSQAf4bhhKKTFdAzrAOwAxEUAH+KEM01SY3gM6wBsEAQB0gJ+maZoC3gI6iPYaAIBJsiRmHU0AALOeFC3aK2cWAACUXe7+AwO0lc9eTHYTAAAAAElFTkSuQmCC') no-repeat; |
|||
background-position: 0px 0px; |
|||
} |
|||
.tvu span:hover { |
|||
text-decoration: underline; |
|||
} |
|||
@media screen and (-webkit-min-device-pixel-ratio:0){ |
|||
.tvu{ |
|||
-webkit-animation: webkit-adjacent-element-selector-bugfix infinite 1s; |
|||
} |
|||
|
|||
@-webkit-keyframes webkit-adjacent-element-selector-bugfix { |
|||
from { |
|||
padding: 0; |
|||
} |
|||
to { |
|||
padding: 0; |
|||
} |
|||
} |
|||
} |
|||
#uploader { |
|||
position: absolute; |
|||
top: 0; |
|||
right: 0; |
|||
left: 0; |
|||
height:28px; |
|||
line-height: 24px; |
|||
padding-left: 10px; |
|||
background-color: #444; |
|||
color:#EEE; |
|||
} |
|||
#tree { |
|||
position: absolute; |
|||
top: 28px; |
|||
bottom: 0; |
|||
left: 0; |
|||
width:160px; |
|||
padding: 8px; |
|||
} |
|||
#editor, #preview { |
|||
position: absolute; |
|||
top: 28px; |
|||
right: 0; |
|||
bottom: 0; |
|||
left: 160px; |
|||
border-left:1px solid #EEE; |
|||
} |
|||
#preview { |
|||
background-color: #EEE; |
|||
padding:5px; |
|||
} |
|||
#loader { |
|||
position: absolute; |
|||
top: 36%; |
|||
right: 40%; |
|||
} |
|||
.loader { |
|||
z-index: 10000; |
|||
border: 8px solid #b5b5b5; /* Grey */ |
|||
border-top: 8px solid #3498db; /* Blue */ |
|||
border-bottom: 8px solid #3498db; /* Blue */ |
|||
border-radius: 50%; |
|||
width: 240px; |
|||
height: 240px; |
|||
animation: spin 2s linear infinite; |
|||
display:none; |
|||
} |
|||
|
|||
@keyframes spin { |
|||
0% { transform: rotate(0deg); } |
|||
100% { transform: rotate(360deg); } |
|||
} |
|||
</style> |
|||
<script> |
|||
if (typeof XMLHttpRequest === "undefined") { |
|||
XMLHttpRequest = function () { |
|||
try { return new ActiveXObject("Msxml2.XMLHTTP.6.0"); } catch (e) {} |
|||
try { return new ActiveXObject("Msxml2.XMLHTTP.3.0"); } catch (e) {} |
|||
try { return new ActiveXObject("Microsoft.XMLHTTP"); } catch (e) {} |
|||
throw new Error("This browser does not support XMLHttpRequest."); |
|||
}; |
|||
} |
|||
|
|||
function ge(a){ |
|||
return document.getElementById(a); |
|||
} |
|||
function ce(a){ |
|||
return document.createElement(a); |
|||
} |
|||
|
|||
function sortByKey(array, key) { |
|||
return array.sort(function(a, b) { |
|||
var x = a[key]; var y = b[key]; |
|||
return ((x < y) ? -1 : ((x > y) ? 1 : 0)); |
|||
}); |
|||
} |
|||
|
|||
|
|||
var QueuedRequester = function () { |
|||
this.queue = []; |
|||
this.running = false; |
|||
this.xmlhttp = null; |
|||
} |
|||
QueuedRequester.prototype = { |
|||
_request: function(req){ |
|||
this.running = true; |
|||
if(!req instanceof Object) return; |
|||
var that = this; |
|||
|
|||
function ajaxCb(x,d){ return function(){ |
|||
if (x.readyState == 4){ |
|||
ge("loader").style.display = "none"; |
|||
d.callback(x.status, x.responseText); |
|||
if(that.queue.length === 0) that.running = false; |
|||
if(that.running) that._request(that.queue.shift()); |
|||
} |
|||
}} |
|||
|
|||
ge("loader").style.display = "block"; |
|||
|
|||
var p = ""; |
|||
if(req.params instanceof FormData){ |
|||
p = req.params; |
|||
} else if(req.params instanceof Object){ |
|||
for (var key in req.params) { |
|||
if(p === "") |
|||
p += (req.method === "GET")?"?":""; |
|||
else |
|||
p += "&"; |
|||
p += encodeURIComponent(key)+"="+encodeURIComponent(req.params[key]); |
|||
}; |
|||
} |
|||
|
|||
this.xmlhttp = new XMLHttpRequest(); |
|||
this.xmlhttp.onreadystatechange = ajaxCb(this.xmlhttp, req); |
|||
if(req.method === "GET"){ |
|||
this.xmlhttp.open(req.method, req.url+p, true); |
|||
this.xmlhttp.send(); |
|||
} else { |
|||
this.xmlhttp.open(req.method, req.url, true); |
|||
if(p instanceof String) |
|||
this.xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); |
|||
this.xmlhttp.send(p); |
|||
} |
|||
}, |
|||
stop: function(){ |
|||
if(this.running) this.running = false; |
|||
if(this.xmlhttp && this.xmlhttp.readyState < 4){ |
|||
this.xmlhttp.abort(); |
|||
} |
|||
}, |
|||
add: function(method, url, params, callback){ |
|||
this.queue.push({url:url,method:method,params:params,callback:callback}); |
|||
if(!this.running){ |
|||
this._request(this.queue.shift()); |
|||
} |
|||
} |
|||
} |
|||
|
|||
var requests = new QueuedRequester(); |
|||
|
|||
function createFileUploader(element, tree, editor){ |
|||
var xmlHttp; |
|||
|
|||
var refresh = ce("button"); |
|||
refresh.innerHTML = 'Refresh List'; |
|||
ge(element).appendChild(refresh); |
|||
|
|||
var input = ce("input"); |
|||
input.type = "file"; |
|||
input.multiple = false; |
|||
input.name = "data"; |
|||
input.id="upload-select"; |
|||
ge(element).appendChild(input); |
|||
|
|||
var path = ce("input"); |
|||
path.id = "upload-path"; |
|||
path.type = "text"; |
|||
path.name = "path"; |
|||
path.defaultValue = "/"; |
|||
ge(element).appendChild(path); |
|||
|
|||
var button = ce("button"); |
|||
button.innerHTML = 'Upload'; |
|||
ge(element).appendChild(button); |
|||
|
|||
var mkfile = ce("button"); |
|||
mkfile.innerHTML = 'Create'; |
|||
ge(element).appendChild(mkfile); |
|||
|
|||
var filename = ce("input"); |
|||
filename.id = "editor-filename"; |
|||
filename.type = "text"; |
|||
filename.disabled= true; |
|||
filename.size = 20; |
|||
ge(element).appendChild(filename); |
|||
|
|||
var savefile = ce("button"); |
|||
savefile.innerHTML = ' Save ' ; |
|||
ge(element).appendChild(savefile); |
|||
|
|||
function httpPostProcessRequest(status, responseText){ |
|||
if(status != 200) |
|||
alert("ERROR["+status+"]: "+responseText); |
|||
else |
|||
tree.refreshPath(path.value); |
|||
} |
|||
function createPath(p){ |
|||
var formData = new FormData(); |
|||
formData.append("path", p); |
|||
requests.add("PUT", "/edit", formData, httpPostProcessRequest); |
|||
} |
|||
|
|||
mkfile.onclick = function(e){ |
|||
createPath(path.value); |
|||
editor.loadUrl(path.value); |
|||
path.value="/"; |
|||
}; |
|||
|
|||
savefile.onclick = function(e){ |
|||
editor.execCommand('saveCommand'); |
|||
}; |
|||
|
|||
refresh.onclick = function(e){ |
|||
tree.refreshPath(path.value); |
|||
}; |
|||
|
|||
button.onclick = function(e){ |
|||
if(input.files.length === 0){ |
|||
return; |
|||
} |
|||
var formData = new FormData(); |
|||
formData.append("data", input.files[0], path.value); |
|||
requests.add("POST", "/edit", formData, httpPostProcessRequest); |
|||
var uploadPath= ge("upload-path"); |
|||
uploadPath.value="/"; |
|||
var uploadSelect= ge("upload-select"); |
|||
uploadSelect.value=""; |
|||
}; |
|||
input.onchange = function(e){ |
|||
if(input.files.length === 0) return; |
|||
var filename = input.files[0].name; |
|||
var ext = /(?:\.([^.]+))?$/.exec(filename)[1]; |
|||
var name = /(.*)\.[^.]+$/.exec(filename)[1]; |
|||
if(typeof name !== undefined){ |
|||
filename = name; |
|||
} |
|||
path.value = "/"+filename+"."+ext; |
|||
}; |
|||
} |
|||
|
|||
function createTree(element, editor){ |
|||
var preview = ge("preview"); |
|||
var treeRoot = ce("div"); |
|||
treeRoot.className = "tvu"; |
|||
ge(element).appendChild(treeRoot); |
|||
|
|||
function loadDownload(path){ |
|||
ge('download-frame').src = "/edit?download="+path; |
|||
} |
|||
|
|||
function loadPreview(path){ |
|||
var edfname = ge("editor-filename"); |
|||
edfname.value=path; |
|||
ge("editor").style.display = "none"; |
|||
preview.style.display = "block"; |
|||
preview.innerHTML = '<img src="/edit?edit='+path+'&_cb='+Date.now()+'" style="max-width:100%; max-height:100%; margin:auto; display:block;" />'; |
|||
} |
|||
|
|||
function fillFileMenu(el, path){ |
|||
var list = ce("ul"); |
|||
el.appendChild(list); |
|||
var action = ce("li"); |
|||
list.appendChild(action); |
|||
if(isImageFile(path)){ |
|||
action.innerHTML = "<span>Preview</span>"; |
|||
action.onclick = function(e){ |
|||
loadPreview(path); |
|||
if(document.body.getElementsByClassName('cm').length > 0) document.body.removeChild(el); |
|||
}; |
|||
} else if(isTextFile(path)){ |
|||
action.innerHTML = "<span>Edit</span>"; |
|||
action.onclick = function(e){ |
|||
editor.loadUrl(path); |
|||
if(document.body.getElementsByClassName('cm').length > 0) document.body.removeChild(el); |
|||
}; |
|||
} |
|||
var download = ce("li"); |
|||
list.appendChild(download); |
|||
download.innerHTML = "<span>Download</span>"; |
|||
download.onclick = function(e){ |
|||
loadDownload(path); |
|||
if(document.body.getElementsByClassName('cm').length > 0) document.body.removeChild(el); |
|||
}; |
|||
var delFile = ce("li"); |
|||
list.appendChild(delFile); |
|||
delFile.innerHTML = "<span>Delete</span>"; |
|||
delFile.onclick = function(e){ |
|||
httpDelete(path); |
|||
if(document.body.getElementsByClassName('cm').length > 0) document.body.removeChild(el); |
|||
}; |
|||
} |
|||
|
|||
function showContextMenu(event, path, isfile){ |
|||
var divContext = ce("div"); |
|||
var scrollTop = document.body.scrollTop ? document.body.scrollTop : document.documentElement.scrollTop; |
|||
var scrollLeft = document.body.scrollLeft ? document.body.scrollLeft : document.documentElement.scrollLeft; |
|||
var left = event.clientX + scrollLeft; |
|||
var top = event.clientY + scrollTop; |
|||
divContext.className = 'cm'; |
|||
divContext.style.display = 'block'; |
|||
divContext.style.left = left + 'px'; |
|||
divContext.style.top = top + 'px'; |
|||
fillFileMenu(divContext, path); |
|||
document.body.appendChild(divContext); |
|||
var width = divContext.offsetWidth; |
|||
var height = divContext.offsetHeight; |
|||
divContext.onmouseout = function(e){ |
|||
if(e.clientX < left || e.clientX > (left + width) || e.clientY < top || e.clientY > (top + height)){ |
|||
if(document.body.getElementsByClassName('cm').length > 0) document.body.removeChild(divContext); |
|||
} |
|||
}; |
|||
} |
|||
|
|||
function createTreeLeaf(path, name, size){ |
|||
var leaf = ce("li"); |
|||
leaf.id = name; |
|||
var label = ce("span"); |
|||
label.innerHTML = name; |
|||
leaf.appendChild(label); |
|||
leaf.onclick = function(e){ |
|||
if(isTextFile(leaf.id.toLowerCase())){ |
|||
editor.loadUrl(leaf.id); |
|||
} else if(isImageFile(leaf.id.toLowerCase())){ |
|||
loadPreview(leaf.id); |
|||
} |
|||
}; |
|||
leaf.oncontextmenu = function(e){ |
|||
e.preventDefault(); |
|||
e.stopPropagation(); |
|||
showContextMenu(e, leaf.id, true); |
|||
}; |
|||
return leaf; |
|||
} |
|||
|
|||
function addList(parent, path, items){ |
|||
sortByKey(items, 'name'); |
|||
var list = ce("ul"); |
|||
parent.appendChild(list); |
|||
var ll = items.length; |
|||
for(var i = 0; i < ll; i++){ |
|||
if(items[i].type === "file") |
|||
list.appendChild(createTreeLeaf(path, items[i].name, items[i].size)); |
|||
} |
|||
|
|||
} |
|||
|
|||
function isTextFile(path){ |
|||
var ext = /(?:\.([^.]+))?$/.exec(path)[1]; |
|||
if(typeof ext !== undefined){ |
|||
switch(ext){ |
|||
case "txt": |
|||
case "htm": |
|||
case "html": |
|||
case "js": |
|||
case "css": |
|||
case "xml": |
|||
case "json": |
|||
case "conf": |
|||
case "ini": |
|||
case "h": |
|||
case "c": |
|||
case "cpp": |
|||
case "php": |
|||
case "hex": |
|||
case "ino": |
|||
case "pde": |
|||
return true; |
|||
} |
|||
} |
|||
return false; |
|||
} |
|||
|
|||
function isImageFile(path){ |
|||
var ext = /(?:\.([^.]+))?$/.exec(path)[1]; |
|||
if(typeof ext !== undefined){ |
|||
switch(ext){ |
|||
case "png": |
|||
case "jpg": |
|||
case "gif": |
|||
case "bmp": |
|||
return true; |
|||
} |
|||
} |
|||
return false; |
|||
} |
|||
|
|||
this.refreshPath = function(path){ |
|||
treeRoot.removeChild(treeRoot.childNodes[0]); |
|||
httpGet(treeRoot, "/"); |
|||
}; |
|||
|
|||
function delCb(path){ |
|||
return function(status, responseText){ |
|||
if(status != 200){ |
|||
alert("ERROR["+status+"]: "+responseText); |
|||
} else { |
|||
treeRoot.removeChild(treeRoot.childNodes[0]); |
|||
httpGet(treeRoot, "/"); |
|||
} |
|||
} |
|||
} |
|||
|
|||
function httpDelete(filename){ |
|||
var formData = new FormData(); |
|||
formData.append("path", filename); |
|||
requests.add("DELETE", "/edit", formData, delCb(filename)); |
|||
} |
|||
|
|||
function getCb(parent, path){ |
|||
return function(status, responseText){ |
|||
if(status == 200) |
|||
addList(parent, path, JSON.parse(responseText)); |
|||
} |
|||
} |
|||
|
|||
function httpGet(parent, path){ |
|||
requests.add("GET", "/edit", { list: path }, getCb(parent, path)); |
|||
} |
|||
|
|||
httpGet(treeRoot, "/"); |
|||
return this; |
|||
} |
|||
|
|||
function createEditor(element, file, lang, theme, type){ |
|||
function getLangFromFilename(filename){ |
|||
var lang = "plain"; |
|||
var ext = /(?:\.([^.]+))?$/.exec(filename)[1]; |
|||
if(typeof ext !== undefined){ |
|||
switch(ext){ |
|||
case "txt": lang = "plain"; break; |
|||
case "hex": lang = "plain"; break; |
|||
case "conf": lang = "plain"; break; |
|||
case "htm": lang = "html"; break; |
|||
case "js": lang = "javascript"; break; |
|||
case "h": lang = "c_cpp"; break; |
|||
case "c": lang = "c_cpp"; break; |
|||
case "cpp": lang = "c_cpp"; break; |
|||
case "css": |
|||
case "scss": |
|||
case "php": |
|||
case "html": |
|||
case "json": |
|||
case "xml": |
|||
case "ini": lang = ext; |
|||
} |
|||
} |
|||
return lang; |
|||
} |
|||
|
|||
if(typeof file === "undefined") file = "/index.html"; |
|||
|
|||
if(typeof lang === "undefined"){ |
|||
lang = getLangFromFilename(file); |
|||
} |
|||
|
|||
if(typeof theme === "undefined") theme = "textmate"; |
|||
|
|||
if(typeof type === "undefined"){ |
|||
type = "text/"+lang; |
|||
if(lang === "c_cpp") type = "text/plain"; |
|||
} |
|||
|
|||
var editor = ace.edit(element); |
|||
function httpPostProcessRequest(status, responseText){ |
|||
if(status != 200) alert("ERROR["+status+"]: "+responseText); |
|||
} |
|||
function httpPost(filename, data, type){ |
|||
var formData = new FormData(); |
|||
formData.append("data", new Blob([data], { type: type }), filename); |
|||
requests.add("POST", "/edit", formData, httpPostProcessRequest); |
|||
} |
|||
function httpGetProcessRequest(status, responseText){ |
|||
ge("preview").style.display = "none"; |
|||
ge("editor").style.display = "block"; |
|||
if(status == 200) |
|||
editor.setValue(responseText); |
|||
else |
|||
editor.setValue(""); |
|||
editor.clearSelection(); |
|||
} |
|||
function httpGet(theUrl){ |
|||
requests.add("GET", "/edit", { edit: theUrl }, httpGetProcessRequest); |
|||
} |
|||
|
|||
if(lang !== "plain") editor.getSession().setMode("ace/mode/"+lang); |
|||
editor.setTheme("ace/theme/"+theme); |
|||
editor.$blockScrolling = Infinity; |
|||
editor.getSession().setUseSoftTabs(true); |
|||
editor.getSession().setTabSize(2); |
|||
editor.setHighlightActiveLine(true); |
|||
editor.setShowPrintMargin(false); |
|||
editor.commands.addCommand({ |
|||
name: 'saveCommand', |
|||
bindKey: {win: 'Ctrl-S', mac: 'Command-S'}, |
|||
exec: function(editor) { |
|||
httpPost(file, editor.getValue()+"", type); |
|||
}, |
|||
readOnly: false |
|||
}); |
|||
editor.commands.addCommand({ |
|||
name: 'undoCommand', |
|||
bindKey: {win: 'Ctrl-Z', mac: 'Command-Z'}, |
|||
exec: function(editor) { |
|||
editor.getSession().getUndoManager().undo(false); |
|||
}, |
|||
readOnly: false |
|||
}); |
|||
editor.commands.addCommand({ |
|||
name: 'redoCommand', |
|||
bindKey: {win: 'Ctrl-Shift-Z', mac: 'Command-Shift-Z'}, |
|||
exec: function(editor) { |
|||
editor.getSession().getUndoManager().redo(false); |
|||
}, |
|||
readOnly: false |
|||
}); |
|||
editor.loadUrl = function(filename){ |
|||
var edfname = ge("editor-filename"); |
|||
edfname.value=filename; |
|||
file = filename; |
|||
lang = getLangFromFilename(file); |
|||
type = "text/"+lang; |
|||
if(lang !== "plain") editor.getSession().setMode("ace/mode/"+lang); |
|||
httpGet(file); |
|||
}; |
|||
return editor; |
|||
} |
|||
function onBodyLoad(){ |
|||
var vars = {}; |
|||
var parts = window.location.href.replace(/[?&]+([^=&]+)=([^&]*)/gi, function(m,key,value) { vars[key] = value; }); |
|||
var editor = createEditor("editor", vars.file, vars.lang, vars.theme); |
|||
var tree = createTree("tree", editor); |
|||
createFileUploader("uploader", tree, editor); |
|||
if(typeof vars.file === "undefined") vars.file = "/index.htm"; |
|||
editor.loadUrl(vars.file); |
|||
}; |
|||
</script> |
|||
<script id='ace' src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.6/ace.js" type="text/javascript" charset="utf-8"></script> |
|||
<script> |
|||
if (typeof ace.edit == "undefined") { |
|||
var script = document.createElement('script'); |
|||
script.src = "/ace.js"; |
|||
script.async = false; |
|||
document.head.appendChild(script); |
|||
} |
|||
</script> |
|||
</head> |
|||
<body onload="onBodyLoad();"> |
|||
<div id="loader" class="loader"></div> |
|||
<div id="uploader"></div> |
|||
<div id="tree"></div> |
|||
<div id="editor"></div> |
|||
<div id="preview" style="display:none;"></div> |
|||
<iframe id=download-frame style='display:none;'></iframe> |
|||
</body> |
|||
</html> |
|||
@ -0,0 +1,157 @@ |
|||
/*
|
|||
DateTime.cpp - Arduino Date and Time library |
|||
Copyright (c) Michael Margolis. All right reserved. |
|||
|
|||
This library is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|||
*/ |
|||
|
|||
extern "C" { |
|||
// AVR LibC Includes
|
|||
} |
|||
//#include <string.h> // for memset
|
|||
#include "DateTime.h" |
|||
#include <wiring.h> |
|||
|
|||
//extern unsigned long _time;
|
|||
|
|||
#define LEAP_YEAR(_year) ((_year%4)==0) |
|||
static byte monthDays[]={31,28,31,30,31,30,31,31,30,31,30,31}; |
|||
|
|||
// private methods
|
|||
|
|||
void DateTimeClass::setTime(time_t time) |
|||
{ |
|||
// set the system time to the given time value (as seconds since Jan 1 1970)
|
|||
this->sysTime = time; |
|||
this->prevMillis = millis(); |
|||
} |
|||
|
|||
|
|||
//******************************************************************************
|
|||
//* DateTime Public Methods
|
|||
//******************************************************************************
|
|||
|
|||
DateTimeClass::DateTimeClass() |
|||
{ |
|||
this->status = dtStatusNotSet; |
|||
} |
|||
|
|||
time_t DateTimeClass::now() |
|||
{ |
|||
while( millis() - prevMillis >= 1000){ |
|||
this->sysTime++; |
|||
this->prevMillis += 1000; |
|||
} |
|||
return sysTime; |
|||
} |
|||
|
|||
void DateTimeClass::sync(time_t time) |
|||
{ |
|||
setTime(time); |
|||
//status.isSynced = true; // this will be set back to false if the clock resets
|
|||
//status.isSet = true; // if this is true and isSynced is false then clock was reset using EEPROM -- TODO
|
|||
this->status = dtStatusSync; |
|||
} |
|||
|
|||
boolean DateTimeClass::available() |
|||
{ |
|||
// refresh time components if clock is set (even if not synced), just return false if not set
|
|||
if(this->status != dtStatusNotSet) { |
|||
this->now(); // refresh sysTime
|
|||
this->localTime(&this->sysTime,&Second,&Minute,&Hour,&Day,&DayofWeek,&Month,&Year) ; |
|||
return true; |
|||
} |
|||
else |
|||
return false; |
|||
} |
|||
void DateTimeClass::localTime(time_t *timep,byte *psec,byte *pmin,byte *phour,byte *pday,byte *pwday,byte *pmonth,byte *pyear) { |
|||
// convert the given time_t to time components
|
|||
// this is a more compact version of the C library localtime function
|
|||
|
|||
time_t long epoch=*timep; |
|||
byte year; |
|||
byte month, monthLength; |
|||
unsigned long days; |
|||
|
|||
*psec=epoch%60; |
|||
epoch/=60; // now it is minutes
|
|||
*pmin=epoch%60; |
|||
epoch/=60; // now it is hours
|
|||
*phour=epoch%24; |
|||
epoch/=24; // now it is days
|
|||
*pwday=(epoch+4)%7; |
|||
|
|||
year=70; |
|||
days=0; |
|||
while((unsigned)(days += (LEAP_YEAR(year) ? 366 : 365)) <= epoch) { |
|||
year++; |
|||
} |
|||
*pyear=year; // *pyear is returned as years from 1900
|
|||
|
|||
days -= LEAP_YEAR(year) ? 366 : 365; |
|||
epoch -= days; // now it is days in this year, starting at 0
|
|||
//*pdayofyear=epoch; // days since jan 1 this year
|
|||
|
|||
days=0; |
|||
month=0; |
|||
monthLength=0; |
|||
for (month=0; month<12; month++) { |
|||
if (month==1) { // february
|
|||
if (LEAP_YEAR(year)) { |
|||
monthLength=29; |
|||
} else { |
|||
monthLength=28; |
|||
} |
|||
} else { |
|||
monthLength = monthDays[month]; |
|||
} |
|||
|
|||
if (epoch>=monthLength) { |
|||
epoch-=monthLength; |
|||
} else { |
|||
break; |
|||
} |
|||
} |
|||
*pmonth=month; // jan is month 0
|
|||
*pday=epoch+1; // day of month
|
|||
} |
|||
|
|||
|
|||
time_t DateTimeClass::makeTime(byte sec, byte min, byte hour, byte day, byte month, int year ){ |
|||
// converts time components to time_t
|
|||
// note year argument is full four digit year (or digits since 2000), i.e.1975, (year 8 is 2008)
|
|||
|
|||
int i; |
|||
time_t seconds; |
|||
|
|||
if(year < 69) |
|||
year+= 2000; |
|||
// seconds from 1970 till 1 jan 00:00:00 this year
|
|||
seconds= (year-1970)*(60*60*24L*365); |
|||
|
|||
// add extra days for leap years
|
|||
for (i=1970; i<year; i++) { |
|||
if (LEAP_YEAR(i)) { |
|||
seconds+= 60*60*24L; |
|||
} |
|||
} |
|||
// add days for this year
|
|||
for (i=0; i<month; i++) { |
|||
if (i==1 && LEAP_YEAR(year)) { |
|||
seconds+= 60*60*24L*29; |
|||
} else { |
|||
seconds+= 60*60*24L*monthDays[i]; |
|||
} |
|||
} |
|||
|
|||
seconds+= (day-1)*3600*24L; |
|||
seconds+= hour*3600L; |
|||
seconds+= min*60L; |
|||
seconds+= sec; |
|||
return seconds; |
|||
} |
|||
|
|||
// make one instance for DateTime class the user
|
|||
DateTimeClass DateTime = DateTimeClass() ; |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue