adafruit / adafruit/Adafruit_CircuitPython_ESP_ATcontrol

Documentation Update: Release 0.10.x breaks ESP8266 chips with AT+CIPSTATE

Open Beginner friendly
#69 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
20
Forks
16
PR merge metrics
No merged PRs in 30d

Description

I couldn't find this documented anywhere and it took some digging through the codebase to figure it out. To save others the headache, if you're using this version of the library with an ESP8266, you must set `use_cipstatus=True` when initializing `ESP_ATcontrol`. If this could be added to the RTD documentation that would be super helpful.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the RTD documentation for ESP_ATcontrol initialization and the section covering ESP8266 or release 0.10.x. Document that ESP8266 users must set `use_cipstatus=True` when initializing `ESP_ATcontrol`; the work is done when this requirement is easy to find in the published documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.