smithtek-nodered-ping 1.1.0

A Node-RED node to ping a remote server, for use as a keep-alive check.

npm install smithtek-nodered-ping

SmithTek Ping Node for Node-RED

This node, originally duplicated from the "node-red-node-ping", now includes a node status. This status can be utilized with the Node-RED status node to aid in watchdog routines. It was specifically designed to integrate with the SmithTek store and forward node.

Installation

Install using the NodeRED palette manager.

Usage

The smithtek-nodered-ping node pings one or more devices and returns the trip time in milliseconds as msg.payload. It returns a boolean false if no response is received, or if the host is unresolvable. msg.error will contain any error message if necessary. msg.topic contains the IP address of the target host.

In addition, this node offers a status update feature. If a ping is successful, the node's status will indicate "online". Conversely, if the ping is unsuccessful, the status will display as "offline". These status messages can be utilized in the SmithTek store and forward node to track device status effectively.

There are two modes - Timed and Triggered.

• Timed mode: This is the default mode that pings your devices on a timed basis. The default ping is every 20 seconds but can be configured.
• Triggered mode: This mode permits you to trigger the ping by an input message. If the Target field is left blank and msg.payload is a string or array, you can ping one or more devices on demand. Simply enter your IP or hostname in the Target field. If left blank, you can inject as many IPs or hostnames as required into the node using the msg.payload property.

Refer to the built-in help on the sidebar info panel for more details.

Example

Here's an example usage of the smithtek-nodered-ping node in a compressed format:

Please insert your example usage here...

License

Copyright (c) 2023 www.smithtek.com.au Licensed under the terms of the GPLv3

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL SMITHTEK BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

www.smithtek.com.au