Pyscript: Home Assistant 的 Python 脚本
这个 HACS 自定义集成允许你编写 Python 函数和脚本,可以实现广泛的自动化、逻辑和触发器。状态变量绑定到 Python 变量,服务可以作为 Python 函数调用,因此实现逻辑变得简单而简洁。
你编写的函数可以配置为作为服务调用,或在时间、状态变化或事件触发时运行。函数还可以调用任何服务、触发事件和设置状态变量。函数可以休眠或等待状态变量或事件的额外变化,而不会减慢或影响其他操作。你可以将这些函数视为并行运行的小程序,它们彼此独立,可能会长时间活跃。
Pyscript 还提供了一个与 Jupyter 前端(如 notebook、console、lab 和 VSCode)接口的内核。这允许你交互式地开发和测试 pyscript 代码。此外,你还可以通过查看状态变量、调用服务等方式与 HASS 的大部分功能进行交互。
文档
这里是 pyscript 文档。
有关 Jupyter 内核的更多信息,请参阅 README。 还有一个 Jupyter notebook 教程, 可以下载并在连接到你的实时 HASS 和 pyscript 的 Jupyter notebook 中交互运行。
安装
选项 1:HACS
在 HACS -> 集成下,选择"+",搜索 pyscript
并安装。
选项 2:手动
从 最新发布 下载 zip 文件 hass-custom-pyscript.zip
cd YOUR_HASS_CONFIG_DIRECTORY # 与 configuration.yaml 相同的位置
mkdir -p custom_components/pyscript
cd custom_components/pyscript
unzip hass-custom-pyscript.zip
或者,你可以通过克隆和复制安装当前 GitHub master 版本:
mkdir SOME_LOCAL_WORKSPACE
cd SOME_LOCAL_WORKSPACE
git clone https://github.com/custom-components/pyscript.git
mkdir -p YOUR_HASS_CONFIG_DIRECTORY/custom_components
cp -pr pyscript/custom_components/pyscript YOUR_HASS_CONFIG_DIRECTORY/custom_components
安装 Jupyter 内核
安装 Pyscript Jupyter 内核是可选的。安装和使用步骤在 这个 README 中。
配置
- 在 Home Assistant 配置 UI 的集成菜单中添加
Pyscript Python scripting
。或者,在<config>/configuration.yaml
中添加pyscript:
;pyscript 有两个可选的配置参数,允许导入任何 python 包(如果设置)并将hass
暴露为变量;两者默认为false
:pyscript: allow_all_imports: true hass_is_global: true
- 在
<config>/pyscript
文件夹中添加后缀为.py
的文件。 - 重启 HASS。
- 每当你更改脚本文件时,对
pyscript
进行reload
服务调用。 - 在 HASS 日志中查看
pyscript
错误和脚本的日志输出。
贡献
欢迎贡献!我们鼓励你提交 PR、错误报告、功能请求或在 Wiki 中添加示例和教程。我们很乐意听到你开发的独特和巧妙的应用。请参阅这个 README 来设置开发环境和运行测试。
即使你不是开发者,也请参与我们的 讨论社区。 帮助其他用户也是对 pyscript 做出贡献的另一种很好的方式!
有用链接
- 文档稳定版:最新发布
- 文档最新版:Github 中的当前 master
- 讨论和帮助
- 问题
- Wiki
- GitHub 仓库(如果你喜欢 pyscript,请添加星标!)
- 发布说明
- Jupyter notebook 教程
版权
版权所有 (c) 2020-2023 Craig Barratt。根据 Apache 2.0 许可证 的条款,可以自由使用和复制。