Browse Source

Rebase & feedback

João Brázio 8 years ago
parent
commit
7b5d6ba315
1 changed files with 74 additions and 73 deletions
  1. 74
    73
      Marlin/Configuration.h

+ 74
- 73
Marlin/Configuration.h View File

@@ -604,7 +604,7 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
604 604
   //    O-- FRONT --+
605 605
   //  (0,0)
606 606
   #define X_PROBE_OFFSET_FROM_EXTRUDER 10  // X offset: -left  +right  [of the nozzle]
607
-  #define Y_PROBE_OFFSET_FROM_EXTRUDER 10  // Y offset: -front +behind [the nozzle] 
607
+  #define Y_PROBE_OFFSET_FROM_EXTRUDER 10  // Y offset: -front +behind [the nozzle]
608 608
   #define Z_PROBE_OFFSET_FROM_EXTRUDER 0   // Z offset: -below +above  [the nozzle]
609 609
 
610 610
   #define XY_TRAVEL_SPEED 8000         // X and Y axis travel speed between probes, in mm/min.
@@ -762,7 +762,7 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
762 762
 // @section lcd
763 763
 
764 764
 //
765
-// MARLIN LANGUAGE
765
+// LCD LANGUAGE
766 766
 //
767 767
 // Here you may choose the language used by Marlin on the LCD menus, the following
768 768
 // list of languages are available:
@@ -772,19 +772,18 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
772 772
 #define LANGUAGE_INCLUDE GENERATE_LANGUAGE_INCLUDE(en)
773 773
 
774 774
 //
775
-// LCD CHARSET
775
+// LCD CHARACTER SET
776 776
 //
777
-// Choose ONE of the following charset list, keep in mind that this selection is
778
-// dependent on your physical hardware thus it has to match the type of Character
779
-// based LCD you have.
777
+// Choose ONE of the following charset options. This selection depends on
778
+// your physical hardware, so it must match your character-based LCD.
780 779
 //
781
-// Note: This options is ignored for a full graphic display.
780
+// Note: This option is NOT applicable to graphical displays.
782 781
 //
783
-// To find out what type you have:
784
-//  - Compile and upload with language set to 'test'
785
-//  - Click to get the menu
782
+// To find out what type of display you have:
783
+//  - Compile and upload with the language (above) set to 'test'
784
+//  - Click the controller to view the LCD menu
786 785
 //
787
-// You'll see two typical lines from the upper half of the charset.
786
+// The LCD will display two lines from the upper half of the character set.
788 787
 //
789 788
 // See also https://github.com/MarlinFirmware/Marlin/wiki/LCD-Language
790 789
 //
@@ -797,10 +796,10 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
797 796
 //
798 797
 // You may choose ULTRA_LCD if you have character based LCD with 16x2, 16x4, 20x2,
799 798
 // 20x4 char/lines or DOGLCD for the full graphics display with 128x64 pixels
800
-// (ST7565R family).
799
+// (ST7565R family). (This option will be set automatically for certain displays.)
801 800
 //
802
-// IMPORTANT NOTE: You have to install Arduino's U8glib library for the Full
803
-// Graphics Display to work ! - https://github.com/olikraus/U8glib_Arduino
801
+// IMPORTANT NOTE: The U8glib library is required for Full Graphic Display!
802
+//                 https://github.com/olikraus/U8glib_Arduino
804 803
 //
805 804
 //#define ULTRA_LCD   // Character based
806 805
 //#define DOGLCD      // Full graphics display
@@ -808,16 +807,16 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
808 807
 //
809 808
 // SD CARD
810 809
 //
811
-// SD card support is now disabled by default, if you have [and want] SD support
812
-// then you must uncomment the following directive.
810
+// SD Card support is disabled by default. If your controller has an SD slot,
811
+// you must uncomment the following option or it won't work.
813 812
 //
814 813
 //#define SDSUPPORT
815 814
 
816 815
 //
817 816
 // SD CARD: SPI SPEED
818 817
 //
819
-// You may uncomment *one* of the following directives to use slower SPI transfer
820
-// speeds, this is usually required if you're getting volume init errors.
818
+// Uncomment ONE of the following items to use a slower SPI transfer
819
+// speed. This is usually required if you're getting volume init errors.
821 820
 //
822 821
 //#define SPI_SPEED SPI_HALF_SPEED
823 822
 //#define SPI_SPEED SPI_QUARTER_SPEED
@@ -833,35 +832,36 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
833 832
 //
834 833
 // ENCODER SETTINGS
835 834
 //
836
-// This option defines how many pulses a encoder should produce for a menu
837
-// step to be produced, you should increase this value for highres encoders.
835
+// This option overrides the default number of encoder pulses needed to
836
+// produce one step. Should be increased for high-resolution encoders.
838 837
 //
839 838
 //#define ENCODER_PULSES_PER_STEP 1
839
+
840 840
 //
841
-//
842
-// This option defines how many steps are required for Marlin to move between
843
-// next/prev menu items.
841
+// Use this option to override the number of step signals required to
842
+// move between next/prev menu items.
844 843
 //
845 844
 //#define ENCODER_STEPS_PER_MENU_ITEM 5
845
+
846 846
 //
847
-//
848
-// This option allows you to reverse the direction you have to turn the encoder
849
-// to navigate up/down on the menus, by default CLOCKWISE rotation moves DOWN in
850
-// the LCD menu, when active CLOCKWISE rotation will move UP in the LCD menu.
847
+// This option reverses the encoder direction for navigating LCD menus.
848
+// By default CLOCKWISE == DOWN. With this enabled CLOCKWISE == UP.
851 849
 //
852 850
 //#define REVERSE_MENU_DIRECTION
851
+
853 852
 //
853
+// SPEAKER/BUZZER
854 854
 //
855
-// If you have a speaker activate this directive to enable it.
856
-// By default Marlin assumes your setup is buzzer based and no action is required.
855
+// If you have a speaker that can produce tones, enable it here.
856
+// By default Marlin assumes you have a buzzer with a fixed frequency.
857 857
 //
858 858
 //#define SPEAKER
859
+
859 860
 //
860
-// The duration and frequency the buzzer plays the UI feedback sound.
861
-// You may define these directives with 0 (zero) if you want to disable all sound
862
-// feedback from Marlin.
861
+// The duration and frequency for the UI feedback sound.
862
+// Set these to 0 to disable audio feedback in the LCD menus.
863 863
 //
864
-// Note: You may test the buzzing sound with the G-Code:
864
+// Note: Test audio output with the G-Code:
865 865
 //  M300 S<frequency Hz> P<duration ms>
866 866
 //
867 867
 //#define LCD_FEEDBACK_FREQUENCY_DURATION_MS 100
@@ -870,81 +870,81 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
870 870
 //
871 871
 // CONTROLLER TYPE: Standard
872 872
 //
873
-// Marlin supports a impressive variety of controllers, uncomment the directive
874
-// which defines physical controller you're using.
873
+// Marlin supports a wide variety of controllers.
874
+// Enable one of the following options to specify your controller.
875 875
 //
876
+
876 877
 //
877
-// Activate this directive if you have an ULTIMAKER Controller.
878
+// ULTIMAKER Controller.
878 879
 //
879 880
 //#define ULTIMAKERCONTROLLER
881
+
880 882
 //
881
-//
882
-// Activate this directive if you have a ULTIPANEL as seen on Thingiverse.
883
+// ULTIPANEL as seen on Thingiverse.
883 884
 //
884 885
 //#define ULTIPANEL
886
+
885 887
 //
886
-//
887
-// Activate this directive if you have a PanelOne from T3P3
888
-// (via RAMPS 1.4 AUX2/AUX3) - http://reprap.org/wiki/PanelOne
888
+// PanelOne from T3P3 (via RAMPS 1.4 AUX2/AUX3)
889
+// http://reprap.org/wiki/PanelOne
889 890
 //
890 891
 //#define PANEL_ONE
892
+
891 893
 //
892
-//
893
-// Activate this directive if you have a MaKr3d Makr-Panel with graphic
894
-// controller and SD suppord - http://reprap.org/wiki/MaKr3d_MaKrPanel
894
+// MaKr3d Makr-Panel with graphic controller and SD support.
895
+// http://reprap.org/wiki/MaKr3d_MaKrPanel
895 896
 //
896 897
 //#define MAKRPANEL
898
+
897 899
 //
898
-//
899
-// Activate one of these directives if you have a Panucatt Devices Viki 2.0 or
900
-// mini Viki with Graphic LCD - http://panucatt.com
900
+// Activate one of these if you have a Panucatt Devices
901
+// Viki 2.0 or mini Viki with Graphic LCD
902
+// http://panucatt.com
901 903
 //
902 904
 //#define VIKI2
903 905
 //#define miniVIKI
904 906
 
905
-// This is a new controller currently under development.  https://github.com/eboston/Adafruit-ST7565-Full-Graphic-Controller/
906 907
 //
907
-//
908
-// Activate this directive if you have an Adafruit ST7565 Full Graphic Controller.
908
+// Adafruit ST7565 Full Graphic Controller.
909 909
 // https://github.com/eboston/Adafruit-ST7565-Full-Graphic-Controller/
