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

Proposal to make documentation easier to understand #15

Open
ericvb opened this issue Jun 6, 2022 · 1 comment
Open

Proposal to make documentation easier to understand #15

ericvb opened this issue Jun 6, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ericvb
Copy link

ericvb commented Jun 6, 2022

I was put on the wrong track when reading this part of the documentation.
Easy changes
You can change the AP's SSID and password-protect it by changing the values in include/global_config.h. You can also change the GPIO that connects to the REM pin of the Hunter system (by default, GPIO16 / D0).

I didn't work yet with a D1 mini pro and didn't have pre-knowledge about the used WifiManager library and his http GUI interface (example: https://randomnerdtutorials.com/wifimanager-with-esp8266-autoconnect-custom-parameter-and-manage-your-ssid-and-password/)
So I thought that I could put here my home AP SSID and password directly. But it didn't work.
I figured out by our Google friend that these parameters where only for changing the SSID name of the WifiManager own open wifi access point and to protect it with a password. Nothing to do with the own home wifi-network parameters.

My mistake of course, lack of knowledge, but to help future users to not make the same mistake, maybe adapt the documentation like this?

Try it yourself
Download this project and upload it to your board. Afterwards, connect the microcontroller to the SmartPort (see how in the docs folder).

The first time you power it, by default a "WateringSystemAP" open unprotected WiFi access point will be created. Connect to it and your phone will ask to "sign-in". Click on the notification and follow the steps to connect to your home WiFi. If nothing happens when you connect to the AP, navigate to 192.168.4.1.
You can change this default open unprotected WiFi access point by adapting the AP's SSID "WateringSystemAP" to a name of your choice and password-protect it by changing the values in include/global_config.h

When the board is connected to your home router, you will have an easy to use HTTP API (endpoints in the docs folder).

Easy changes
In the same include/global_config.h as above, you can also change the GPIO that connects to the REM pin of the Hunter system (by default, GPIO16 / D0).

@ecodina
Copy link
Owner

ecodina commented Jun 7, 2022

Thanks! I don't have access to my usual laptop for a few days, but will improve the documentation.

@ecodina ecodina added the documentation Improvements or additions to documentation label Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants