<commit_before>node-red-contrib-sparkplug
=========

A node for an MQTT Edge Node client for MQTT device communication using the
Sparkplug Specification from Cirrus Link Solutions.  

https://s3.amazonaws.com/ignition-modules/Current/Sparkplug+Specification.pdf

The client will connect to an MQTT Server and act as an MQTT Edge of Network
(EoN) Node.  It will publish birth certificates (NBIRTH), node data messages
(NDATA), and process node command messages (NCMD) that have been sent from
another MQTT client.

The client also provides and interface for other nodes to publish device birth
certificates (DBIRTH), device data messages (DDATA), device death certificates
(DDEATH), and receive device command messages (DCMD) that have been sent from
another MQTT client.

## Installation

  npm install node-red-contrib-sparkplug

## Usage

### Configuring the Sparkplug Node

When editing the Sparkplug Node the following properties are configurable:

* ServerUrl: The URL of the MQTT server.<commit_msg>[CS-48] Added link to sparkplug-client documentation in the README<commit_after>node-red-contrib-sparkplug
=========

A node for an MQTT Edge Node client for MQTT device communication using the
Sparkplug Specification from Cirrus Link Solutions.  

https://s3.amazonaws.com/ignition-modules/Current/Sparkplug+Specification.pdf

The client will connect to an MQTT Server and act as an MQTT Edge of Network
(EoN) Node.  It will publish birth certificates (NBIRTH), node data messages
(NDATA), and process node command messages (NCMD) that have been sent from
another MQTT client.

The client also provides and interface for other nodes to publish device birth
certificates (DBIRTH), device data messages (DDATA), device death certificates
(DDEATH), and receive device command messages (DCMD) that have been sent from
another MQTT client.

Additional details on the example payloads below can be found here:

https://www.npmjs.com/package/sparkplug-client

## Installation

  npm install node-red-contrib-sparkplug

## Usage

### Configuring the Sparkplug Node

When editing the Sparkplug Node the following properties are configurable:

* ServerUrl: The URL of the MQTT server.
{'fraction_non_alphanumeric': 0.06559633027522936, 'fraction_numerical': 0.001834862385321101, 'mean_word_length': 4.991758241758242, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '257154', 'n_tokens_mistral': 613, 'n_tokens_neox': 581, 'n_words': 273}