PHPackages welterrocks/ecophacs - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. welterrocks/ecophacs ActiveProject[API Development](/categories/api) welterrocks/ecophacs ==================== PHP library for ecovacs API. v0.28(5y ago)4341GPL-3.0-onlyPHPPHP >=7.1 Since Oct 12Pushed 5y ago1 watchersCompare [ Source](https://github.com/WelterRocks/ecophacs)[ Packagist](https://packagist.org/packages/welterrocks/ecophacs)[ Fund](https://tidelift.com/funding/github/welterrocks/ecophacs)[ RSS](/packages/welterrocks-ecophacs/feed)WikiDiscussions main Synced 3w ago READMEChangelog (10)Dependencies (6)Versions (12)Used By (0) EcoPhacs is a PHP client library for the Ecovacs API ==================================================== [](#ecophacs-is-a-php-client-library-for-the-ecovacs-api) [![License](https://camo.githubusercontent.com/3bd154b9b19d95f665899bf085c57448b0f10a282dc1b1d99c9e3d6c77e2cf61/68747470733a2f2f706f7365722e707567782e6f72672f77656c746572726f636b732f65636f70686163732f6c6963656e7365)](https://packagist.org/packages/welterrocks/ecophacs)[![Total Downloads](https://camo.githubusercontent.com/f71ae573f365da879265ddf0d7c6c40147e30ee83dcfcb46f95b2e39b0b77e96/68747470733a2f2f706f7365722e707567782e6f72672f77656c746572726f636b732f65636f70686163732f646f776e6c6f616473)](https://packagist.org/packages/welterrocks/ecophacs)[![Latest Stable Version](https://camo.githubusercontent.com/382367924033c980f824d3eaa13ea6b1ef3149af24dea45ff4480d8a748c970b/68747470733a2f2f706f7365722e707567782e6f72672f77656c746572726f636b732f65636f70686163732f762f737461626c65)](https://packagist.org/packages/welterrocks/ecophacs)[![Latest Unstable Version](https://camo.githubusercontent.com/6f284b2015c21a597861e3d6aee0947e83a38a71ce8949f573731fe62ba23bdb/68747470733a2f2f706f7365722e707567782e6f72672f77656c746572726f636b732f65636f70686163732f762f756e737461626c65)](https://packagist.org/packages/welterrocks/ecophacs)[![Linux Build](https://camo.githubusercontent.com/06aa7821305937581b40760c2b327366fc0d7f2fa782cf22108c864440825660/68747470733a2f2f7472617669732d63692e6f72672f77656c746572726f636b732f65636f70686163732e7376673f6272616e63683d6d61696e)](https://travis-ci.org/welterrocks/ecophacs)[![Windows Build](https://camo.githubusercontent.com/36c814b0ee1b25cdee1278a6c83237272a1871340cbc5a3f3a86b6e286caf8e5/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f6769746875622f77656c746572726f636b732f65636f7068616373)](https://ci.appveyor.com/project/WelterRocks/ecophacs) This library uses PHP to connect to the Ecovacs API and let you control your Ecovacs based devices, like Deebot for example. You need an Ecovacs cloud account and a password to login or a local server like [Bumper](https://github.com/bmartin5692/bumper). The library shows and let you control the supported and registered devices, linked to your account. EcoPhacs has been written in PHP and is an alternative to the [Sucks](https://github.com/wpietri/sucks) project. News ==== [](#news) - **2020-10-21** Added bumper compat. Now, it is possible to use EcoPhacs with bumper. Added some compatibility code to make EcoPhacs work with the bumper server project. - **2020-10-17** EcoPhacs-MQTT release. The first beta version of the EcoPhacs-MQTT daemon has been released. Now, it is possible to connect your Ecovacs Deebot directly to a MQTT broker, which is e.g. useful to control and supervise your Ecovacs robot devices with your favorite IOT controllers, like OpenHAB. The EcoPhacs-MQTT daemon automatically requests device status updates and post them through the given MQTT topic. Currently the script doenst survive a broker restart, because of some unexpected behaviour of the third party mosquitto lib. But this will be fixed in the next few days. - **2020-10-16** EcoPhacs-Daemon and EcoPhacs-Client released. If you would like to have fast access to your bots and immidiate command reactions and responses, then this new daemon/client combination is probably what you are searching for. You need two FIFOs in /run, named `ecophacs-in.fifo` and `ecophacs-out.fifo`, which can be accessed by the `EcoPhacs-Daemon.php` while running. The requirement to run the daemon is to create a config file, using `EcoPhacs-Configure.php`. After the daemon has started, you can use EcoPhacs-Client.php to send commands, which your bot immidiatly executes. Installation requirements ========================= [](#installation-requirements) Project requirements are given in `composer.json` ( [Composer website](https://getcomposer.org)): You can use this library in your project by running: ``` composer require welterrocks/ecophacs ``` or just clone it from GitHub: ``` git clone https://github.com/WelterRocks/ecophacs ``` After you got your copy of ecophacs, change to the installation directory and run the following command, if you want to install ecophacs to your system: ``` sudo ./install.sh ``` Just wait for the script to finish the installation. To create a config file, just type: ``` sudo EcoPhacs-Configure.php ``` After that, copy ~/.ecophacsrc to /etc/ecophacs/ecophacs.conf: ``` sudo cp ~/.ecophacsrc /etc/ecophacs/ecophacs.conf ``` Now you can start the daemon: ``` sudo EcoPhacs-Daemon.php start ``` If you would like to start the daemon at system start-up, type: ``` systemctl enable ecophacs-daemon ``` to see, whats going on, tail your syslog: ``` sudo tail -f /var/log/syslog ``` Now, you can start controlling your bots: ``` EcoPhacs-Client.php devicelist ``` This will give you the list of registered devices. Choose one, e.g. E0000111122223333344444, clean for 10 seconds and than go back to the charger: ``` EcoPhacs-Client.php --device-id E0000111122223333344444 auto --wait 10 charge ``` If you want to use the MQTT version, remember to stop the Daemon, because synchronous running is currently not supported. If you use systemd, it will automatically take care of stopping the other daemon. You can run the MQTT daemon with: ``` EcoPhacse-MQTT.php start ``` But remember, to configure your /etc/ecophacs/ecophacs.conf with `EcoPhacs-Configure.php`to set up your MQTT credentials. Also, TLS is currently not supported by the `EcoPhacs-MQTT.php` tool. Bumper usage ------------ [](#bumper-usage) If you want to use EcoPhacs with bumper, add the following options to `EcoPhacs-Daemon.php`or `EcoPhacs-MQTT.php`, to enable to bumper compatibility mode in EcoPhacs: ``` 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 ``` Library usage ============= [](#library-usage) General information ------------------- [](#general-information) This library is in an early development stage. You can use this library with the ecovacs cloud, to control your registered devices. Also it has been tested with [Bumper](https://github.com/bmartin5692/bumper), which is a great project by [Brian Martin](https://github.com/bmartin5692), giving you a local server for your bots. Use this lib with care and do NOT use it for production environments for now, because there is too much testing to do...Hope I can get you to give it a try. TODO's ------ [](#todos) - **testing** - writing some testing routines for packaging currently there is only one working Example.php and no tests ### Health Score 24 — LowBetter than 31% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity12 Limited adoption so far Community8 Small or concentrated contributor base Maturity46 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 11 Last Release 2080d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/19888555?v=4)[Oliver Welter](/maintainers/welterrocks)[@WelterRocks](https://github.com/WelterRocks) --- Top Contributors [![WelterRocks](https://avatars.githubusercontent.com/u/19888555?v=4)](https://github.com/WelterRocks "WelterRocks (85 commits)") --- Tags phplibraryecovacsdeebot ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/welterrocks-ecophacs/health.svg) ``` [![Health](https://phpackages.com/badges/welterrocks-ecophacs/health.svg)](https://phpackages.com/packages/welterrocks-ecophacs) ``` ### Alternatives [maxbeckers/amazon-alexa-php Php library for amazon echo (alexa) skill development. 11559.6k2](/packages/maxbeckers-amazon-alexa-php)[ontraport/sdk-php ONTRAPORT PHP Library 19405.8k2](/packages/ontraport-sdk-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)