Skip to main content

前端数据

前端传递一个单一的 hass 对象。这个对象包含了最新的状态，允许你发送命令回服务器，并提供格式化实体状态的辅助功能。

每当状态发生变化时，都会创建一个新的变化对象。所以你可以通过进行严格的相等性检查轻松看出是否有变化：

const changed = newVal !== oldVal;

为了查看 hass 对象中可用的数据，访问你喜欢的浏览器中的 HomeAssistant 前端并打开浏览器的开发者工具。在元素面板中，选择 <home-assistant> 元素，或任何其他具有 hass 属性的元素，然后在控制台面板中运行以下命令：

$0.hass

这种读取 hass 对象的方法仅应作为参考。为了在你的代码中与 hass 进行交互，确保它被正确传递给你的代码。

数据​

hass.states​

一个包含 Home Assistant 中所有实体状态的对象。键是 entity_id，值是状态对象。

{
  "sun.sun": {
    "entity_id": "sun.sun",
    "state": "above_horizon",
    "attributes": {
      "next_dawn": "2018-08-18T05:39:19+00:00",
      "next_dusk": "2018-08-17T18:28:52+00:00",
      "next_midnight": "2018-08-18T00:03:51+00:00",
      "next_noon": "2018-08-18T12:03:58+00:00",
      "next_rising": "2018-08-18T06:00:33+00:00",
      "next_setting": "2018-08-17T18:07:37+00:00",
      "elevation": 60.74,
      "azimuth": 297.69,
      "friendly_name": "太阳"
    },
    "last_changed": "2018-08-17T13:46:59.083836+00:00",
    "last_updated": "2018-08-17T13:49:30.378101+00:00",
    "context": {
      "id": "74c2b3b429c844f18e59669e4b41ec6f",
      "user_id": null
    },
  },
  "light.ceiling_lights": {
    "entity_id": "light.ceiling_lights",
    "state": "on",
    "attributes": {
      "min_mireds": 153,
      "max_mireds": 500,
      "brightness": 180,
      "color_temp": 380,
      "hs_color": [
        56,
        86
      ],
      "rgb_color": [
        255,
        240,
        35
      ],
      "xy_color": [
        0.459,
        0.496
      ],
      "white_value": 200,
      "friendly_name": "天花板灯",
      "supported_features": 151
    },
    "last_changed": "2018-08-17T13:46:59.129248+00:00",
    "last_updated": "2018-08-17T13:46:59.129248+00:00",
    "context": {
      "id": "2c6bbbbb66a84a9dae097b6ed6c93383",
      "user_id": null
    },
  }
}

hass.user​

已登录用户。

{
  "id": "758186e6a1854ee2896efbd593cb542c",
  "name": "Paulus",
  "is_owner": true,
  "is_admin": true,
  "credentials": [
    {
      "auth_provider_type": "homeassistant",
      "auth_provider_id": null
    }
  ]
}

方法​

所有以 call 开头的方法都是异步方法。这意味着它们将返回一个 Promise，该 Promise 将以调用的结果解析。

hass.callService(domain, service, data)​

在后台调用一个服务操作。

hass.callService('light', 'turn_on', {
  entity_id: 'light.kitchen'
});

hass.callWS(message)​

在后台调用 WebSocket 命令。

this.hass.callWS({
  type: 'config/auth/create',
  name: 'Paulus',
}).then(userResponse =>
  console.log("创建用户", userResponse.user.id));

hass.callApi(method, path, data)​

在 Home Assistant 服务器上调用 API。例如，如果你想通过向 /api/hassio/backups 发出 GET 请求来获取所有 Home Assistant 备份：

hass.callApi('get', 'hassio/backups')
  .then(backups => console.log('接收到的备份！', backups));

如果需要传递数据，传递第三个参数：

hass.callApi('delete', 'notify.html5', { subscription: 'abcdefgh' });
info

我们正在逐步淘汰 API 调用，并将一切迁移到 hass.callWS(message) 调用。

实体状态格式化​

这些方法允许你格式化实体的状态和属性。值将使用用户个人资料设置（语言、数字格式、日期格式、时区）和计量单位进行本地化。

hass.formatEntityState(stateObj, state)​

格式化实体的状态。你需要传递实体状态对象。

hass.formatEntityState(hass.states["light.my_light"]); // "开启"

你可以使用第二个可选参数强制状态值。

hass.formatEntityState(hass.states["light.my_light"], 'off'); // "关闭"

hass.formatEntityAttributeValue(stateObj, attribute, value)​

格式化实体的属性值。你需要传递实体状态对象和属性名称。

hass.formatEntityAttributeValue(hass.states["climate.thermostat"], "current_temperature"); // "20.5 °C"

你可以使用第三个可选参数强制状态值。

hass.formatEntityAttributeValue(hass.states["climate.thermostat"], "current_temperature", 18); // "18 °C"

hass.formatEntityAttributeName(stateObj, attribute)​

格式化实体的属性名称。你需要传递实体状态对象和属性名称。

hass.formatEntityAttributeName(hass.states["climate.thermostat"], "current_temperature"); // "当前温度"