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.

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

Clarify MQTT tenant-id usage for TTN V3 #280

Closed
mtxgithub opened this issue Mar 23, 2021 · 1 comment
Closed

Clarify MQTT tenant-id usage for TTN V3 #280

mtxgithub opened this issue Mar 23, 2021 · 1 comment
Assignees
Milestone

Comments

@mtxgithub
Copy link

Summary

The Documentation for MQTT can be misleading about required tenant-id usage for TTN V3.
Adding some info can clarify it.

Why do we need this ?

Easier to understand on first usage; background in the Forum:
https://www.thethingsnetwork.org/forum/t/downlink-formatter/45359/8

What is already there? What do you see now?

https://www.thethingsindustries.com/docs/integrations/mqtt/

What is missing? What do you want to see?

MQTT Server -> "Multi-Tenancy"

"Note that on multi-tenant environments such as Cloud, application IDs and other endpoints include the tenant ID, e.g app1@tenant1. On single tenant environments such as Open Source, the tenant ID can be removed, i.e app1."

"tenant ID can be removed" is misleading if you read this for the first time, better add something like:
"The Things Network V3" requires including the tenant ID "@ttn"

"Integration with MQTT Clients":

"Eclipse Mosquitto":

(typo: replace /up by /push): in the example
mosquitto_pub -h "thethings. ... -t "v3/app1/devices/dev1/up" ....
(better mention the requirement of the tenant ID as well)

"Eclipse Paho":

Adopted the example / working would be this one (...adding the tenant-id again):

publish.single("v3/{application-id}@{tenant-id}/devices/{device-id}/down/push", '{"downlinks":[{"f_port": 15,"frm_payload":"vu8=","priority": "NORMAL"}]}', hostname="thethings.example.com", port=1883, auth={'username':"{application-id}@{tenant-id}",'password':"NNSXS.VEEBURF3KR77ZR.."})

How do you propose to document this?

mentioned above.

Can you do this yourself and submit a Pull Request?

no

@github-actions github-actions bot added the needs/triage We still need to triage this label Mar 23, 2021
@nejraselimovic nejraselimovic self-assigned this Mar 24, 2021
@nejraselimovic nejraselimovic added this to the 2021 Q1 milestone Mar 24, 2021
@nejraselimovic nejraselimovic added documentation and removed needs/triage We still need to triage this labels Mar 24, 2021
@nejraselimovic
Copy link
Contributor

Thank you for your contribution @mtxgithub!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants