Создание обработчика

• имя — наименование обработчика;
• описание — подробная характеристика обработчика, заполняется при необходимости;
• параметры по умолчанию — поведение обработчика при получении пакета данных, в котором нет нужных входных аргументов:
  • брать последнее присланное значение — в качестве значений недостающих в пакете параметров будет подставлено последнее полученное значение по этим параметрам.
    Например, в обработчике вы рассчитываете эффективную температуру на базе двух входных значений: температура и влажность, однако они приходят не в одном пакете, а в разных, последовательно. Тогда при получении только температуры обработчик сам возьмет последнее полученное значение влажности для расчета, и наоборот.
  • заменять на “null” — в качестве значений недостающих в пакете параметров будет подставлен “null”. Например, в обработчике вы рассчитываете среднее значение скорости на базе последних десяти значений. Однако скорость вы получаете не в каждом пакете. Если вы выберете режим “брать последнее присланное значение”, то при получении пакета без скорости обработчик возьмет последнее значение скорости и проведет для него расчет. Вы получите некорректную выходную величину. Если же вы выберете режим “заменять на “null”, то такую ситуацию вы можете обработать и не проводить расчет:

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

1. Сохранить: Сохранить изменения обработчика. Если ранее обработчик был запущен на объектах, он продолжит работать уже в обновленной версии
2. Тестировать: Открыть окно тестирования, в котором можно ввести входные параметры и проверить получившиеся выходные значения
3. Download .js: Экспортировать обработчик в файл формата JSON
4. В данной части комментария указывается дополнительное описание обработчика
5. В данной части комментария указывается логин автора обработчика
6. В данной части комментария указываются входные параметры в следующем формате

  * @param {<тип_данных>} <имя> <описание>

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

7. В круглых скобках указываются имена входных параметров в следующем формате

function process(параметр_1, параметр_2, ..., параметр_n)

function process(rawData)

8. Код обработчика, работающий с входными параметрами по заданному алгоритму
9. В фигурных скобках после слова return указываются имена выходных параметров в следующем формате

return {параметр_1, параметр_2, ..., параметр_n};

return { time, hypotenuse };

• Пополняемый GitHub репозиторий полезных обработчиков (opens in a new tab)

Встроенные библиотеки и модули

• JSON (opens in a new tab)
• Date (opens in a new tab)
• Math (opens in a new tab)
• и другие (opens in a new tab)

• генерация событий;
• декодирование Base64;
• организация локального хранилища.

Генерация событий

/**
 * @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

/**
 * 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=

Локальное хранилище

/**
 * 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,
  };
}

💡

При разработке большого и сложного кода пользуйтесь дополнительными возможностями, список которых можно открыть, кликнув правой кнопкой мыши в области кода обработчика. Например, там есть функция автоформатирования кода.

Сторонние библиотеки и модули

• максимальный размер библиотеки — 65 Кбайт;
• в коде должны использоваться только стандартные объекты JavaScript (opens in a new tab). Если библиотека использует какие-то расширенные API (например, Buffer из Node.js), или их встроенные модули (например, fs, path), или браузерные API (fetch, WebSocket), то она не заработает.

• 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)

Подключение Javascript модуля

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 };
}

💡

Важно: Обратите внимание, что при импорте модулей с GitHub репозитория необходимо использовать их “raw” версию, т.к. иначе сервер GitHub будет отдавать HTML страницу для просмотра, а не само содержимое файла. Для получения нужного адреса ссылки нажмите кнопку Raw в интерфейсе GitHub.

💡

Подсказка: Если вас смущает, что слово process при подключении сторонних библиотек становится бледным, добавьте слово export перед словом function.

Подключение библиотеки из 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 };
}