@ray-js/api 1.7.79 → 1.7.80

package/lib/PlayNetKit-1.3.30.js

@@ -6,6 +6,22 @@ const factory = createFactory('PlayNetKit');
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { analysisMatterQRCode } = playnet;
+ *
+ * analysisMatterQRCode({
+ *   qrCodeStr: 'MT:YNJV40800006IB5A010',
+ *   success: (result) => {
+ *     console.log('analysisMatterQRCode success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('analysisMatterQRCode fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const analysisMatterQRCode = factory('analysisMatterQRCode', {
   namespace: 'playnet'
@@ -13,6 +29,24 @@ export const analysisMatterQRCode = factory('analysisMatterQRCode', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { autoConnectToAp } = playnet;
+ *
+ * autoConnectToAp({
+ *   ssidPrefix: 'SmartLife-',
+ *   ssid: 'SmartLife-XXXX',
+ *   pwd: '',
+ *   success: () => {
+ *     console.log('autoConnectToAp success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('autoConnectToAp fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const autoConnectToAp = factory('autoConnectToAp', {
   namespace: 'playnet'
@@ -20,6 +54,24 @@ export const autoConnectToAp = factory('autoConnectToAp', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { autoConnectToApWithSSIDPrefix } = playnet;
+ *
+ * autoConnectToApWithSSIDPrefix({
+ *   ssidPrefix: 'SmartLife-',
+ *   ssid: 'SmartLife-XXXX',
+ *   pwd: '',
+ *   success: () => {
+ *     console.log('autoConnectToApWithSSIDPrefix success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('autoConnectToApWithSSIDPrefix fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const autoConnectToApWithSSIDPrefix = factory('autoConnectToApWithSSIDPrefix', {
   namespace: 'playnet'
@@ -27,6 +79,39 @@ export const autoConnectToApWithSSIDPrefix = factory('autoConnectToApWithSSIDPre
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { checkBleWifiDeviceReset } = playnet;
+ *
+ * checkBleWifiDeviceReset({
+ *   link: 'https://example.com/short',
+ *   packet: {
+ *     id: 'example',
+ *     name: 'example',
+ *     providerName: 'example',
+ *     data: 'example',
+ *     configType: 'example',
+ *     productId: 'example',
+ *     uuid: 'example',
+ *     mac: 'example',
+ *     address: 'example',
+ *     deviceType: 0,
+ *     isbind: false,
+ *     flag: 0,
+ *     isShare: false,
+ *     rssi: 0,
+ *     pidHexString: 'example',
+ *   },
+ *   success: (result) => {
+ *     console.log('checkBleWifiDeviceReset success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('checkBleWifiDeviceReset fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const checkBleWifiDeviceReset = factory('checkBleWifiDeviceReset', {
   namespace: 'playnet'
@@ -34,6 +119,23 @@ export const checkBleWifiDeviceReset = factory('checkBleWifiDeviceReset', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { connectMatterDevice } = playnet;
+ *
+ * connectMatterDevice({
+ *   spaceId: 0,
+ *   timeout: 60,
+ *   success: (result) => {
+ *     console.log('connectMatterDevice success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('connectMatterDevice fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const connectMatterDevice = factory('connectMatterDevice', {
   namespace: 'playnet'
@@ -41,6 +143,24 @@ export const connectMatterDevice = factory('connectMatterDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { connectWifi } = playnet;
+ *
+ * connectWifi({
+ *   ssidPrefix: 'SmartLife-',
+ *   ssid: 'SmartLife-XXXX',
+ *   pwd: '',
+ *   success: () => {
+ *     console.log('connectWifi success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('connectWifi fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const connectWifi = factory('connectWifi', {
   namespace: 'playnet'
@@ -48,6 +168,24 @@ export const connectWifi = factory('connectWifi', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { continueMatterCommission } = playnet;
+ *
+ * continueMatterCommission({
+ *   activeModel: 'MATTER',
+ *   relationId: 0,
+ *   spaceId: 0,
+ *   success: () => {
+ *     console.log('continueMatterCommission success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('continueMatterCommission fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const continueMatterCommission = factory('continueMatterCommission', {
   namespace: 'playnet'
@@ -55,6 +193,21 @@ export const continueMatterCommission = factory('continueMatterCommission', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { getCurrentWifiSSID } = playnet;
+ *
+ * getCurrentWifiSSID({
+ *   success: (result) => {
+ *     console.log('getCurrentWifiSSID success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getCurrentWifiSSID fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getCurrentWifiSSID = factory('getCurrentWifiSSID', {
   namespace: 'playnet'
@@ -62,6 +215,21 @@ export const getCurrentWifiSSID = factory('getCurrentWifiSSID', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { getDeviceSecurityConfigs } = playnet;
+ *
+ * getDeviceSecurityConfigs({
+ *   success: (result) => {
+ *     console.log('getDeviceSecurityConfigs success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getDeviceSecurityConfigs fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getDeviceSecurityConfigs = factory('getDeviceSecurityConfigs', {
   namespace: 'playnet'
@@ -69,6 +237,22 @@ export const getDeviceSecurityConfigs = factory('getDeviceSecurityConfigs', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { getPairConfigToken } = playnet;
+ *
+ * getPairConfigToken({
+ *   gid: 0,
+ *   success: (result) => {
+ *     console.log('getPairConfigToken success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('getPairConfigToken fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const getPairConfigToken = factory('getPairConfigToken', {
   namespace: 'playnet'
@@ -76,6 +260,21 @@ export const getPairConfigToken = factory('getPairConfigToken', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { hasBlePermission } = playnet;
+ *
+ * hasBlePermission({
+ *   success: (result) => {
+ *     console.log('hasBlePermission success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('hasBlePermission fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const hasBlePermission = factory('hasBlePermission', {
   namespace: 'playnet'
@@ -83,6 +282,21 @@ export const hasBlePermission = factory('hasBlePermission', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { hasLocalNetworkPermission } = playnet;
+ *
+ * hasLocalNetworkPermission({
+ *   success: (result) => {
+ *     console.log('hasLocalNetworkPermission success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('hasLocalNetworkPermission fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const hasLocalNetworkPermission = factory('hasLocalNetworkPermission', {
   namespace: 'playnet'
@@ -90,6 +304,22 @@ export const hasLocalNetworkPermission = factory('hasLocalNetworkPermission', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { hasPermission } = playnet;
+ *
+ * hasPermission({
+ *   permission: 'WIFI',
+ *   success: (result) => {
+ *     console.log('hasPermission success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('hasPermission fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const hasPermission = factory('hasPermission', {
   namespace: 'playnet'
@@ -97,6 +327,23 @@ export const hasPermission = factory('hasPermission', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { isExistInCurrentAccount } = playnet;
+ *
+ * isExistInCurrentAccount({
+ *   uuid: 'example',
+ *   mac: 'AA:BB:CC:DD:EE:FF',
+ *   success: (result) => {
+ *     console.log('isExistInCurrentAccount success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('isExistInCurrentAccount fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const isExistInCurrentAccount = factory('isExistInCurrentAccount', {
   namespace: 'playnet'
@@ -104,6 +351,21 @@ export const isExistInCurrentAccount = factory('isExistInCurrentAccount', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { isSystemPopupInAutoConnectAp } = playnet;
+ *
+ * isSystemPopupInAutoConnectAp({
+ *   success: (result) => {
+ *     console.log('isSystemPopupInAutoConnectAp success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('isSystemPopupInAutoConnectAp fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const isSystemPopupInAutoConnectAp = factory('isSystemPopupInAutoConnectAp', {
   namespace: 'playnet'
@@ -111,6 +373,16 @@ export const isSystemPopupInAutoConnectAp = factory('isSystemPopupInAutoConnectA
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offActivateIntermediateState } = playnet;
+ *
+ * offActivateIntermediateState((result) => {
+ *   console.log('offActivateIntermediateState', result);
+ * });
+ * ```
  */
 export const offActivateIntermediateState = factory('offActivateIntermediateState', {
   namespace: 'playnet'
@@ -118,6 +390,16 @@ export const offActivateIntermediateState = factory('offActivateIntermediateStat
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offBLEScanDevice } = playnet;
+ *
+ * offBLEScanDevice((result) => {
+ *   console.log('offBLEScanDevice', result);
+ * });
+ * ```
  */
 export const offBLEScanDevice = factory('offBLEScanDevice', {
   namespace: 'playnet'
@@ -125,6 +407,16 @@ export const offBLEScanDevice = factory('offBLEScanDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offBLEScanDeviceWithUUID } = playnet;
+ *
+ * offBLEScanDeviceWithUUID((result) => {
+ *   console.log('offBLEScanDeviceWithUUID', result);
+ * });
+ * ```
  */
 export const offBLEScanDeviceWithUUID = factory('offBLEScanDeviceWithUUID', {
   namespace: 'playnet'
@@ -132,6 +424,16 @@ export const offBLEScanDeviceWithUUID = factory('offBLEScanDeviceWithUUID', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offBLEStateChange } = playnet;
+ *
+ * offBLEStateChange((result) => {
+ *   console.log('offBLEStateChange', result);
+ * });
+ * ```
  */
 export const offBLEStateChange = factory('offBLEStateChange', {
   namespace: 'playnet'
@@ -139,6 +441,16 @@ export const offBLEStateChange = factory('offBLEStateChange', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offBlePermissionChange } = playnet;
+ *
+ * offBlePermissionChange((result) => {
+ *   console.log('offBlePermissionChange', result);
+ * });
+ * ```
  */
 export const offBlePermissionChange = factory('offBlePermissionChange', {
   namespace: 'playnet'
@@ -146,6 +458,16 @@ export const offBlePermissionChange = factory('offBlePermissionChange', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offDeviceActivateResult } = playnet;
+ *
+ * offDeviceActivateResult((result) => {
+ *   console.log('offDeviceActivateResult', result);
+ * });
+ * ```
  */
 export const offDeviceActivateResult = factory('offDeviceActivateResult', {
   namespace: 'playnet'
@@ -153,6 +475,16 @@ export const offDeviceActivateResult = factory('offDeviceActivateResult', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offReceiveActivatorState } = playnet;
+ *
+ * offReceiveActivatorState((result) => {
+ *   console.log('offReceiveActivatorState', result);
+ * });
+ * ```
  */
 export const offReceiveActivatorState = factory('offReceiveActivatorState', {
   namespace: 'playnet'
@@ -160,6 +492,16 @@ export const offReceiveActivatorState = factory('offReceiveActivatorState', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offScanDeviceInfo } = playnet;
+ *
+ * offScanDeviceInfo((result) => {
+ *   console.log('offScanDeviceInfo', result);
+ * });
+ * ```
  */
 export const offScanDeviceInfo = factory('offScanDeviceInfo', {
   namespace: 'playnet'
@@ -167,6 +509,16 @@ export const offScanDeviceInfo = factory('offScanDeviceInfo', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offWifiStateChange } = playnet;
+ *
+ * offWifiStateChange((result) => {
+ *   console.log('offWifiStateChange', result);
+ * });
+ * ```
  */
 export const offWifiStateChange = factory('offWifiStateChange', {
   namespace: 'playnet'
@@ -174,6 +526,16 @@ export const offWifiStateChange = factory('offWifiStateChange', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { offlocalNetWorkPermissionChange } = playnet;
+ *
+ * offlocalNetWorkPermissionChange((result) => {
+ *   console.log('offlocalNetWorkPermissionChange', result);
+ * });
+ * ```
  */
 export const offlocalNetWorkPermissionChange = factory('offlocalNetWorkPermissionChange', {
   namespace: 'playnet'
@@ -181,6 +543,16 @@ export const offlocalNetWorkPermissionChange = factory('offlocalNetWorkPermissio
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onActivateIntermediateState } = playnet;
+ *
+ * onActivateIntermediateState((result) => {
+ *   console.log('onActivateIntermediateState', result);
+ * });
+ * ```
  */
 export const onActivateIntermediateState = factory('onActivateIntermediateState', {
   namespace: 'playnet'
@@ -188,6 +560,16 @@ export const onActivateIntermediateState = factory('onActivateIntermediateState'
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onBLEScanDevice } = playnet;
+ *
+ * onBLEScanDevice((result) => {
+ *   console.log('onBLEScanDevice', result);
+ * });
+ * ```
  */
 export const onBLEScanDevice = factory('onBLEScanDevice', {
   namespace: 'playnet'
@@ -195,6 +577,16 @@ export const onBLEScanDevice = factory('onBLEScanDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onBLEScanDeviceWithUUID } = playnet;
+ *
+ * onBLEScanDeviceWithUUID((result) => {
+ *   console.log('onBLEScanDeviceWithUUID', result);
+ * });
+ * ```
  */
 export const onBLEScanDeviceWithUUID = factory('onBLEScanDeviceWithUUID', {
   namespace: 'playnet'
@@ -202,6 +594,16 @@ export const onBLEScanDeviceWithUUID = factory('onBLEScanDeviceWithUUID', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onBLEStateChange } = playnet;
+ *
+ * onBLEStateChange((result) => {
+ *   console.log('onBLEStateChange', result);
+ * });
+ * ```
  */
 export const onBLEStateChange = factory('onBLEStateChange', {
   namespace: 'playnet'
@@ -209,6 +611,16 @@ export const onBLEStateChange = factory('onBLEStateChange', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onBlePermissionChange } = playnet;
+ *
+ * onBlePermissionChange((result) => {
+ *   console.log('onBlePermissionChange', result);
+ * });
+ * ```
  */
 export const onBlePermissionChange = factory('onBlePermissionChange', {
   namespace: 'playnet'
@@ -216,6 +628,16 @@ export const onBlePermissionChange = factory('onBlePermissionChange', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onDeviceActivateResult } = playnet;
+ *
+ * onDeviceActivateResult((result) => {
+ *   console.log('onDeviceActivateResult', result);
+ * });
+ * ```
  */
 export const onDeviceActivateResult = factory('onDeviceActivateResult', {
   namespace: 'playnet'
@@ -223,6 +645,16 @@ export const onDeviceActivateResult = factory('onDeviceActivateResult', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onReceiveActivatorState } = playnet;
+ *
+ * onReceiveActivatorState((result) => {
+ *   console.log('onReceiveActivatorState', result);
+ * });
+ * ```
  */
 export const onReceiveActivatorState = factory('onReceiveActivatorState', {
   namespace: 'playnet'
@@ -230,6 +662,16 @@ export const onReceiveActivatorState = factory('onReceiveActivatorState', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onScanDeviceInfo } = playnet;
+ *
+ * onScanDeviceInfo((result) => {
+ *   console.log('onScanDeviceInfo', result);
+ * });
+ * ```
  */
 export const onScanDeviceInfo = factory('onScanDeviceInfo', {
   namespace: 'playnet'
@@ -237,6 +679,16 @@ export const onScanDeviceInfo = factory('onScanDeviceInfo', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onWifiStateChange } = playnet;
+ *
+ * onWifiStateChange((result) => {
+ *   console.log('onWifiStateChange', result);
+ * });
+ * ```
  */
 export const onWifiStateChange = factory('onWifiStateChange', {
   namespace: 'playnet'
@@ -244,6 +696,16 @@ export const onWifiStateChange = factory('onWifiStateChange', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { onlocalNetWorkPermissionChange } = playnet;
+ *
+ * onlocalNetWorkPermissionChange((result) => {
+ *   console.log('onlocalNetWorkPermissionChange', result);
+ * });
+ * ```
  */
 export const onlocalNetWorkPermissionChange = factory('onlocalNetWorkPermissionChange', {
   namespace: 'playnet'
@@ -251,6 +713,40 @@ export const onlocalNetWorkPermissionChange = factory('onlocalNetWorkPermissionC
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { queryDeviceConfigState } = playnet;
+ *
+ * queryDeviceConfigState({
+ *   homeId: 0,
+ *   pairType: 'AP',
+ *   bleWifiPairParams: {
+ *     id: 'example',
+ *     name: 'example',
+ *     providerName: 'example',
+ *     data: 'example',
+ *     configType: 'example',
+ *     productId: 'example',
+ *     uuid: 'example',
+ *     mac: 'AA:BB:CC:DD:EE:FF',
+ *     address: 'example',
+ *     deviceType: 0,
+ *     isbind: false,
+ *     flag: 0,
+ *     isShare: false,
+ *     rssi: 0,
+ *     pidHexString: 'example',
+ *   },
+ *   success: (result) => {
+ *     console.log('queryDeviceConfigState success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('queryDeviceConfigState fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const queryDeviceConfigState = factory('queryDeviceConfigState', {
   namespace: 'playnet'
@@ -258,6 +754,25 @@ export const queryDeviceConfigState = factory('queryDeviceConfigState', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { queryWifiListByNormalChannel } = playnet;
+ *
+ * queryWifiListByNormalChannel({
+ *   timeout: 30,
+ *   size: 10,
+ *   pairType: 'AP',
+ *   uuid: 'example',
+ *   success: (result) => {
+ *     console.log('queryWifiListByNormalChannel success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('queryWifiListByNormalChannel fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const queryWifiListByNormalChannel = factory('queryWifiListByNormalChannel', {
   namespace: 'playnet'
@@ -265,6 +780,21 @@ export const queryWifiListByNormalChannel = factory('queryWifiListByNormalChanne
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { releaseP2PWifi } = playnet;
+ *
+ * releaseP2PWifi({
+ *   success: () => {
+ *     console.log('releaseP2PWifi success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('releaseP2PWifi fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const releaseP2PWifi = factory('releaseP2PWifi', {
   namespace: 'playnet'
@@ -272,6 +802,24 @@ export const releaseP2PWifi = factory('releaseP2PWifi', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { removeApConfigration } = playnet;
+ *
+ * removeApConfigration({
+ *   ssidPrefix: 'SmartLife-',
+ *   ssid: 'SmartLife-XXXX',
+ *   pwd: '',
+ *   success: () => {
+ *     console.log('removeApConfigration success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('removeApConfigration fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const removeApConfigration = factory('removeApConfigration', {
   namespace: 'playnet'
@@ -279,6 +827,22 @@ export const removeApConfigration = factory('removeApConfigration', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { requestPermission } = playnet;
+ *
+ * requestPermission({
+ *   permission: 'WIFI',
+ *   success: () => {
+ *     console.log('requestPermission success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('requestPermission fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const requestPermission = factory('requestPermission', {
   namespace: 'playnet'
@@ -286,6 +850,21 @@ export const requestPermission = factory('requestPermission', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { requestWifiList } = playnet;
+ *
+ * requestWifiList({
+ *   success: (result) => {
+ *     console.log('requestWifiList success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('requestWifiList fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const requestWifiList = factory('requestWifiList', {
   namespace: 'playnet'
@@ -293,6 +872,23 @@ export const requestWifiList = factory('requestWifiList', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { resetDevice } = playnet;
+ *
+ * resetDevice({
+ *   uuid: 'example',
+ *   pairType: 'WIFI_BLE',
+ *   success: (result) => {
+ *     console.log('resetDevice success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('resetDevice fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const resetDevice = factory('resetDevice', {
   namespace: 'playnet'
@@ -300,6 +896,23 @@ export const resetDevice = factory('resetDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { resetDeviceActivatedStatus } = playnet;
+ *
+ * resetDeviceActivatedStatus({
+ *   tokens: ['example_token'],
+ *   scanDeviceBeans: [],
+ *   success: () => {
+ *     console.log('resetDeviceActivatedStatus success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('resetDeviceActivatedStatus fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const resetDeviceActivatedStatus = factory('resetDeviceActivatedStatus', {
   namespace: 'playnet'
@@ -307,6 +920,21 @@ export const resetDeviceActivatedStatus = factory('resetDeviceActivatedStatus',
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { resumeActive } = playnet;
+ *
+ * resumeActive({
+ *   success: () => {
+ *     console.log('resumeActive success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('resumeActive fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const resumeActive = factory('resumeActive', {
   namespace: 'playnet'
@@ -314,6 +942,39 @@ export const resumeActive = factory('resumeActive', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startActivator } = playnet;
+ *
+ * startActivator({
+ *   pairType: 'AP',
+ *   apActivatorParams: {
+ *     ssid: 'MyWifi',
+ *     pwd: 'password',
+ *     token: 'example_token',
+ *     timeout: 100,
+ *     isRecovery: false,
+ *     securityConfig: 'example',
+ *   },
+ *   bleWifiActivatorParams: {
+ *     uuid: 'example',
+ *     ssid: 'MyWifi',
+ *     pwd: 'password',
+ *     token: 'example_token',
+ *     timeout: 100,
+ *     isRecovery: false,
+ *     phase1Timeout: 60000,
+ *   },
+ *   success: (result) => {
+ *     console.log('startActivator success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('startActivator fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startActivator = factory('startActivator', {
   namespace: 'playnet'
@@ -321,6 +982,58 @@ export const startActivator = factory('startActivator', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startActivatorNormal } = playnet;
+ *
+ * startActivatorNormal({
+ *   pairType: 'AP',
+ *   apParams: {
+ *     homeId: 0,
+ *     ssid: 'MyWifi',
+ *     pwd: 'password',
+ *     token: 'example_token',
+ *     timeout: 100,
+ *     isRecovery: false,
+ *     securityConfig: 'example',
+ *   },
+ *   bleWifiParams: {
+ *     homeId: 0,
+ *     uuid: 'example',
+ *     ssid: 'MyWifi',
+ *     pwd: 'password',
+ *     token: 'example_token',
+ *     timeout: 100,
+ *     isRecovery: false,
+ *     phase1Timeout: 60000,
+ *     bleWifiPacket: {
+ *       id: 'example',
+ *       name: 'example',
+ *       providerName: 'example',
+ *       data: 'example',
+ *       configType: 'example',
+ *       productId: 'example',
+ *       uuid: 'example',
+ *       mac: 'AA:BB:CC:DD:EE:FF',
+ *       address: 'example',
+ *       deviceType: 0,
+ *       isbind: false,
+ *       flag: 0,
+ *       isShare: false,
+ *       rssi: 0,
+ *       pidHexString: 'example',
+ *     },
+ *   },
+ *   success: (result) => {
+ *     console.log('startActivatorNormal success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('startActivatorNormal fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startActivatorNormal = factory('startActivatorNormal', {
   namespace: 'playnet'
@@ -328,6 +1041,23 @@ export const startActivatorNormal = factory('startActivatorNormal', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startBLEScanDevice } = playnet;
+ *
+ * startBLEScanDevice({
+ *   timeout: 30,
+ *   scanType: 'NORMAL',
+ *   success: () => {
+ *     console.log('startBLEScanDevice success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('startBLEScanDevice fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startBLEScanDevice = factory('startBLEScanDevice', {
   namespace: 'playnet'
@@ -335,6 +1065,23 @@ export const startBLEScanDevice = factory('startBLEScanDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startBLEScanDeviceWithUUID } = playnet;
+ *
+ * startBLEScanDeviceWithUUID({
+ *   scanType: 'NORMAL',
+ *   uuid: 'example',
+ *   success: () => {
+ *     console.log('startBLEScanDeviceWithUUID success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('startBLEScanDeviceWithUUID fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startBLEScanDeviceWithUUID = factory('startBLEScanDeviceWithUUID', {
   namespace: 'playnet'
@@ -342,6 +1089,24 @@ export const startBLEScanDeviceWithUUID = factory('startBLEScanDeviceWithUUID',
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startDeviceActivate } = playnet;
+ *
+ * startDeviceActivate({
+ *   activeModel: 'EZ',
+ *   relationId: 0,
+ *   spaceId: 0,
+ *   success: () => {
+ *     console.log('startDeviceActivate success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('startDeviceActivate fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startDeviceActivate = factory('startDeviceActivate', {
   namespace: 'playnet'
@@ -349,6 +1114,40 @@ export const startDeviceActivate = factory('startDeviceActivate', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startResetBleWifiDevice } = playnet;
+ *
+ * startResetBleWifiDevice({
+ *   packet: {
+ *     id: 'example',
+ *     name: 'example',
+ *     providerName: 'example',
+ *     data: 'example',
+ *     configType: 'example',
+ *     productId: 'example',
+ *     uuid: 'example',
+ *     mac: 'AA:BB:CC:DD:EE:FF',
+ *     address: 'example',
+ *     deviceType: 0,
+ *     isbind: false,
+ *     flag: 0,
+ *     isShare: false,
+ *     rssi: 0,
+ *     pidHexString: 'example',
+ *   },
+ *   encryptedAuthKey: 'example',
+ *   random: 'example',
+ *   success: (result) => {
+ *     console.log('startResetBleWifiDevice success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('startResetBleWifiDevice fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startResetBleWifiDevice = factory('startResetBleWifiDevice', {
   namespace: 'playnet'
@@ -356,6 +1155,23 @@ export const startResetBleWifiDevice = factory('startResetBleWifiDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startScanDevice } = playnet;
+ *
+ * startScanDevice({
+ *   scanType: ['EZ', 'AP'],
+ *   spaceId: 0,
+ *   success: () => {
+ *     console.log('startScanDevice success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('startScanDevice fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startScanDevice = factory('startScanDevice', {
   namespace: 'playnet'
@@ -363,6 +1179,21 @@ export const startScanDevice = factory('startScanDevice', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { startScanWifi } = playnet;
+ *
+ * startScanWifi({
+ *   success: (result) => {
+ *     console.log('startScanWifi success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('startScanWifi fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const startScanWifi = factory('startScanWifi', {
   namespace: 'playnet'
@@ -370,6 +1201,23 @@ export const startScanWifi = factory('startScanWifi', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { stopActivator } = playnet;
+ *
+ * stopActivator({
+ *   uuid: 'example',
+ *   pairType: 'WIFI_BLE',
+ *   success: () => {
+ *     console.log('stopActivator success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('stopActivator fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const stopActivator = factory('stopActivator', {
   namespace: 'playnet'
@@ -377,6 +1225,23 @@ export const stopActivator = factory('stopActivator', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { stopActivatorNormal } = playnet;
+ *
+ * stopActivatorNormal({
+ *   uuid: 'example',
+ *   pairType: 'WIFI_BLE',
+ *   success: () => {
+ *     console.log('stopActivatorNormal success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('stopActivatorNormal fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const stopActivatorNormal = factory('stopActivatorNormal', {
   namespace: 'playnet'
@@ -384,6 +1249,21 @@ export const stopActivatorNormal = factory('stopActivatorNormal', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { stopBLEScan } = playnet;
+ *
+ * stopBLEScan({
+ *   success: () => {
+ *     console.log('stopBLEScan success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('stopBLEScan fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const stopBLEScan = factory('stopBLEScan', {
   namespace: 'playnet'
@@ -391,6 +1271,21 @@ export const stopBLEScan = factory('stopBLEScan', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { stopBleScanWithUUID } = playnet;
+ *
+ * stopBleScanWithUUID({
+ *   success: () => {
+ *     console.log('stopBleScanWithUUID success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('stopBleScanWithUUID fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const stopBleScanWithUUID = factory('stopBleScanWithUUID', {
   namespace: 'playnet'
@@ -398,6 +1293,24 @@ export const stopBleScanWithUUID = factory('stopBleScanWithUUID', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { stopDeviceActivate } = playnet;
+ *
+ * stopDeviceActivate({
+ *   activeModel: 'EZ',
+ *   relationId: 0,
+ *   spaceId: 0,
+ *   success: () => {
+ *     console.log('stopDeviceActivate success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('stopDeviceActivate fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const stopDeviceActivate = factory('stopDeviceActivate', {
   namespace: 'playnet'
@@ -405,6 +1318,23 @@ export const stopDeviceActivate = factory('stopDeviceActivate', {
 /**
  * @public
  * @since @ray-js/ray 1.6.31
+ * @example 基础调用
+ * ```tsx
+ * import { playnet } from '@ray-js/ray';
+ *
+ * const { stopScanDevice } = playnet;
+ *
+ * stopScanDevice({
+ *   scanType: ['EZ', 'AP'],
+ *   spaceId: 0,
+ *   success: () => {
+ *     console.log('stopScanDevice success');
+ *   },
+ *   fail: (error) => {
+ *     console.log('stopScanDevice fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const stopScanDevice = factory('stopScanDevice', {
   namespace: 'playnet'