Skip to content

Commit eb842f8

Browse files
luc-githubluc-github
committed
Create wiki source directory and github-action to sync with wiki
Move wiki images to wiki directory Move Readme images in images directory
1 parent 68c0c3a commit eb842f8

File tree

86 files changed

+695
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+695
-0
lines changed

‎.github/workflows/wiki.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Deploy Wiki
2+
3+
on:
4+
push:
5+
paths:
6+
# Trigger only when wiki directory changes
7+
- 'wiki/**'
8+
branches:
9+
# And only on main branch
10+
- 2.1.x
11+
12+
jobs:
13+
deploy-wiki:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
18+
- name: Push Wiki Changes
19+
uses: Andrew-Chen-Wang/github-wiki-action@v2
20+
env:
21+
# Make sure you have that / at the end. We use rsync
22+
# WIKI_DIR's default is wiki/
23+
WIKI_DIR: wiki/
24+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
GH_MAIL: ${{ secrets.MY_EMAIL }}
26+
GH_NAME: ${{ github.repository_owner }}
27+
EXCLUDED_FILES: "a/ b.md"

‎UI/repetier/testui.htm ‎archives/repetier/testui.htm

File renamed without changes.

‎images/sponsors-supporters/FYSETC/LOGO.png

19.4 KB
Loading

‎images/sponsors-supporters/FYSETC/fysetc2.svg

+69
Loading

‎images/sponsors-supporters/PanucattDevices/Panucatt.jpg

9.98 KB
Loading

‎images/sponsors-supporters/sponsor.PNG

1.59 KB
Loading

