Merge pull request #1 from Rightech/release1_0

Release1 0

Author: Rulur

.images/Logo_Rightech.svg

@@ -1 +1,19 @@
-# ric-public
+<p align="center">
+  <a href="http://rightech.io">
+    <img
+      alt="Rightech IoT Cloud"
+      src="./.images/Logo_Rightech.svg"
+      width="200"
+    />
+  </a>
+</p>
+
+Rightech IoT Cloud (RIC) — это облачная платформа Интернета Вещей, выступающая в качестве связующего звена при разработке IoT-решений. Для получения более подробной информации посетите [портал rightech.io](http://rightech.io) 
+
+### Полезные ссылки
+- [Платформа](https://dev.rightech.io)
+- [Release 1.0](./release-notes/v1_0.md)
+- [Документация](https://rightech.io/developers/introductions/)
+- [Видеоуроки](https://rightech.io/video-tutorials/)
+- [Группа Telegram](https://t.me/rightech_iot) 
+- [Сообщество ВК](https://vk.com/rightech)

README.md

@@ -0,0 +1,9 @@
+# Rightech IoT Examples
+
+## MQTT
+ - [Examples](./mqtt/)
+
+## Handlers
+
+ - [Basic examples](./handlers/basic)
+ - [Parse LoRa payloads](./handlers/lora)

examples/README.md

@@ -0,0 +1,11 @@
+const events = require('@ric/handler/events');
+
+/**
+ * Generate event if value more than 20
+ * @param {number} value some
+ */
+function process(value) {
+  if (value > 20) {
+    events.gen('something-happened', { message: 'Do somethig!', value });
+  }
+}

examples/handlers/basic/events.js

@@ -0,0 +1,13 @@
+const history = require('@ric/handler/history');
+
+/**
+ * Makes the sum of last 10 x'es
+ * @param {number} x first
+ */
+function process(x) {
+  const sum = history.get(['x'], 10)
+    .map(({ x }) => Number(x))
+    .reduce((acc, val) => acc + val, 0);
+
+  return { sum };
+}

examples/handlers/basic/history.js

@@ -0,0 +1,9 @@
+/**
+ * Makes the sum of two numbers
+ * @param {number} a first
+ * @param {number} b second
+ */
+function process(a, b) {
+  const sum = a + b;
+  return { sum };
+}

examples/handlers/basic/sum.js

@@ -0,0 +1,59 @@
+const { Buffer } = require('buffer');
+
+/**
+ * possible binary number payload parsers
+ *
+ * @param {number} int8 signed 8-bit integer
+ * @param {number} int16be signed 16-bit big-endian integer
+ * @param {number} int16le signed 16-bit little-endian integer
+ * @param {number} int32be signed 32-bit big-endian integer
+ * @param {number} int32le signed 32-bit little-endian integer
+ * 
+ * @param {number} uint8 unsigned 8-bit integer
+ * @param {number} uint16be unsigned 16-bit big-endian integer
+ * @param {number} uint16le unsigned 16-bit little-endian integer
+ * @param {number} uint32be unsigned 32-bit big-endian integer
+ * @param {number} uint32le unsigned 32-bit little-endian integer
+ * 
+ * @param {number} float32be 32-bit big-endian float
+ * @param {number} float32le 32-bit little-endian float
+ * @param {number} double64be 64-bit big-endian double
+ * @param {number} double64le 64-bit little-endian double
+ */
+function process(
+  int8,
+  int16be,
+  int16le,
+  int32be,
+  int32le,
+
+  uint8,
+  uint16be,
+  uint16le,
+  uint32be,
+  uint32le,
+
+  float32be,
+  float32le,
+  double64be,
+  double64le,
+) {
+  return {
+    int8   : Buffer.from(int8).readInt8(),
+    int16be: Buffer.from(int16be).readInt16BE(),
+    int16le: Buffer.from(int16le).readInt16LE(),
+    int32be: Buffer.from(int32be).readInt32BE(),
+    int32le: Buffer.from(int32le).readInt32BE(),
+
+    uint8   : Buffer.from(uint8).readUInt8(),
+    uint16be: Buffer.from(uint16be).readUInt16BE(),
+    uint16le: Buffer.from(uint16le).readUInt16LE(),
+    uint32be: Buffer.from(uint32be).readUInt32BE(),
+    uint32le: Buffer.from(uint32le).readUInt32BE(),
+
+    float32be : Buffer.from(float32be).readFloatBE(),
+    float32le : Buffer.from(float32le).readFloatLE(),
+    double64be: Buffer.from(double64be).readDoubleBE(),
+    double64le: Buffer.from(double64le).readDoubleLE(),
+  };
+}

examples/handlers/binary/numbers.js

@@ -0,0 +1,42 @@
+const { Buffer } = require('buffer');
+
+/**
+ * Parse Vega SI-11 (Вега СИ-11) Payload
+ *   https://en.iotvega.com/product/si11
+ * From LoRa Server project
+ *   https://www.loraserver.io/
+ * 
+ * @param {string} loraData raw
+ */
+function process(loraData) {
+  const buffer = Buffer.from(loraData, 'base64');
+  const bytes = [...buffer];
+
+  let offset = 0;
+  const event = bytes[offset++];
+  const battery = bytes[offset++];
+  offset++; // skip config byte
+
+  let eventin = -1;
+  if (event === 2) {
+    eventin = bytes[offset++];
+  }
+  let devtime = buffer.readInt32LE(offset); offset += 4;
+  devtime = devtime * 1000;
+  let temp;
+  if (event === 1) {
+    temp = bytes[offset++];
+  }
+
+  const in1 = buffer.readInt32LE(offset);  offset += 4;
+  const in2 = buffer.readInt32LE(offset);  offset += 4;
+  const in3 = buffer.readInt32LE(offset);  offset += 4;
+  const in4 = buffer.readInt32LE(offset);  offset += 4;
+
+  return { event, battery, temp, eventin, devtime, in1, in2, in3, in4};
+}
+
+
+/** 
+ @test loraData 'AWMMgHV1WJwAAAAAAAAAAAAAAAAAAAAA'
+*/

examples/handlers/lora/vega-si11.js

@@ -0,0 +1,34 @@
+const { Buffer } = require('buffer');
+
+function bit(value, bit) {
+  return ((value) & (1 << bit)) !== 0;
+}
+
+/**
+ * Parse Vega TD-11 (Вега ТД-11) Payload
+ *   https://en.iotvega.com/product/td11
+ * From LoRa Server project
+ *   https://www.loraserver.io/
+ * 
+ * Sample model for this example:
+ *   https://github.com/Rightech/ric-examples/blob/master/.ric-models/mqtt-loraserver-td11.ric-model.json
+ * 
+ * @param {string} loraData raw
+ */
+function process(loraData) {
+  const bytes = [...Buffer.from(loraData, 'base64')];
+  const [, b1, , b3, b4, b5, b6] = bytes;
+
+  const temp = ((b4 << 8) | b3) / 10;
+  const security = bit(b6, 0);
+  const tamper = bit(b6, 1);
+  const hall1 = bit(b6, 2);
+  const hall2 = bit(b6, 3);
+
+  return { battery: b1, temp, security, tamper, hall1, hall2 };
+}
+
+
+/** 
+ @test loraData 'AWIIIQEADw=='
+*/

examples/handlers/lora/vega-td11.js

@@ -0,0 +1,19 @@
+declare module "@ric/handler/reject" {
+  function reject(): void;
+  export = reject;
+}
+
+declare module "@ric/handler/split" {
+  interface Split<T> { };
+  function split<T>(packets: T[]): T;
+  export = split;
+}
+
+declare module "@ric/handler/events" {
+  export function gen<T>(name: string, payload?: T): void;
+}
+
+declare module "@ric/handler/history" {
+  export function get<T extends string>(params: Array<T>, count?: number): { [K in T]: number | string | boolean }[];
+  export function last<T extends string>(params: Array<T>): { [K in T]: number | string | boolean };
+}