Working on better Documentation

README.md

@@ -1,13 +1,15 @@
 
 # LinuxCNC_ArduinoConnector
+
+![Chip loves Arduino.](ArduinoChip.png)
 By Alexander Richter, info@theartoftinkering.com 2022  
 please consider supporting me on Patreon: https://www.patreon.com/theartoftinkering
 
-For my CNC Machine i wanted to include more IO's than my Mesa card was offering. This Projekt enables to connect Arduino to LinuxCNC to include as many IO's as you wish.
+This Projekt enables you to connect an Arduino to LinuxCNC and provides as many IO's as you could ever wish for.
 
-This Software is used as IO Expansion for LinuxCNC. Here i am using a Mega 2560.
+This Software is used as IO Expansion for LinuxCNC. I am using a Mega 2560.
 
-+++It is NOT intended for timing and security relevant IO's. Don't use it for Emergency Stops or Endstop switches!+++
+**It is NOT intended for timing and security relevant IO's. Don't use it for Emergency Stops or Endstop switches!**
 
 You can create as many digital & analog Inputs, Outputs and PWM Outputs as your Arduino can handle.
 You can also generate "virtual Pins" by using latching Potentiometers, which are connected to one analog Pin, but are read in Hal as individual Pins.
@@ -16,7 +18,7 @@ In LinuxCNC each LED is listed as one Output that can be set to HIGH and LOW. Fo
 This way, you can make them turn on or shut off or have them Change color, from Green to Red for example. 
 
 
-Currently the Software provides: 
+Currently the Software Supports: 
 - analog Inputs
 - digital Inputs
 - digital Outputs
@@ -31,23 +33,24 @@ For 2.8 however you have to change #!/usr/bin/python3.9 in the first line of ard
 
 
 # Installation
-- configure the Firmware file to your demands and flash it to your arduino
+1. configure the Firmware file to your demands and flash it to your arduino
-- connect the arduino to your LinuxCNC Computer via USB
+2. connect the arduino to your LinuxCNC Computer via USB
-- install python-serial
+3. install python-serial  
-    sudo apt-get install python-serial
+    '''sudo apt-get install python-serial'''  
-- edit arduino.py to match your arduino settings.
+4. edit arduino.py to match your arduino settings.
-- also check if the Serial adress is correct for your Arduino. I found it easyest to run "sudo dmesg | grep tty" in Terminal. 
+5. also check if the Serial adress is correct for your Arduino. I found it easyest to run '''sudo dmesg | grep tty''' in Terminal. 
-- move arduino.py to  /usr/bin and make it executable with chmod +x
+6. move arduino.py to  /usr/bin and make it executable with chmod +x  
-    sudo chmod +x arduino.py
+    '''
-    sudo cp arduino.py /usr/bin/arduino
+    - sudo chmod +x arduino.py  
-
+    - sudo cp arduino.py /usr/bin/arduino  
-- add to your hal file: loadusr arduino
+    '''
+7. add to your hal file: loadusr arduino
 
 # Testing
-To test your Setup, you can run "halrun" in Terminal.
+To test your Setup, you can run '''halrun''' in Terminal.
 Then you will see halcmd:
 
-Enter "loadusr arduino" and then "show pin"
+Enter '''loadusr arduino''' and then '''show pin'''
 
 All the Arduino generated Pins should now be listed and the State they are in. 
 You can click buttons now and if you run show pin again the state should've changed. 
@@ -60,7 +63,59 @@ You can now use arduino pins in your hal file.
 Pin Names are named arduino.[Pin Type]-[Pin Number]. Example:
 arduino.digital-in-32 for Pin 32 on an Arduino Mega2560
 
+# analog Inputs
+These are used for example to connect Potentiometers. You can add as many as your Arduino has Analog Pins.
+The Software has a smoothing parameter, which will remove jitter.
 
+# digital Inputs
+Digital Inputs use internal Pullup Resistors. So to trigger them you just short the Pin to Ground. There are two Digital Input Types implemented.
+Don't use them for Timing or Safety relevant Stuff like Endstops or Emergency Switches.
+1. INPUTS uses the spezified Pins as Inputs. The Value is parsed to LinuxCNC dirketly. There is also a inverted Parameter per Pin.
+2. Trigger INPUTS (SINPUTS) are handled like INPUTS, but simulate Latching Buttons. So when you press once, the Pin goes HIGH and stays HIGH, until you press the Button again. 
+# digital Outputs
+Digital Outputs drive the spezified Arduinos IO's as Output Pins. You can use it however you want, but don't use it for Timing or Safety relevant Stuff like Stepper Motors.
+# support of Digital RGB LEDs like WS2812 or PL9823
+Digital LED's do skale very easily, you only need one Pin to drive an infinite amount of them.
+To make implementation in LinuxCNC easy you can set predefined LED RGB colors. 
+You can set a color for "on" and "off" State for each LED. 
+LED colors are set with values 0-255 for Red, Green and Blue. 0 beeing off and 255 beeing full on.
+Here are two examples:
+
+1. This LED should be glowing Red when "on" and just turn off when "off". 
+The Setting in ARduino is: 
+  int DledOnColors[DLEDcount][3] = {
+                  {255,0,0}
+                  };
+
+  int DledOffColors[DLEDcount][3] = {
+                  {0,0,0}
+                  };
+
+
+2. This LED should glow Green when "on" and Red when "off". 
+  int DledOnColors[DLEDcount][3] = {
+                  {0,255,0}
+                  };
+
+  int DledOffColors[DLEDcount][3] = {
+                  {255,0,0}
+                  };
+Easy right?                 
+# latching Potentiometers
+This is a special Feature for rotary Selector Switches. Instead of loosing one Pin per Selection you can turn your Switch in a Potentiometer by soldering 10K resistors between the Pins and connecting the Selector Pin to an Analog Input. 
+The Software will divide the Measured Value and create Hal Pins from it. This way you can have Selector Switches with many positions while only needing one Pin for it.
+
+# 1 absolute encoder input
+Some rotary Selector Switches work with Binary Encoded Positions. The Software Supports Encoders with 32 Positions. (this could be more if requested)
+For each Bit one Pin is needed. So for all 32 Positions 5 Pins are needed = 1,2,4,8,16 
+
+# Status LED
+The Arduino only works, if LinuxCNC is running and an USB Connection is established. 
+To give optical Feedback of the State of the connection a Status LED setting is provided. 
+This can be either an LED connected to an Output Pin or you can select one LED in your Digital LED Chain.
+It will flash slowly after startup, when it waits for communication setup by LinuxCNC.
+It will glow constantly when everything works.
+it Will flash short when Connection was lost.
 
 # Serial communication over USB
 The Send and receive Protocol is <Signal><PinNumber>:<Pin State>