Python: Elgato Lights的异步客户端

Elgato Lights的异步Python客户端。

关于

此包允许您以编程方式控制和监控Elgato Light设备。它主要创建用于允许第三方程序自动化Elgato Light设备的行为。

已知兼容并经过测试的Elgato设备

• Elgato Key Light
• Elgato Key Light Air
• Elgato Key Light Mini
• Elgato Light Strip

安装

pip install elgato

用法

import asyncio

from elgato import Elgato, State, Info


async def main():
    """Show example on controlling your Elgato Light device."""
    async with Elgato("elgato-key-light.local") as elgato:
        info: Info = await elgato.info()
        print(info)

        state: State = await elgato.state()
        print(state)

        # Toggle the Light
        await elgato.light(on=(not state.on))


if __name__ == "__main__":
    asyncio.run(main())

变更日志 & 发布

此存储库使用GitHub的发布功能维护变更日志。日志格式基于Keep a Changelog。

版本基于语义版本控制，并使用MAJOR.MINOR.PATCH格式。简而言之，版本将根据以下内容递增

• MAJOR：不兼容或主要更改。
• 小版本：向后兼容的新功能和改进。
• 修补程序：向后兼容的错误修复和软件包更新。

贡献

这是一个活跃的开源项目。我们始终欢迎那些想要使用代码或为其做出贡献的人。

我们已为我们的贡献指南设置了一个单独的文档。

感谢您的参与！:heart_eyes

设置开发环境

开始的最简单方法是在这里的GitHub上打开CodeSpace，或者使用Visual Studio Code的开发容器功能。

此Python项目完全使用Poetry依赖项管理器进行管理。但也依赖于NodeJS在开发期间进行某些检查。

您至少需要

• Python 3.11+
• Poetry
• NodeJS 20+（包括NPM）

安装所有软件包，包括所有开发需求

npm install
poetry install

由于此存储库使用pre-commit框架，所有更改都会在每次提交时进行代码审查和测试。您可以使用以下命令手动运行所有检查和测试

poetry run pre-commit run --all-files

仅运行Python测试

poetry run pytest

作者和贡献者

此存储库的原始设置由Franck Nijhof完成。

要查看所有作者和贡献者的完整列表，请查看贡献者页面。

许可协议

MIT许可

版权所有 (c) 2019-2023 Franck Nijhof

在此，任何人都可以免费获得此软件及其相关文档副本（“软件”），在不受限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向软件提供软件的人这样做，前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论这些责任是因合同、侵权或其他原因而产生的，以及与软件或其使用或其他方式有关。