WIKA parsers

Getting started ​

Try the parsers online on the WIKA Toolbox.

As mentioned in the introduction, the WIKA parsers are runtime-agnostic message interpreters written in TypeScript. They can be used in various environments, including LoRaWAN gateways, network servers, web applications, and server applications.

They parsers are written on a per-device basis, allowing for easy customization and extension. All supported devices are listed in the Supported Devices section.

LoRaWAN Gateways and Network Servers ​

The parsers are designed to be used in LoRaWAN gateways and network servers. They follow the LoRaWAN® Payload Codec API Specification TS013-1.0.0 and expose standard API functions.

Default API ​

The parsers expose the following primary function by default:

  • decodeUplink(input) - Decodes uplink messages from your devices

For spec-compliant gateways and network servers, you can use the parsers as-is without any modifications. Simply upload the parser and it will work immediately.

Adjusting Measuring Ranges

Always adjust the measuring ranges to match your specific sensor's data sheet. This can be done via the WIKA IIoT Toolbox before downloading, or programmatically using adjustMeasuringRange().

Non-Compliant Gateways/Network Servers ​

Some gateways or network servers may not fully comply with the LoRaWAN® Payload Codec API specification and expect different function names (e.g., decode, Decode, decodePayload). In these cases, you need to add a simple wrapper function at the bottom of your downloaded parser:

javascript
// Example wrapper for non-compliant systems
function decode(input) {
    return decodeUplink(input)
}

Check your gateway or network server documentation to see which function name it expects.

More Information ​

You can download prebuilt parsers from the Downloads page. The WIKA IIoT Toolbox allows you to configure and download parsers tailored to your specific devices.

Web and Server Applications ​

The parsers are available as npm packages, which allows you to easily integrate them into your web or server applications. This package is actually a wrapper around the raw parsers, providing a simplified interface and a few additional features.

You can install the package via npm and use the parsers to decode uplink messages and encode downlink messages in your application.

bash
npm i @w2a-iiot/parsers

After installing the package, you can import the parsers and use them in your application. The parsers encapsulate the raw parsers and add some additional functionality, such as minifying downlink frames.

typescript
import { NETRIS2Parser } from '@w2a-iiot/parsers'

const {
  decodeUplink,
  encodeDownlink,
  adjustRoundingDecimals
} = NETRIS2Parser()

From here on you can use the parsers functions to decode uplink messages and encode downlink messages. See here for web and server examples.