‎wiki/AZSMZ-mini-and-AZSMZ-lcd.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Where to connect ESP on AZSMZ-mini board
2+
![](https://github.com/luc-github/ESP3D/blob/master/images/AZSMZ-mini/AZSMZ-mini.jpg)
3+
4+
If you don't have the soldering skills to grab the connectors from the unpopulated ethernet connection, you can also get 3.3v and GND from the ISP header (bottom left on the diagram above).
5+
6+
# Where to connect ESP on AZSMZ lcd
7+
![](https://github.com/luc-github/ESP3D/blob/master/images/AZSMZ-mini/AZSMZ-12864-LCD.jpg)

‎wiki/Azteeg-X5-mini.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Where to connect ESP on Azteeg X5 mini
2+
![](https://github.com/luc-github/ESP3D/blob/master/images/AzteegX5-mini/azteeg.PNG)

‎wiki/BIQU-KFB2.0.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
## Where to connect on BIQU KFB2.0 (all in one Ramps1.4/Mega2560 R3 controller based)
2+
![](https://github.com/luc-github/ESP3D/blob/master/images/BIQU-KFB2.0/board.jpg)

‎wiki/Cheap-ESP-12F-based-serial-wifi-module.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
We can flash our loved ESP3D to cheap ESP-12F based serial wifi module (eg [from aliexpress](https://www.aliexpress.com/item/ESP8266-ESP-12F-Serial-WIFI-Wireless-Transceiver-Module-For-Arduino-ESP-12F-Adapter-Expansion-Board-For/32804504326.html) ). It contains built in 2way levelshifter/bi-directional logic level converter. So we can power and use via 5V uart from the 3d printers' motherboard.
2+
3+
* We need to manualy ground the ```IO0``` while powering up to start in flash mode while powering up (there is no switch for that, neither for reset)
4+
* ![wiring](https://i.imgur.com/GgirQpB.png)
5+
* I used FTDI adapter as usb2serial
6+
* We have to see in console/serial monitor boot mode is (*1*,7).
7+
* baudrate: 74880
8+
* ``` rst cause:2, boot mode:(3,7)```
9+
* Then flash like other esp based board for esp3d
10+
* [check flash size](https://github.com/luc-github/ESP3D/wiki/Flash-Size). Mine has 4M
11+
* [Install](https://github.com/luc-github/ESP3D/wiki/Install-Instructions)
12+
13+

‎wiki/Creality-CR-10-Ender-3.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
For the Sanguino based CR-10 and Ender printers you will need to solder to any of the via circled (can also be done in the backside of board), or to the legs of the Arduino or ftdi. Connect TX from the board to RX of Wemos D1 mini and RX from board to TX of Wemos D1 mini. 5v and GND are located in the six pin header next to the LCD connector.
2+
3+
![](https://i.imgur.com/2TFdjQh.jpg)
4+
5+
Since soldering might be difficult because the solder points are so close to each other, another option is to scrape off the insulation from the traces on the backside and solder there. Be extra careful not to scrape the surrounding ground plane. You need suitable fine scraping tools for this. The picture below shows an Ender-2 PCB.
6+
7+
![](https://user-images.githubusercontent.com/2480569/60397893-7df68c00-9b41-11e9-8286-e624623df3f2.jpg)

‎wiki/Creality-Ender-4.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
You will need to solder to small circle, or to the legs of the ATmega2560 (RXD0 pin 2, TXD0 pin 3)
2+
3+
![Ender 4](https://i.imgur.com/5gHKrrm.jpg)

‎wiki/D1-mini.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Two Methods for connecting the Wemos d1 mini
2+
_______________________________________________
3+
4+
connection Wemos d1 mini and Logic Level Converter:
5+
![](https://github.com/jayjojayson/ESP3D/blob/2.1/images/D1_mini/wemos-d1-mini_logic-level-converter.jpg)
6+
7+
example:
8+
![](https://github.com/jayjojayson/ESP3D/blob/2.1/images/D1_mini/wemos-d1-mini_logic-level-converter-2.jpg)
9+
10+
printed case:https://www.thingiverse.com/thing:4128593
11+
12+
_______________________________________________
13+
14+
connection Wemos d1 mini and Diode
15+
16+
connection:
17+
![](https://github.com/luc-github/ESP3D/blob/master/images/D1_mini/FB_IMG_1510306696875.jpg)
18+
19+
example:
20+
![](https://github.com/luc-github/ESP3D/blob/master/images/D1_mini/20171111_215253.jpg)
21+
22+
printed case:
23+
https://www.thingiverse.com/thing:2671591

‎wiki/Davinci-1.0-and-2.0-board.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Where to connect ESP on Davinci 1.0/2.0 board
2+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/davinci.png)
3+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/board.jpg)
4+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/boardconnected.jpg)
5+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/backside.jpg)
6+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/screen.jpg)
7+
#
8+
# Where to connect NodeMCU V3 on Davinci 1.0A board
9+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/davinciA-1.jpg)
10+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/davinciA-4.jpg)
11+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/davinciA-2.jpg)
12+
# Alternate Module placement for increased WiFi range (outside metal chassis, antenna has vertical polarization).
13+
![](https://github.com/luc-github/ESP3D/blob/master/images/Davinci/davinciA-3.jpg)

‎wiki/Direct-ESP3D-commands.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Direct commands:
2+
3+
* [v2.0](https://github.com/luc-github/ESP3D/blob/2.0/docs/Commands.txt)
4+
* [v2.1](https://github.com/luc-github/ESP3D/blob/2.1/docs/Commands.txt)
5+
* [v3.0](https://github.com/luc-github/ESP3D/blob/3.0/docs/Commands.txt)

‎wiki/ESP-01-serial-wifi-module.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
![](https://www.keyestudio.com/u_file/1901/products/11/ff587ce89a.jpg)
2+
more info about the Breakout PCB: https://www.keyestudio.com/keyestudio-esp-01s-wifi-to-serial-shield-module-for-arduino-esp8266-wifi-p0499-p0499.html
3+
4+

‎wiki/ESP-32-CAM.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Wiring ESP32 CAM
2+
Once the board is programmed, the wiring to the printer board should be like this:
3+
![ESP32 CAM connection diagram](https://user-images.githubusercontent.com/62440824/77234429-a7af8180-6bae-11ea-9121-d215436c38a2.png)
4+
5+
6+
note: this is not the only way to connect the board.
7+
* other values for the resistors could be used (always in the ratio 1:2)
8+
* could use a logic level coverter 5V - 3.3V (see [D1-mini wiki page](https://github.com/luc-github/ESP3D/wiki/D1-mini) )

‎wiki/ESP8266-01.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Wiring ESP01
2+
* Use GPIO2 to ground to reset all settings in hard way - 2-6 sec after boot / not before!! Set GPIO2 to ground before boot change boot mode and go to special boot that do not reach FW. Currently boot take 10 sec - giving 8 seconds to connect GPIO2 to GND and do an hard recovery for settings
3+
* Use GPIO0 to ground to be in update mode
4+
5+
![](https://github.com/luc-github/ESP3D/blob/master/images/HW/Wires.png)

‎wiki/ESP8266-12E-F.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Wiring ESP12E/F
2+
ESP need 3.3v, it is not 5v tolerant, if printer board use more than 3.3V like 5V on ramps.
3+
![](https://github.com/luc-github/ESP3D/blob/master/images/HW/WiresESP12E.png)
4+
5+
you can also use Logic LevelConverter Bi-Directional
6+
7+
![picture](https://github.com/luc-github/ESP3D/blob/master/images/HW/logic.PNG)
8+
9+
In order to flash some ESP12E/F boards via their UART interface, the following pins need to be connected:
10+
11+
* VCC to GPIO2
12+
* GND to GPIO0
13+
14+
This has been tested with ESP-12-E boards labeled "ESP8266 For ESP3D FYSETC.COM"

‎wiki/Email_and_SMTP.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
* Email Notification using SMTP and HTTPS
2+
`[ESP610]type=EMAIL T1=<token1> T2=<token2> TS=<settings>`
3+
4+
SMTP need several parameters:
5+
**token1** = ID to login to your email supplier
6+
**token2** = Password to login to your email supplier
7+
**settings** = the recipient#smtp server:port, where **#** and **:** are fields separators.
8+
for example `[email protected]#smtp.gmail.com:465`
9+
10+
1 - type the parameters:
11+
`[ESP610]type=EMAIL [email protected] T2=mypassword [email protected]#smtp.gmail.com:465`
12+
13+
2 - type `[ESP610]` to verify (T1 and T2 won't be displayed)
14+
15+
3 - Try to send message:
16+
[ESP600]Hi there, test from ESP3D
17+
18+
4 - **Important** : if you are using Gmail there is an additional as by default https access is disabled
19+
go to : https://myaccount.google.com/lesssecureapps and allow less secure applications to connect
20+
![](https://github.com/luc-github/ESP3D/blob/3.0/images/Notifications/Email/google.PNG)
21+
22+

‎wiki/Firmware--support.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## References
2+
3+
FW on Board | GCODE
4+
------------ | -------------
5+
Repetier | https://github.com/repetier/Repetier-Firmware/blob/master/src/ArduinoDUE/Repetier/Repetier.ino#L39-L151
6+
Repetier for Davinci | https://github.com/luc-github/Repetier-Firmware-0.92/blob/master/src/ArduinoDUE/Repetier/Repetier.ino#L39-L144
7+
Marlin | http://marlinfw.org/meta/gcode/
8+
Marlinkimbra |https://github.com/MagoKimbra/MarlinKimbra/blob/V4_2_9/Documentation/GCodes.md
9+
Smoothieware | http://smoothieware.org/supported-g-codes
10+
GRBL | https://github.com/gnea/grbl/wiki/Grbl-v1.1-Commands
11+
Reprap | https://duet3d.dozuki.com/Wiki/Gcode
12+
13+
***
14+
15+
## Temperature query
16+
17+
FW on Board | GCODE | Answer | Note | Supported ?
18+
------------ | ------------- | ------------- | ------------- | -------------
19+
Repetier | M105 | T:24.59 / 0 B:29.17 / 0 B@:0 @:0 T0:24.59 / 0 @0:0 T1:25.68 / 0 @1:0 | T and T0 are E0, T1 is E1, B is bed | Yes
20+
Marlin | M105 | ok T:25.8 /0.0 B:26.1 /0.0 T0:25.8 /0.0 T1:25.5 /0.0 @:0 B@:0 @0:0 @1:0 |T and T0 are E0, T1 is E1, B is bed | Yes
21+
MarlinKimbra | M105 | ok T:26.4 /0.0 B:26.3 /0.0 T0:26.4 /0.0 T1:26.3 /0.0 @:0 B@:0 @0:0 @1:0 |T and T0 are E0, T1 is E1, B is bed | Yes
22+
Smoothieware | M105 | ok T:25.6 /0.0 @0 T1:24.5 /0.0 @0 B:25.7 /0.0 @0 | T is E0, T1 is E1, B is bed | Yes
23+
GRBL| N/A | | | N/A
24+
Reprap | M105 | T:26.5 /0.0 B:24.8 /0.0 | | TBA
25+
26+
***
27+
## Position query
28+
29+
FW on Board | GCODE | Answer | Note | Supported ?
30+
------------ | ------------- | ------------- | ------------- | -------------
31+
Repetier | M114| X:0.00 Y:0.00 Z:0.000 E:0.0000 | | Yes
32+
Marlin | M114| X:0.00 Y:0.00 Z:0.00 E:0.00 Count X: 0 Y:0 Z:0 | | Yes
33+
MarlinKimbra | M114| X:0.00 Y:0.00 Z:0.00 E:0.00 Count X:0 Y:0 Z:0 | | Yes
34+
Smoothieware | M114| ok C: X:0.0000 Y:0.0000 Z:0.0000 E:0.000 | | Yes
35+
GRBL| ?| &lt;Idle&#124;MPos:10.000,0.000,0.000&#124;FS:0,0 &#124;Ov:71,100,147&gt; | | Yes
36+
Reprap | M114 | X:0.000 Y:0.000 Z:0.000 E0:0.0 E1:0.0 E2:0.0 Count 0 0 0 User 0.0 0.0 0.0 | | TBA
37+
38+
***
39+
40+
## SD Card file list
41+
42+
FW on Board | GCODE | Answer | Note | Supported ?
43+
------------ | ------------- | ------------- | ------------- | -------------
44+
Repetier | M20 | Begin file list<br>sample1.g 599<br>MYFOLDER/<br>End file list<br> | filename and size, folder name end with / | Yes
45+
Marlin | M20 | Begin file list<br>`CURA~1.GCO` <br>`/MYFOLDER/CURA~1.GCO` <br>End file list | only filename, folder name start with / | Yes
46+
MarlinKimbra | M20 | Begin file list<br>cura.gcode<br>MYFOLDER/<br>MYFOLDER/cura.gcode<br>End file list | only filename, folder name end with / | Yes
47+
Smoothieware | M20 | Begin file list<br>myfolder/<br>config.txt<br>End file list | only filename, folder name end with / | Yes
48+
GRBL| N/A| | | N/A
49+
Reprap | M20 S2 P/ | {"dir":"/","files":["*System Volume Information","*sys","AxholderV5.gcode","*folder1","*New folder","New Text Document.txt","test.g","test - Copy.g","*folder1 - Copy","license.txt"],"err":0} | folder start with *, JSON format | TBA
50+
51+
***

‎wiki/Flash-Size.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
The ESP8266 comes in various models:
2+
3+
configure your Arduino IDE -> Tools -> Boards as:
4+
5+
# Known working configs
6+
7+
### The latest ESP01 and ESP12Es come with 4Mb of flash: For those
8+
* Board: Generic ESP8266 Module
9+
* Flash Mode: DIO
10+
* Flash Frequency: 40Mhz
11+
* Flash Size: 4M (3M SPIFFS)
12+
* Debug Port: Disabled
13+
* Debug Level: None
14+
* Reset Method: CK
15+
* Upload Speed: 115200
16+
17+
### Some of the older devices come with 1M flash
18+
* Board: Generic ESP8266 Module
19+
* Flash Mode: DIO
20+
* Flash Frequency: 40Mhz
21+
* Flash Size: 1M (128K SPIFFS)
22+
* Debug Port: Disabled
23+
* Debug Level: None
24+
* Reset Method: CK
25+
* Upload Speed: 115200
26+
27+
### Though now no longer supported, it is possible to run the firmware on devices like the ESP07 with 512K of flash:
28+
* Board: Generic ESP8266 Module
29+
* Flash Mode: DIO
30+
* Flash Frequency: 40Mhz
31+
* Flash Size: 512k (128K SPIFFS)
32+
* Debug Port: Disabled
33+
* Debug Level: None
34+
* Reset Method: CK
35+
* Upload Speed: 115200
36+
37+
# Figuring out the Flash Size
38+
If you are unsure how much flash memory your particular module has. you can figure it out from the Arduino IDE:
39+
40+
1. Open the Arduino IDE
41+
2. Click File, Examples, ESP8266, CheckFlashConfig
42+
3. Upload the sketch to the ESP8266
43+
4. View the Serial Monitor (115200 baud)
44+
5. This compares what you have in Tools -> Board -> Flash Size to what is actually on the board...
45+
46+
For example
47+
`Flash real id: 001340C8`
48+
49+
`Flash real size: 524288`
50+
51+
52+
53+
`Flash ide size: 524288`
54+
55+
`Flash ide speed: 40000000`
56+
57+
`Flash ide mode: DIO`
58+
59+
`Flash Chip configuration ok.`
60+
61+
(NB: If you dont get a 'Flash Chip configuration ok.' uploading will appear to work succesfully but the chip will crash on startup and never show an access point / serial output)

‎wiki/Home.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Welcome to the ESP8266 wiki!
2+
3+
# Releases
4+
https://github.com/luc-github/ESP3D/releases
5+
6+
***
7+
8+
# Nice things done using ESP3D
9+
* [Rainmeter skin by @StArL0rd84](https://github.com/luc-github/ESP3D/wiki/Rainmeter-skin)
10+
11+
12+
***
13+
14+
check right menu for more
15+
16+
if you need to upload images to wiki please use [this](https://github.com/luc-github/ESP3D/issues/427) to upload them, so you can use them in wiki

0 commit comments

Comments
 (0)