PHPackages                             exposuresoftware/laravel-zway - 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. [Utility & Helpers](/categories/utility)
4. /
5. exposuresoftware/laravel-zway

AbandonedArchivedLibrary[Utility & Helpers](/categories/utility)

exposuresoftware/laravel-zway
=============================

Z-Way Server SDK for Laravel

v0.8.1(5y ago)2449[5 PRs](https://github.com/ExposureSoftware/LaravelWave/pulls)MITPHPPHP >=7.1.3

Since Jun 22Pushed 3y ago1 watchersCompare

[ Source](https://github.com/ExposureSoftware/LaravelWave)[ Packagist](https://packagist.org/packages/exposuresoftware/laravel-zway)[ Docs](https://github.com/ExposureSoftware/LaravelWave)[ Fund](https://tidelift.com/funding/github/packagist/exposuresoftware/laravel-zway)[ RSS](/packages/exposuresoftware-laravel-zway/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (7)Versions (31)Used By (0)

LaravelWave [![Build Status](https://camo.githubusercontent.com/c38081ffce2f49f2bff2031c64747f68419d7ed8ffc488934be9d764e6695dde/68747470733a2f2f7472617669732d63692e636f6d2f4578706f73757265536f6674776172652f4c61726176656c576176652e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/ExposureSoftware/LaravelWave)
===============================================================================================================================================================================================================================================================================================================================

[](#laravelwave-)

Provides a Laravel package to integrate with an existing [Z-Way](https://z-wave.me/z-way/) server.

Installation
------------

[](#installation)

Installation is performed via [Composer](https://getcomposer.org).

#### Install Composer

[](#install-composer)

See the Composer [Getting Started](https://getcomposer.org/doc/00-intro.md) documentation for how to install Composer on your platform.

#### Require LaravelWave in your project

[](#require-laravelwave-in-your-project)

The simplest way to do this is by running this command:

```
composer require exposuresoftware/laravel-zway

```

Alternatively, you may add the requirement directly by adding `"exposuresoftware/laravel-zway": "^0.0.1"`to your `require` section of `composer.json`.

#### Publish the package to your project

[](#publish-the-package-to-your-project)

Run `php artisan vendor:publish`.

This will add `laravelwave.php` to your config directory.

#### Configure the package

[](#configure-the-package)

The package is configurable via environment variables. To configure in this way add the following lines to your `.env`, changing the values to match your configuration:

```
# The host URI for your Z-Way server.
# Defaults to http://localhost
# Include the schema and do not provide a trailing slash
ZWAY_HOST=http://localhost
# The port on which your Z-Way server is listening.
# Defaults to Z-Way default port 8083.
ZWAY_PORT=8083
# API User
# Defaults to the Z-Way default of admin
ZWAY_USER=admin
# API User's password
ZWAY_PASSWORD=
```

You may also edit the `laravelwave.php` file in your config directory.

***Note:** It is **not** recommended to store your credentials in the configuration file if committed to a publicly accessible repository (like Github).*

Usage
-----

[](#usage)

There are a number of methods of employing the SDK in your project. Each provides access to all the methods made accessible, a full list of which is available in this document.

All communication with the Z-Way server, except logging in, require authentication when accessed via this SDK at this time. Once you have successfully logged into the server once a token will be optionally stored for you. If you choose not to store the token it will only be available for the life of the current SDK instance.

#### Via provided Facade

[](#via-provided-facade)

```