Rightech IoT Core

https://rightech.io/en/developers/
Admin
Rightech IoT Core is an IoT platform that enables device connectivity across multiple protocols,...
Tokens:33,404
Snippets:558
Trust Score:7.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install MicroK8s

Source: https://rightech.io/en/developers/trial/helm

Installs MicroK8s using snap. Ensure Kubernetes version 1.30+ is met.

```bash
snap install microk8s --classic
```

--------------------------------

### Rightech Platform Configuration Example

Source: https://rightech.io/en/developers/trial/helm

Example `values.yaml` file for configuring the Rightech platform. Key parameters include admin password, ingress host, and MQTT port exposure.

```yaml
initWith:
  adminPassword: PleaseChange2026
 
ingress:
  host: localhost
  tls:
    enabled: false
 
inlets:
  mqtt:
    expose:
      type: nodePort
      nodePort: 31883

```

--------------------------------

### WebSocket Connection URL Example

Source: https://rightech.io/en/developers/examples/websocket

Example of a full WebSocket URL for connecting a device to the platform, including the object identifier.

```text
ws://ws.dev.rightech.io/api/v1/objects/ws_lamp/connect
```

--------------------------------

### Install Rightech IoT Core Platform

Source: https://rightech.io/en/developers/trial/helm

Installs or updates the Rightech IoT Core trial using Helm. Customize admin password and ingress host as needed. Ensure to change the default password for production.

```bash
microk8s helm upgrade --install rightech oci://ghcr.io/rightech/charts/trial \
  --namespace rightech --create-namespace  \
  --set initWith.adminPassword=PleaseChange2026 \
  --set ingress.host=localhost
```

--------------------------------

### API Link Example

Source: https://rightech.io/en/developers/intro

This example shows how to construct an API link to display an entity's state in JSON format. Use this to access entity data via the RESTful API.

```text
GET dev.rightech.io/api/v1/:store/:id
```

--------------------------------

### GET /api/v1/objects

Source: https://rightech.io/en/developers/http/objects

Retrieves a list of all project objects.

```APIDOC
## GET /api/v1/objects

### Description
Retrieves a list of all project objects.

### Method
GET

### Endpoint
/api/v1/objects

### Response
#### Success Response (200)
- **objects** (array) - Array of all project objects
```

--------------------------------

### Get a list of entities

Source: https://rightech.io/en/developers/http/base

Use GET /api/v1/:store to retrieve a list of entities. Supports parameters like offset, limit, only, and date range filtering.

```http
GET /api/v1/:store
```

```http
/api/v1/:store?offset=20000
```

```http
/api/v1/:store?offset=3&limit=2
```

```http
/api/v1/:store?limit=2\&only=name,description
```

```http
/api/v1/:store?from=1640131200000&to=1640563200000
```

```http
/api/v1/:store?from=2021-12-22T00:00&to=2021-12-27T00:00
```

--------------------------------

### POST /api/v1/objects/:id/automatons/:automaton/start

Source: https://rightech.io/en/developers/http/logic

Starts the execution of an automation script on a specific object.

```APIDOC
## POST /api/v1/objects/:id/automatons/:automaton/start

### Description
Starts an automation script on a specific object.

### Method
POST

### Endpoint
/api/v1/objects/:id/automatons/:automaton/start

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the object
- **automaton** (string) - Required - The identifier of the automaton
```

--------------------------------

### POST /api/v1/objects/:id/handlers/:handler/start

Source: https://rightech.io/en/developers/http/handlers

Starts the execution of a handler on a specific object.

```APIDOC
## POST /api/v1/objects/:id/handlers/:handler/start

### Description
Starts the execution of a handler on a specific object.

### Method
POST

### Endpoint
/api/v1/objects/:id/handlers/:handler/start

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the object.
- **handler** (string) - Required - The identifier of the handler.

### Response
#### Success Response (200)
- **Object** - Information about the status of the request execution
```

--------------------------------

### GET /api/v1/handlers

Source: https://rightech.io/en/developers/http/handlers

Retrieves a list of all project handlers.

```APIDOC
## GET /api/v1/handlers

### Description
Retrieves a list of all project handlers.

### Method
GET

### Endpoint
/api/v1/handlers

### Response
#### Success Response (200)
- **Array** - List of all project handlers
```

--------------------------------

### GET /api/v1/geofences

Source: https://rightech.io/en/developers/http/geofences

Retrieve a list of all geofences in the project.

```APIDOC
## GET /api/v1/geofences

### Description
Retrieve a list of all geofences in the project.

### Method
GET

### Endpoint
/api/v1/geofences

### Response
#### Success Response (200)
- **Array** - List of all geofences in the project.
```

--------------------------------

### LwM2M DISCOVER Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to get a list of all supported objects, instances, and resources. The response is in CoRE Link Format.

```json
{
  "method": "GET",
  "path": "/1",
  "data": "discover"
}
```

--------------------------------

### Send Command with Parameters

Source: https://rightech.io/en/developers/http/objects

For commands that require parameters, include them in the JSON body of the POST request. The example shows sending a 'state_param'.

```json
{
  "state_param": 42
}
```

--------------------------------

### GET /api/v1/labels

