---
name: "getDeviceStatus"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getDeviceStatus - 获取设备状态信息。"
summary: "获取设备状态信息。"
---

## getDeviceStatus

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### 描述

读取设备在线/休眠等综合状态。

### 参数

无


### 返回值

类型: `DeviceStatus`

设备状态对象

##### DeviceStatus

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `type` | `"offline" \| "online" \| "sleep"` | 总状态：在线 / 离线 / 休眠 |
| `connectEnable` | `boolean` | 是否允许用户手动发起连接（如 BLE） |
| `onlineTypes` | `"local" \| "cloud" \| "ble" \| "localMatter" \| "unknown"[]` | 在线通道列表（位语义由平台展开为数组） |
| `sleepPeriod` | `Object` | 休眠窗口（仅 sleep 时） |
| `isWifiActive` | `boolean` | Wi-Fi 模块是否上电工作 |
| `isWifiMatter` | `boolean` | 是否支持为 wifi 走 matter 方案 |

##### DeviceStatus.sleepPeriod 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `start` | `number` | 是 | - | 开始 |
| `end` | `number` | 是 | - | 结束 |


### 示例代码

#### 示例

```ts
import { getDeviceStatus } from '@ray-js/lock-sdk';
const status = getDeviceStatus();
```