---
name: "getDeviceRoomInfo"
mode: "kit"
versionRequirements:
  - { name: "HomeKit", version: "3.0.1" }
  - { name: "@ray-js/ray", version: "1.2.10" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getDeviceRoomInfo

> [VERSION] HomeKit >= 3.0.1 | @ray-js/ray >= 1.2.10

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Get device room information

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | Yes | - | `3.0.1` | Device ID |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `roomId` | `number` | `3.0.3` | Room ID |
| `name` | `string` | `3.0.3` | Room name |

#### fail callback parameters

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

##### fail(params).innerError properties

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


### Examples

#### Demo

```tsx
import { home } from '@ray-js/ray'

home.getDeviceRoomInfo({
  deviceId: "6c2a2eiadnrgt0wd",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```