Skip to content
Draft
Changes from 4 commits
Commits
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
48 changes: 48 additions & 0 deletions content/about_documentation/test-text.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Step-by-step guide for MQTT Service device connection

1. Make sure the MQTT Service is available
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use direct imperative voice instead of 'make sure'. Consider: 'Verify that MQTT Service is available'

Copilot uses AI. Check for mistakes.
First, check that all prerequisites are fulfilled. Check if MQTT Service is already available for your Cumulocity tenant.

For that, navigate to **Administration** → **Ecosystem** → **Microservices** in your tenant.
Filter or look for Mqtt-service and Messaging-management.

Here we go, MQTT-Service & Messaging-management are installed.

2. Install management UI
Now we should make sure to install the new Management UI for MQTT Service and Notification 2.0.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uses first person ('we') which violates the style guide. Should use direct imperatives or second person. Consider: 'Install the new Management UI for MQTT Service and Notification 2.0.'

Copilot uses AI. Check for mistakes.

You can find it on the user menu when clicking on your user profile in the top right. Select Manage beta features in the section Beta features.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UI elements should be formatted in bold and use direct commands. Consider: 'Find it on the user menu by clicking your user profile in the top right. Select Manage beta features in the Beta features section.'

Copilot uses AI. Check for mistakes.

Toggle the Messaging service-monitoring & management

After an automated refresh, you should see a new Monitoring Navigation point to enter the management UI.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UI elements should be formatted in bold. Consider: 'After an automated refresh, you should see a new Monitoring navigation point to enter the management UI.'

Copilot uses AI. Check for mistakes.

3. Select the right MQTT device
Now we are ready to connect a device via MQTT. There are plenty of MQTT devices out there.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uses first person ('we are') which violates the style guide. Consider: 'You are now ready to connect a device via MQTT. There are many MQTT devices available.'

Copilot uses AI. Check for mistakes.

Physical device
Normally, you would select a physical device. The easiest ones already have an MQTT client embedded, and you just need to configure the broker.

There are plenty of examples of devices like smart cameras, smart gateways, PLCs, and many more.

Alternatively, you can also build your own device like using an ESP32 and attaching any sensor.
With that, you can connect to MQTT Service: https://esphome.io/components/mqtt.html

Please note: Be aware of the current limitations of MQTT Service, which could result in your device being unable to connect, such as:

Last Will Retained Message - results in the device being rejected
Clean Session / Clean Start must be set to true - otherwise, the device is rejected
Simulators
If you don’t have a physical device at hand, you can also use simulators to publish data to MQTT Service.

For example, you can use a nodeRED flow to generate data and publish it to MQTT Service, e.g., check out this simple flow
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace 'e.g.' with 'for example' and add proper punctuation: 'For example, you can use a nodeRED flow to generate data and publish it to MQTT Service. For example, check out this simple flow.'

Copilot uses AI. Check for mistakes.

Another example could be a small Python script to generate data and publish it to MQTT.

Here is an example:
https://github.com/DamascenoRafael/mqtt-simulator

MQTT client
Also, of course, you can just use any MQTT Client like MQTTx, connect manually to MQTT Service, and publish messages or subscribe on topics.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove filler words 'Also, of course' and 'just'. Use direct language: 'You can use any MQTT Client like MQTTx, connect manually to MQTT Service, and publish messages or subscribe to topics.'

Copilot uses AI. Check for mistakes.

In this guide, I will demonstrate connecting using an MQTT Client and a Device Simulator.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uses first person ('I will') which violates the style guide. Consider: 'This guide demonstrates connecting using an MQTT client and a device simulator.'

Copilot uses AI. Check for mistakes.