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.

Sign up for GitHub

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

Jump to bottom

Cleaner version and Tested with other boards #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Cleaner version and Tested with other boards #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c15a65c
Fix/Remove Comments and Add new ports
Jun 30, 2022
e2b8e79
Add config.h and Remove test/debug comments
Jun 30, 2022
f317031
Add/Fix header comment block and fix markdown readme
Jun 30, 2022
70ac3b1
Update Readme.md
Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 21 additions & 156 deletions EspSerialPassthrough.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,109 +1,39 @@
/*
EspSerialPassthrough v1.0
ESP8266 / ESP-01 Serial Passthrough for flashing using Arduino SAMD MCU

This Arduino sketch allows you to send AT commands, watch bootloader messages, or flash an ESP-01/ESP8266 through a SAMD21/SAMD51 or similar MCU.
The MCU should be operating at 3.3V, if not, voltage level shifters must be used on the connections to ESP.
The program might also work on other ESPs, but have only been tested with ESP8266 in the form of a ESP-01 board.
/***********************************************************************

EspSerialPassthrough v1.0
ESP8266 / ESP-01 Serial Passthrough for flashing using Arduino SAMD MCU

Developed and tested with a Arduino MKR board, SAMD21-based.
The program might work on MCUs without native USB, but no guarantees! :-)

Sending AT commands has been tested using the Arduino serial monitor, Visual Micro serial monitor and Putty in serial mode.
The same goes for watching bootloader output.
Firmware upgrade/flashing has been done with the official ESP8266 Flash Download Tool from https://www.espressif.com/en/support/download/other-tools,
with firmware downloaded from https://www.espressif.com/en/support/download/at

This Arduino sketch allows you to send AT commands, watch bootloader messages, or flash an ESP-01/ESP8266 through a SAMD21/SAMD51 or similar MCU.
The MCU should be operating at 3.3V, if not, voltage level shifters must be used on the connections to ESP.
The program might also work on other ESPs, but have only been tested with ESP8266 in the form of a ESP-01 board.

Developed and tested with a Arduino MKR board, SAMD21-based.
The program might work on MCUs without native USB, but no guarantees! :-)

Sending AT commands has been tested using the Arduino serial monitor, Visual Micro serial monitor and Putty in serial mode.
The same goes for watching bootloader output.
Firmware upgrade/flashing has been done with the official ESP8266 Flash Download Tool from https://www.espressif.com/en/support/download/other-tools,
with firmware downloaded from https://www.espressif.com/en/support/download/at

Copyright 2021 Kåre Smith (Kaare Smith)

This code is licensed under the Apache License, Version 2.0 (the "License");

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

*/

// Arduino SAMD MCUs have native USB, but others might have native USB as well. If so: define HAVE_NATIVEUSB manually
#ifdef SERIAL_PORT_USBVIRTUAL
#define HAVE_NATIVEUSB
#define SERIAL_WRITE_BUFFER_SIZE 16384
#else
#define SERIAL_WRITE_BUFFER_SIZE 64
#endif

// Baud rates used for ESP8266 Serial port
#define BOOTLOADER_BAUD 74880 // Used when ESP8266 is in bootloader, for instance crashing after a failed flash of firmware, and in the first second or two after boot
#define AT_MODE_BAUD 115200 // Used when in AT command mode (I have read that some ESP8266 use 9600 baud in AT mode...)
#define FLASH_MODE_BAUD 115200 // Used when in firmware flashing mode

// Set PASSTHROUGH_MODE to AutoMode, AtCommandsMode, BootloaderMode or FlashingMode
//#define PASSTHROUGH_MODE AtCommandsMode
//#define PASSTHROUGH_MODE BootloaderMode
//#define PASSTHROUGH_MODE FlashingMode
// This controls baudrate and how the pins on the ESP8266 is set
#ifndef PASSTHROUGH_MODE
#ifdef HAVE_NATIVEUSB
#define PASSTHROUGH_MODE AutoMode // Automatic switch between modes
#else
// If not native USB: default to AtCommandsMode
#define PASSTHROUGH_MODE AtCommandsMode
#endif
#endif
***********************************************************************/

// AutoMode is only for devices with native USB, like Arduino Zero, Arduino MKR and compatibles (SAMD21/SAMD51 MCU), since DTR and RTS signals is vital.
// In AutoMode, baud rate switching is supported using the ESP flash tool, hence on a SAMD21, flashing can be done at speeds up to 1500000 (1.5Mbit/s).
// In FlashingMode, a fixed baudrate is used to the ESP, and the ESP flash download tool MUTS be set to the same baud rate.
#include "config.h"

// If serial port on MCU used to connect to PC (even if connecting through a USB serial adapter):
// It is best that USB baud towards PC matches the baudrate of the ESP8266, but when using it to see bootloader messages or test AT commands this isn't important
// since the serial buffers will not overflow. Having a fixed baudrate to the PC, makes it easier by not having to change baudrate in Putty (or other terminal emulator).
// When flashing ESP8266 firmware, it could be more important that the baudrate from PC to MCU is equal to the baudrate used from the MCU to the ESP8266.
// Native USB connection to PC:
// If using a Arduino board with native USB, like Arduino Zero or MKR series, the baud rate isn't important, since virtual serial transfers is at the native USB bus speed.
unsigned long pcUsbBaud = 115200;