Source: https://rightech.io/en/developers/http/labels

Retrieve a list of all project labels.

```APIDOC
## GET /api/v1/labels

### Description
Retrieve a list of all project labels.

### Method
GET

### Endpoint
/api/v1/labels

### Response
#### Success Response (200)
- **Array** - List of all project labels
```

--------------------------------

### Wialon IPS Command Examples

Source: https://rightech.io/en/developers/examples/wialon

Commands for controlling vehicle units. Note that the platform automatically appends the required \r\n (0D0A) sequence when sending these commands.

```text
#can_closealldoor#\r\n
```

```text
#can_openalldoor#\r\n
```

```text
#can_blinkerflasing#\r\n
```

```text
#can_horn#\r\n
```

```text
#can_hornblinker#\r\n
```

```text
#can_stopengine#\r\n
```

```text
#can_startengine#\r\n
```

--------------------------------

### GET /api/v1/automatons

Source: https://rightech.io/en/developers/http/logic

Retrieves a list of all automation scenarios in the project.

```APIDOC
## GET /api/v1/automatons

### Description
Retrieves an array of all automation scripts in the project.

### Method
GET

### Endpoint
/api/v1/automatons

### Response
#### Success Response (200)
- **identifier** (string) - Unique identifier
- **name** (string) - Name of the automaton
- **description** (string) - Description of the automaton
- **selected models** (array) - List of associated models
```

--------------------------------

### Webhook Request Body Format

Source: https://rightech.io/en/developers/handlers/webhooks

Example JSON structure for parameters passed to a webhook.

```json
{ "param1": 123, "param2": "text" }
```

--------------------------------

### GET /api/v1/:store

Source: https://rightech.io/en/developers/http/base

Retrieves a list of entities for a specified store type with optional filtering and pagination.

```APIDOC
## GET /api/v1/:store

### Description
Retrieves a list of entities from the specified store. Supports pagination and field filtering.

### Method
GET

### Endpoint
/api/v1/:store

### Parameters
#### Path Parameters
- **store** (string) - Required - The entity type (e.g., models, objects, automatons, handlers, labels, geofences, messages, users, groups, invites, roles, tokens).

#### Query Parameters
- **offset** (integer) - Optional - Number of entities to skip.
- **limit** (integer) - Optional - Maximum number of entities to return (max 10000).
- **only** (string) - Optional - Comma-separated list of fields to include in the response.
- **from** (string/integer) - Optional - Start of time interval (Unix time or ISO 8601).
- **to** (string/integer) - Optional - End of time interval (Unix time or ISO 8601).
- **begin** (string/integer) - Optional - Alternative to from.
- **end** (string/integer) - Optional - Alternative to to.
```

--------------------------------

### GET /api/v1/geofences/:id

Source: https://rightech.io/en/developers/http/geofences

Retrieve detailed information about a specific geofence.

```APIDOC
## GET /api/v1/geofences/:id

### Description
Get information about one geofence.

### Method
GET

### Endpoint
/api/v1/geofences/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the geofence.

### Response
#### Success Response (200)
- **Object** - JSON representation of a geofence.
```

--------------------------------

### GET /api/v1/automatons/:id

Source: https://rightech.io/en/developers/http/logic

Retrieves detailed information about a specific automation scenario.

```APIDOC
## GET /api/v1/automatons/:id

### Description
Retrieves the JSON representation of a specific automation script.

### Method
GET

### Endpoint
/api/v1/automatons/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the automation scenario

### Response
#### Success Response (200)
- **identifier** (string) - Unique identifier
- **name** (string) - Name of the automaton
- **description** (string) - Description of the automaton
- **selected models** (array) - List of associated models
- **states and transitions** (object) - Information about constructed states and transitions
```

--------------------------------

### GET /api/v1/objects/:id

Source: https://rightech.io/en/developers/http/objects

Retrieves information about a specific object by its ID.

```APIDOC
## GET /api/v1/objects/:id

### Description
Retrieves the representation of a specific object.

### Method
GET

### Endpoint
/api/v1/objects/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The object identifier

### Response
#### Success Response (200)
- **object** (object) - Representation of an object in JSON format
```

--------------------------------

### GET /api/v1/handlers/:id

Source: https://rightech.io/en/developers/http/handlers

Retrieves information about a specific handler by its ID.

```APIDOC
## GET /api/v1/handlers/:id

### Description
Retrieves information about a specific handler by its ID.

### Method
GET

### Endpoint
/api/v1/handlers/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the handler.

### Response
#### Success Response (200)
- **Object** - Handler representation in JSON format
```

--------------------------------

### GET /api/v1/:store/:id

Source: https://rightech.io/en/developers/http/base

Retrieves detailed information about a single entity by its unique identifier.

```APIDOC
## GET /api/v1/:store/:id

### Description
Retrieves information on a single entity.

### Method
GET

### Endpoint
/api/v1/:store/:id

### Parameters
#### Path Parameters
- **store** (string) - Required - The entity type.
- **id** (string) - Required - The 12-byte unique identifier of the entity.
```

--------------------------------

### GET /api/v1/objects/:id/packets

Source: https://rightech.io/en/developers/http/objects

