salfter/WifiModem
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
David Hansel
2018-11-12 20:57:48 -05:00
committed by GitHub
parent 74a1762af7
commit e8885521d9
1 changed files with 45 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@@ -25,7 +25,7 @@ to adapt the wiring for other versions.
![ESP8266](/images/ESP8266-Pinout.png) ![ESP8266](/images/ESP8266-Pinout.png)
Pin | Name | Wire to Pin | Name | Wire to
--------------------------------------- ----|-------|--------------------------
1 | GND | Ground 1 | GND | Ground
2 | TX | RX (serial input) of connected device 2 | TX | RX (serial input) of connected device
3 | GPIO2 | --> LED --> 150+ Ohm Resistor --> Ground 3 | GPIO2 | --> LED --> 150+ Ohm Resistor --> Ground
@@ -35,6 +35,12 @@ Pin | Name | Wire to
7 | RX | TX (serial output) of connected device 7 | RX | TX (serial output) of connected device
8 | VCC | +3.3V 8 | VCC | +3.3V
The LED on pin 3 (GPIO2) is not required but helpful since it displays the WiFi
connection status: Off means "not connected", Blinking means "connecting", On means "connected".
If you would like to be able to reset the module without turning off power then
connect pin 6 (RESET) via a pushbutton to ground (keep the resistor though).
## Initial setup ## Initial setup
Initial setup (i.e. connecting to the WiFi network) is done via the serial connection. Initial setup (i.e. connecting to the WiFi network) is done via the serial connection.
@@ -46,3 +52,41 @@ After the information is entered, the module will attempt to connect to the netw
and display its IP address if successful. The module is now fully active, using and display its IP address if successful. The module is now fully active, using
9600 baud 8N1 on the serial port. To change the serial parameters, connect to 9600 baud 8N1 on the serial port. To change the serial parameters, connect to
the module's web server (see below). the module's web server (see below).
## Changing the WiFi network connection
Once the WiFi setup is completed, the module will automatically attempt to re-connect
to the network when it boots up. The LED will blink while connecting. If a connection
can not be established, the module automatically goes into network configuration mode
(same as during initial setup).
If you wish to re-configure the WiFi network (i.e. select a different network), send
an ESC (27) character over the serial port while the module is attempting to connect.
Doing so will cause the module to go into network configuration mode.
Note that network configuration is ALWAYS done at 9600 baud, 8N1 regardless of what
the WiFi parameters were set to before.
## Configuring the serial connection
By default the module uses 9600 baud 8N1 on its serial connection. To modify the serial
parameter, the module provides a (minimal) web server on port 80. After the module
connects to WiFi it will display its IP address on the serial port. Using a web
browser, connect to that address (port 80).
The following options can be configured:
- Baud rate: a number of pre-defined baud rates are given. You can set a custom
rate by going to the following URL: http://[module-ip-address]/set?baud=[rate]
where "rate" is the desired baud rate.
- Data bits (5-8)
- Parity (none, even, odd)
- Stop bits (1 or 2)
- Show WiFi connection information: enable or disable whether or not the module
will send out it's IP address on the serial connection after booting up.
- Telnet negotiation: the Telnet protocol includes a negotiation protocol to
agree on some terminal options. The module can either handle this for you
in a very basic way (will basically say "no" to any requested option) or pass
the negotiation through to the device connected on the serial port.
Not handling the Telnet negotiation may show some weird characters when connecting
some BBSs. Some may also stop communicating at all after connecting.