├── .gitignore ├── .jshintrc ├── .travis.yml ├── Gruntfile.js ├── LICENSE ├── README.md ├── examples ├── consumer.js └── package.json ├── index.js ├── lib ├── logger.js └── mqtt-influxdb.js ├── package.json └── test └── mqttToInfluxdbTest.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .gitignore support plugin (hsz.mobi) 2 | ### Node template 3 | # Logs 4 | logs 5 | *.log 6 | 7 | # Runtime data 8 | pids 9 | *.pid 10 | *.seed 11 | 12 | # Directory for instrumented libs generated by jscoverage/JSCover 13 | lib-cov 14 | 15 | # Coverage directory used by tools like istanbul 16 | coverage 17 | 18 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 19 | .grunt 20 | 21 | # Compiled binary addons (http://nodejs.org/api/addons.html) 22 | build/Release 23 | 24 | # Dependency directory 25 | # Commenting this out is preferred by some people, see 26 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- 27 | node_modules 28 | 29 | # Users Environment Variables 30 | .lock-wscript 31 | -------------------------------------------------------------------------------- /.jshintrc: -------------------------------------------------------------------------------- 1 | { 2 | "curly": true, 3 | "eqeqeq": true, 4 | "immed": true, 5 | "latedef": true, 6 | "newcap": true, 7 | "noarg": true, 8 | "sub": true, 9 | "undef": true, 10 | "unused": true, 11 | "boss": true, 12 | "eqnull": true, 13 | "node": true 14 | } 15 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | 3 | node_js: 4 | - "0.10" 5 | 6 | env: 7 | - INFLUX=0.8.5 8 | 9 | before_script: 10 | - npm install -g grunt-cli 11 | - wget "http://s3.amazonaws.com/influxdb/influxdb_$(echo $INFLUX)_amd64.deb" 12 | - sudo dpkg -i "influxdb_$(echo $INFLUX)_amd64.deb" 13 | - sudo service influxdb start 14 | - sleep 5 15 | 16 | install: npm install 17 | 18 | 19 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | module.exports = function(grunt) { 4 | // Show elapsed time at the end 5 | require('time-grunt')(grunt); 6 | // Load all grunt tasks 7 | require('load-grunt-tasks')(grunt); 8 | 9 | // Project configuration. 10 | grunt.initConfig({ 11 | nodeunit: { 12 | files: ['test/**/*_test.js'] 13 | }, 14 | jshint: { 15 | options: { 16 | jshintrc: '.jshintrc', 17 | reporter: require('jshint-stylish') 18 | }, 19 | gruntfile: { 20 | src: 'Gruntfile.js' 21 | }, 22 | lib: { 23 | src: ['lib/**/*.js'] 24 | }, 25 | test: { 26 | src: ['test/**/*.js'] 27 | } 28 | }, 29 | mochacli: { 30 | options: { 31 | reporter: 'spec', 32 | bail: true 33 | }, 34 | all: ['test/*.js'] 35 | }, 36 | watch: { 37 | gruntfile: { 38 | files: '<%= jshint.gruntfile.src %>', 39 | tasks: ['jshint:gruntfile'] 40 | }, 41 | lib: { 42 | files: '<%= jshint.lib.src %>', 43 | tasks: ['jshint:lib', 'mochacli'] 44 | }, 45 | test: { 46 | files: '<%= jshint.test.src %>', 47 | tasks: ['jshint:test', 'mochacli'] 48 | } 49 | }, 50 | mocha_istanbul: { 51 | coverage: { 52 | src: 'test' 53 | } 54 | }, 55 | istanbul_check_coverage: { 56 | default: { 57 | options: { 58 | coverageFolder: 'coverage*', // will check both coverage folders and merge the coverage results 59 | check: { 60 | lines: 80, 61 | statements: 80 62 | } 63 | } 64 | } 65 | } 66 | 67 | 68 | }); 69 | 70 | // Default task. 71 | grunt.registerTask('default', ['jshint', 'mochacli']); 72 | 73 | 74 | }; 75 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 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 | (This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.) 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | {description} 474 | Copyright (C) {year} {fullname} 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | {signature of Ty Coon}, 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | 506 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Overview 2 | 3 | MQTT is a machine-to-machine (M2M)/"Internet of Things" connectivity 4 | protocol. It was designed as an extremely lightweight publish/subscribe 5 | messaging transport. It is useful for connections with remote locations where 6 | a small code footprint is required and/or network bandwidth is at a premium. 7 | 8 | InfluxDB is a time-series metrics and events database based on the LevelDB key-value store. 9 | 10 | mqtt-influxdb offer a simple way to store packets information with timestamp in an influxdb database. 11 | 12 | ### Getting started 13 | 14 | ## Installing 15 | 16 | In node install with npm install git+https://github.com/sguilly/mqtt-influxdb.git 17 | 18 | ## Setup params 19 | 20 | 21 | var mqttInfluxdb = require('mqtt-influxdb'); 22 | 23 | var opts = { 24 | logger: {...}, 25 | mqtt: {...}, 26 | influx :{...}, 27 | decoder :{...} 28 | }; 29 | 30 | var consumer = mqttInfluxdb(opts); 31 | 32 | consumer.open(); 33 | 34 | ### logger 35 | 36 | * **name** - name fo the logger 37 | * **stream** - streams of buyan (see : https://github.com/trentm/node-bunyan) 38 | 39 | example : 40 | 41 | mqtt: { 42 | ip : '127.0.0.1', 43 | port: 3001, // tcp 44 | clientId : 'mqtt-influxdb', 45 | subscribe : ['mqtt-teleinfo/#','mqtt-zibase/#'], 46 | qos : 1 // 0 : without persistence and no ACK | 1 : with offline mode and ACK 47 | } 48 | 49 | ### mqtt 50 | 51 | * **ip** : adress of the mqtt broker 52 | * **port** : port of the mqtt broker 53 | * **clientId** : name of the mqtt client 54 | * **subscribe** : array of topics to subscribe 55 | * **qos** : define the quality of service (0 : without persistence and no ACK | 1 : with offline mode and ACK) 56 | 57 | example : 58 | 59 | mqtt: { 60 | ip : '127.0.0.1', 61 | port: 3001, // tcp 62 | clientId : 'mqtt-influxdb', 63 | subscribe : ['mqtt-teleinfo/#','mqtt-zibase/#'], 64 | qos : 1 // 0 : without persistence and no ACK | 1 : with offline mode and ACK 65 | } 66 | 67 | ### influxdb 68 | 69 | * **host** : adress of the influxdb server 70 | * **port** : port of the influxdb database (default 8086) 71 | * **username** : username with write permission 72 | * **password** : password 73 | * **database** : name of the database to store information 74 | 75 | example : 76 | 77 | influx :{ 78 | host : '127.0.0.1', 79 | port : 8086, // optional, default 8086 80 | username : 'root', 81 | password : 'root', 82 | database : 'timeseries' 83 | } 84 | 85 | ### decoder 86 | 87 | * **idKeys** : array of keys to use as the name of the timeseries 88 | * **timeKeys** : array of keys to use as the timestamp (by default timestamp is now() 89 | * **denyKeys** : array of keys not to save in the timeserie 90 | * **transform** : object with pair of keys to transform the name of some labels before save it 91 | * **allowString** : allow to save string value 92 | 93 | 94 | example : 95 | 96 | decoder :{ 97 | idKeys : ['id'], 98 | timeKeys : ['time','date'], 99 | denyKeys : ['power'], 100 | transform : {tem : 'temperature', hum : 'humidity'}, 101 | allowString : false 102 | } 103 | 104 | 105 | 106 | 107 | -------------------------------------------------------------------------------- /examples/consumer.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Created by sguilly on 24/11/14. 3 | */ 4 | 5 | var bunyan = require('bunyan'); 6 | var logger = bunyan.createLogger({name: "myapp"}); 7 | 8 | var mqttInfluxdb = require('../lib/mqtt-influxdb'); 9 | 10 | 11 | var opts = { 12 | logger: logger, 13 | mqtt: { 14 | ip : '127.0.0.1', 15 | port: 1883, // tcp 16 | clientId : 'mqtt-influxdb', 17 | subscribe: ['windguru'], 18 | qos : 1 // 0 : without persistence and no ACK | 1 : with offline mode and ACK 19 | }, 20 | influx :{ 21 | host : '127.0.0.1', 22 | port : 8086, // optional, default 8086 23 | username : 'root', 24 | password : 'root', 25 | database : 'timeseries' 26 | }, 27 | decoder :{ 28 | idKeys : ['id'], 29 | timeKeys : ['time','date'], 30 | denyKeys : ['power'], 31 | transform : {tem : 'temperature', hum : 'humidity'}, 32 | allowString : false 33 | } 34 | }; 35 | 36 | var consumer = mqttInfluxdb(opts); 37 | 38 | consumer.open(); 39 | -------------------------------------------------------------------------------- /examples/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mqtt-influxdb-bridge", 3 | "dependencies": { 4 | "bunyan": "^1.2.3", 5 | "mqtt-influxdb": "git+https://github.com/sguilly/mqtt-influxdb.git" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require('./lib/mqtt-influxdb'); 2 | -------------------------------------------------------------------------------- /lib/logger.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Created by sguilly on 07/01/15. 3 | */ 4 | 5 | 6 | module.exports.trace = function info(message) { 7 | console.log(message); 8 | }; 9 | 10 | module.exports.debug = function info(message) { 11 | console.log(message); 12 | }; 13 | 14 | module.exports.info = function info(message) { 15 | console.log(message); 16 | }; 17 | 18 | module.exports.warn = function info(message) { 19 | console.log(message); 20 | }; 21 | 22 | module.exports.error = function info(message) { 23 | console.log(message); 24 | }; 25 | 26 | module.exports.fatal = function info(message) { 27 | console.log(message); 28 | }; 29 | 30 | 31 | -------------------------------------------------------------------------------- /lib/mqtt-influxdb.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Created by sguilly on 24/11/14. 3 | */ 4 | 5 | var mqtt = require('mqtt'); 6 | var influx = require('influx'); 7 | 8 | var _ = require('underscore'); 9 | 10 | function Consumer(opts) { 11 | if (!(this instanceof Consumer)) { 12 | return new Consumer(opts); 13 | } 14 | this.options = opts; 15 | this.transformKeys = Object.getOwnPropertyNames(this.options.decoder.transform); 16 | 17 | if (opts.logger) { 18 | this.log = opts.logger; 19 | } 20 | else { 21 | this.log = require('./logger'); 22 | } 23 | 24 | this.log.trace('Application started'); 25 | 26 | } 27 | 28 | Consumer.prototype.open = function () { 29 | var that = this; 30 | 31 | var clientMqtt = mqtt.createClient(this.options.mqtt.port, this.options.mqtt.ip, { 32 | clean: false, 33 | encoding: 'utf8', 34 | clientId: this.options.mqtt.clientId, 35 | protocolId: 'MQIsdp', 36 | protocolVersion: 3 37 | }); 38 | 39 | var clientInflux = influx(this.options.influx); 40 | 41 | //clientMqtt.subscribe('mqtt-zibase/#', {qos: this.options.mqtt.qos}); 42 | clientMqtt.subscribe(this.options.mqtt.subscribe, {qos: this.options.mqtt.qos}); 43 | 44 | clientMqtt.on('message', function (topic, message) { 45 | that.log.trace(topic); 46 | 47 | 48 | var obj = JSON.parse(message.toString()); 49 | 50 | that.log.trace(obj); 51 | 52 | var point = {}; 53 | 54 | var indexId = -1; 55 | var indexTime = -1; 56 | 57 | for (var propertyName in obj) { 58 | 59 | if(that.options.decoder.denyKeys.indexOf(propertyName) > -1) 60 | { 61 | continue; 62 | } 63 | 64 | if(indexId === -1) 65 | { 66 | indexId = that.options.decoder.idKeys.indexOf(propertyName); 67 | if(indexId > -1) 68 | { 69 | point['id'] = obj[propertyName]; 70 | continue; 71 | } 72 | } 73 | 74 | if(indexTime === -1) 75 | { 76 | indexTime = that.options.decoder.timeKeys.indexOf(propertyName); 77 | if(indexTime > -1) 78 | { 79 | var dateObj = new Date(obj[propertyName]); 80 | point['time'] = dateObj; 81 | continue; 82 | } 83 | } 84 | 85 | var value = obj[propertyName]; 86 | 87 | var idTransform = that.transformKeys.indexOf(propertyName); 88 | 89 | if(idTransform > -1) 90 | { 91 | propertyName = that.options.decoder.transform[that.transformKeys[idTransform]]; 92 | } 93 | 94 | if(that.options.decoder.allowString || _.isNumber(value) ) 95 | { 96 | point[propertyName] = value; 97 | 98 | } 99 | 100 | } 101 | 102 | if(indexTime === -1) 103 | { 104 | point['time'] = new Date(); 105 | } 106 | 107 | 108 | 109 | clientInflux.writePoint(point['id'],point, function(err) 110 | { 111 | if(err) 112 | { 113 | that.log.error(err); 114 | } 115 | else 116 | { 117 | that.log.trace('point to insert = '); 118 | that.log.trace(point); 119 | that.log.trace('insertion in fluxdb done'); 120 | } 121 | }); 122 | 123 | }); 124 | }; 125 | 126 | module.exports = Consumer; 127 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "author": { 3 | "name": "Stéphane GUILLY", 4 | "email": "stephane.guilly@gmail.com" 5 | }, 6 | "name": "mqtt-influxdb", 7 | "description": "Simple bridge to store MQTT time event to a INFLUXDB database ", 8 | "version": "0.1.2", 9 | "license": "LGPLv2", 10 | "keywords": [ 11 | "mqtt", 12 | "influxdb" 13 | ], 14 | "repository": { 15 | "type": "git", 16 | "url": "https://github.com/sguilly/mqtt-influxdb.git" 17 | }, 18 | "main": "index.js", 19 | "files": [ 20 | "lib" 21 | ], 22 | "devDependencies": { 23 | "chai": "^3.0.0", 24 | "expect.js": "^0.3.1", 25 | "grunt-contrib-jshint": "^0.11.2", 26 | "grunt-contrib-nodeunit": "^0.4.1", 27 | "grunt-contrib-watch": "^0.6.1", 28 | "grunt-mocha-cli": "^1.13.0", 29 | "grunt-mocha-istanbul": "^2.4.0", 30 | "istanbul": "^0.3.16", 31 | "jshint-stylish": "^2.0.1", 32 | "load-grunt-tasks": "^3.2.0", 33 | "mocha": "^2.2.5", 34 | "mosca": "^0.30.3", 35 | "requirejs": "^2.1.18", 36 | "should": "^7.0.1", 37 | "sinon": "^1.15.3", 38 | "time-grunt": "^1.2.1", 39 | "bunyan": "^1.4.0", 40 | "bunyan-prettystream": "^0.1.3", 41 | "grunt": "^0.4.5" 42 | }, 43 | "scripts": { 44 | "test": "grunt" 45 | }, 46 | "preferGlobal": "true", 47 | "dependencies": { 48 | "influx": "^3.4.0", 49 | "mqtt": "^1.3.1", 50 | "underscore": "^1.8.3" 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /test/mqttToInfluxdbTest.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Created by sguilly on 03/12/14. 3 | */ 4 | /*jshint expr: true, unused: false*/ 5 | /*global describe, it, before, after, not */ 6 | 7 | var assert = require('assert'); 8 | 9 | var mqttInfluxdb = require('../lib/mqtt-influxdb'); 10 | 11 | var bunyan = require('bunyan'); 12 | 13 | var PrettyStream = require('bunyan-prettystream'); 14 | 15 | var prettyStdOut = new PrettyStream(); 16 | prettyStdOut.pipe(process.stdout); 17 | 18 | var mosca = require('mosca'); 19 | 20 | var ascoltatore = { 21 | type: 'memory' 22 | }; 23 | 24 | var settings = { 25 | port: 1883, 26 | backend: ascoltatore 27 | }; 28 | 29 | var logger = bunyan.createLogger({ 30 | name: 'mochacli', 31 | streams: [ 32 | { 33 | level: 'error', 34 | type: 'raw', 35 | stream: prettyStdOut 36 | }] 37 | }); 38 | 39 | var opts = { 40 | logger: bunyan.createLogger({ 41 | name: 'mqtt-influxdb', 42 | streams: [ 43 | { 44 | level: 'error', 45 | type: 'raw', 46 | stream: prettyStdOut 47 | }] 48 | }), 49 | mqtt: { 50 | ip: 'localhost', 51 | port: 1883, // tcp 52 | topic: 'mqtt-zibase/#', 53 | clientId: 'mqtt-influxdb', 54 | subscribe: ['mqtt-teleinfo/#', 'mqtt-zibase/#'], 55 | qos: 1 // 0 : without persistence and no ACK | 1 : with offline mode and ACK 56 | }, 57 | influx: { 58 | host: '188.213.25.148', 59 | port: 8086, // optional, default 8086 60 | username: 'root', 61 | password: 'root', 62 | database: 'timeseriesTest' 63 | }, 64 | decoder: { 65 | idKeys: ['id'], 66 | timeKeys: ['time', 'date'], 67 | denyKeys: ['itemToDeny'], 68 | transform: {tem: 'temperature', hum: 'humidity'}, 69 | allowString: false 70 | } 71 | }; 72 | 73 | var serverMqtt; // To simulate the broker 74 | var clientMqtt; // To emit new events 75 | 76 | describe('#start mqtt server', function () { 77 | it('should receive ready', function (done) { 78 | 79 | 80 | serverMqtt = new mosca.Server(settings); 81 | 82 | serverMqtt.on('clientConnected', function (client) { 83 | logger.info('client connected', client.id); 84 | }); 85 | 86 | serverMqtt.on('ready', function () { 87 | logger.info('mosca server ready'); 88 | done(); 89 | }); 90 | }); 91 | }); 92 | 93 | describe('#start influxdb client', function () { 94 | 95 | it('should create a temp database', function (done) { 96 | 97 | 98 | var influx = require('influx'); 99 | var clientInflux = influx(opts.influx); 100 | 101 | assert(clientInflux instanceof influx.InfluxDB); 102 | 103 | clientInflux.getDatabaseNames(function (err,array){ 104 | 105 | logger.trace('array=', array); 106 | 107 | if (array.indexOf(opts.influx.database) === -1) 108 | { 109 | clientInflux.createDatabase(opts.influx.database, function(err) 110 | { 111 | if (err) { 112 | logger.error('err=', err); 113 | } 114 | assert.equal(err, null); 115 | 116 | setTimeout(function () { 117 | done(); 118 | 119 | }, 1000); 120 | 121 | }); 122 | } 123 | else 124 | { 125 | logger.info('delete database'); 126 | clientInflux.deleteDatabase(opts.influx.database, function(err) 127 | { 128 | logger.info('create database'); 129 | clientInflux.createDatabase(opts.influx.database, function(err) 130 | { 131 | 132 | if (err) { 133 | logger.error('err=', err); 134 | } 135 | assert.equal(err, null); 136 | 137 | setTimeout(function () { 138 | done(); 139 | 140 | }, 1000); 141 | 142 | }); 143 | }); 144 | } 145 | 146 | }); 147 | 148 | }); 149 | }); 150 | 151 | 152 | describe('#start mqtt-influxdb bridge', function () { 153 | 154 | before(function (done) { 155 | var mqtt = require('mqtt'); 156 | 157 | clientMqtt = mqtt.createClient(1883, 'localhost', { 158 | clean: false, 159 | encoding: 'utf8', 160 | clientId: 'testMqtt' 161 | }); 162 | 163 | clientMqtt.on('connect', function(){ 164 | 165 | done(); 166 | }); 167 | 168 | var consumer = mqttInfluxdb(opts); 169 | 170 | consumer.open(); 171 | }); 172 | 173 | 174 | it('should receive a connect event', function (done) { 175 | 176 | done(); 177 | 178 | }); 179 | 180 | }); 181 | 182 | describe('#generate OS01 & OS02 event -> wait 35s and query influxdb', function () { 183 | 184 | this.timeout(35000); 185 | 186 | var clientInflux; 187 | 188 | before(function (done) { 189 | var influx = require('influx'); 190 | clientInflux = influx(opts.influx); 191 | 192 | clientMqtt.publish('mqtt-zibase/1', JSON.stringify({id: 'OS01', itemToDeny: true, tem: 20})); 193 | 194 | clientMqtt.publish('mqtt-zibase/2', JSON.stringify({id: 'OS02', time: new Date(), tem: 14.5})); 195 | 196 | setTimeout(function () { 197 | 198 | 199 | done(); 200 | 201 | }, 30000); 202 | }); 203 | 204 | it('should read series from the database', function (done) { 205 | clientInflux.query('list series;', function (err, res) { 206 | 207 | logger.trace('-----------'); 208 | logger.trace('list series'); 209 | logger.trace('err', err); 210 | logger.trace('res=', res); 211 | 212 | assert.equal(err, null); 213 | assert(res instanceof Array); 214 | assert.equal(res.length, 1); 215 | assert.equal(res[0].name, 'list_series_result'); 216 | 217 | done(); 218 | }); 219 | }); 220 | 221 | it('should read the event OS01 from the database', function (done) { 222 | 223 | clientInflux.query('select temperature FROM OS01;', function (err, res) { 224 | logger.trace('-----------'); 225 | logger.trace('query OS01'); 226 | logger.trace('err', err); 227 | logger.trace('res=', res); 228 | 229 | assert.equal(err, null); 230 | assert(res instanceof Array); 231 | assert.equal(res.length, 1); 232 | assert.equal(res[0].name, 'OS01'); 233 | assert.equal(res[0].points[0][2], 20); 234 | 235 | done(); 236 | }); 237 | }); 238 | 239 | it('should read the event OS02 from the database', function (done) { 240 | 241 | clientInflux.query('SELECT temperature FROM OS02;', function (err, res) { 242 | 243 | logger.trace('-----------'); 244 | logger.trace('query OS02'); 245 | logger.trace('err=', err); 246 | logger.trace('res=', res); 247 | 248 | assert.equal(err, null); 249 | assert(res instanceof Array); 250 | assert.equal(res.length, 1); 251 | assert.equal(res[0].name, 'OS02'); 252 | assert.equal(res[0].points[0][2], 14.5); 253 | 254 | done(); 255 | }); 256 | }); 257 | 258 | }); 259 | 260 | --------------------------------------------------------------------------------