welterrocks / ecophacs
Ecovacs API的PHP库。
Requires
- php: >=7.1
Requires (Dev)
- ext-mosquitto: 0.4.0
- friendsofphp/php-cs-fixer: 3.0.x-dev
- norgul/xmpp-php: 2.2.3
- phpmd/phpmd: 2.6.0
- phpseclib/phpseclib: 2.*
- phpunit/phpunit: 6.*
- squizlabs/php_codesniffer: 3.4.2
This package is auto-updated.
Last update: 2024-09-25 17:16:08 UTC
README
这个库使用PHP连接到Ecovacs API,并允许您控制基于Ecovacs的设备,例如Deebot。您需要一个Ecovacs云账户和密码进行登录,或者一个本地服务器,如Bumper。该库显示并允许您控制与您的账户关联的受支持和已注册的设备。EcoPhacs是用PHP编写的,是Sucks项目的替代品。
新闻
- 2020-10-21 添加了bumper兼容性。现在,可以使用EcoPhacs与bumper一起使用。添加了一些兼容性代码,以便EcoPhacs与bumper服务器项目一起工作。
- 2020-10-17 EcoPhacs-MQTT发布。EcoPhacs-MQTT守护进程的第一个beta版本已发布。现在,可以将您的Ecovacs Deebot直接连接到MQTT代理,例如,这对于使用您最喜欢的IOT控制器(如OpenHAB)控制和管理您的Ecovacs机器人设备非常有用。EcoPhacs-MQTT守护进程会自动请求设备状态更新并通过指定的MQTT主题发布它们。由于第三方mosquitto库的一些意外行为,脚本无法在代理重启时存活,但将在接下来的几天内修复。
- 2020-10-16 EcoPhacs-Daemon和EcoPhacs-Client发布。如果您想快速访问您的机器人并立即执行命令和响应,那么这个新的守护进程/客户端组合可能是您要找的。您需要在/run中创建两个FIFO,命名为
ecophacs-in.fifo
和ecophacs-out.fifo
,它们可以在运行时由EcoPhacs-Daemon.php
访问。运行守护进程的要求是创建一个配置文件,使用EcoPhacs-Configure.php
。守护进程启动后,您可以使用EcoPhacs-Client.php发送命令,机器人会立即执行。
安装要求
项目要求在composer.json
中给出(Composer网站)
您可以通过运行以下命令在您的项目中使用此库
composer require welterrocks/ecophacs
或者直接从GitHub克隆它
git clone https://github.com/WelterRocks/ecophacs
在获取到ecophacs的副本后,切换到安装目录并运行以下命令,如果您想将ecophacs安装到系统中
sudo ./install.sh
只需等待脚本完成安装。要创建配置文件,只需键入
sudo EcoPhacs-Configure.php
然后,将 ~/.ecophacsrc 复制到 /etc/ecophacs/ecophacs.conf
sudo cp ~/.ecophacsrc /etc/ecophacs/ecophacs.conf
现在您可以启动守护进程
sudo EcoPhacs-Daemon.php start
如果您想使守护进程在系统启动时启动,请键入
systemctl enable ecophacs-daemon
以查看发生了什么,使用tail查看syslog
sudo tail -f /var/log/syslog
现在,您可以通过控制台启动控制您的机器人
EcoPhacs-Client.php devicelist
这将列出已注册的设备列表。选择一个,例如E0000111122223333344444,清洁10秒钟,然后返回充电器
EcoPhacs-Client.php --device-id E0000111122223333344444 auto --wait 10 charge
如果您想使用MQTT版本,请记住停止守护进程,因为目前不支持同步运行。如果您使用systemd,它将自动处理停止其他守护进程。您可以使用以下命令运行MQTT守护进程
EcoPhacse-MQTT.php start
但请记住,使用EcoPhacs-Configure.php
配置您的 /etc/ecophacs/ecophacs.conf 以设置您的MQTT凭据。另外,目前EcoPhacs-MQTT.php
工具不支持TLS。
Bumper使用
如果您想使用EcoPhacs与bumper一起使用,请将以下选项添加到EcoPhacs-Daemon.php
或EcoPhacs-MQTT.php
,以在EcoPhacs中启用bumper兼容模式
EcoPhacs-{Daemon|MQTT}.php --bump-api /path/to/bumper/certs/bumper.crt --dry-login --api-urls "https://[IP-OF-BUMPER-SERVER]/v1/private/%country%/%app_language%/%device_id%/%app_code%/%app_version%/%app_channel%/%device_type%" "https://[IP-OF-BUMPER-SERVER]/api/users/user.do" --is-bumper-server start|foreground
库使用
一般信息
这个库还处于早期开发阶段。您可以使用这个库与ecovacs云服务配合,控制您已注册的设备。此外,它已经与Bumper进行了测试,这是Brian Martin开发的一个优秀项目,为您的小机器人提供本地服务器。请谨慎使用这个库,目前请不要在生产环境中使用它,因为还有大量的测试要做...希望您能尝试一下。
待办事项
- 测试 - 编写一些测试例程,目前只有一个是正常工作的Example.php,没有测试