Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 3.06 KB

README.md

File metadata and controls

75 lines (47 loc) · 3.06 KB
Raw

Netrunr heartbeat example

Collect heartbeat data from Axiomware's Netrunr gateways using gapi-v3-sdk JavaScript SDK

This Program will illustrate the following basic API functions:

  • Install and include the SDK in a NodeJS Program.
  • Connect to a MQTT broker and collect heartbeat data.
  • Verify the configuration of the gateway.

This example uses promises and async/await functionality present in Nodejs version 8.+.

SDK, Documentation and examples

Requirements

  • Netrunr E24 gateway
  • Nodejs (see https://nodejs.org/en/ for download and installation instructions)
    • Nodejs version 8.x.x or higher is required due to the use of promises/async/await
  • NPM (Node package manager - part of Nodejs)
  • Windows, MacOS or Linux computer with access to internet

Installation

Clone the repo

git clone https://github.com/axiomware/netrunr-heartbeat-v3.git

or download as zip file to a local directory and unzip.

Install all module dependencies by running the following command inside the directory

cd netrunr-heartbeat-v3

npm install

Optional customization before running the program

This example uses the default setup of the Netrunr gateway:

  • The client computer is connected to the LAN port of Netrunr gateway
  • The built-in MQTT broker is used and the IP address of the gateway is 192.168.8.1
  • The MQTT broker port is 1883
  • The MQTT topic prefix is netrunrfe

Usage - Collect information in single shot

Run the nodejs application:

node netrunr-heartbeat.js -h "192.168.8.1" -p 1883 -t "netrunrfe"

The tls flag will enable operation over MQTTS. This mode will use client certificates and collect data over secure link:

node netrunr-heartbeat.js -h 'yourmqtthostname.com' -p 8883 -t 'netrunrfe' --tls --ca-filename='./yourRootCA.pem' --key-filename='./your-private-key.pem.key' --crt-filename='./your-client-certificate.pem.crt'

Usage - Collect information in continuous mode

Run the nodejs application:

node netrunr-heartbeat-continuous.js -h "192.168.8.1" -p 1883 -t "netrunrfe"

The tls flag will enable operation over MQTTS. This mode will use client certificates and collect data over secure link:

node netrunr-heartbeat-continuous.js -h 'yourmqtthostname.com' -p 8883 -t 'netrunrfe' --tls --ca-filename='./yourRootCA.pem' --key-filename='./your-private-key.pem.key' --crt-filename='./your-client-certificate.pem.crt'

To force exit at any time, use:

CTRL-C

Error conditions/Troubleshooting

  • If the program fails with module not installed, make sure npm Install is run prior to connecting to Netrunr gateway.
  • For security reasons, Clients connected to LAN ports of Netrunr gateway have limited access to upstream network.
  • If you do not see any heartbeat activity, verify network connections and your configuration.