Retrieves packet history for an object.

```APIDOC
## GET /api/v1/objects/:id/packets

### Description
Retrieves a list of all packets for an object, optionally filtered by time range.

### Method
GET

### Endpoint
/api/v1/objects/:id/packets

### Parameters
#### Path Parameters
- **id** (string) - Required - The object identifier

#### Query Parameters
- **from** (string) - Optional - Start time (Unix time or ISO 8601)
- **to** (string) - Optional - End time (Unix time or ISO 8601)

### Response
#### Success Response (200)
- **packets** (array) - Array of all packets of an object
```

--------------------------------

### Retrieve a single entity

Source: https://rightech.io/en/developers/http/base

Use GET /api/v1/:store/:id to retrieve information on a single entity.

```http
GET /api/v1/:store/:id
```

--------------------------------

### GET /api/v1/labels/:id

Source: https://rightech.io/en/developers/http/labels

Retrieve information about a specific label by its ID.

```APIDOC
## GET /api/v1/labels/:id

### Description
Retrieve information about a specific label by its ID.

### Method
GET

### Endpoint
/api/v1/labels/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the label.

### Response
#### Success Response (200)
- **Object** - JSON representation of the label
```

--------------------------------

### Get Packet History with ISO 8601

Source: https://rightech.io/en/developers/http/objects

Retrieve packet history for an object within a specified time range using ISO 8601 date-time format.

```http
/api/v1/objects/:id/packets?from=2021-12-22T00:00&to=2021-12-27T00:00
```

--------------------------------

### Edit Existing Handler

Source: https://rightech.io/en/developers/http/handlers

Modify an existing handler by sending a PATCH request with the fields to be updated in the request body. This example shows updating the name and description.

```json
{
  "name": "test-handler-02",
  "description": "Handler for sensor"
}
```

--------------------------------

### JSON Telemetry Data Packet

Source: https://rightech.io/en/developers/models/protocols

Example of a complex JSON payload structure for sending multiple parameters in a single CoAP packet.

```json
{
  "stringKey": "value1",
  "booleanKey": true,
  "doubleKey": 3.1415,
  "longKey": 73,
  "jsonKey": {
    "someNumber": 42,
    "someArray": [1, 2, 3],
    "someNestedObject": {
      "key": "value"
    }
  }
}
```

--------------------------------

### Get Packet History with Unix Time

Source: https://rightech.io/en/developers/http/objects

Retrieve packet history for an object within a specified time range using Unix timestamps (milliseconds since epoch).

```http
/api/v1/objects/:id/packets?from=1640131200000&to=1640563200000
```

--------------------------------

### GET /api/v1/messages/history

Source: https://rightech.io/en/developers/http/messages

Retrieves a list of all messages received in the project. Message history is preserved even if the source object has been deleted.

```APIDOC
## GET /api/v1/messages/history

### Description
Get a list of all messages received in the project. Even if an object has already been deleted, the messages received from it will be stored in the history.

### Method
GET

### Endpoint
/api/v1/messages/history

### Response
#### Success Response (200)
- An array of message objects.
```

--------------------------------

### Enable MicroK8s Add-ons

Source: https://rightech.io/en/developers/trial/helm

Enables the ingress and hostpath-storage add-ons for MicroK8s. Wait for their status to become enabled.

```bash
microk8s enable ingress
```

```bash
microk8s enable hostpath-storage
```

--------------------------------

### Launch Eclipse Wakaama Client for LwM2M

Source: https://rightech.io/en/developers/examples/lwm2m

Use this command to launch the Eclipse Wakaama client for testing LwM2M device connections. Ensure you replace 'test_device' with your actual device identifier.

```bash
./lwm2mclient -4 -h dev.rightech.io -n test_device -c
```

--------------------------------

### Device Connection Configuration

Source: https://rightech.io/en/developers/connect

To connect equipment to the platform, you need to specify the server address (host) and port. This can be done using a configurator program or other methods described in the equipment's instruction manual.

```APIDOC
## Connecting a Device

To connect your equipment to the Rightech platform, you need to configure the server address and port.

### Server Details
*   **Address**: `dev.rightech.io` (IP Address: `89.108.112.87`)
*   **Port**: Varies based on the equipment's protocol.
```

--------------------------------

### Send Test Data via MQTT

Source: https://rightech.io/en/developers/trial/helm

Publishes a temperature reading to the 'base/state/temperature' topic using `mosquitto_pub`. Requires the platform to be accessible at `localhost` on port 31883.

```bash
mosquitto_pub -d \
    --host localhost \
    --port 31883 \
    -i mqtt-rightech-rooj8r \
    -t base/state/temperature \
    -m 36.6
```

--------------------------------

### POST /api/v1/objects/:id/geofences/:geofence/start

Source: https://rightech.io/en/developers/http/geofences

Add a geofence to an object.

```APIDOC
## POST /api/v1/objects/:id/geofences/:geofence/start

### Description
Add a geofence to an object.

### Method
POST

### Endpoint
/api/v1/objects/:id/geofences/:geofence/start

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the object.
- **geofence** (string) - Required - The identifier of the geofence.

### Response
#### Success Response (200)
- **Object** - Information about the status of the request execution.
```

