Skip to content

Commit

Permalink
Updated comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@hjd1964
hjd1964 committed Apr 30, 2021
1 parent 627b5e8 commit 2070dcc
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions Config.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,37 @@
// ADJUST THE FOLLOWING TO CONFIGURE YOUR CONTROLLER FEATURES ----------------------------------------------------------------------
// <-Req'd = always must set, <-Often = usually must set, Option = optional, Adjust = adjust as req'd, Infreq = infrequently changed

// PINMAP ---------------------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#PINMAP
// PINMAP ------------------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#PINMAP
// *** See the matching Pins.xxx.h file for your setup (found by looking in src/pinmaps/Models.h) with detailed information ***
// *** to be sure it matches your wiring. *** USE AT YOUR OWN RISK *** ***

// Parameter Name Value Default Notes Hint
#define PINMAP OFF // OFF, Choose from: MiniPCB, MiniPCB2, MaxPCB, MaxPCB2, STM32Blue, <-Req'd
// Ramps14, MaxESP3, MaxSTM3. Check Constants.h for more info.

// SERIAL PORT COMMAND CHANNELS ------------------------------------ see https://onstep.groups.io/g/main/wiki/6-Configuration#SERIAL
// SERIAL PORT COMMAND CHANNELS --------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#SERIAL
#define SERIAL_A_BAUD_DEFAULT 9600 // 9600, n. Where n=9600,19200,57600,115200 (common baud rates.) Infreq
#define SERIAL_B_BAUD_DEFAULT 9600 // 9600, n. See (src/HAL/) for your MCU Serial port # etc. Option
#define SERIAL_B_ESP_FLASHING OFF // OFF, ON Upload ESP8266 WiFi firmware through SERIAL_B with :ESPFLASH# cmd. Option
#define SERIAL_C_BAUD_DEFAULT OFF // OFF, n, ON for ESP32 Bluetooth. Option
#define SERIAL_C_BLUETOOTH_NAME "OnStep" // "On..", Bluetooth device name for ESP32. Option

// MOUNT TYPE -------------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#MOUNT_TYPE
// MOUNT TYPE ----------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#MOUNT_TYPE
#define MOUNT_TYPE GEM // GEM, GEM for German Equatorial, FORK for Equatorial Fork, or ALTAZM <-Req'd
// Dobsonian etc. mounts. GEM Eq mounts perform meridian flips.

// USER FEEDBACK -------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#USER_FEEDBACK
// USER FEEDBACK ----------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#USER_FEEDBACK
#define LED_STATUS ON // ON, Blinks w/sidereal tracking otherwise steady on indicates activity. Option
#define LED_STATUS2 OFF // OFF, ON Blinks 1s interval w/PPS sync, steady for gotos, off if in standby. Option
#define LED_RETICLE OFF // OFF, n. Where n=0..255 (0..100%) activates feature sets default brightness. Option
#define BUZZER OFF // OFF, ON, n. Where n=100..6000 (Hz freq.) for piezo speaker. ON for buzzer. Option
#define BUZZER_STATE_DEFAULT OFF // OFF, ON Start with piezo buzzer/speaker enabled. Option

// TIME AND LOCATION -------------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#TLS
// TIME AND LOCATION ----------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#TLS
#define TIME_LOCATION_SOURCE OFF // OFF, DS3231 (I2c,) DS3234 (Spi,) TEENSY (T3.2 internal,) or GPS source. Option
// Provides Date/Time, and if available, PPS & Lat/Long also.

// SENSORS -------------------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#SENSORS
// SENSORS ----------------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#SENSORS
// * = also supports ON_PULLUP or ON_PULLDOWN to activate MCU internal resistors if present.
#define WEATHER OFF // OFF, BME280 (I2C 0x77,) BME280_0x76, BME280_SPI (see pinmap for CS.) Option
// BMP280 (I2C 0x77,) BMP280_0x76, BMP280_SPI (see pinmap for CS.)
Expand All @@ -65,7 +65,7 @@
#define PPS_SENSE OFF // OFF, ON* enables PPS (pulse per second,) senses signal rising edge. Option
// Better tracking accuracy especially for Mega2560's w/ceramic resonator.

// ST4 INTERFACE ------------------------------------------------------ see https://onstep.groups.io/g/main/wiki/6-Configuration#ST4
// ST4 INTERFACE --------------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Controller#ST4
// *** It is up to you to verify the interface meets the electrical specifications of any connected device, use at your own risk ***
#define ST4_INTERFACE OFF // OFF, ON, ON_PULLUP enables interface. <= 1X guides unless hand control mode. Option
// During goto btn press: aborts slew or continue meridian flip pause home
Expand All @@ -74,36 +74,36 @@
// Hold [N]+[S] btns >2s: Usr cat item [E]- [W]+ [N] goto [S] snd on/off
#define ST4_HAND_CONTROL_FOCUSER OFF // OFF, ON alternate to above: Focuser move [E]f1 [W]f2 [N]- [S]+ Option

// GUIDING BEHAVIOUR ---------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#GUIDING
// GUIDING BEHAVIOUR ------------------------------------------ see https://onstep.groups.io/g/main/wiki/Configuration-Mount#GUIDING
#define GUIDE_TIME_LIMIT 0 // 0, No guide time limit. Or n. Where n=1..120 second time limit guard. Adjust
#define GUIDE_DISABLE_BACKLASH OFF // OFF, Disable backlash takeup during guiding at <= 1X Option

// TRACKING BEHAVIOUR -------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#TRACKING
// TRACKING BEHAVIOUR ---------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Mount#TRACKING
#define TRACK_AUTOSTART OFF // OFF, ON Start with tracking enabled. Option
#define TRACK_REFRACTION_RATE_DEFAULT OFF // OFF, ON Start w/atmospheric refract. compensation (RA axis/Eq mounts only.) Option
#define TRACK_BACKLASH_RATE 25 // 25, n. Where n=2..50 (x sidereal rate) during backlash takeup. Option
// Too fast motors stall/gears slam or too slow and sluggish in backlash.

// SLEWING BEHAVIOUR ---------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#SLEWING
// SLEWING BEHAVIOUR ------------------------------------------ see https://onstep.groups.io/g/main/wiki/Configuration-Mount#SLEWING
#define SLEW_RATE_BASE_DESIRED 1.0 // 1.0, n. Desired slew rate in deg/sec. Adjustable at run-time from <-Req'd
// 1/2 to 2x this rate, and as MCU performace considerations require.
#define SLEW_RATE_MEMORY OFF // OFF, ON Remembers rates set across power cycles. Option
#define SLEW_ACCELERATION_DIST 5.0 // 5.0, n, (degrees.) Approx. distance for acceleration (and deceleration.) Adjust
#define SLEW_RAPID_STOP_DIST 2.5 // 2.0, n, (degrees.) Approx. distance required to stop when a slew Adjust
// is aborted or a limit is exceeded.

// PIER SIDE BEHAVIOUR -------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#SYNCING
// PIER SIDE BEHAVIOUR -------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration---Mount#SYNCING
#define MFLIP_SKIP_HOME OFF // OFF, ON Goto directly to the destination without visiting home position. Option
#define MFLIP_PAUSE_HOME_MEMORY OFF // OFF, ON Remember meridian flip pause at home setting across power cycles. Option
#define MFLIP_AUTOMATIC_MEMORY OFF // OFF, ON Remember automatic meridian flip setting across power cycles. Option

#define PIER_SIDE_SYNC_CHANGE_SIDES OFF // OFF, ON Allows sync to change pier side, for GEM mounts. Option
#define PIER_SIDE_PREFERRED_DEFAULT BEST // BEST, Stays on current side if possible. EAST or WEST switch if possible. Option

// PARKING BEHAVIOUR ---------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#PARKING
// PARKING BEHAVIOUR ------------------------------------------ see https://onstep.groups.io/g/main/wiki/Configuration-Mount#PARKING
#define STRICT_PARKING OFF // OFF, ON Un-parking is only allowed if successfully parked. Option

// MOTION CONTROL -------------------------------------------------- see https://onstep.groups.io/g/main/wiki/6-Configuration#MOTION
// MOTION CONTROL ---------------------------------------------- see https://onstep.groups.io/g/main/wiki/Configuration-Mount#MOTION
#define STEP_WAVE_FORM SQUARE // SQUARE, PULSE Step signal wave form faster rates. SQUARE best signal integrity. Adjust

// Stepper driver models (also see ~/OnStep/src/sd_drivers/Models.h for additional infrequently used models and more info.):
Expand All @@ -113,7 +113,7 @@
// *** = SSS TMC5160 you must set stepper driver current (in mA) w/ #define AXISn_TMC_IRUN (IHOLD, etc.)

// AXIS1 RA/AZM
// see https://onstep.groups.io/g/main/wiki/6-Configuration#AXIS1
// see https://onstep.groups.io/g/main/wiki/Configuration-Mount#AXIS1
#define AXIS1_STEPS_PER_DEGREE 12800.0 // 12800, n. Number of steps per degree: <-Req'd
// n = (stepper_steps * micro_steps * overall_gear_reduction)/360.0
#define AXIS1_STEPS_PER_WORMROT 0 // 0, n. Number steps per worm rotation (PEC Eq mode only, 0 disables PEC.) <-Req'd
Expand All @@ -134,7 +134,7 @@
// n. Where n= 180.. 360 (degrees.) Maximum Azimuth for AltAzm mode.

// AXIS2 DEC/ALT
// see https://onstep.groups.io/g/main/wiki/6-Configuration#AXIS2
// see https://onstep.groups.io/g/main/wiki/Configuration-Mount#AXIS2
#define AXIS2_STEPS_PER_DEGREE 12800.0 // 12800, n. Number of steps per degree: <-Req'd
// n = (stepper_steps * micro_steps * overall_gear_reduction)/360.0

Expand All @@ -153,7 +153,7 @@
#define AXIS2_LIMIT_MAX 90 // 90, n. Where n=0..90 (degrees.) Maximum allowed declination. Infreq

// AXIS3 ROTATOR
// see https://onstep.groups.io/g/main/wiki/6-Configuration#AXIS3
// see https://onstep.groups.io/g/main/wiki/Configuration-Rotator-and-Focusers#AXIS3
#define ROTATOR OFF // OFF, ON to enable the rotator (or de-rotator for ALTAZM mounts.) Option
#define AXIS3_STEPS_PER_DEGREE 64.0 // 64.0, n. Number of steps per degree for rotator/de-rotator. Adjust
// Alt/Az de-rotation: n = (num_circumference_pixels * 2)/360, minimum
Expand All @@ -170,7 +170,7 @@
#define AXIS3_LIMIT_MAX 180 // 180, n. Where n=0..360 (degrees.) Maximum allowed rotator angle. Infreq

// AXIS4 FOCUSER 1
// see https://onstep.groups.io/g/main/wiki/6-Configuration#AXIS4
// see https://onstep.groups.io/g/main/wiki/Configuration-Rotator-and-Focusers#AXIS4
#define FOCUSER1 OFF // OFF, ON to enable this focuser. Option
#define AXIS4_STEPS_PER_MICRON 0.5 // 0.5, n. Steps per micrometer. Figure this out by testing or other means. Adjust
#define AXIS4_SLEW_RATE_DESIRED 500 // 500, n, Where n=200..5000 (um/s.) Max microns/second. In DC mode, max pwr % Adjust
Expand All @@ -188,7 +188,7 @@
#define AXIS4_LIMIT_MAX 50 // 50, n. Where n=0..500 (millimeters.) Maximum allowed position. Adjust

// AXIS5 FOCUSER 2
// see https://onstep.groups.io/g/main/wiki/6-Configuration#AXIS5
// see https://onstep.groups.io/g/main/wiki/Configuration-Rotator-and-Focusers#AXIS5
#define FOCUSER2 OFF // OFF, ON to enable this focuser. Option
#define AXIS5_STEPS_PER_MICRON 0.5 // 0.5, n. Steps per micrometer. Figure this out by testing or other means. Adjust
#define AXIS5_SLEW_RATE_DESIRED 500 // 500, n, Where n=200..5000 (um/s.) Max microns/second. In DC mode, max pwr % Adjust
Expand Down

0 comments on commit 2070dcc

Please sign in to comment.