nymea/README.md

78 lines
3.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# nymea - open source IoT edge server
--------------------------------------------
<p align="center">
<a href="https://nymea.io">
<img src="https://nymea.io/downloads/img/nymea-logo.svg" width=300>
</a>
</p>
nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols and APIs. With the build-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment.
## Quick start
### Install nymea on a Raspberry Pi
<p align="center">
<img src="https://nymea.io/downloads/img/nymea-pi.svg" width=300 >
</p>
We have created an image for your Raspberry Pi (all models) that comes with an array of plugins for different smart devices!
[Download](https://downloads.nymea.io/images/raspberrypi/latest)
### Get nymea:app here:
<table align="middle">
<tr>
<td>
<p>
<a href="https://itunes.apple.com/us/app/nymea-app/id1400810250?mt=8">
<img border="0" align="middle" alt="iOS Badge" src="https://nymea.io/downloads/img/app-store/appstore.png" width=200>
</p>
</td>
<td>
<p>
<a href="https://play.google.com/store/apps/details?id=io.guh.nymeaapp&hl=en&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1">
<img border="0" align="middle" alt="Android Badge" src="https://nymea.io/downloads/img/app-store/playstore.png" width=200>
</p>
</td>
<td>
<p>
<a href="https://downloads.nymea.io/nymea-app/nymea-app-osx-bundle.dmg">
<img border="0" align="middle" alt="macOS Badge" src="https://nymea.io/downloads/img/app-store/macos.png" width=200">
</p>
</td>
<td>
<p>
<a href="https://snapcraft.io/nymea-app">
<img border="0" align="middle" alt="Snap Badge" src="https://nymea.io/downloads/img/app-store/snap-store.png" width=200>
</p>
</td>
<td>
<p>
<a href="https://downloads.nymea.io/nymea-app/nymea-app-win-installer.exe">
<img border="0" align="middle" alt="Windows Badge" src="https://nymea.io/downloads/img/app-store/windows.svg" width=200>
</p>
</td>
</tr>
</table>
A detailed description how to install and getting started with *nymea* can be found in the [nymea | user documentation](https://nymea.io/documentation/users/installation/getting-started).
## Getting help
If you want to present your project or want to share your newest developments you can share it in
[Our Forum](https://forum.nymea.io)
If you are facing any troubles, don't hesitate to reach out for us or the community members, we will be pleased to help you:
Chat with us on [Telegram](http://t.me/nymeacommunity) or [Discord](https://discord.gg/tX9YCpD)
## Developing with nymea
A detailed documentation on how to develop with *nymea* is available on the [nymea | developer documentation](https://nymea.io/documentation/developers/).
## License
--------------------------------------------
> nymea is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.