--------------------------------

### Create a new model

Source: https://rightech.io/en/developers/http/models

Sends a POST request to create a new model with required base and name fields.

```json
{
  "base": "mqtt",
  "name": "test-model-01",
  "description": "Model of microcontroller"
}
```

--------------------------------

### POST /api/v1/automatons

Source: https://rightech.io/en/developers/http/logic

Creates a new automation scenario.

```APIDOC
## POST /api/v1/automatons

### Description
Creates a new automation scenario.

### Method
POST

### Endpoint
/api/v1/automatons

### Parameters
#### Request Body
- **model** (string) - Required - Model identifier
- **name** (string) - Required - Name of the new automation scenario
- **description** (string) - Optional - Description of the automaton

### Request Example
{
  "model": "<model-id>",
  "name": "test-automaton-01",
  "description": "Automaton for sensor"
}
```

--------------------------------

### LwM2M OBSERVE Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to set up observation for a resource. The response from the client must be in SenML JSON format.

```json
{
  "method": "GET",
  "path": "/3/0/9",
  "data": "observe"
}
```

--------------------------------

### POST /api/v1/objects

Source: https://rightech.io/en/developers/http/objects

Creates a new object in the system.

```APIDOC
## POST /api/v1/objects

### Description
Creates a new object by providing its representation in JSON format.

### Method
POST

### Endpoint
/api/v1/objects

### Parameters
#### Request Body
- **model** (string) - Required - Model identifier
- **id** (string) - Required - Object identifier for device connection
- **name** (string) - Required - Name of the new object

### Request Example
{
  "model": "<model-id>",
  "id": "test-object-01",
  "name": "test-object-01"
}

### Response
#### Success Response (200)
- **object** (object) - Representation of the created object
```

--------------------------------

### POST /api/v1/:store

Source: https://rightech.io/en/developers/http/base

Creates a new entity within the specified store.

```APIDOC
## POST /api/v1/:store

### Description
Adds a new entity to the platform.

### Method
POST

### Endpoint
/api/v1/:store

### Parameters
#### Path Parameters
- **store** (string) - Required - The entity type.

### Request Example
{
  "some_field": "SOME_VALUE",
  "other_field": "OTHER_VALUE"
}
```

--------------------------------

### Store and Average Last 10 Parameters

Source: https://rightech.io/en/developers/handlers/create

Stores the last ten received parameters in local storage, calculating their count, sum, and average. Initializes local store with default values if empty.

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

--------------------------------

### Create an entity

Source: https://rightech.io/en/developers/http/base

Use POST /api/v1/:store to create a new entity. Requires a JSON payload with entity-specific fields.

```http
POST /api/v1/:store
```

```json
{
  "some_field": "SOME_VALUE",
  "other_field": "OTHER_VALUE"
}
```

--------------------------------

### LwM2M EXECUTE Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to initiate the execution of actions on a resource.

```json
{
  "method": "POST",
  "path": "/31024/10/2"
}
```

--------------------------------

### Create Automation Scenario

Source: https://rightech.io/en/developers/http/logic

Use this endpoint to create a new automation scenario. The request body requires the model identifier and the name of the scenario. An optional description can also be provided.

```json
{
  "model": "<model-id>",
  "name": "test-automaton-01",
  "description": "Automaton for sensor"
}
```

--------------------------------

### POST /api/v1/handlers

Source: https://rightech.io/en/developers/http/handlers

Creates a new handler.

```APIDOC
## POST /api/v1/handlers

### Description
Creates a new handler using the provided JSON representation.

### Method
POST

### Endpoint
/api/v1/handlers

### Parameters
#### Request Body
- **name** (string) - Required - Name of the new handler.
- **userCode** (string) - Required - The handler code.

### Request Example
{
  "name": "test-handler-01",
  "userCode": "function process(a, b) { return { sum: a + b } }"
}

### Response
#### Success Response (200)
- **Object** - Handler representation in JSON format
```

--------------------------------

### POST /api/v1/objects/:id/commands/:command

Source: https://rightech.io/en/developers/http/objects

Sends a command to a device.

```APIDOC
## POST /api/v1/objects/:id/commands/:command

### Description
Sends a command to a specific object. Parameters can be included in the body if required.

### Method
POST

### Endpoint
/api/v1/objects/:id/commands/:command

### Parameters
#### Path Parameters
- **id** (string) - Required - The object identifier
- **command** (string) - Required - The command identifier

### Request Example
{
  "state_param": 42
}

### Response
#### Success Response (200)
- **response** (object) - Response from the device in JSON format
```

--------------------------------

### Import and Use Sum Function

Source: https://rightech.io/en/developers/handlers/create

Imports a 'sum' function from a remote JavaScript module and uses it to calculate the sum of two input parameters.

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

--------------------------------

### Lamp Control Command JSON Format

Source: https://rightech.io/en/developers/examples/websocket

These JSON formats are used to send commands to control the lamp on the device.

```json
{
  "device": "lamp",
  "data": 1
}
```

```json
{
  "device": "lamp",
  "data": 0
}
```

--------------------------------

### Import and Use GPS Library

