node-opentherm-parser v0.1.5

Opentherm parser

This module parses the opentherm messages passed to it.

Installation

npm install node-opentherm-parser

Usage

Usage of the module is very straight forward, include the module in your script and pass it an Opentherm message.

const parser = require('node-opentherm-parser')

console.log(parser('C000CCCC'))

The response is a JSON object of the form:

{
  msgType: { code: 4, text: 'Read-Ack' },
  dataId: { id: 0, name: 'Status' },
  properties: {
    fault: false,
    ch_active: false,
    dhw_active: true,
    flame_on: true,
    cooling_active: false,
    ch2_active: false,
    diagnostic: true,
    electricity_production: true
  }
}

where:

• msgType is an object containing the numeric and textual representation of the type of message and can be one of:

  • Read-Data (0)
  • Write-Data (1)
  • Invalid-Data (2)
  • Reserved (3)
  • Read-Ack (4)
  • Write-Ack (5)
  • Data-Invalid (6)
  • Unknown-DataId (7)

• dataId is the Opentherm data object containing the id and name

• properties is an object containing all properties of the data object and their values

Supported Data objects and their properties

The following data objects and properties are supported by this module: