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

Document connecting popular gateways #1140

Closed
15 of 25 tasks
johanstokking opened this issue Aug 12, 2019 · 16 comments
Closed
15 of 25 tasks

Document connecting popular gateways #1140

johanstokking opened this issue Aug 12, 2019 · 16 comments
Assignees
Labels
documentation This involves writing user documentation umbrella This issue needs actionable issues referenced
Milestone

Comments

@johanstokking
Copy link
Member

johanstokking commented Aug 12, 2019

Summary

Document connecting popular gateways

Why do we need this?

For people to know how to connect their gateway using official documentation, on a per-gateway model basis

What is already there? What do you see now?

No documentation

What is missing? What do you want to see?

Documentation for phase 1 (UDP-based gateways):

Documentation for phase 2 (Basic Station gateways):

Documentation for phase 3 (existing gateways that are getting Basic Station support):

  • Cisco IXM with Basic Station
  • MultiTech Conduit AEP with Basic Station
  • Laird Sentrius with Basic Station
  • Lorix One with Basic Station
  • Ursalink with Basic Station

For the UDP gateways (everything expect TTIG for now), please use the JSON configuration using GCS.

This is a URL that people need to build manually.

How do you propose to implement this?

  • Make sure you have a stock version of these gateways. If we don't have one, please let me know and we'll get one. You can also start with copying docs from https://www.thethingsnetwork.org/docs/gateways
  • Probably refer to a common section about creating a gateway and UDP configuration
  • Add a guide in the docs, one file for each gateway brand and/or model, depending on how it looks

Can you do this yourself and submit a Pull Request?

Will review

@johanstokking
Copy link
Member Author

Looped in @adriansmares for support as well. Please coordinate accordingly.

@johanstokking
Copy link
Member Author

Added Cisco IXM

@johanstokking
Copy link
Member Author

See also existing documentation on https://www.thethingsnetwork.org/docs/gateways/

This should act as a reference; that documentation has grown over time and does not follow one style or structure.

Please start with defining a style and structure and align all gateway documentation with that.

@KrishnaIyer
Copy link
Member

@adriansmares, @mjamescompton and @johanstokking:

@laurensslats
Copy link

@benolayinka can we revisit this list and see what gateway documentation we still want to add?

Suggesting to:

  • Look at the Kerlink documentation, we might be able to improve the quality
  • Tektelic gateways with Basics Station
  • RAK with UDP & Basics Station

@johanstokking
Copy link
Member Author

Please open issues specific for gateway models.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This involves writing user documentation umbrella This issue needs actionable issues referenced
Projects
None yet
Development

No branches or pull requests