Flutter智能家居控制插件home_assistant的使用

Flutter智能家居控制插件home_assistant的使用

介绍

home_assistant 是一个用于与 Home Assistant API 交互的 Dart 库。通过这个库，你可以在 Dart 或 Flutter 应用中轻松连接到 Home Assistant 实例，获取实体信息，控制设备，并使用 Home Assistant 服务执行各种操作。

功能

• 使用 API 令牌连接到 Home Assistant 实例。
• 验证 Home Assistant API 的状态。
• 获取实体及其状态的信息。
• 控制设备和实体。
• 程序化访问 Home Assistant 服务。

安装

要在项目中使用 home_assistant 插件，首先需要在 pubspec.yaml 文件中添加依赖：

dependencies:
  home_assistant: ^1.0.0 # 请使用 pub.dev 上的最新版本

然后，在 Dart 代码中导入库：

import 'package:home_assistant/home_assistant.dart';

快速入门

以下是一个完整的示例 Demo，展示了如何使用 home_assistant 插件与 Home Assistant 进行交互：

1. 初始化 Home Assistant 实例

// 初始化 Home Assistant 实例
final homeAssistant = HomeAssistant(
  baseUrl: 'https://your-home-assistant-url.com', // 替换为你的 Home Assistant URL
  bearerToken: 'your-api-token', // 替换为你的 API 令牌
);

2. 验证 API 是否正常工作

// 验证 Home Assistant API 是否正常工作
try {
  final isApiWorking = await homeAssistant.verifyApiIsWorking();
  if (isApiWorking) {
    print('Home Assistant API is working.');
  } else {
    print('Home Assistant API is not working.');
  }
} catch (e) {
  print('Error verifying API: $e');
}

3. 获取实体列表

// 获取实体列表
try {
  final entities = await homeAssistant.fetchStates();
  print('Entities: ${entities.map((entity) => entity.entityId).join(', ')}');
} catch (e) {
  print('Error fetching entities: $e');
}

4. 控制设备

4.1 打开开关

// 打开指定的开关
try {
  await homeAssistant.turnOnSwitch('switch.entity_id'); // 替换为你要控制的开关实体 ID
  print('Switch turned on.');
} catch (e) {
  print('Failed to turn on the switch: $e');
}

4.2 关闭开关

// 关闭指定的开关
try {
  await homeAssistant.turnOffSwitch('switch.entity_id'); // 替换为你要控制的开关实体 ID
  print('Switch turned off.');
} catch (e) {
  print('Failed to turn off the switch: $e');
}

4.3 控制灯光

// 打开灯光并设置亮度和色温
try {
  await homeAssistant.executeService(
    "light.bedside_lamp_mercury", // 替换为你要控制的灯光实体 ID
    "turn_on",
    additionalActions: {
      "brightness": 255, // 设置亮度为最大值
      "color_temp": 400, // 设置色温
    },
  );
  print('Light turned on with brightness and color temp set.');
} catch (e) {
  print('Failed to control the light: $e');
}

// 关闭灯光
try {
  await homeAssistant.executeService(
    "light.bedside_lamp_mercury", // 替换为你要控制的灯光实体 ID
    "turn_off",
  );
  print('Light turned off.');
} catch (e) {
  print('Failed to turn off the light: $e');
}

5. 获取配置信息

// 获取 Home Assistant 配置信息
try {
  final config = await homeAssistant.fetchConfig();
  print('Configuration: ${config.toJson()}');
} catch (e) {
  print('Error fetching configuration: $e');
}

6. 获取服务列表

// 获取 Home Assistant 服务列表
try {
  final services = await homeAssistant.fetchServices();
  print('Services: ${services.map((service) => service.domain).join(', ')}');
} catch (e) {
  print('Error fetching services: $e');
}

完整示例代码

以下是一个完整的示例代码，结合了上述所有功能：

import 'package:home_assistant/home_assistant.dart';
import 'package:home_assistant/src/models/configuration.dart';
import 'package:home_assistant/src/models/entity.dart';
import 'package:home_assistant/src/models/service.dart';

void main() async {
  // 初始化 Home Assistant
  final HomeAssistant homeAssistant = HomeAssistant(
    baseUrl: 'https://your-home-assistant-url.com', // 替换为你的 Home Assistant URL
    bearerToken: 'your-api-token', // 替换为你的 API 令牌
  );

  // 验证 API 是否正常工作
  try {
    final isApiWorking = await homeAssistant.verifyApiIsWorking();
    print('The API is working: $isApiWorking');
  } catch (e) {
    print('Error verifying API: $e');
  }

  // 获取 Home Assistant 配置信息
  try {
    final Configuration config = await homeAssistant.fetchConfig();
    print('Configuration: ${config.toJson()}');
  } catch (e) {
    print('Error fetching configuration: $e');
  }

  // 获取实体列表
  try {
    final List<Entity> entities = await homeAssistant.fetchStates();
    print('Entities: ${entities.map((entity) => entity.entityId).join(', ')}');

    // 获取第一个实体的详细信息
    if (entities.isNotEmpty) {
      final Entity entity = await homeAssistant.fetchState(entities.first.entityId);
      print('Entity details: ${entity.toJson()}');
    }
  } catch (e) {
    print('Error fetching entities: $e');
  }

  // 获取服务列表
  try {
    final List<Service> services = await homeAssistant.fetchServices();
    print('Services: ${services.map((service) => service.domain).join(', ')}');
  } catch (e) {
    print('Error fetching services: $e');
  }

  // 控制设备
  try {
    // 打开开关
    await homeAssistant.turnOnSwitch('switch.ceiling_lights_socket_1'); // 替换为你要控制的开关实体 ID
    print('Switch turned on.');

    // 打开灯光并设置亮度和色温
    await homeAssistant.executeService(
      "light.bedside_lamp_mercury", // 替换为你要控制的灯光实体 ID
      "turn_on",
      additionalActions: {
        "brightness": 255, // 设置亮度为最大值
        "color_temp": 400, // 设置色温
      },
    );
    print('Light turned on with brightness and color temp set.');

    // 等待1秒
    await Future.delayed(Duration(seconds: 1));

    // 关闭开关
    await homeAssistant.turnOffSwitch('switch.ceiling_lights_socket_1'); // 替换为你要控制的开关实体 ID
    print('Switch turned off.');

    // 关闭灯光
    await homeAssistant.executeService(
      "light.bedside_lamp_mercury", // 替换为你要控制的灯光实体 ID
      "turn_off",
    );
    print('Light turned off.');
  } catch (e) {
    print('Error controlling devices: $e');
  }
}