# BlubbFish.IoT.Zway (Zway)
<!-- Short description of the project. -->

Library that connects to a zway controller device and recieves crawls zwave data. This library contains drivers for a Zwave.me installation. This readme is meant for describing the software library.

This library is running on every hardware that supports dotnet.

<!-- A teaser figure may be added here. It is best to keep the figure small (<500KB) and in the same repo -->

## Getting Started
<!-- Instruction to make the project up and running. -->

The project documentation is available on the [Wiki](https://git.blubbfish.net/vs_projects/Zway/wiki).

## Usage
<!-- Deployment/Installation instructions. If this is software library, change this section to "Usage" and give usage examples -->
This software can not run itselfs, cause its a library.

## Development
<!-- Developer instructions. -->
* Versioning: Use [SemVer](http://semver.org/) and tag the repository with full version string. E.g. `v1.0.0`

### Copyright

This library is under GNU LESSER GENERAL PUBLIC LICENSE Version 3

### Prerequisite

If you want to work with this library, please checkout [zway-project](https://git.blubbfish.net/vs/zway-project) with all submodules, to get all dependencies.

#### Internal
* BlubbFish.Utils ([Utils](http://git.blubbfish.net/vs_utils/Utils))
* BlubbFish.Utils.IoT.Interfaces ([Iot-Interfaces](http://git.blubbfish.net/vs_utils/Iot-Interfaces))

#### External
* litjson ([Used Fork](https://github.com/blubbfish/litjson), [Original](https://github.com/LitJSON/litjson))

### Test

You need to compile he library and use it with a calling agent.

### Build

Build it with Visual Studio.

## Contributing
Contributions are welcome. 

Please fork, make your changes, and submit a pull request. For major changes, please open an issue first and discuss it with the other authors.