adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: samples: net: mqtt: improve formatting

Browse source 
use code literal formatting for KConfig identifiers

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-06-18 14:59:50 +02:00 committed by Anas Nashif
parent f6db733f4a
commit bd73073708
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
samples/net/cloud/mqtt_azure/README.rst
View file

@ -38,23 +38,23 @@ copied from `<https://github.com/Azure/azure-iot-sdk-c/blob/master/certs/certs.c
Configure the following Kconfig options based on your Azure Cloud IoT Hub
in your own overlay config file:
- SAMPLE_CLOUD_AZURE_USERNAME - Username field use::
- ``SAMPLE_CLOUD_AZURE_USERNAME`` - Username field use::
{iothubhostname}/{device_id}/?api-version=2018-06-30,
where ``{iothubhostname}`` is the full CName of the IoT hub.
- SAMPLE_CLOUD_AZURE_PASSWORD - Password field, use an SAS token.
- SAMPLE_CLOUD_AZURE_CLIENT_ID - ClientId field, use the deviceId.
- SAMPLE_CLOUD_AZURE_HOSTNAME - IoT hub hostname
- SAMPLE_CLOUD_AZURE_SERVER_ADDR - IP address of the Azure MQTT broker
- SAMPLE_CLOUD_AZURE_SERVER_PORT - Port number of the Azure MQTT broker
- ``SAMPLE_CLOUD_AZURE_PASSWORD`` - Password field, use an SAS token.
- ``SAMPLE_CLOUD_AZURE_CLIENT_ID`` - ClientId field, use the deviceId.
- ``SAMPLE_CLOUD_AZURE_HOSTNAME`` - IoT hub hostname
- ``SAMPLE_CLOUD_AZURE_SERVER_ADDR`` - IP address of the Azure MQTT broker
- ``SAMPLE_CLOUD_AZURE_SERVER_PORT`` - Port number of the Azure MQTT broker
You'll also need to set these Kconfig options if you're running
the sample behind a proxy:
- SAMPLE_SOCKS_ADDR - IP address of SOCKS5 Proxy server
- SAMPLE_SOCKS_PORT - Port number of SOCKS5 Proxy server
- ``SAMPLE_SOCKS_ADDR`` - IP address of SOCKS5 Proxy server
- ``SAMPLE_SOCKS_PORT`` - Port number of SOCKS5 Proxy server
On your Linux host computer, open a terminal window, locate the source code
of this sample application (i.e., :zephyr_file:`samples/net/cloud/mqtt_azure`) and type: