Creating docs dir

docs/assembling.rst

@@ -0,0 +1,26 @@
+Assembling guide
+================
+
+
+
+Assembling the box
+-------------------
+...
+
+Preparing Y Axis
+----------------
+...
+
+Assembling X Axis
+-----------------
+...
+
+Assembling Y Axis
+-----------------
+...
+
+Calibrating the printer
+-----------------------
+
+Embosser
+...

docs/bom.rst

@@ -0,0 +1,77 @@
+Bill of material
+================
+
+Laser cut box
+-------------
+...
+
+
+
+Printed parts
+-------------
+
+=== ===============
+Qty file
+=== ===============
+6   igus support
+1   plateforme up
+1   plateforme down
+...
+=== ===============
+
+Mechanical parts
+----------------
+
+
+=== =========================================
+Qty Type
+=== =========================================
+4   8mm linear shaft 330 mm length
+1   8mm linear shaft 300 mm length
+1   8mm linear shaft 365 mm length
+1   8mm linear shaft *120 mm* length
+
+6   RJ4JP-01-08 Polimer linear bearing 
+
+
+3   GT2 pulley 20 teeth bore 8mm    
+2   GT2 idler pulley 20 teeth bore 3mm (with ball bearing)
+
+4   KP08  linear shaft 8mm horizontal pillow
+2   KFL08 linear shaft 8mm vertical pillow 
+
+1   Flex shaft coupler 5mm/8mm
+
+2   Nema 17 40 N/cm with wire
+
+1   Close timing belt 160 mm
+2   Open timing belt 630 mm length
+
+1   Electro-magnet *tau-826*
+
+1   1N4004 flyback diode or equivalent (12V 2A)
+1   Red del with appropriate resistor for 12V
+1   Stripboard
+
+1   Embase USB
+1   Embase 230V with switch 
+
+1   12v power supply 10A
+
+1   MKS GEN 1.4 or Ramps 1.4 compatible electronic board
+2   DRV8825 stepper stick with *radiateur*
+
+x   BTR M3 5mm
+x   BTR M3 10mm
+x   M3 nuts
+x   M3 nylstop nuts
+x   M3 washer
+
+x   BTR M4 10
+4   BTR M4 50mm *partiellement filete* 
+
+...
+=== =========================================
+
+
+

docs/history.rst

@@ -0,0 +1,27 @@
+BrailleRap-SP Project History
+=============================
+
+The beginning
+-------------
+
+Formarly in 2016 MyHumanKit organize an Hackaton called Fabrikarium with Airbus industries. During the Fabrikarium some test where made to hack a 3d printer to 
+embosse braille on `160g paper sheet <https://myhumankit.org/actualite/fabrikarium-2016-au-croisement-des-mondes/>`_,
+the project was called `BrailleRap <https://github.com/arthursw/BrailleRap/blob/master/Documentation/documentation-en.md>`_.
+
+
+We thougt on the BrailleRap-SP team that it was a proof a concept and that we need some custom hardware to emboss braille easyly than with hacked 3D printer
+
+OpenBraille
+-----------
+
+In 2017 Carlos Campos start the project OpenBraille and build a braille embosser base on recycled printers parts, the project demonstrate that we can move the 
+paper sheet in the machine.
+
+BrailleRap-SP
+-------------
+In January 2018 we start with some linear rail, printed parts and nema, tying to build a Braille embosser. Further step later we started to show some samples 
+of embossed paper and everyone was enthousiast, BrailleRAP-SP was born.
+
+
+
+

docs/index.rst

@@ -0,0 +1,30 @@
+.. BrailleRap-SP documentation master file, created by
+   sphinx-quickstart on Mon Mar  5 11:31:40 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+.. image :: braillerapV3_001.png 
+  :width: 800px
+  :height: 100px
+  :align: center
+
+
+
+Welcome to BrailleRap-SP's documentation!
+=========================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   history
+   bom
+   marlin
+   assembling
+
+
+.. index:: history, bom, marlin, assembling
+
+

docs/marlin.rst

@@ -0,0 +1,72 @@
+Marlin Firmware for Ramps or compatible
+=======================================
+
+
+
+Notes
+-----
+We use stadard marlin firmware to implement M3 / M4 GCode command
+
+Board configuration
+-------------------
+
+in configuration.h 
+
+Motherboard configuration ::
+
+   #ifndef MOTHERBOARD
+     //#define MOTHERBOARD BOARD_RAMPS_14_EFB
+     #define MOTHERBOARD BOARD_RAMPS_14_SF
+   #endif
+
+Spindle / laser / pen configuration ::
+
+   // BRAILLE RAP CONFIG
+   #define SPINDLE_LASER_ENABLE
+   #define SPINDLE_LASER_ENABLE_PIN  RAMPS_D8_PIN      // !!! sortie BED MOSFET
+   #define SPINDLE_LASER_PWM_PIN     RAMPS_D10_PIN     // !!! sortie E0 MOSFET 
+   #define SPINDLE_DIR_PIN           5                 // pin servo
+
+
+Endstop configuration ::
+
+   // Mechanical endstop with COM to ground and NC to Signal uses "false" here (most common setup).
+   #define X_MIN_ENDSTOP_INVERTING false // set to true to invert the logic of the endstop.
+   #define Y_MIN_ENDSTOP_INVERTING false // set to true to invert the logic of the endstop.
+   #define Z_MIN_ENDSTOP_INVERTING false // set to true to invert the logic of the endstop.
+   #define X_MAX_ENDSTOP_INVERTING false // set to true to invert the logic of the endstop.
+   #define Y_MAX_ENDSTOP_INVERTING false // set to true to invert the logic of the endstop.
+   #define Z_MAX_ENDSTOP_INVERTING false // set to true to invert the logic of the endstop.
+   #define Z_MIN_PROBE_ENDSTOP_INVERTING false // set to true to invert the logic of the probe.
+
+
+Motor step / mm ::
+
+   #define DEFAULT_AXIS_STEPS_PER_UNIT   { 80, 46, 4000, 500 }
+
+Max feedrate ::
+
+   #define DEFAULT_MAX_FEEDRATE          { 300, 300, 5, 25 }
+
+Acceleration ::
+
+   #define DEFAULT_MAX_ACCELERATION      { 1500, 1500, 100, 10000 }
+
+   #define DEFAULT_ACCELERATION          1500    // X, Y, Z and E acceleration for printing moves
+   #define DEFAULT_RETRACT_ACCELERATION  1500    // E acceleration for retracts
+   #define DEFAULT_TRAVEL_ACCELERATION   1500    // X, Y, Z acceleration for travel (non printing) moves
+
+Jerk ::
+
+   #define DEFAULT_XJERK                 5.0
+   #define DEFAULT_YJERK                 5.0
+   #define DEFAULT_ZJERK                  0.3
+   #define DEFAULT_EJERK                  5.0
+
+
+ 
+ 
+
+
+
+