particle-iot / particle-iot/docs
Particle.connect/disconnect docs suggestion
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
"In most cases, you do not need to call Particle.connect(); it is called automatically when the device turns on. Typically you only need to call Particle.connect() after disconnecting with Particle.disconnect() or when you change the system mode."
My understanding now is that you must call Particle.disconnect() and Particle.connect() if you expect firmware updates to occur automatically from a corporate dashboard. In addition, it does sound like you need a minimum time of being disconnected in order for a connect to work properly. If I'm understanding this correctly, you may need to document that as well.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the quoted Particle.connect()/Particle.disconnect() guidance and the linked community discussion. Confirm whether corporate-dashboard firmware updates require disconnecting and reconnecting, including any minimum disconnect interval, then update the relevant documentation and ensure the guidance is consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100