From 8df7189058e228dd101385ca891ca0fb67a51023 Mon Sep 17 00:00:00 2001 From: dceejay Date: Wed, 4 Mar 2015 19:55:53 +0000 Subject: [PATCH] Add discovery (mdns) and SNMP nodes --- io/mdns/LICENSE | 177 ++++++++++++++++++++++++++++++++++++++ io/mdns/README.md | 43 +++++++++ io/mdns/icons/bonjour.png | Bin 0 -> 2412 bytes io/mdns/mdns.html | 65 ++++++++++++++ io/mdns/mdns.js | 51 +++++++++++ io/mdns/package.json | 24 ++++++ io/snmp/LICENSE | 177 ++++++++++++++++++++++++++++++++++++++ io/snmp/README.md | 39 +++++++++ io/snmp/package.json | 24 ++++++ io/snmp/snmp.html | 126 +++++++++++++++++++++++++++ io/snmp/snmp.js | 107 +++++++++++++++++++++++ 11 files changed, 833 insertions(+) create mode 100644 io/mdns/LICENSE create mode 100644 io/mdns/README.md create mode 100644 io/mdns/icons/bonjour.png create mode 100644 io/mdns/mdns.html create mode 100644 io/mdns/mdns.js create mode 100644 io/mdns/package.json create mode 100644 io/snmp/LICENSE create mode 100644 io/snmp/README.md create mode 100644 io/snmp/package.json create mode 100644 io/snmp/snmp.html create mode 100644 io/snmp/snmp.js diff --git a/io/mdns/LICENSE b/io/mdns/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/io/mdns/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/io/mdns/README.md b/io/mdns/README.md new file mode 100644 index 00000000..ebd97b67 --- /dev/null +++ b/io/mdns/README.md @@ -0,0 +1,43 @@ +node-red-node-discover +====================== + +A Node-RED node that uses Bonjour + / Avahi to discover local network services such as iTunes libraries, printers, etc. + +Prerequisites +------------- + +please read the [install instructions](https://www.npmjs.com/package/mdns) for the underlying npm. + +For Debian / Ubuntu this requires installing + + sudo apt-get install libavahi-compat-libdnssd-dev + +Install +------- + +Run the following command in the root directory of your Node-RED install + + npm install node-red-node-discover + +Usage +----- + +Uses a javascript implenetation of mdns ( mdns-js ) to provide a Bonjour / Avahi +service discovery capability. + +**msg.payload** contains the service object on both arrival and leaving. + +**msg.state** contains boolean true or false depending if the service has arrived (true) or gone away (false).. + +Within the msg.payload object the most interesting things are: + + * msg.payload.name + * msg.payload.interface + * msg.payload.port + * msg.payload.addresses + * msg.payload.txtRecord + +For a full list of official service types see [this list](http://www.dns-sd.org/ServiceTypes.html" target="_new). + +**Note**: When Node-RED starts you will get a big WARNING message about the Bonjour compatability layer... this is just a warning so don't worry. diff --git a/io/mdns/icons/bonjour.png b/io/mdns/icons/bonjour.png new file mode 100644 index 0000000000000000000000000000000000000000..7dc35a5266bc3b5b508a15130e900af9b337fd0e GIT binary patch literal 2412 zcmV-y36u7TP)C3<00001b5ch_0Itp) z=>Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2j2k< z3LiTu%_CX>@2HM@dakSAh-}000QbNklD&^NvBbnI zF~n`mupfr`j|Ssd;*?YzH{FF;n${f zEoH$aOV*Rzf4=*j^F8l5&w0=DzQByl*o@8C|B;!g{&?Yq7i<`Y*Jd)A%5*xN&t|j# zSigR~{wKki*#tpgL}dI~DwUcthBw*6!-o&2hlYk8O{deV7A{=4ps%m*<9++~ZOP~J zE|p5n25^vwhA#(1L>g4}u0$enJrQ}T3IIk#jvHhCKtu!6t|phuc?S+0c%Z$#JwG%w zq^jz&*{rs)WEL9nAa}X0Dqe8`aFbg_%2;d4!prh^UAtGdpG;V&+y6`M#=7 znhX>Q1uG)Ac6D_%wzaiw85$ZIRaK3mNJPXH3Wef@3l}zrVR%qP95cVi%uT9F6M)n) zbF+v9BI4qoGP8~WQq{5N{UY*|h*XUEj|WO563YO*XpC8sNF;(}GHFD_Ip<)EaZwbN z-hco7W22*^9~xtXh*ko42Ef|5EY}gy^F;J@RrORgoWM(C%qR48&N%>1Rp+VdQviM# zhT*JnFnxV}6`tqaXN*~z$z&eP<#O3lsnjnbaL!Q}hA0#Y9W^yIi;~IYti9Ns`di-tExU>jCmEnQ6kDZ=Sl!nRo!?dhzx+AS!=&F-c2HMhpILc zQPMeA>g??N`N@+f%WGwo@!~UyM559;w;-8Jew&Ck z8e0q> z`#f2bjEsylS5#D7)7I8Dn9XKW$z<~S_V)Hu=gysLZfR*5hKS4&kzFF0q=3g*#NksCh`rzfZj?J4lHy%8A@IW@3Ed)VO%;j>!hYug#xqbWg zN>WwC8`2oliHL?&^>u6Q$W%dz=(|L;f`~o>Falr?fLS8)xQKjyD!-{r$2A}p#rBaJ3D=UeJoQQykP*qiBSFT*Snuw^NsypM}cVn3vYu`zLqyYRB zfCtQe2+5iD*w; zA^@lYaLW|sc>uuIRP{N}^Zq4!zV8=^s7X~%tLhW^eBS%iLT)>H^ys@sjvRUI+_`f@ zxm-@VySs~Tyz$2Fj*gCF;_GX`=?sZ`ohR#tX;>(;Gr_x1HHS+rbFMauqB;?2 z^nL$fBFX?b58woVC90YNaKE+oJ?GpC0L$W;69HICMD+l!Rn=-DN&~R*&~!xPRJGGN z_j_Z^2LL*J-|wDQ>4jlfYm8Y3V70aOtIj!A)iNR~0VwGwn^O`%0ze3$ERJW1$f~Nd z)<&utsOlc)T-F%V1K>Bq!^0!#begYNc1}onMcg6x5z%S@dsH>&oEtXAELPQbipAoo zWHNaZfIiRjmJrcx02Zq1F#sMBJ!h?Lp6*-TbT9b6KN5!F5o_&_V(j5l@IadYXvS4UB6s1yWwlSvB7&AXsYxPkS-7uY>s#;Z@6YHH?01Kz{ znHG%ac~wMoQ%v51F{a!1{h{gnqA1D$xHB$o4S*YiAfT%%leIP(1VMEaMIRIjg*Ws0 ze4$V%-1+j$FV_tW3>@CDVZ*;o_8Vfg1*Y#oV@D$2|fA8TF;!!UEzoQb7oa@n$F zUs|wW!E7RO&N*j{adYO(sa>&R#U1?gp@{rly8Jvm1hq z8#k^#e*Adnm{tygz_qrv?%uU)*F&m$dcq)_Se~vh3>&ZX8&|sNVbi8fZy94YR##Uy zMNu>l!1+?Cv~TU&wW|Qs#aRFm8C5m$31X9T?r;CCD-<8VbpXDwZr!?uLZR^1@bK_p ztbGDzE;92O5jo4ucZXr + + + + + + diff --git a/io/mdns/mdns.js b/io/mdns/mdns.js new file mode 100644 index 00000000..8972aec3 --- /dev/null +++ b/io/mdns/mdns.js @@ -0,0 +1,51 @@ +/** + * Copyright 2015 IBM Corp. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +module.exports = function(RED) { + "use strict"; + + function MdnsNode(n) { + var mdns = require('mdns'); + if (process.platform === "linux") { + RED.log.info("You may ignore the warning about Bonjour compatability."); + } + RED.nodes.createNode(this, n); + this.topic = n.topic || ""; + this.service = n.service; + var browser = mdns.createBrowser(this.service); + var node = this; + + browser.on('serviceUp', function (service) { + if (RED.settings.verbose) { node.log("here : " + service.name); } + service.state = true; + var msg = {topic: node.topic, payload: service}; + node.send(msg); + }); + browser.on('serviceDown', function (service) { + if (RED.settings.verbose) { node.log("away : " + service.name); } + service.state = false; + var msg = {topic: node.topic, payload: service}; + node.send(msg); + }); + browser.start(); + + node.on("close", function () { + browser.stop(); + }); + } + + RED.nodes.registerType("discovery", MdnsNode); +} diff --git a/io/mdns/package.json b/io/mdns/package.json new file mode 100644 index 00000000..4813e3f1 --- /dev/null +++ b/io/mdns/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-discovery", + "version" : "0.0.5", + "description" : "A Node-RED node that uses Bonjour / Avahi to discover nearby services.", + "dependencies" : { + "mdns" : "2.2.*" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/io/mdns" + }, + "license": "Apache", + "keywords": [ "node-red", "mdns", "avahi", "bonjour" ], + "node-red" : { + "nodes" : { + "discover": "mdns.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/io/snmp/LICENSE b/io/snmp/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/io/snmp/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/io/snmp/README.md b/io/snmp/README.md new file mode 100644 index 00000000..b49691f9 --- /dev/null +++ b/io/snmp/README.md @@ -0,0 +1,39 @@ +node-red-node-snmp +================== + +A pair of Node-RED nodes that +fetch either individual oids, or a table oid from a SNMP enabled host. + +Install +------- + +Run the following command in the user directory of your Node-RED install. +( typically ~/.node-red ) + + npm install node-red-node-snmp + + +Usage +----- + +###snmp + +SNMP oids fetcher. Can fetch a single or comma separated list of oids. Triggered by any input. + +**msg.oid** may contain a comma separated list of oids to search for. (no spaces) + +The oids confgured in the edit config will override msg.oid. Leave blank if you +want to use msg.oid to provide input. + +Outputs **msg.payload** containing a table of objects. Values depends on the oids being requested. + +###snmp-table + +Simple SNMP table oid fetcher. Triggered by any input. + +**msg.oid** may contain the oid of a single table to search for. + +The oid confgured in the edit config will override msg.oid. Leave blank if you +want to use msg.oid to provide input. + +Outputs **msg.payload** containing the table of objects. Values depends on the oids being requested. diff --git a/io/snmp/package.json b/io/snmp/package.json new file mode 100644 index 00000000..bcafecfd --- /dev/null +++ b/io/snmp/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-snmp", + "version" : "0.0.1", + "description" : "A Node-RED node that looks for SNMP oids.", + "dependencies" : { + "net-snmp" : "1.1.13" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/io/snmp" + }, + "license": "Apache v2", + "keywords": [ "node-red", "snmp", "oid" ], + "node-red" : { + "nodes" : { + "snmp": "snmp.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +} diff --git a/io/snmp/snmp.html b/io/snmp/snmp.html new file mode 100644 index 00000000..7a7f0bb5 --- /dev/null +++ b/io/snmp/snmp.html @@ -0,0 +1,126 @@ + + + + + + + + + + + + + + diff --git a/io/snmp/snmp.js b/io/snmp/snmp.js new file mode 100644 index 00000000..03a3e504 --- /dev/null +++ b/io/snmp/snmp.js @@ -0,0 +1,107 @@ +/** + * Copyright 2014 IBM Corp. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +module.exports = function(RED) { + var snmp = require ("net-snmp"); + + function SnmpNode(n) { + RED.nodes.createNode(this,n); + this.community = n.community || "public"; + this.host = n.host || "127.0.0.1"; + this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; + this.oids = n.oids.replace(/\s/g,""); + this.session = snmp.createSession (this.host, this.community, {version: this.version}); + var node = this; + + this.on("input",function(msg) { + var oids = node.oids || msg.oid; + if (oids) { + node.session.get(oids.split(","), function(error, varbinds) { + if (error) { + node.error(error.toString()); + } else { + for (var i = 0; i < varbinds.length; i++) { + if (snmp.isVarbindError (varbinds[i])) { + node.error(snmp.varbindError (varbinds[i])); + } + else { + if (varbinds[i].type == 4) { varbinds[i].value = varbinds[i].value.toString(); } + varbinds[i].tstr = snmp.ObjectType[varbinds[i].type]; + //node.log(varbinds[i].oid + "|" + varbinds[i].tstr + "|" + varbinds[i].value); + } + } + msg.oid = oids; + msg.payload = varbinds; + node.send(msg); + } + }); + } + else { + node.warn("No oid(s) to search for"); + } + }); + } + RED.nodes.registerType("snmp",SnmpNode); + + function SnmpTNode(n) { + RED.nodes.createNode(this,n); + this.community = n.community || "public"; + this.host = n.host || "127.0.0.1"; + this.version = (n.version === "2c") ? snmp.Version2c : snmp.Version1; + this.oids = n.oids.replace(/\s/g,""); + this.session = snmp.createSession (this.host, this.community, {version: this.version}); + var node = this; + var maxRepetitions = 20; + + function sortInt (a, b) { + if (a > b) return 1; + else if (b > a) return -1; + else return 0; + } + + function responseCb (error, table) { + if (error) { + console.error (error.toString ()); + } else { + var indexes = []; + for (index in table) { indexes.push (parseInt (index)); } + indexes.sort (sortInt); + for (var i = 0; i < indexes.length; i++) { + var columns = []; + for (column in table[indexes[i]]) { columns.push(parseInt (column)); } + columns.sort(sortInt); + console.log ("row index = " + indexes[i]); + for (var j = 0; j < columns.length; j++) { + console.log (" column " + columns[j] + " = " + table[indexes[i]][columns[j]]); + } + } + msg.payload = table; + node.send(msg); + } + } + this.on("input",function(msg) { + var oids = node.oids || msg.oid; + if (oids) { + msg.oids = oids; + node.session.table(oids, maxRepetitions, responseCb); + } + else { + node.warn("No oid to search for"); + } + }); + } + RED.nodes.registerType("snmp table",SnmpTNode); +}