PHP download

Download the PHP package welterrocks/ecophacs without Composer

On this page you can find all versions of the php package welterrocks/ecophacs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download welterrocks/ecophacs
More information about welterrocks/ecophacs
Files in welterrocks/ecophacs

Vendor welterrocks
Package ecophacs
Short Description PHP library for ecovacs API.
License GPL-3.0-only

Keywords php library ecovacs deebot

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of welterrocks/ecophacs

Informations about the package ecophacs

EcoPhacs is a PHP client library for the Ecovacs API

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. 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 project.

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

Project requirements are given in composer.json ( Composer website):

You can use this library in your project by running:

or just clone it from GitHub:

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:

Just wait for the script to finish the installation. To create a config file, just type:

After that, copy ~/.ecophacsrc to /etc/ecophacs/ecophacs.conf:

Now you can start the daemon:

If you would like to start the daemon at system start-up, type:

to see, whats going on, tail your syslog:

Now, you can start controlling your bots:

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:

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:

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

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:

Library usage

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, which is a great project by Brian Martin, 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

testing - writing some testing routines for packaging currently there is only one working Example.php and no tests

All versions of ecophacs with dependencies

PHP Build Version

Package Version

Version v0.28 Release 21. Oct 2020
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of ecophacs from vendor welterrocks

Requires php Version >=7.1

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package welterrocks/ecophacs contains the following files

Loading the files please wait ....