https://github.com/petretiandrea/mqtt-km

A simple MQTT client kotlin multiplatform implementation.
https://github.com/petretiandrea/mqtt-km

arm kotlin kotlin-multiplatform linux mqtt mqtt-client

Last synced: 13 days ago
JSON representation

A simple MQTT client kotlin multiplatform implementation.

• Host: GitHub
• URL: https://github.com/petretiandrea/mqtt-km
• Owner: petretiandrea
• Created: 2022-02-28T15:21:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-11T17:34:17.000Z (over 2 years ago)
• Last Synced: 2024-10-10T20:06:18.992Z (27 days ago)
• Topics: arm, kotlin, kotlin-multiplatform, linux, mqtt, mqtt-client
• Language: Kotlin
• Homepage:
• Size: 200 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# MQTT-KM (MQTT Kotlin Multiplatform)

A simple MQTT client kotlin multiplatform implementation.

[![GitHub Build](https://github.com/petretiandrea/mqtt-km/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/petretiandrea/mqtt-km/actions/workflows/build.yml)

[![Kotlin](https://img.shields.io/badge/kotlin-1.6.10-orange.svg)](http://kotlinlang.org/)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.petretiandrea/mqtt-km.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.petretiandrea%22%20AND%20a:%22mqtt-km%22)

[![codecov](https://codecov.io/gh/petretiandrea/mqtt-km/branch/main/graph/badge.svg?token=G8YD0T377P)](https://codecov.io/gh/petretiandrea/mqtt-km)

**WIKI will be available as soon as possible**

## Supported platforms and features

| Platform    |     MQTT 3.1.1     | TCP                |        TLS         |     Websocket      |

| :---:       |:------------------:| :------------:     |:------------------:|:------------------:|

| JVM         | :white_check_mark: | :white_check_mark: | --- | --- |

| Windows X64 | :white_check_mark: | :white_check_mark: | --- | --- |

| Linux X64   | :white_check_mark: | :white_check_mark: | --- | --- |

| Linux ARM64 | :white_check_mark: | :white_check_mark: | --- | --- |

| Linux ARM32 | --- | --- | --- | --- |

| Node.js     | --- | --- | --- | --- |

## Install

The library is available on Maven Central, so you can install with gradle by:

```gradle

implementation("io.github.petretiandrea:mqtt-km:x.x.x") // kotlin dsl

implementation 'io.github.petretiandrea:mqtt-km:x.x.x' // groovy

```

## Example

The mqtt library works by creating a safe event loop using coroutines. 

To build a valid client instance you need to provide a coroutine scope where launch a "background" coroutine event loop.

You can create a simple mqtt client instance by a special dsl provided by library.

```kotlin

fun main() = runBlocking { scope ->

    val client = mqtt(scope) {

        tcp { // also provide ssl, or websocket builder (actually not implemented)

            hostname = "broker.hivemq.com"

            port = 1883

            clientId = "client-1234"

        }

        // you can subscribe a lot of callbacks during creation...

        // onMessageReceive, onDisconnect, onDeliveryCompleted, etc...

        onSubscribeCompleted { subscribe, qoS ->

            println("Subscribe to: ${subscribe.topic} with qos: $qoS")

        }

    }

}

// ...or after

client.onMessageReceived { message -> println("$message")}

// connect returns a Result, which is a success when connection process ends successfully

client.connect()

// publish. This return a boolean, but the effective delivery of message is handled by event loop, so the message

// complete the delivery when onDeliveryCompleted is called.

val message = Message(MessageId.generate(), "topic/subtopic/", "data", QoS.Q1, retain = false, duplicate = false)

client.publish(message)

// disconnect

client.disconnect()

```