Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mp-se committed Oct 2, 2023
1 parent d33a195 commit 43b4c91
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
12 changes: 12 additions & 0 deletions src_docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,18 @@ Just select a baud rate of 115200, 8N1.

.. _setup_wifi:

WIFI compatibility
==================

The esp has limited wifi support and still relies on old standards so these are a few things to consider on the wifi setup.

* Don't use space in your wifi SSID or wifi password
* Only supports 2.4Ghz bands, channels must be 1-13, other channels are not supported (In 802.11 b/g/n modes)
* Channels between 20-25 Mhz bands
* SSID must be visible (hidden SSID dont work)

Source: https://www.espressif.com/sites/default/files/esp8266_wi-fi_channel_selection_guidelines.pdf

Configuring WIFI
================

Expand Down
16 changes: 8 additions & 8 deletions src_docs/source/q_and_a.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ What does the messages in the error log mean

Check the format for your custom header. This means it has not a correct format.

What does the http error codes mean
-----------------------------------
HTTP error codes
----------------

All these errors are standard http error codes. This are the common ones;

Expand All @@ -118,10 +118,10 @@ All these errors are standard http error codes. This are the common ones;
* 403 - Forbidden. Could be an issue with token or URL.
* 404 - Not found. Probably a wrong URL.

What does the mqtt error codes mean
-----------------------------------
MQTT error codes
----------------

In some cases there can be negative error codes which have the following meaning:
MQTT connection errors:

* -1 - Connection refused
* -2 - Send header failed
Expand All @@ -136,7 +136,7 @@ In some cases there can be negative error codes which have the following meaning
* -11 - Read timeout
* -100 - Endpoint skipped since its SSL and the device is in gravity mode

* MQTT push on <topic> failed error
MQTT push on topic errors:

* -1 - Buffer to short
* -2 - Overflow
Expand All @@ -147,8 +147,8 @@ In some cases there can be negative error codes which have the following meaning
* -10 - Connection denied
* -11 - Failed subscription

What does the wifi error codes mean
-----------------------------------
WIFI error codes
----------------

* 1 - No SSID found.
* 4 - Connection failed.
Expand Down

0 comments on commit 43b4c91

Please sign in to comment.