diff --git a/.changeset/shaggy-parents-think.md b/.changeset/shaggy-parents-think.md new file mode 100644 index 0000000..2917aee --- /dev/null +++ b/.changeset/shaggy-parents-think.md @@ -0,0 +1,7 @@ +--- +"vue-paho-mqtt": patch +--- + +Added more Paho options: (https://eclipse.dev/paho/files/jsdoc/Paho.MQTT.Client.html) +- keepAliveInterval: The server disconnects this client if there is no activity for this number of milliseconds. The default value of 60000 milliseconds is assumed if not set. +- cleanSession: if true(default) the client and server persistent state is deleted on successful connect. diff --git a/README.md b/README.md index bfbbb1f..6f380cb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@
- + @@ -18,10 +18,10 @@ - + - +
The `vue-paho-mqtt` plugin provides a convenient way to use the [Eclipse Paho MQTT JavaScript client](https://www.eclipse.org/paho/clients/js/) with Vue 3. @@ -196,10 +196,14 @@ You can configure the MQTT client by passing an object with the following option - `enableMainTopic` (`boolean`, default: `true`) - Enables usage of the main topic. -- `watchdogTimeout` (`number`, default: `2000`) - The time in milliseconds to wait for a connection to the broker before timing out. +- `watchdogTimeout` (`number`, default: `30000`) - The time in milliseconds to wait for a connection to the broker before timing out. - `reconnectTimeout` (`number`, default: `5000`) - The time in milliseconds to wait before attempting to reconnect to the broker after a disconnection. +- `keepAliveInterval` (`number`, default: `60000`) - The server disconnects this client if there is no activity for this number of milliseconds. + +- `cleanSession` (`boolean`, default: `true`) - Whether to delete the server persistent state on a new connection. + --- ### MQTT Quality of Service (QoS) and Retention Options for Publish @@ -338,7 +342,7 @@ const result = await $mqtt.connect(); | `onConnectionLost` | disconnected or connection lost connection | responseObject: {errorCode: number} | | `onMessageArrived` | message arrived from one of the subscribed topics | message: {payloadString: string;destinationName: string;} | -#### Custom Callback Usage example: +#### Custom Callback Usage example ```ts $mqtt.connect({ @@ -990,8 +994,8 @@ This project is created and actively maintained by [kaandesu](https://github.com | Maintainer | E-Mail | Twitter | | --------------------------------------- | ------------------------------------------ | --------------------------------------------- | -| [kaandesu](https://github.com/kaandesu) | kaandesu00@gmail.com | - | -| [EgeOnder](https://github.com/EgeOnder) | 40398628+EgeOnder@users.noreply.github.com | [@EgeOnder23](https://twitter.com/EgeOnder23) | +| [kaandesu](https://github.com/kaandesu) |