mirror of https://github.com/nymea/nymea.git
113 lines
4.3 KiB
Markdown
113 lines
4.3 KiB
Markdown
# nymea - open source IoT edge server
|
||
--------------------------------------------
|
||
<p align="center">
|
||
<a href="https://nymea.io">
|
||
<img src="https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/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 Install on Ubuntu
|
||
|
||
<p align="center">
|
||
<img src="https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-ubuntu.svg" width=300 >
|
||
</p>
|
||
|
||
In order to install nymea on Ubuntu, you simply need to download this bash script:
|
||
|
||
```
|
||
wget https://downloads.nymea.io/install-nymea.sh
|
||
```
|
||
Extract into your Home folder and just run
|
||
|
||
```
|
||
chmod +x install-nymea.sh
|
||
sudo ./install-nymea.sh
|
||
```
|
||
Once the success message has printed on your screen, simply run: *sudo nymead -n* to start nymea!
|
||
|
||
## Quick Install on a Raspberry Pi
|
||
|
||
<p align="center">
|
||
<img src="https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/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 the nymea mobile app here:
|
||
|
||
<p align="center">
|
||
<img src="https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/ios-app.png" width=300>
|
||
</p>
|
||
|
||
<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/app/default/assets/addons/default/guh/default-theme/resources/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/app/default/assets/addons/default/guh/default-theme/resources/img/app-store/playstore.png" width=200>
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
## Get the nymea desktop app here:
|
||
<p align="center">
|
||
<img src="https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/desktop-app.png?v=1555314733">
|
||
</p>
|
||
|
||
<table align="center">
|
||
<tr>
|
||
<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/app/default/assets/addons/default/guh/default-theme/resources/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/app/default/assets/addons/default/guh/default-theme/resources/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/app/default/assets/addons/default/guh/default-theme/resources/img/app-store/windows.svg" width=200>
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## 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)
|
||
|
||
## Wiki and Documentation
|
||
|
||
* A detailed description how to install and getting started with the *nymea* can be found in the
|
||
|
||
[nymea | github wiki](https://wiki.nymea.io).
|
||
|
||
* A detailed documentation of the source code can be found in the
|
||
|
||
[nymea | developer documentation](https://doc.nymea.io).
|
||
|
||
|
||
## 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 2 of the License.
|