Source: https://rightech.io/en/developers/handlers/create

Imports the 'gps' library from Skypack to parse NMEA formatted strings and extract latitude and longitude coordinates.

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

--------------------------------

### LwM2M CREATE Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to create an instance of an object. The data must be submitted in SenML JSON format.

```json
{
  "method": "POST",
  "path": "/31024",
  "data": [
    {
      "bn": "/31024/",
      "n": "11/1",
      "v": 8
    }
  ]
}
```

--------------------------------

### Create a New Object

Source: https://rightech.io/en/developers/http/objects

Use this endpoint to create a new object. The request body must include the object's model, ID, and name.

```json
{
  "model": "<model-id>",
  "id": "test-object-01",
  "name": "test-object-01"
}
```

--------------------------------

### Create New Label - POST /api/v1/labels

Source: https://rightech.io/en/developers/http/labels

Use this endpoint to create a new label. The request body must include the 'name' field, and optionally 'value', 'link', and 'description'.

```json
{
  "name": "👩 Emma White",
  "value": "381763724",
  "link": "https://vk.com/emma",
  "description": "Card ID 381763724"
}
```

--------------------------------

### WebSocket Connection URL

Source: https://rightech.io/en/developers/models/protocols

URL format for connecting to a device via WebSocket. Replace ':id' with the object ID.

```url
ws://ws.dev.rightech.io:80/api/v1/objects/:id/connect
```

--------------------------------

### POST /api/v1/labels

Source: https://rightech.io/en/developers/http/labels

Create a new label by providing its representation in JSON format.

```APIDOC
## POST /api/v1/labels

### Description
Create a new label.

### Method
POST

### Endpoint
/api/v1/labels

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new label.
- **value** (string) - Optional - The value associated with the label.
- **link** (string) - Optional - A URL link associated with the label.
- **description** (string) - Optional - A description of the label.

### Request Example
{
  "name": "👩 Emma White",
  "value": "381763724",
  "link": "https://vk.com/emma",
  "description": "Card ID 381763724"
}

### Response
#### Success Response (200)
- **Object** - JSON representation of the created label
```

--------------------------------

### Configure WebSocket Authentication Header

Source: https://rightech.io/en/developers/objects/create

Use this HTTP Basic Authentication header when connecting via WebSocket to secure the device connection.

```http
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=''
```

--------------------------------

### Define Message Content with Dynamic Parameters

Source: https://rightech.io/en/developers/logic/create

Use the double curly brace syntax to inject current object parameter values into message content.

```json
{
  "event": "Good conditions",
  "temperature": "{{object.state.temperature}}"
}
```

--------------------------------

### Send Command to Object

Source: https://rightech.io/en/developers/http/objects

Send a command to a specific object using its ID. The command identifier is part of the URL.

```http
POST /api/v1/objects/:id/commands/:command
```

--------------------------------

### WebSocket Connection

Source: https://rightech.io/en/developers/models/protocols

Connect to a device via WebSocket for real-time data communication.

```APIDOC
## GET /api/v1/objects/:id/connect

### Description
Establishes a WebSocket connection to a specific device object.

### Method
GET

### Endpoint
ws://ws.dev.rightech.io:80/api/v1/objects/:id/connect

### Parameters
#### Path Parameters
- **id** (string) - Required - The object ID to connect to.

### Request Example
{
  "stringKey": "value1",
  "booleanKey": true,
  "jsonKey": {
    "someNumber": 42
  }
}
```

--------------------------------

### Basic Models API

Source: https://rightech.io/en/developers/http/models

Endpoints for retrieving basic and all available models.

```APIDOC
## GET /api/v1/models/base

### Description
Retrieves a list of base models available for use.

### Method
GET

### Endpoint
/api/v1/models/base

### Response
#### Success Response (200)
Array of base models available for use.
```

```APIDOC
## GET /api/v1/models

### Description
Retrieves a list of all models in the project.

### Method
GET

### Endpoint
/api/v1/models

### Response
#### Success Response (200)
Array of all models in the project.
```

--------------------------------

### POST /api/v1/objects/:id/automatons/:automaton/emit

Source: https://rightech.io/en/developers/http/logic

Sends an event to a running automation script.

```APIDOC
## POST /api/v1/objects/:id/automatons/:automaton/emit

### Description
Sends an event to an automation script running on an object.

### Method
POST

### Endpoint
/api/v1/objects/:id/automatons/:automaton/emit

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the object
- **automaton** (string) - Required - The identifier of the automaton

#### Request Body
- **event** (string) - Required - The event identifier to generate

### Request Example
{
  "event": "<event-id>"
}
```

--------------------------------

### Referencing Device Parameters in Messages

Source: https://rightech.io/en/developers/logic/multi

Use this syntax to include current parameter values from different devices within message text in your scenarios. Ensure the object number and parameter ID are correct.

```json
{
  "event": "currentstate",
  "temperature1": "{{objects[0].state.temperature}}",
  "temperature2": "{{objects[1].state.temperature}}",
  "speed": "{{objects[2].state.speed}}"
}
```

--------------------------------

### Create a new node

Source: https://rightech.io/en/developers/http/models

Sends a POST request to create a new node within a specific model.

