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

## getCurrentHomeInfo

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

> [PLATFORM] iOS, Android

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

### Description

Get current home information

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `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 |
| --- | --- | --- | --- |
| `homeName` | `string` | `3.0.3` | Home name |
| `homeId` | `string` | `3.0.3` | Home ID |
| `longitude` | `string` | `3.0.3` | Longitude |
| `latitude` | `string` | `3.0.3` | Latitude |
| `address` | `string` | `3.0.3` | Detailed address |
| `admin` | `boolean` | `3.0.3` | Is admin true: admin; false: not admin |
| `mode` | `number` | `3.7.8` | Home mode, values from ThingSmartHomeMode |
| `role` | `number` | `3.7.12` | Home role, values from ThingSmartHomeRole |

#### 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.getCurrentHomeInfo({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```