@ditchoom/mqtt-base-models
v1.0.37
Published
[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linke
Downloads
3
Readme
About The Project
Runtime Dependencies
Supported Platforms
| Platform | 🛠Builds🛠 + 🔬Tests🔬 | Deployed Artifact | Non Kotlin Sample |
| :---: | :---: |:----------------------------------:|:-----------------:|
| JVM
1.8 |🚀| maven central 🔮 | WIP |
| Node.js
|🚀| npm 🔮 | WIP |
| Browser
(Chrome) |🚀| npm 🔮 | WIP |
| Android
|🚀| maven central 🔮 | WIP |
| iOS
|🚀| WIP cocoapods 🔮 | WIP |
| WatchOS
|🚀| WIP cocoapods 🔮 | WIP |
| TvOS
|🚀| WIP cocoapods 🔮 | WIP |
| MacOS
|🚀| WIP cocoapods 🔮 | WIP |
| Linux X64
|🚀| WIP apt/yum 🔮 | WIP |
| Windows X64
|🚀| WIP chocolatey 🔮 | WIP |
Installation
Gradle
NPM
Usage
Control Packet
A ControlPacket
defines a message that can be serialized and deserialized over MQTT. More info can be found here
Serializing a Control Packet
ControlPacket.serialize
provides a default way to serialize any control packet without knowing specific implementation details. This is useful when writing a generic client that doesn't care how the particular implementation serializes data
Deserializing a Control Packet
ControlPacketFactory
provides a mechanism to provide an interface to allocate specific types of control packets regardless of the MQTT version. This allows for an easier upgrade path from MQTT 4 to 5.
Building Locally
git clone [email protected]:DitchOoM/mqtt-base-models.git
- Open cloned directory with Intellij IDEA.
- Be sure to open with gradle
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the Apache 2.0 License. See LICENSE
for more information.