```json
{
  "id": "floorTemperature",
  "type": "argument",
  "name": "Floor Temperature",
  "unit": "temperature-celsius",
  "dataType": "number"
}
```

--------------------------------

### LwM2M WRITE Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to update values. The data to be written must be in Plain Text format.

```json
{
  "method": "PUT",
  "path": "/31024/10/1",
  "data": 254
}
```

--------------------------------

### Create New Handler

Source: https://rightech.io/en/developers/http/handlers

Use this endpoint to create a new handler. The request body must include the handler's name and its JavaScript code.

```json
{
  "name": "test-handler-01",
  "userCode": "function process(a, b) { return { sum: a + b } }"
}
```

--------------------------------

### LwM2M Actions

Source: https://rightech.io/en/developers/models/protocols

Standard LwM2M operations performed via CoAP commands.

```APIDOC
## LwM2M Operations

### Description
Perform LwM2M operations such as Read, Write, Execute, Create, Delete, Write-Attributes, Discover, and Observation management.

### Method
GET, PUT, POST, DELETE

### Endpoint
/ (Path varies based on Object/Instance/Resource)

### Parameters
#### Request Body
- **method** (string) - Required - The CoAP method (GET, PUT, POST, DELETE).
- **path** (string) - Required - The LwM2M path (e.g., /31024/10/1).
- **data** (any) - Optional - Payload data required for specific commands like Write or Create.

### Request Example
{
  "method": "PUT",
  "path": "/31024/10/1",
  "data": 254
}
```

--------------------------------

### Protocol Limitations

Source: https://rightech.io/en/developers/connect

Information on specific limitations for certain protocols, including MQTT and LwM2M.

```APIDOC
## Limitations

### MQTT
*   Persistent Session is not supported.
*   Message Expiry Interval is not supported.
*   Extended authorization (SCRAM-SHA-1, GS2-KRB5, etc.) is not supported.
*   Password must be in UTF-8 format.
*   Some properties added in MQTT v5 are not used.

### LwM2M
*   Bootstrap server is not supported.
*   DTLS is not supported.
```

--------------------------------

### LwM2M READ Server Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to read data from a single resource, object instance, or object. The response is expected in SenML JSON format.

```json
{
  "method": "GET",
  "path": "/1"
}
```

--------------------------------

### Add Geofence to Object

Source: https://rightech.io/en/developers/http/geofences

Associates a geofence with a specific object. The ':id' refers to the object's identifier, and ':geofence' is the geofence's identifier.

```http
POST /api/v1/objects/:id/geofences/:geofence/start
```

--------------------------------

### Verify Rightech Pod Status

Source: https://rightech.io/en/developers/trial/helm

Checks the status of all pods in the 'rightech' namespace to ensure they are running. This is a crucial step before accessing the platform.

```bash
microk8s kubectl -n rightech get pods
```

--------------------------------

### LoRaWAN Packet Forwarder Configuration

Source: https://rightech.io/en/developers/examples/lorawan

Configuration settings for the LoRaWAN modem's Packet Forwarder to connect to the Rightech platform. Ensure these settings are applied and saved.

```json
{
  "gateway_conf": {
    "gateway_ID": "<Gateway EUI>",
    "server_address": "dev.rightech.io",
    "serv_port_up": 1700,
    "serv_port_down": 1700
  }
}
```

--------------------------------

### Supported Data Transfer Protocols

Source: https://rightech.io/en/developers/connect

The Rightech platform supports various data transfer protocols for IoT device communication. Below is a list of implemented protocols. If a required protocol is not listed, contact info@rightech.io.

```APIDOC
## Data Transfer Protocols

The following protocols are supported for data exchange between IoT devices and the Rightech platform:

| Protocol Name             | Address to Connect                               | Notes                                                                   |
| --------------------------- | ------------------------------------------------ | ----------------------------------------------------------------------- |
| **MQTT/MQTTS**              | `dev.rightech.io:1883/TCP`, `dev.rightech.io:8883/TLS` | MQTT Specification (MQTT v5.0 and below)                                |
| **MQTT over WebSocket**     | `ws-mqtt.dev.rightech.io:443/WSS`                | MQTT Specification                                                      |
| **Wialon IPS**              | `dev.rightech.io:20332/TCP`                      | Wialon IPS v1.1 and 2.0                                                 |
| **Wialon Combine**          | `dev.rightech.io:20333/TCP`                      | Wialon Combine                                                          |
| **Galileosky**              | `dev.rightech.io:20268/TCP`                      | Manual                                                                  |
| **Omni E-Scooters**         | `dev.rightech.io:20510/TCP`                      | Manufacturer Website                                                    |
| **Queclink**                | `dev.rightech.io:20514/TCP`                      | Queclink                                                                |
| **Teltonika**               | `dev.rightech.io:21451/TCP`                      | Example, Teltonika Wiki                                                 |
| **AutoFon 8x**              | `dev.rightech.io:20518/TCP`                      | AutoFon                                                                 |
| **AutoFon 7x**              | `dev.rightech.io:20519/TCP`                      | AutoFon                                                                 |
| **AutoFon 5-6**             | `dev.rightech.io:20520/TCP`                      | AutoFon                                                                 |
| **AutoFon Micro-Beacon**    | `dev.rightech.io:20521/TCP`                      | AutoFon Micro-Beacon                                                    |
| **OKAI**                    | `dev.rightech.io:20516/TCP`                      | OKAI                                                                    |
| **Concox**                  | `dev.rightech.io:20515/TCP`                      | Concox                                                                  |
| **Arnavi3**                 | `dev.rightech.io:20512/TCP`                      | Arnavi Guide                                                            |
| **Navtelecom (Flex)**       | `dev.rightech.io:21400/TCP`                      | Example, Navtelecom v6.1                                                |
| **LoRaWAN**                 | `dev.rightech.io:1700`                           | LoRaWAN 1.1 (EU868 / RU864)                                             |
| **CoAP**                    | `dev.rightech.io:5683/UDP`                       | RFC7252                                                                 |
| **LwM2M**                   | `dev.rightech.io:5683/UDP`                       | OMA LwM2M 1.2                                                           |
| **WebSocket**               | `ws://ws.dev.rightech.io`, `wss://ws.dev.rightech.io` | RFC6455                                                                 |

