Download the PHP package kan-agency/hive-php-api without Composer
On this page you can find all versions of the php package kan-agency/hive-php-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kan-agency/hive-php-api
More information about kan-agency/hive-php-api
Files in kan-agency/hive-php-api
Package hive-php-api
Short Description An unofficial package to support the Hive Home API
License MIT
FAQ
Example:
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 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.
Informations about the package hive-php-api
Hive Home PHP API
An unofficial package to support the Hive Home API
Installation
This package can be installed via Composer:
It requires PHP >= 7.0.0.
Simple Usage
There's a helper class, named Kan\Hive\Hive, which should be instantiated with the same credentials used to login to https://my.hivehome.com/login. This can be done like the below:
Once that's complete, we need to create a reference to a device using it's ID (Note: You can locate the ID of devices by viewing the URL of the https://my.hivehome.com/dashboard after selecting the required device).
The device we're using here is a Plug, so, the below code will work for the above $plug device:
That's it, simple. For more advance useage, see the below section.
Advance Usage
We should still instantiate an instance of the helper class Kan\Hive\Hive, however, you can utilise a Service Provider to inject this as a dependency into a class. We won't go into depth on how to do that, so for this example, we'll use the same method as above:
We can now create a new class within our project, let's name it Lamp and ensure it extends the correct device class. For this example, that is Kan\Hive\Device\Plug, as we have a lamp plugged into a plug. We need to implement the method getDevice() to return an instance of the correct device using it's ID, as explained above:
Now we have our specific device class, we're able to perform actions on those easily like the below:
Methods
The below outlines the supported devices and actions, along with the methods you're able to use for each:
Active Plug: Kan\Hive\Device\Plug
->on(): This will switch the plug on.->off(): This will switch the plug off.
Camera: Kan\Hive\Device\Camera
->on(): This will arm the camera, enabling features like detection and notifications.->off(): This will disarm the camera.
Action: Kan\Hive\Device\Action
->trigger(): This will trigger the pre-defined action to be run.
Testing
Unit tests can be run inside the package:
Contributing
Please see CONTRIBUTING for details.
License
kan-agency/hive-php-api is licensed under the MIT license. See the LICENSE file for more details.
