powersync-plugins-modbus/README.md

48 lines
2.7 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 plug-ins modbus
--------------------------------------------
<p align="center">
<a href="https://nymea.io">
<img src="https://nymea.io/downloads/img/nymea-logo.svg" width=300>
</a>
</p>
This repository contains modbus integrations for nymea.
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.
## 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)
## Documentation
* A detailed description how to install and getting started with the *nymea* can be found here:
[nymea | user documentation](https://nymea.io/documentation/users/installation/getting-started).
* A detailed documentation for developers can be found here:
[nymea | developer documentation](https://nymea.io/documentation/developers/).
## Contributing
To contribute support for a device or service, you're welcome to file a pull request to this repository. If you need help in creating an integration plugin, feel free to ask in our forum or the Telegram group as well.
If you don't have any developer skills at all, still feel free to bring the topic up. Our community is happy to help wherever possible."
## License
--------------------------------------------
The nymea plug-ins inside this repository are licensed under the GNU General Public License, version 3 or (at your option) any later version. The reusable libraries `libnymea-modbus` and `libnymea-sunspec` are licensed under the GNU Lesser General Public License, version 3 or (at your option) any later version. Every C++ source and header file now carries the appropriate SPDX identifier (`GPL-3.0-or-later` for the plug-ins and `LGPL-3.0-or-later` for the libraries) together with the full boilerplate describing the terms.
The full license texts can be found in [`LICENSE.GPL3`](LICENSE.GPL3) for the GPL components and [`LICENSE.LGPL3`](LICENSE.LGPL3) for the LGPL libraries. Copyright (C) 2013-2024 nymea GmbH and (C) 2024-2025 chargebyte austria GmbH. See `debian/copyright` for the authoritative overview and exact file listings.
If you distribute a modified version of this project you must follow the respective GPL or LGPL requirements, including providing source code to recipients and keeping the copyright notices intact.