Skip to content
This repository was archived by the owner on Dec 14, 2021. It is now read-only.

Commit deefdb7

Browse files
committed
doc: Add screenshot of console
1 parent eaaabc5 commit deefdb7

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

DOCUMENTATION.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@
1919

2020
## Description
2121

22-
This package provides you an easy way to connect to The Things Network via MQTT. Take note that, you'll first need to create an application with a device to run the constructor of the MQTT client because you need to provide, an applicationID and a deviceID.
23-
First include the package in your file like this:
22+
This package provides you an easy way to connect to The Things Network via MQTT. First include the package in your file like this:
2423
```python
2524
from ttnmqtt import MQTTClient as mqtt
2625
```
@@ -32,9 +31,10 @@ The class constructor can be called following this scheme:
3231
mqtt(appID, appAccessKey, [mqttAddress])
3332
```
3433
- `appID`: **string** this the name you gave your application when you created it.
34+
![Screenshot of the console with app section](./images/app-console.png?raw=true)
3535
- `appAccessKey`: **string** it can be found at the bottom of your application page under **ACCESS KEYS**.
36-
- `mqttAddress`: **string** this the address of the handler to which your application was registered. If you registered to a personnal or private handler, please provide the address, if not you don't need to provide this argument. Please make sure you also give the port number when providing the mqttAddress.
37-
All the above informations can be found in your The Things Network console.
36+
![Screenshot of the console with accesskey section](./images/accesskey-console.png?raw=true)
37+
- `mqttAddress`: **string** this the address of the handler to which your application was registered.
3838
The constructor returns an **MQTTClient object** set up with your application informations, ready for connection.
3939

4040
### connect

images/accesskey-console.png

19.4 KB
Loading

images/app-console.png

35.1 KB
Loading

0 commit comments

Comments
 (0)