910 910
 //
911 911
 //#define ELB_FULL_GRAPHIC_CONTROLLER
912
+
912 913
 //
913
-//
914
-// Activate this directive if you have a RepRapDiscount Smart Controller.
914
+// RepRapDiscount Smart Controller.
915 915
 // http://reprap.org/wiki/RepRapDiscount_Smart_Controller
916 916
 //
917
-// Note: Usually sold in a white PCB.
917
+// Note: Usually sold with a white PCB.
918 918
 //
919 919
 //#define REPRAP_DISCOUNT_SMART_CONTROLLER
920
+
920 921
 //
921
-//
922
-// Activate this directive if you have a BQ LCD Smart Controller shipped by
922
+// BQ LCD Smart Controller shipped by
923 923
 // default with the BQ Hephestos 2 and Witbox 2.
924 924
 //
925 925
 //#define BQ_LCD_SMART_CONTROLLER
926
+
926 927
 //
927
-//
928
-// Activate this directive if you have a GADGETS3D G3D LCD/SD Controller
928
+// GADGETS3D G3D LCD/SD Controller
929 929
 // http://reprap.org/wiki/RAMPS_1.3/1.4_GADGETS3D_Shield_with_Panel
930 930
 //
931
-// Note: Usually sold in a blue PCB.
931
+// Note: Usually sold with a blue PCB.
932 932
 //
933 933
 //#define G3D_PANEL
934
+
934 935
 //
935
-//
936
-// Activate this directive if you have a RepRapDiscount FULL GRAPHIC Smart Controller
936
+// RepRapDiscount FULL GRAPHIC Smart Controller
937 937
 // http://reprap.org/wiki/RepRapDiscount_Full_Graphic_Smart_Controller
938 938
 //
939 939
 // #define REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER
940
+
940 941
 //
941
-//
942
-// Activate this directive if you have a MakerLab Mini Panel with graphic
942
+// MakerLab Mini Panel with graphic
943 943
 // controller and SD support - http://reprap.org/wiki/Mini_panel
944 944
 //#define MINIPANEL
945
+
945 946
 //
946
-//
947
-// Activate this directive if you have a RepRapWorld REPRAPWORLD_KEYPAD v1.1
947
+// RepRapWorld REPRAPWORLD_KEYPAD v1.1
948 948
 // http://reprapworld.com/?products_details&products_id=202&cPath=1591_1626
949 949
 //
950 950
 // REPRAPWORLD_KEYPAD_MOVE_STEP sets how much should the robot move when a key
@@ -959,20 +959,21 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
959 959
 // Note: These controllers require the installation of Arduino's LiquidCrystal_I2C
960 960
 // library. For more info: https://github.com/kiyoshigawa/LiquidCrystal_I2C
961 961
 //
962
+
962 963
 //
963
-// Activate this directive if you have an Elefu RA Board Control Panel
964
+// Elefu RA Board Control Panel
964 965
 // http://www.elefu.com/index.php?route=product/product&product_id=53
965 966
 //
966 967
 //#define RA_CONTROL_PANEL
967 968
 //#define LCD_I2C_SAINSMART_YWROBOT
969
+
968 970
 //
969
-//
970
-// Activate this directive if you have a LCM160 LCD adapter.
971
+// LCM160 LCD adapter.
971 972
 //
972 973
 //#define LCM1602
974
+
973 975
 //
974
-//
975
-// Activate this directive if you have a PANELOLU2 LCD with status LEDs,
976
+// PANELOLU2 LCD with status LEDs,
976 977
 // separate encoder and click inputs.
977 978
 //
978 979
 // Note: This controller requires Arduino's LiquidTWI2 library v1.2.3 or later.
@@ -982,15 +983,15 @@ const bool Z_MIN_PROBE_ENDSTOP_INVERTING = false; // set to true to invert the l
982 983
 // a pin (if BTN_ENC defined to != -1) or read through I2C (when BTN_ENC == -1).
983 984
 //
984 985
 //#define LCD_I2C_PANELOLU2
986
+
985 987
 //
986
-//
987
-// Activate this directive if you have a Panucatt VIKI LCD with status LEDs,
988
+// Panucatt VIKI LCD with status LEDs,
988 989
 // integrated click & L/R/U/D buttons, separate encoder inputs.
989 990
 //
990 991
 //#define LCD_I2C_VIKI
992
+
991 993
 //
992
-//
993
-// Activate this directive if you have a SSD1306 OLED full graphics generic display
994
+// SSD1306 OLED full graphics generic display
994 995
 //
995 996
 //#define U8GLIB_SSD1306
996 997
 

Loading…
Cancel
Save