Added some documentation.

README.md

@@ -1,58 +1,60 @@
-Eggduino
+# Der Sternenlabor EggBot
-====
+* Basiert auf EggDuino mit folgenden Anpassungen
+   * portiert auf ESP32
+   * Bessere Stepper Library
+   * Einfache Bahnplanung (weniger Verzerrungen)
+   * Stift Servo mit Rampensteuerung
+   * Webinterface für Logging und Einstellungen (Anschlussbelegung)
+   * BLE Interface (http://Eggbot.app)
+   * Web Socket Interace (aktuell ungetestet)
+   * RS232 Kommunikation mit 115200 (zuvor 9600)
+* Inkscape Plugin AxiDraw_395 (siehe GIT)
+   * Modifizierte ebb_serial.py zur Erkennung 
+   * Modifizierte eggbot.py - entfernt Pausen zwischen Bewegungen
+* Verwendung ohne Inkscape mittels http://EggBot.app
 
-Arduino Firmware for Eggbot / Spherebot with Inkscape-Integration
+Ohne angepasstes Inkscape Plugin kann keine Kommunikation zum EggBot aufgenommen werden.
 
-Version 1.6a
+# Materialliste
-tested with Inkscape Portable 0.91, Eggbot Extension and patched eggbot.py
 
-Regards: Eggduino-Firmware by Joachim Cerny, 2015
+Schrauben:
+* Motor Welle Ei: M3x8
+* Motorbefestigung: 8x M3x10
+* Motor Welle Stift: M3x12
+* Klemme für Eihalterung: 2x M3x16
+* Spannschraube Stift: M3x25
+* Armgelenk: M3x30
+* Mutter: 4x M3 **vierkant!**
+* Platine Schrauben: 4x M2.3x5
+* Schrauben für Feder: 2x M2.3x5
+* Scheiben für Feder: 2x M3x6x0.5
 
-Thanks for the nice libs ACCELSTEPPER and SERIALCOMMAND, which made this project much easier. Thanks to the Eggbot-Team for such a funny and enjoyable concept! Thanks to my wife and my daughter for their patience. :-)
+Sonstiges:
+* Zugfeder: 8x17 (entspannt)
+* O-Ring: 3x 18x2
+* Kugellager: 608ZZ (8x22x7)
 
-Features:
+Elektronik:
+* 2x Schrittmotor Nema 17 (200 Schritte/Umd.)
+* 2x Anschlusskabel
+* 1x Micro Servo
+* 1x CNC Shield (z.B. AZDelivery)
+* 2x Schrittmotor Treiber DRV8825
+* 1x ESP32 Arduino UNO Formfaktor
+* 1x Netzteil 12V min. 1A
+* 1x Micro USB Kabel
 
-- Implemented Eggbot-Protocol-Version 2.1.0
+3D-Druckteile: https://www.thingiverse.com/thing:3431363 (hoffentlich bald in unserem GIT)
-- Turn-on homing: switch-on position of pen will be taken as reference point.
-- No collision-detection!!
-- Supported Servos: At least one type ;-) I use Arduino Servo-Lib with TG9e- standard servo.
-- Full Arduino-Compatible. I used an Arduino Uno
-- Button-support (3 buttons)
 
-Tested and fully functional with Inkscape.
+# Elektronik
+Damit der ESP32 mit angeschlossenem CNC Shield korrekt funktioniert. Muss zwischen Enable und GND ein 1k Widerstand eingelötet werden.
+ ![CNC Mod](res/cnc-shield-mod.png)
 
-Installation:
+## Anschlussbelegung
-
+* Ei-Drehen Stepper: Y
-- Upload Eggduino.ino with Arduino-IDE or similar tool to your Arudino (i.e. Uno)
+* Stift-Bewegen Stepper: X
-- Disable Autoreset on Arduinoboard (there are several ways to do this... Which one does not matter...)
+* Servo Ctrl Pin: Z-Step
-- Install Inkscape Tools wit Eggbot extension. Detailed instructions: (You yust need to complete Steps 1 and 2)
+* USB Versorgung an ESP32 UNO (nötig)
-http://wiki.evilmadscientist.com/Installing_software
+* 12V Netzteil an CNC Shield (nicht ESP32 UNO Buche)
-
-- Because of an bug in the Eggbot-extension (Function findEiBotBoards()), the Eggduino cannot be detected by default.
-	Hopefully, the guys will fix this later on. But we can fix it on our own.
-    It is quiete easy:
-	
-        - Go to your Inkscape-Installationfolder and navigate to subfolder .\App\Inkscape\share\extensions
-		- open File "eggbot.py" in texteditor and search for line:
-			"Try any devices which seem to have EBB boards attached"
-                - comment that block with "#" like this:
-                		# Try any devices which seem to have EBB boards attached
-				# for strComPort in eggbot_scan.findEiBotBoards():
-				#	serialPort = self.testSerialPort( strComPort )
-				#	if serialPort:
-				#		self.svgSerialPort = strComPort
-				#		return serialPort
-		- In my version lines 1355-1360
- 
-
-## Setup
-Add credentials.h file with content like this:
-
-    const char *kWifiSsid = "MySSID";
-    const char *kWifiPassword = "MySecret";
-
-To disable Wifi:
-
-    const char *kWifiSsid = 0;
-    const char *kWifiPassword = 0;
 
+Falls von der Anschlussbelegung abgewichen wird, muss die geänderte Belegung über das Webinterface angepasst werden.