Gateway Features

This topic describes the gateway service APIs that are used to implement features for your gateway product.

Prerequisites

To use gatewayApi, you must install dependencies first.

Bind and unbind a Bluetooth LE sub-device

Name

bleSubDevRelationUpdate

Description

Binds a Bluetooth Low Energy (LE) device with a gateway and unbinds it from the gateway.

Request parameters

BleNodeInfo

Sample request

import { gatewayApi } from '@tuya/tuya-panel-api';
import { GatewayUtils } from '@tuya/tuya-panel-gateway-sdk';
import { TYSdk } from 'tuya-panel-kit';

const { bleSubDevRelationUpdate } = gatewayApi.relationApi;
const { isBlueSub, getAllDevice, isAddableDevice } = GatewayUtils;

// The list of devices that belong to the home.
const devList = await getAllDevice();

// The list of devices that can be added to the gateway.
const addableDeviceList = devList.filter(subDev =>
  isAddableDevice({
    devInfo: subDev,
    gatewayDevInfo: TYSdk.devInfo,
  })
);

// The Bluetooth LE devices that can be added to the gateway.
const bleDevList = addableDeviceList.filter(device => isBlueSub(device.capability));

// The node information required to combine API methods.
const nodes = bleDevList.map(device => ({ devId: device.devId, uuid: device.uuid }));

/**
 * desc: Binds a Bluetooth LE sub-device.
 */
bleSubDevRelationUpdate(TYSdk.devInfo.sigmeshId, nodes, TYSdk.devInfo.devId)
  .then(response => {
    console.log(response);
  })
  .catch();

/**
 * desc: Unbinds a Bluetooth LE device.
 */
bleSubDevRelationUpdate(TYSdk.devInfo.devId, nodes, null)
  .then(response => {
    console.log(response);
  })
  .catch();

Bind and unbind Bluetooth mesh devices

Name

sigmeshSubDevRelationUpdate

Description

Binds Bluetooth mesh devices with a gateway and unbinds them from the gateway.

Request parameters

Sample request

import { gatewayApi } from '@tuya/tuya-panel-api';
import { GatewayUtils } from '@tuya/tuya-panel-gateway-sdk';
import { TYSdk } from 'tuya-panel-kit';

const { sigmeshSubDevRelationUpdate } = gatewayApi.relationApi;
const { isSigmeshSub, getAllDevice, isAddableDevice } = GatewayUtils;

// The list of devices that belong to the home.
const devList = await getAllDevice();
// The list of devices that can be added to the gateway.
const addableDeviceList = devList.filter(subDev =>
  isAddableDevice({
    devInfo: subDev,
    gatewayDevInfo: TYSdk.devInfo,
  })
);
// The Bluetooth mesh devices that can be added to the gateway.
const sigmeshDevList = addableDeviceList.filter(device => isSigmeshSub(device.capability));

// The node information required to combine API methods.
const nodeIds = sigmeshDevList.map(device => device.nodeId);

// Scans for the Bluetooth mesh devices with `meshId`.
const deviceWithMeshId = sigmeshDevList.find(device => device.meshId !== undefined);

// If no devices are found, the system cannot proceed with subsequent steps.
if (!deviceWithMeshId) return;

/**
 * desc: Binds a Bluetooth mesh device.
 */
sigmeshSubDevRelationUpdate(deviceWithMeshId.meshId, nodeIds, TYSdk.devInfo.devId)
  .then(response => {
    console.log(response);
  })
  .catch();

/**
 * desc: Unbinds a Bluetooth mesh device.
 */
sigmeshSubDevRelationUpdate(TYSdk.devInfo.devId, nodeIds, null)
  .then(response => {
    console.log(response);
  })
  .catch();

Unbind and bind beacon devices

Name

beaconSubDevRelationUpdate

Description

Binds beacon devices with a gateway and unbinds them from the gateway.

Request parameters

BeaconNodeInfo

Sample request

import { gatewayApi } from '@tuya/tuya-panel-api';
import { GatewayUtils } from '@tuya/tuya-panel-gateway-sdk';
import { TYSdk } from 'tuya-panel-kit';

const { beaconSubDevRelationUpdate } = gatewayApi.relationApi;
const { isBeaconSub, getAllDevice, isAddableDevice, transformMac } = GatewayUtils;

// The list of devices that belong to the home.
const devList = await getAllDevice();

// The list of devices that can be added to the gateway.
const addableDeviceList = devList.filter(subDev =>
  isAddableDevice({
    devInfo: subDev,
    gatewayDevInfo: TYSdk.devInfo,
    // Set the value to `true`. Otherwise, the result will not include beacon devices.
    supportBeacon: true,
  })
);

// The list of beacon devices.
const beaconDevList = addableDeviceList.filter(device => isBeaconSub(device.capability));

// The node information required to combine API methods.
const nodeIds = beaconDevList.map(device => ({
  devId: device.devId,
  mac: transformMac(device.mac, true, false),
}));

/**
 * desc: Binds a beacon device.
 */
beaconSubDevRelationUpdate(null, nodeIds, TYSdk.devInfo.devId)
  .then(response => {
    console.log(response);
  })
  .catch();

/**
 * desc: Unbinds a beacon device.
 */
beaconSubDevRelationUpdate(TYSdk.devInfo.devId, nodeIds, null)
  .then(response => {
    console.log(response);
  })
  .catch();