集成中一些常用的对象与函数

hass对象

hass对象，代表当前正在运行的HomeAssistant Core实例。通过它，与系统底层逻辑打交道。

• hass

  通过hass对象可以进行执行任务管理与调度。

  • 在协程中调用阻塞函数
  • 在协程中启动一个并行执行的任务

• hass.states对象

  hass.states代表Homeassistant中实体的状态机。可以通过这个对象，设定与管理系统中状态的变化。

  • (async_)set
  • (async_)remove
  • get

• hass.services对象

  hass.services代表HomeAssistant中的服务机制。可以通过这个对象，注册、删除、调用服务。

  • (async_)register
  • (async_)remove
  • (async_)call

  样例：服务注册

• hass.bus对象

  hass.bus代表HomeAssistant中的服务总线。可以通过这个对象，进行事件的监听与触发。

  • (async_)listen
  • (async_)listen_once
  • (async_)fire

  样例：在HomeAssistant启动与停止时执行任务

• hass.data[DOMAIN]

  集成程序可以在hass.data[DOMAIN]中保存全局的信息（类似于全局变量）

  样例：ping集成

辅助函数

• homeassistant.helpers

  homeassistant.helpers中包含了与HomeAssistan有关的一些辅助函数的实现

  例如，homeassistant.helpers.event.(async_)track_point_in_utc_time在某个时刻执行某个动作。

• homeassistant.util

  homeassistant.util中包含了与HomeAssistant无直接关系的一些辅助函数的实现

  例如，homeassistant.util.dt.utcnow获得当前的格林威治标准时间

样例：在sun集成中，周期性的更新实体sun.sun的状态

注：周期性执行，也可以使用homeassistant.helpers.event.(async_)track_time_interval函数

完整的HomeAssistant内部API文档

https://dev-docs.home-assistant.io/en/master/index.html

返回课程目录↩