**Available Upon Request:**
*   KNX
*   Modbus TCP/RTU
*   Wialon Retranslator
*   Starline
*   Omni Lock
*   Queclink
*   Gate8000
*   DiWo
*   Mta6
```

--------------------------------

### Control Teltonika Relay States

Source: https://rightech.io/en/developers/models/protocols

Use the setdigout command with a positional key to toggle relay states. Use '?' to ignore a relay and '1' or '0' to set its state.

```text
setdigout ??1?
```

```text
setdigout ??0?
```

```text
setdigout ?1
```

```text
setdigout 11
```

--------------------------------

### Sensor Data JSON Format

Source: https://rightech.io/en/developers/examples/websocket

This JSON format is used by the sensor to transmit room illumination data and lamp status.

```json
{
  "luminosity": 134,
  "lamp": true
}
```

--------------------------------

### Change node

Source: https://rightech.io/en/developers/http/models

Sends a PATCH request to update specific fields of an existing node.

```json
{
  "name": "Floor Temperature (in Fahrenheits)",
  "unit": "temperature-fahrenheit"
}
```

--------------------------------

### POST /api/v1/messages

Source: https://rightech.io/en/developers/http/messages

Creates a new message. The message content and details must be provided in the request body in JSON format.

```APIDOC
## POST /api/v1/messages

### Description
Create new message. In the body of the request to create a new message, specify its representation in the JSON format.

### Method
POST

### Endpoint
/api/v1/messages

### Parameters
#### Request Body
- **id** (string) - Required - Identifier of the object for which the message will be sent.
- **importance** (string) - Required - Message importance level. Possible values: `information`, `important`, `critical`.
- **text** (string) - Required - Content of the notification.

### Request Example
```json
{
  "id": "<object-id>",
  "importance": "important",
  "text": "test-message-01"
}
```

### Response
#### Success Response (200)
- Information about the status of request execution.

#### Error Response
- Recaptcha requires verification.
- Protected by reCAPTCHA.
```

--------------------------------

### Parse Navtelecom FLEX Parameters

Source: https://rightech.io/en/developers/models/protocols

Access specific bits of a parameter by appending the bit index to the tag identifier.

```text
tag_139.2
```

--------------------------------

### Model Management API

Source: https://rightech.io/en/developers/http/models

Endpoints for retrieving, creating, updating, and deleting models.

```APIDOC
## GET /api/v1/models/:id

### Description
Retrieves information about a specific model.

### Method
GET

### Endpoint
/api/v1/models/:id

### Response
#### Success Response (200)
Representation of a model in JSON format.
```

```APIDOC
## POST /api/v1/models

### Description
Creates a new model.

### Method
POST

### Endpoint
/api/v1/models

### Parameters
#### Request Body
- **base** (string) - Required - Base model identifier.
- **name** (string) - Required - Name of the new model.
- **description** (string) - Optional - Description of the new model.

### Request Example
```json
{
  "base": "mqtt",
  "name": "test-model-01",
  "description": "Model of microcontroller"
}
```

### Response
#### Success Response (200)
Representation of the created model in JSON format.
```

```APIDOC
## PATCH /api/v1/models/:id

### Description
Modifies an existing model.

### Method
PATCH

### Endpoint
/api/v1/models/:id

### Parameters
#### Request Body
- **name** (string) - Optional - The new name for the model.
- **description** (string) - Optional - The new description for the model.

### Request Example
```json
{
  "name": "test-model-02",
  "description": "Model of sensor"
}
```

### Response
#### Success Response (200)
Representation of the model in JSON format taking into account changed fields.
```

```APIDOC
## DELETE /api/v1/models/:id

### Description
Deletes a specific model.

### Method
DELETE

### Endpoint
/api/v1/models/:id

