Installation

This guide will help you add Pulse MQTT to your Android project.

Gradle Setup

Step 1: Add Dependencies

Add Pulse MQTT and required dependencies to your app's build.gradle:

"build.gradle.kts (Kotlin DSL)"

    dependencies {
        // Pulse MQTT Library
        implementation("com.eternal.kits:pulse-mqtt:<latest_version>")

        // Required: Gson for JSON serialization
        implementation("com.google.code.gson:gson:<latest_version>")

        // Required: AndroidX WorkManager (for health monitoring)
        implementation("androidx.work:work-runtime-ktx:<latest_version>")
    }

"build.gradle (Groovy)"

    dependencies {
        // Pulse MQTT Library
        implementation 'com.eternal.kits:pulse-mqtt:<latest_version>'

        // Required: Gson for JSON serialization
        implementation 'com.google.code.gson:gson:<latest_version>'

        // Required: AndroidX WorkManager (for health monitoring)
        implementation 'androidx.work:work-runtime-ktx:<latest_version>'
    }

Step 3: Add Permissions

Add required permissions to your AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android">

    <!-- Required: Internet access for MQTT connection -->
    <uses-permission android:name="android.permission.INTERNET" />

    <!-- Required: Network state monitoring -->
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

    <!-- Optional: For AlarmManager health monitoring (API 31+) -->
    <uses-permission 
        android:name="android.permission.SCHEDULE_EXACT_ALARM"
        android:maxSdkVersion="32" />

    <!-- Optional: For AlarmManager health monitoring (API 33+) -->
    <uses-permission android:name="android.permission.USE_EXACT_ALARM" />

    <application>
        <!-- Your app content -->
    </application>
</manifest>

Version Catalog (Optional)

If you're using Gradle Version Catalogs, add the following to your libs.versions.toml:

[versions]
pulseMqtt = "1.0.0"
gson = "2.10.1"
workManager = "2.9.0"

[libraries]
pulse-mqtt = { module = "com.eternal.kits:pulse-mqtt", version.ref = "pulseMqtt" }
gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
androidx-work-runtime = { module = "androidx.work:work-runtime-ktx", version.ref = "workManager" }

Then in your build.gradle.kts:

dependencies {
    implementation(libs.pulse.mqtt)
    implementation(libs.gson)
    implementation(libs.androidx.work.runtime)
}

Next Steps

Now that you have Pulse MQTT installed, continue to:

• Quick Start Guide - Get started with your first MQTT connection
• Configuration - Learn about configuration options

Need Help?

• Check the FAQ for common questions
• Report issues on GitHub