├── .gitattributes ├── .gitignore ├── .travis.yml ├── LICENSE.md ├── README.md ├── examples └── esp8266 │ └── settingBearerTokenInSketch │ └── settingBearerTokenInSketch.ino ├── lib └── readme.txt ├── library.properties ├── platformio.ini ├── scripts └── travis │ └── platformioSingle.sh └── src ├── TwitterApi.cpp ├── TwitterApi.h ├── TwitterBearerToken.cpp └── TwitterBearerToken.h /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | 19 | # Compiled Static libraries 20 | *.lai 21 | *.la 22 | *.a 23 | *.lib 24 | 25 | # Executables 26 | *.exe 27 | *.out 28 | *.app 29 | .pioenvs 30 | .piolibdeps 31 | .clang_complete 32 | .gcc-flags.json 33 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "2.7" 4 | 5 | # Cache PlatformIO packages using Travis CI container-based infrastructure 6 | sudo: false 7 | cache: 8 | directories: 9 | - "~/.platformio" 10 | 11 | env: 12 | - SCRIPT=platformioSingle EXAMPLE_NAME=ChannelStatistics EXAMPLE_FOLDER=/ BOARDTYPE=ESP8266 BOARD=d1_mini 13 | - SCRIPT=platformioSingle EXAMPLE_NAME=ChannelStatisticsWithWifiManager EXAMPLE_FOLDER=/ BOARDTYPE=ESP8266 BOARD=d1_mini 14 | 15 | 16 | install: 17 | - pip install -U platformio 18 | # 19 | # Libraries from PlatformIO Library Registry: 20 | # 21 | # http://platformio.org/lib/show/64/ArduinoJson 22 | - platformio lib -g install 64 23 | # http://platformio.org/lib/show/567/WifiManager 24 | - platformio lib -g install 567 25 | 26 | script: scripts/travis/$SCRIPT.sh 27 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DEPRACATED in favor of new library I am working on 2 | 3 | https://github.com/witnessmenow/TweESP32 4 | 5 | 6 | ## arduino-twitter-api 7 | A wrapper for the [Twitter API](https://dev.twitter.com/overview/api) for Arduino (works on ESP8266) 8 | 9 | In the api FAQ twitter mentions that they do not expire bearer tokens, so once you do not generate a new one with the same Credentials it should continue working 10 | 11 | 12 | ## Getting API Key & Secret 13 | 14 | - [Go to the following URL](https://apps.twitter.com/app/new) - sign in if you havent already. 15 | - Fill in the fields, For website you can enter any webpage (e.g. http://google.com), and create your app 16 | - Then click on the Keys & Tokens tab. Your Consumer Key and Consumer Secret will be there. 17 | 18 | 19 | ## Getting Bearer Token 20 | 21 | I am hoping to make this a little more simple going forward, as we should be able to do this on the board directly, but here they are for now :) 22 | 23 | - Get curl on your machine ([Windows: try this](http://callejoabel.blogspot.co.uk/2013/09/making-curl-work-on-windows-7.html) it shoud already be installed on mac and linux) 24 | - Make the following request using the key and token from the above section 25 | ``` 26 | curl -u "CONSUMER_KEY:CONSUMER_SECRET" --data 'grant_type=client_credentials' 'https://api.twitter.com/oauth2/token' 27 | ``` 28 | - The response will contain a bearer token (it is the big long one!), use this with the setBearerToken [as shown in the example](https://github.com/witnessmenow/arduino-twitter-api/blob/master/examples/esp8266/settingBearerTokenInSketch/settingBearerTokenInSketch.ino). 29 | -------------------------------------------------------------------------------- /examples/esp8266/settingBearerTokenInSketch/settingBearerTokenInSketch.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | /******************************************************************* 4 | * An Example of getting data back from the TwitterAPI * 5 | * https://github.com/witnessmenow/arduino-twitter-api * 6 | * * 7 | * Written by Brian Lough * 8 | *******************************************************************/ 9 | 10 | 11 | #include 12 | #include 13 | 14 | //------- Replace the following! ------ 15 | char ssid[] = "SSID"; // your network SSID (name) 16 | char password[] = "password"; // your network key 17 | 18 | // Normally we would use these to generate the bearer token but its not working yet :/ 19 | // Use steps on the readme to generate the Bearer Token 20 | 21 | #define BEARER_TOKEN "this is long jumble of characters" 22 | 23 | //Using curl to get bearer token 24 | // curl -u "$CONSUMER_KEY:$CONSUMER_SECRET" \ 25 | // --data 'grant_type=client_credentials' \ 26 | // 'https://api.twitter.com/oauth2/token' 27 | 28 | WiFiClientSecure client; 29 | TwitterApi api(client); 30 | 31 | unsigned long api_mtbs = 60000; //mean time between api requests 32 | unsigned long api_lasttime = 0; //last time api request has been done 33 | bool firstTime = true; 34 | 35 | //Inputs 36 | 37 | String screenName = "witnessmenow"; 38 | bool haveBearerToken = false; 39 | 40 | void setup() { 41 | 42 | Serial.begin(115200); 43 | 44 | // Set WiFi to station mode and disconnect from an AP if it was Previously 45 | // connected 46 | WiFi.mode(WIFI_STA); 47 | WiFi.disconnect(); 48 | delay(100); 49 | 50 | // Attempt to connect to Wifi network: 51 | Serial.print("Connecting Wifi: "); 52 | Serial.println(ssid); 53 | WiFi.begin(ssid, password); 54 | while (WiFi.status() != WL_CONNECTED) { 55 | Serial.print("."); 56 | delay(500); 57 | } 58 | Serial.println(""); 59 | Serial.println("WiFi connected"); 60 | Serial.println("IP address: "); 61 | IPAddress ip = WiFi.localIP(); 62 | Serial.println(ip); 63 | 64 | api.setBearerToken(BEARER_TOKEN); 65 | haveBearerToken = true; 66 | getTwitterStats(screenName); 67 | 68 | } 69 | 70 | void getTwitterStats(String name) { 71 | Serial.println("Getting twitter stats for " + name); 72 | String responseString = api.getUserStatistics(name); 73 | Serial.println(responseString); 74 | DynamicJsonBuffer jsonBuffer; 75 | JsonObject& response = jsonBuffer.parseObject(responseString); 76 | if (response.success()) { 77 | Serial.println("parsed Json"); 78 | // Use Arduino Json to parse the data 79 | } else { 80 | Serial.println("Failed to parse Json"); 81 | } 82 | } 83 | 84 | void loop() { 85 | if(haveBearerToken){ 86 | if ((millis() > api_lasttime + api_mtbs)) { 87 | getTwitterStats(screenName); 88 | api_lasttime = millis(); 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /lib/readme.txt: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for the project specific (private) libraries. 3 | PlatformIO will compile them to static libraries and link to executable file. 4 | 5 | The source code of each library should be placed in separate directory, like 6 | "lib/private_lib/[here are source files]". 7 | 8 | For example, see how can be organized `Foo` and `Bar` libraries: 9 | 10 | |--lib 11 | | |--Bar 12 | | | |--docs 13 | | | |--examples 14 | | | |--src 15 | | | |- Bar.c 16 | | | |- Bar.h 17 | | |--Foo 18 | | | |- Foo.c 19 | | | |- Foo.h 20 | | |- readme.txt --> THIS FILE 21 | |- platformio.ini 22 | |--src 23 | |- main.c 24 | 25 | Then in `src/main.c` you should use: 26 | 27 | #include 28 | #include 29 | 30 | // rest H/C/CPP code 31 | 32 | PlatformIO will find your libraries automatically, configure preprocessor's 33 | include paths and build them. 34 | 35 | More information about PlatformIO Library Dependency Finder 36 | - http://docs.platformio.org/page/librarymanager/ldf.html 37 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=TwitterApi 2 | version=1.0.0 3 | author=Brian Lough 4 | maintainer=Brian Lough 5 | sentence=A wrapper for the Twitter API for Arduino (supports ESP8266 & WiFi101 boards) 6 | paragraph= 7 | category=Communication 8 | url=https://github.com/witnessmenow/arduino-twitter-api 9 | architectures=* 10 | -------------------------------------------------------------------------------- /platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; http://docs.platformio.org/page/projectconf.html 10 | [common] 11 | lib_deps_external = ArduinoJson 12 | 13 | [env:d1_mini] 14 | platform = espressif8266 15 | board = d1_mini 16 | framework = arduino 17 | lib_deps = ${common.lib_deps_external} 18 | -------------------------------------------------------------------------------- /scripts/travis/platformioSingle.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh -eux 2 | 3 | platformio ci $PWD/examples/$BOARDTYPE$EXAMPLE_FOLDER$EXAMPLE_NAME/$EXAMPLE_NAME.ino -l '.' -b $BOARD 4 | -------------------------------------------------------------------------------- /src/TwitterApi.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Brian Lough. All right reserved. 3 | 4 | TwitterApi - An Arduino wrapper for the Twitter API 5 | 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 2.1 of the License, or (at your option) any later version. 10 | 11 | This library is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public 17 | License along with this library; if not, write to the Free Software 18 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | 21 | 22 | #include "TwitterApi.h" 23 | 24 | TwitterApi::TwitterApi(Client &client) { 25 | this->client = &client; 26 | } 27 | 28 | void TwitterApi::setBearerToken(String bearerToken){ 29 | _bearerToken = bearerToken; 30 | } 31 | 32 | String TwitterApi::sendGetToTwitter(String command) { 33 | String body; 34 | String headers; 35 | bool finishedHeaders = false; 36 | bool currentLineIsBlank = true; 37 | unsigned long now; 38 | bool avail; 39 | // Connect with twitter api over ssl 40 | if (client->connect(TW_API_HOST, TW_API_SSL_PORT)) { 41 | //Serial.println(".... connected to server"); 42 | String a=""; 43 | char c; 44 | int ch_count=0; 45 | client->println("GET " + command + " HTTP/1.1"); 46 | client->println("Host: " TW_API_HOST); 47 | client->println("User-Agent: arduino/1.0.0"); 48 | client->println("Authorization: Bearer " + _bearerToken); 49 | client->println(""); 50 | now=millis(); 51 | avail=false; 52 | while (millis() - now < TW_API_TIMEOUT) { 53 | while (client->available()) { 54 | 55 | // Allow body to be parsed before finishing 56 | avail = finishedHeaders; 57 | char c = client->read(); 58 | //Serial.write(c); 59 | 60 | if(!finishedHeaders){ 61 | if (currentLineIsBlank && c == '\n') { 62 | finishedHeaders = true; 63 | //Serial.println(headers); 64 | } 65 | else{ 66 | headers = headers + c; 67 | 68 | } 69 | } else { 70 | if (ch_count < maxMessageLength) { 71 | body=body+c; 72 | ch_count++; 73 | } 74 | } 75 | 76 | if (c == '\n') { 77 | currentLineIsBlank = true; 78 | }else if (c != '\r') { 79 | currentLineIsBlank = false; 80 | } 81 | } 82 | if (avail) { 83 | //Serial.println("Body:"); 84 | //Serial.println(body); 85 | //Serial.println("END"); 86 | break; 87 | } 88 | } 89 | } 90 | 91 | return body; 92 | } 93 | 94 | String TwitterApi::getUserStatistics(String screenName){ 95 | String command="/1.1/users/show.json?screen_name="+screenName; 96 | //Serial.println(command); 97 | return sendGetToTwitter(command); //recieve reply from twitter 98 | } 99 | -------------------------------------------------------------------------------- /src/TwitterApi.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Brian Lough. All right reserved. 3 | 4 | TwitterApi - An Arduino wrapper for the YouTube API 5 | 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 2.1 of the License, or (at your option) any later version. 10 | 11 | This library is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public 17 | License along with this library; if not, write to the Free Software 18 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | 21 | 22 | #ifndef TwitterApi_h 23 | #define TwitterApi_h 24 | 25 | #include 26 | #include 27 | #include 28 | 29 | #define TW_API_HOST "api.twitter.com" 30 | #define TW_API_SSL_PORT 443 31 | #define TW_API_TIMEOUT 1500 32 | 33 | class TwitterApi 34 | { 35 | public: 36 | TwitterApi (Client &client); 37 | String sendGetToTwitter(String command); 38 | String getUserStatistics(String screenName); 39 | void setBearerToken(String bearerToken); 40 | 41 | private: 42 | Client *client; 43 | String _bearerToken; 44 | const int maxMessageLength = 10000; 45 | }; 46 | 47 | #endif 48 | -------------------------------------------------------------------------------- /src/TwitterBearerToken.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Brian Lough. All right reserved. 3 | 4 | Get the twitter bearer token from consumerKey and consumerSecret 5 | 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 2.1 of the License, or (at your option) any later version. 10 | 11 | This library is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public 17 | License along with this library; if not, write to the Free Software 18 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | 21 | 22 | #include "TwitterBearerToken.h" 23 | 24 | TwitterBearerToken::TwitterBearerToken(Client &client) { 25 | this->client = &client; 26 | } 27 | 28 | char * TwitterBearerToken::getEncodedBearerCredentials(const char * consumerKey, const char * consumerSecret) { 29 | char toencodeLen = strlen(consumerKey)+strlen(consumerSecret)+1; 30 | char *toencode = new char[toencodeLen]; 31 | if(toencode == NULL) 32 | { 33 | return NULL; 34 | } 35 | char *encodedCredentials = new char[base64_encode_expected_len(toencodeLen)+1]; 36 | if(encodedCredentials == NULL) 37 | { 38 | return NULL; 39 | } 40 | 41 | // They say to URL encode the key and secret for future proofing, but I am a rebel 42 | sprintf(toencode, "%s:%s", consumerKey, consumerSecret); 43 | Serial.println(toencode); 44 | if(base64_encode_chars(toencode, toencodeLen, encodedCredentials) > 0 ){ 45 | Serial.println(String(encodedCredentials)); 46 | return encodedCredentials; 47 | } 48 | 49 | return NULL; 50 | } 51 | 52 | String TwitterBearerToken::getNewToken(const char * consumerKey, const char * consumerSecret) { 53 | char body[200]; 54 | 55 | String encodedCredentials = String(getEncodedBearerCredentials(consumerKey, consumerSecret)); 56 | bool finishedHeaders = false; 57 | bool currentLineIsBlank = true; 58 | unsigned long now; 59 | bool avail; 60 | // Connect with twitter api over ssl 61 | Serial.println(".... trying server"); 62 | if (client->connect(TWB_API_HOST, TWB_API_SSL_PORT)) { 63 | Serial.println(".... connected to server for token"); 64 | String a=""; 65 | char c; 66 | int ch_count=0; 67 | client->println("POST /oauth2/token HTTP/1.1"); 68 | client->println("Host: " TWB_API_HOST); 69 | client->println("User-Agent: arduino/1.0.0"); 70 | client->println("Authorization: Basic " + encodedCredentials); 71 | client->println("Accept: */*"); 72 | client->println("Content-Length: 29"); 73 | client->println("Content-Type: application/x-www-form-urlencoded;charset=utf-8"); 74 | client->println(); 75 | delay(100); 76 | client->println("grant_type=client_credentials"); 77 | 78 | Serial.println("POST /oauth2/token HTTP/1.1"); 79 | Serial.println("Host: " TWB_API_HOST); 80 | Serial.println("User-Agent: arduino/1.0.0"); 81 | Serial.println("Authorization: Basic " + encodedCredentials); 82 | Serial.println("Accept: */*"); 83 | Serial.println("Content-Length: 29"); 84 | Serial.println("Content-Type: application/x-www-form-urlencoded"); 85 | Serial.println(); 86 | Serial.println("grant_type=client_credentials"); 87 | now=millis(); 88 | avail=false; 89 | while (millis() - now < TWB_API_TIMEOUT) { 90 | while (client->available()) { 91 | Serial.println("Got something"); 92 | // Allow body to be parsed before finishing 93 | avail = finishedHeaders; 94 | char c = client->read(); 95 | Serial.write(c); 96 | 97 | if(!finishedHeaders){ 98 | if (currentLineIsBlank && c == '\n') { 99 | finishedHeaders = true; 100 | } 101 | } else { 102 | if (ch_count < maxMessageLength) { 103 | body[ch_count] = c; 104 | ch_count++; 105 | } 106 | } 107 | 108 | if (c == '\n') { 109 | currentLineIsBlank = true; 110 | }else if (c != '\r') { 111 | currentLineIsBlank = false; 112 | } 113 | } 114 | if (avail) { 115 | DynamicJsonBuffer jsonBuffer; 116 | JsonObject& root = jsonBuffer.parseObject(body); 117 | if (root.success()) { 118 | if (root.containsKey("access_token")) { 119 | token = root["access_token"].as(); 120 | return token; 121 | } 122 | } 123 | Serial.println("Error with response:"); 124 | Serial.println(body); 125 | break; 126 | } 127 | } 128 | } 129 | return ""; 130 | } 131 | -------------------------------------------------------------------------------- /src/TwitterBearerToken.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Brian Lough. All right reserved. 3 | 4 | Get the twitter bearer token from consumerKey and consumerSecret 5 | 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 2.1 of the License, or (at your option) any later version. 10 | 11 | This library is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | Lesser General Public License for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public 17 | License along with this library; if not, write to the Free Software 18 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | 21 | 22 | #ifndef TwitterBearerToken_h 23 | #define TwitterBearerToken_h 24 | 25 | #include 26 | #include 27 | #include 28 | #include 29 | 30 | #define TWB_API_HOST "api.twitter.com" 31 | #define TWB_API_SSL_PORT 443 32 | #define TWB_API_TIMEOUT 1500 33 | 34 | class TwitterBearerToken 35 | { 36 | public: 37 | TwitterBearerToken(Client &client); 38 | String getNewToken(const char * consumerKey, const char * consumerSecret); 39 | String token; 40 | 41 | private: 42 | Client *client; 43 | char * getEncodedBearerCredentials(const char * consumerKey, const char * consumerSecret); 44 | const int maxMessageLength = 1000; 45 | }; 46 | 47 | #endif 48 | --------------------------------------------------------------------------------