From 5a95e9c404b4d8f9f00a66cae889b4e85a2e4bb8 Mon Sep 17 00:00:00 2001 From: Dave Conway-Jones Date: Thu, 11 Feb 2016 22:50:30 +0000 Subject: [PATCH] update snap node docs to make outputs more obvious --- io/snmp/README.md | 12 ++++++------ io/snmp/package.json | 2 +- io/snmp/snmp.html | 6 ++++-- io/snmp/snmp.js | 2 +- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/io/snmp/README.md b/io/snmp/README.md index b49691f9..d6c3c235 100644 --- a/io/snmp/README.md +++ b/io/snmp/README.md @@ -12,7 +12,6 @@ Run the following command in the user directory of your Node-RED install. npm install node-red-node-snmp - Usage ----- @@ -20,20 +19,21 @@ Usage 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) +`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. +Outputs `msg.payload` containing a table of objects, and the requested `msg.oid`. +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. +`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. +Outputs `msg.payload` containing the table of objects, and the requested `msg.oid`. +Values depends on the oids being requested. diff --git a/io/snmp/package.json b/io/snmp/package.json index 28654146..3bae612e 100644 --- a/io/snmp/package.json +++ b/io/snmp/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-snmp", - "version" : "0.0.3", + "version" : "0.0.4", "description" : "A Node-RED node that looks for SNMP oids.", "dependencies" : { "net-snmp" : "1.1.13" diff --git a/io/snmp/snmp.html b/io/snmp/snmp.html index 7a7f0bb5..3c7e2202 100644 --- a/io/snmp/snmp.html +++ b/io/snmp/snmp.html @@ -43,7 +43,8 @@