publishDpsWithPipeType - Send DPS control commands over a specified channel

publishDpsWithPipeType(params: Object)

Requires:

DeviceKit≥1.2.6@ray-js/ray≥0.6.23

Platforms:

iOSAndroid

import { device } from '@ray-js/ray';

const { publishDpsWithPipeType } = device;

// Promise usage
try {
  const res = await publishDpsWithPipeType({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Send dps control commands over a specified channel

Parameters

Property	Type	Required	Description
`deviceId`	string	Yes	Device ID
		Yes	dps
`mode`	number	Yes	Delivery channel type 0: LAN 1: Network 2: Auto
`pipelines`	number[]	Yes	Priority of delivery channels LAN = 0, // LAN MQTT = 1, // MQTT HTTP = 2, // Http BLE = 3, // Single Point Bluetooth SIGMesh = 4, // Sig Mesh BLEMesh = 5, // Thing Private Mesh BLEBeacon = 6, // Beacon
		Yes	Reserved flag for delivery logic configuration; can be extended later, for example to deliver sounds or define follow-up actions
`complete`	() => void	No	Completion callback (executed on both success and failure)
		No	Callback on successful API call
`fail`	(params: Object) => void	No	Failure callback

fail callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Examples

import { device } from '@ray-js/ray'

device.publishDpsWithPipeType({
  deviceId: "xx",
  dps: { "xx": {} },
  mode: 1,
  pipelines: [1],
  options: { "xx": {} },
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});