Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify paho version & fix typo #1146

Merged
merged 6 commits into from
Mar 27, 2024
Merged

docs: clarify paho version & fix typo #1146

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2b5956c
docs: clarify paho-mqtt version
GavinZhengOI Mar 21, 2024
bdbd07a
docs: fix typo
GavinZhengOI Mar 21, 2024
23b4541
Merge branch 'master' into patch-3
derberg Mar 25, 2024
5f294d1
Update docs/generator-template.md
Florence-Njeri Mar 25, 2024
349bf13
Merge branch 'master' into patch-3
Florence-Njeri Mar 26, 2024
aa934a3
Merge branch 'master' into patch-3
Florence-Njeri Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/generator-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ class TemperatureServiceClient:
self.client.publish(topic, id)
```

Make sure you have the Paho-MQTT library installed. You can install it using pip with the `pip install paho-mqtt` command.
Make sure you have the Paho-MQTT library installed. You can install it using pip with the `pip install paho-mqtt==1.6.1` command. Please note that this tutorial is based on Paho-MQTT version 1.6.1. The Paho-MQTT library has since been updated to version 2.0.0, which includes changes that are not covered in this tutorial. To ensure compatibility and to follow along without any issues, please install version 1.6.1 of the Paho-MQTT library.

Let's break down the previous code snippet:

1. Imports the MQTT module from the Paho package, which provides the MQTT client functionality.
Expand Down Expand Up @@ -331,7 +332,7 @@ Generator Error: This template requires the following missing params: server.
Update your `test:generate` script in **package.json** to include the server param

```json
test:generate": "asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ --output test/project --force-write --param server=dev"
"test:generate": "asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ --output test/project --force-write --param server=dev"
```

You can now replace the static broker from `mqttBroker = 'test.mosquitto.org'` to `mqttBroker = "${asyncapi.servers().get(params.server).url()}"` in **index.js**.
Expand Down
Loading