Creating a handler

• name - name of the handler;
• description - detailed description of the handler, to be filled in if necessary; description - detailed description of the handler if necessary;
• default parameters - behavior of the handler when receiving a packet of data packet that does not contain the required input arguments:
  • take last sent value - the values of missing parameters in the packet will be substituted by the last received value for these parameters. parameters missing in the packet will be substituted by the last received value for these parameters. parameters. For example, in the handler you calculate the effective temperature on the basis of two input values: temperature and humidity. two input values: temperature and humidity, but they come not in one package, but in different in one packet, but in different ones, sequentially. Then when you receive only temperature, the handler itself will take the last received humidity value for calculation, and vice versa.
  • replace with "null " - "null" will be substituted for the values of parameters missing in the package. will be substituted with "null". For example, in the handler you calculate the average value of velocity on the basis of of the last ten values. However, you do not get the speed in every packet. If you choose the "take the last value sent" mode, then when you receive a packet without speed, the handler will take the last value. packet without speed, the handler will take the last speed value and calculate for it. and calculate for it. You will get an incorrect output value. If you choose the "replace with "null" mode, then you can handle this situation and not perform the calculation: if you receive a packet with no speed, the handler will take the last speed value and perform the calculation for it. and not perform the calculation:

    if (speed === null) {
      return {};
    }

1. Save: Save the changes to the handler. If the handler was previously handler was previously run on objects, it will continue to work already in the updated version
2. test: Open the test window, where you can enter input parameters and check the resulting output values. parameters and check the resulting output values
3. Download .js: Export the handler to a JSON file.
4. This part of the comment specifies an additional description of the handler
5. This part of the comment specifies the login of the handler author
6. This part of the comment specifies input parameters in the following format format

 * @param {<data_type>} <name> <description>

 * @param {string} rawData input data in base64 format

7. The names of input parameters in parentheses are specified in the following format

function process(parameter_1, parameter_2, ..., parameter_n)

function process(rawData)

8. Handler code that works with input parameters according to the given algorithm
9. The names of output parameters are specified in curly brackets after the word return in the following format

return {parameter_1, parameter_2, ..., parameter_n};

return { time, hypotenuse };

• GitHub's growing repository of useful handlers (opens in a new tab)

Built-in libraries and modules

• JSON (opens in a new tab)
• Date (opens in a new tab)
• Math (opens in a new tab)
• and others (opens in a new tab)

• event generation;
• Base64 decoding;
• organization of local storage.

Event generation

/**
 * @param {number} a sample param 1
 * @param {number} b sample param 2
 */
 
function process(a, b) {
  const sum = a + b;
  if (sum > 25) {
    ric.events.gen("model-event-01", { sum });
  }
  return { sum };
}

Base64 decoding

/**
 * Parse { lat, lon } params from binary
 *
 * ```
 * +----------+----------+
 * | lat      | lon      |
 * +----------+----------+
 * | 32bit be | 32bit be |
 * | ieee 754 | ieee 754 |
 * +----------+----------+
 * ```
 *
 * @param {string} payload base64 encoded bytes
 */
function process(payload) {
  const buf = ric.base64.decode(payload);
 
  return {
    lat: buf.getFloat32(0),
    lon: buf.getFloat32(4),
  };
}
 
// test Ql8Z6EIWn/M=

Local Storage

/**
 * Calc average of last 10 a's
 * @param {number} a sample param
 */
 
function process(a = 0) {
  /* init local store with default values (if empty)
     and reduce it with fresh values */
  const { counter, last10 } = ric.localStore.forObject
    .initWith({
      counter: 0,
      last10: [a],
    })
    .reduce((prev) => ({
      counter: prev.counter + 1,
      last10: [...prev.last10, a].slice(-10),
    }));
 
  /* calc sum and avg of last 10 values */
  const sum = last10.reduce((acc, val) => acc + val, 0);
  const avg = sum / last10.length;
 
  return {
    counter,
    sum,
    avg,
  };
}

💡

When developing large and complex code, take advantage of the additional You can open the list of additional features by right-clicking in the code area of the handler. in the code area of the handler. For example, there is a function of code auto-formatting.

Third-party libraries and modules

• maximum library size is 65 Kbytes;
• code must use only standard JavaScript objects (opens in a new tab). If the library uses any extended APIs (e.g. Buffer from Node.js), or their built-in modules (e.g., fs, path), or browser APIs (fetch, WebSocket) (fetch, WebSocket), it will not work.

• https://www.skypack.dev/ (opens in a new tab)
• https://esm.sh/ (opens in a new tab)
• https://www.jsdelivr.com/esm (opens in a new tab)

Import Javascript module

export function sum(a, b) {
  return a + b;
}

import { sum } from "https://raw.githubusercontent.com/rightech/ric-examples/master/handlers/lib/example.js";
 
function process(a, b) {
  const res = sum(a, b);
  return { sum: res };
}

💡

Important: Note that when importing modules from the GitHub repository. you must use their "raw" version, because otherwise the GitHub server will HTML page for viewing, but not the content of the file itself. To click the Raw button in the GitHub interface to get the desired link address.

💡

Tip: If you are confused that the word process becomes faint when third-party libraries are attached, add the word export before the word function. libraries, add the word export before the word function.

Import library from npm

import GPS from "https://cdn.skypack.dev/gps@0.6.1";
 
function process(nmea) {
  const gps = new GPS();
 
  let lat = 0;
  let lon = 0;
 
  gps.on("data", (parsed) => {
    lat = parsed.lat;
    lon = parsed.lon;
  });
 
  gps.update(nmea);
 
  return { lat, lon };
}