README

@jcoreio/sparkplug-payload

A library that provides tools for encoding and decoding payload objects using the Sparkplug Google Protocol Buffer Schema described in the Sparkplug Specification from Cirrus Link Solutions.

https://s3.amazonaws.com/cirrus-link-com/Sparkplug+Topic+Namespace+and+State+ManagementV2.1+Apendix++Payload+B+format.pdf

Not a drop-in replacement for the original sparkplug-payload package; require paths have changed.

Installation

npm install --save @jcoreio/sparkplug-payload

Encoding a payload

Here is a code example of encoding a payload:

var sparkplug = require('sparkplug-payload/spBv1.0'),
  payload = {
    timestamp: new Date().getTime(),
    metrics: [
      {
        name: 'intMetric',
        value: 1,
        type: 'Int32',
      },
    ],
  },
  encoded = sparkplug.encodePayload(payload)

Decoding a payload

Here is a code example of decoding an encoded payload:

var decoded = sparkplug.decodePayload(encoded)

License

All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html

Contributors: Cirrus Link Solutions, JCore Systems

Usage no npm install needed!