enum PassthroughMode {
AtCommandsMode // Locked to AT mode
,BootloaderMode // Locked to bootloader mode
,FlashingMode // Locked to flashing mode
#ifdef HAVE_NATIVEUSB
,AutoMode // Start in AT command mode, but enter flash mode, if esptool/espressif flash download tool connects.
#endif
};
// In Auto mode, USB serial DTR and RTS is controlling GPIO0 and CH_PD (EN) pins om ESP.

// Set Passthrough mode from defined mode
PassthroughMode passthroughMode = PASSTHROUGH_MODE;

// Sets ESP baudrate to AT_MODE_BAUD, BOOTLOADER_BAUD or FLASH_MODE_BAUD according to mode.
uint32_t espBaud = passthroughMode == AtCommandsMode ? AT_MODE_BAUD : passthroughMode == BootloaderMode ? BOOTLOADER_BAUD : FLASH_MODE_BAUD;

// Serial1 is the physical serial port on the Arduino MKR series boards (and compatible boards)
#define esp8266 Serial1

// The pin used on the Arduino board. Important: must be 3.3V GPIO pins, or use voltage level shifter
#define CH_PD_PIN 8 // Arduino pin connected to CH_PD (sometimes marked EN) pin on ESP8266
#define GPIO0_PIN 9 // Arduino pin connected to GPIO0 pin on ESP8266
#define RESET_PIN 10 // Arduino pin connected to RESET pin on ESP8266
// Arduino GND is connected to ESP GND
// Arduino VCC (3.3V) is connected to ESP8266 3V3
// Arduino TX is connected to ESP8266 RX
// Arduino RX is connected to ESP8266 TX
// ESP8266 GPIO2 is left unconnected

// Definitions from ESP flashing tool esptool.py
#define SLIP_END 0xC0
#define ESP_SYNC 0x08
#define ESP_CHANGE_BAUDRATE 0x0F

static bool gpio0Pin = true;
static bool gpio0PinBefore = true;
static bool chPdPin = true;
Expand Down Expand Up @@ -459,69 +389,4 @@ void enterAtMode() {
digitalWrite(CH_PD_PIN, LOW);
delay(300);
digitalWrite(CH_PD_PIN, HIGH);
}

/*
// List version information
AT+GMR
AT version:1.1.0.0(May 11 2016 18:09:56)
SDK version:1.5.4(baaeaebb)
compile time:May 20 2016 15:08:19
OK

// After upgrade:
AT+GMR
AT version:1.7.4.0(May 11 2020 19:13:04)
SDK version:3.0.4(9532ceb)
compile time:May 27 2020 10:12:17
Bin version(Wroom 02):1.7.4
OK


// List mode: 1 = Station mode, 2 = Access point mode, 3 = Both station and access point
AT+CWMODE?
+CWMODE:2

OK

// Set combined accesspoint and station (client) mode
AT+CWMODE=3

OK
// List networks
AT+CWLAP

AT+CWLAP
+CWLAP:(3,"Get-2G-A4948D",-87,"98:1e:19:a4:94:92",1,-26,0)
+CWLAP:(4,"Lars_Anette",-84,"70:b1:4e:7d:26:d9",1,-46,0)
+CWLAP:(3,"DIRECT-53-HP M281 LaserJet",-42,"2e:6f:c9:46:3d:53",6,-32,0)
+CWLAP:(3,"HP-Print-7C-Officejet Pro 6830",-85,"64:51:06:ba:ad:7c",6,-21,0)
+CWLAP:(3,"SMITH",-36,"58:cb:52:b9:7f:bc",6,0,0)
+CWLAP:(3,"SMITHX",-35,"5a:cb:52:b9:7f:bc",6,0,0)
+CWLAP:(3,"Ryums vei",-86,"f0:72:ea:4f:40:42",6,0,0)
+CWLAP:(3,"skynet",-80,"88:41:fc:ab:88:d7",6,-17,0)
+CWLAP:(3,"MaxVirus 2",-83,"98:1e:19:a3:9c:58",11,-17,0)
+CWLAP:(3,"NTGR_VMB_3127449426",-88,"a4:11:62:5a:cb:d2",11,-12,0)
+CWLAP:(3,"SMITH",-63,"58:cb:52:b9:77:66",11,-4,0)
+CWLAP:(3,"SMITHX",-63,"5a:cb:52:b9:77:64",11,-4,0)
+CWLAP:(3,"skynet",-85,"88:41:fc:ab:88:d3",11,-29,0)


//Bootloader messages (will vary with firmware version and ESP-variant):
ets Jan 8 2013,rst cause:4, boot mode:(3,7)

wdt reset
load 0x40100000, len 27728, room 16
tail 0
chksum 0x2a
load 0x3ffe8000, len 2124, room 8
tail 4
chksum 0x07
load 0x3ffe8850, len 9276, room 4
tail 8
chksum 0xba
csum 0xba
�rlL�
ready

*/
}
25 changes: 0 additions & 25 deletions EspSerialPassthrough.sln
View file
Open in desktop

This file was deleted.

Loading