Reekoh Formatters

The Reekoh Formatters are a set of custom codes being run by the Reekoh Engine in the back-end to transform raw data coming from different devices connected to the Reekoh platform.

Formatters are categorized in two:

• Interpreters https://github.com/Reekoh/interpreters
• Converters

Converters

While interpreters transform raw data to JSON, converters transform the data values from raw string to meaningful data. Why is there a need for converters? Classic examples:

1. A temperature sensor is configured to send temperature data as Farenheit. One would like to use Celsius.
2. A device is configured to send distance in units of meters. One would like to use miles or kilometers as base.
3. Devices send date/time data in different formats like ddMMYYYYHHmmss, MMddYYHHmmss etc.

It would be a tremendous challenge to catch all of the scenarios that can occur. So in order for the platform to be as flexible as possible, we give our users the freedom to write their own custom code to make sense of the values returned from the interpreters.

Code Format

exports.convert = function () {
	// data is in the global namespace. It is the same data returned by the interpreter
	// convert data here
	// return the converted data using the exit function
	// convertedData should be a valid JavaScript Object (JSON)
	exit(convertedData);
};

Return

Same with the interpreters, the return value of a converter should be a valid JavaScript Object (JSON) or an Array/Collection of JavaScript Objects. It should also have the device field and the is_data field.

API

Interpreters and Converters are given access to the APIs or libraries stated below.

Utility Libraries

• Lodash (v3.8.0) as _
• Moment.js (v2.10.2) as moment
• node-xml2js (v0.4.8) as xml2js

These libraries are available in the global namespace so if you would like to use lodash, just use it like _.contains(['123', '456', '789'], '123').

Node Native API

You are also given access to Node's native API. The following modules is available to use in your custom parser code. These are all in the global namespace. Names are as is.

• assert
• buffer
• crypto
• querystring
• url
• string_decoder
• timers
• util

JavaScript Native API

Of course, you are also given access to JavaScript's global objects and functions. These are all in the global namespace. Names are as is.

• Object
• Function
• Boolean
• Error
• Number
• Math
• Date
• String
• RegExp
• Array
• JSON
• parseInt
• parseFloat
• isNaN
• isFinite
• decodeURI
• decodeURIComponent
• encodeURI
• encodeURIComponent