### Response
#### Success Response (200)
JSON representation of a remote model.
```

--------------------------------

### Create New Message

Source: https://rightech.io/en/developers/http/messages

Use this endpoint to send a new message. Specify the object ID, importance level, and message text in the JSON body. The response will contain information about the request execution status.

```json
{
  "id": "<object-id>",
  "importance": "important",
  "text": "test-message-01"
}
```

--------------------------------

### Change the model

Source: https://rightech.io/en/developers/http/models

Sends a PATCH request to update specific fields of an existing model.

```json
{
  "name": "test-model-02",
  "description": "Model of sensor"
}
```

--------------------------------

### Authenticate with Bearer Token

Source: https://rightech.io/en/developers/http/auth

Include the access token in the Authorization header for all HTTP requests.

```HTTP
Authorization: Bearer <ACCESS_TOKEN>
```

--------------------------------

### Query Teltonika Device IO

Source: https://rightech.io/en/developers/models/protocols

Retrieve available inputs and outputs to determine the number of relays.

```text
getio
```

--------------------------------

### CoAP Telemetry URL Structure

Source: https://rightech.io/en/developers/models/protocols

The base URL format for sending telemetry data via POST requests to the Rightech platform.

```text
coap://dev.rightech.io:5683/api/v1/objects/:id/:path
```

```text
coap://dev.rightech.io:5683/api/v1/objects/:id/base/state/humidity
```

```text
coap://dev.rightech.io:5683/api/v1/objects/:id/state/telemetry1
```

--------------------------------

### POST /api/v1/objects/:id/geofences/:geofence/stop

Source: https://rightech.io/en/developers/http/geofences

Delete a geofence from an object.

```APIDOC
## POST /api/v1/objects/:id/geofences/:geofence/stop

### Description
Delete a geofence from an object.

### Method
POST

### Endpoint
/api/v1/objects/:id/geofences/:geofence/stop

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the object.
- **geofence** (string) - Required - The identifier of the geofence.

### Response
#### Success Response (200)
- **Object** - Information about the status of the request execution.
```

--------------------------------

### Send Event to Running Automation Script

Source: https://rightech.io/en/developers/http/logic

Send an event to a running automation script on a specific object. The request body must include the event identifier. This is analogous to pressing a 'Generate event' button within the automaton's interface.

```json
{
  "event": "<event-id>"
}
```

--------------------------------

### Set Teltonika Relay Duration

Source: https://rightech.io/en/developers/models/protocols

Specify relay state and duration in seconds positionally, using 0 for relays that should not change state.

```text
setdigout ????1 0 0 0 0 0 5
```

--------------------------------

### Authorization Header for WebSocket Connection

Source: https://rightech.io/en/developers/examples/websocket

This header is required for WebSocket connections when login and password authentication are specified.

```http
Authorization: Basic bXlfbG9naW46bXlfcGFzc3dvcmQ=
```

--------------------------------

### PATCH /api/v1/geofences/:id

Source: https://rightech.io/en/developers/http/geofences

Modify an existing geofence.

```APIDOC
## PATCH /api/v1/geofences/:id

### Description
Modify an existing geofence by specifying the fields to update.

### Method
PATCH

### Endpoint
/api/v1/geofences/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the geofence.

### Request Example
{
  "color": "#fc0fc0"
}

### Response
#### Success Response (200)
- **Object** - JSON representation of a geofence including modified fields.
```

--------------------------------

### Event Generation with Ric Object

Source: https://rightech.io/en/developers/handlers/create

This handler generates a 'model-event-01' event when the sum of two input parameters exceeds 25. It utilizes the 'ric.events.gen' method for event creation.

```javascript
/**
 * @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 };
}
```

--------------------------------

### Processing Coordinates from Webhook

Source: https://rightech.io/en/developers/handlers/webhooks

Extracting latitude and longitude from a webhook request body and returning them as output parameters.

```javascript
function process() {
  const body = ric.webhook?.request?.body ??? {};
  const lat = +(body.lat || 0);
  const lon = +(body.lon || 0);
  return { lat, lon }
}
```

--------------------------------

### LwM2M WRITE-Attributes Action

Source: https://rightech.io/en/developers/models/protocols

Use this CoAP method to change attribute values for a resource.

```json
{
  "method": "PUT",
  "path": "/31024/10/1?pmin=5&pmax=60"
}
```

--------------------------------

### Change Automation Scenario

Source: https://rightech.io/en/developers/http/logic

Modify an existing automation scenario by sending a PATCH request with the fields to be updated in the request body. The scenario is identified by its ID.

```json
{
  "name": "test-automaton-02"
}
```

--------------------------------

### DELETE Request for Entity Deletion

Source: https://rightech.io/en/developers/http/base

Send a DELETE request to this endpoint to remove an entity. No message body is required for deletion. The `:store` parameter must be a supported entity type.

```http
DELETE /api/v1/:store/:id
```

--------------------------------

### Update Geofence Color

Source: https://rightech.io/en/developers/http/geofences

Use this endpoint to change the display color of an existing geofence. Specify the new color in hexadecimal format.

```json
{
  "color": "#fc0fc0"
}
```

--------------------------------

### Conditional Logic for Null Parameters

Source: https://rightech.io/en/developers/handlers/create

Use this snippet to handle cases where input parameters might be null. It prevents calculations when a required parameter is missing.

```javascript
if (speed === null) {
  return {};
}
```
Tokens:
Raw