Merge Develop to publish changes (#37)

- Added AZ configuration for OAM
- Added description to completed steps.
- Moved BYJ motor options to the end for RA and DEC
- Added ALT settings back for OAM
- Hardcoded default pin settings for OAM Hall sensors
- Added Homing pins for RA and DEC for all trackers
- Supressed I2C pins if no info display is selected
- Made some adjustments to OAE defaults

Author: ClutchplateDude

README.md

@@ -1,21 +1,21 @@
-# OAT Configurator
+# OpenAstroTech Mount Configurator
 This is the source code for a small React-based app, using AntDesign that asks the user a bunch of questions about what components
-they used to build their tracker and then spits out the defines that need to be placed in configuration_local.hpp.
+they used to build their mount and then spits out the defines that need to be placed in configuration_local.hpp.
 
 It can be used live at https://config.openastrotech.com
 
 # Status
-Captures the great majority of use cases for the OAT. Please file Issues if you would like to see more variables supported, or if you are 
-able, please create and submit a PR with an extra step in the code. It's pretty easy to add a new stpe to the Wizard, just look at the
-stepProps array in WizardSteps.jsx and add a new array item there. 
+Captures the great majority of use cases for the OAT, OAE and OAM. Please file Issues if you would like to see more variables supported, or if you are 
+able, please create and submit a PR with an extra step in the code. It's pretty easy to add a new step to the Wizard, just look at the
+stepProps array in one of the oxxSteps.js files and add a new array item there. 
 
 # Roadmap
 - Bluetooth - not currently queried.
 - Dark mode support.
 
 # Using Source code
 
-If you want to constribute to stig project, you'll need to get the source code. If you want to just use it, simply go to https://config.openastrotech.com
+If you want to constribute to this project, you'll need to get the source code. If you want to just use it, simply go to https://config.openastrotech.com
 
 ## Available Scripts
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "oat-config-builder",
-  "version": "0.1.0",
+  "version": "3.11.0",
   "private": true,
   "dependencies": {
     "@testing-library/jest-dom": "^5.11.9",

src/modules/Home.jsx

@@ -13,7 +13,7 @@ const Home = (props) => {
         <div className="intro-link-child">
         <h3 className="intro-header">OAT/OAM/OAE Firmware Configuration Generator</h3>
           <a className="intro-link" href="steps">START</a>
-          <p className="version">V3.10</p>
+          <p className="version">V3.12</p>
         </div>
       </div>
 

src/modules/configurations/base/commonSteps.js

@@ -103,12 +103,12 @@ export const createBoardStep = () => ({
             { key: 'M10', value: 'MKS GEN L V1.0', image: '/images/mksv10.png', defineValue: 'BOARD_AVR_MKS_GEN_L_V1' },
             { key: 'M20', value: 'MKS GEN L V2.0', image: '/images/mksv20.png', defineValue: 'BOARD_AVR_MKS_GEN_L_V2' },
             { key: 'M21', value: 'MKS GEN L V2.1', image: '/images/mksv21.png', defineValue: 'BOARD_AVR_MKS_GEN_L_V21' },
-            { key: 'OAEV1', value: 'OAE_V1', image: '/images/oaeboard.png', defineValue: 'BOARD_OAE_V1' },
+            { key: 'OAEV1', value: 'OAE V1', image: '/images/oaeboard.png', defineValue: 'BOARD_OAE_V1' },
         ]
     },
 });
 
-// RA Driver step (OAT/OAM)
+// RA Driver step (OAT/OAM/OAE)
 export const createRADriverStep = () => ({
     id: 'RDO',
     title: 'RA Driver',
@@ -119,9 +119,9 @@ export const createRADriverStep = () => ({
     control: {
         type: 'radioimg',
         choices: [
-            { key: 'A', value: 'Generic A4988', image: '/images/a4988.png', defineValue: 'DRIVER_TYPE_A4988_GENERIC' },
             { key: 'TU', value: 'TMC2209-UART', image: '/images/tmc2209.png', defineValue: 'DRIVER_TYPE_TMC2209_UART' },
             { key: 'TS', value: 'TMC2209-Standalone', image: '/images/tmc2209.png', defineValue: 'DRIVER_TYPE_TMC2209_STANDALONE' },
+            { key: 'A', value: 'Generic A4988', image: '/images/a4988.png', defineValue: 'DRIVER_TYPE_A4988_GENERIC' },
         ]
     },
 });
@@ -154,7 +154,6 @@ export const createDECStepperStep = () => ({
     control: {
         type: 'radioimg',
         choices: [
-            { key: 'BY', value: 'Modded 28BYJ-48 (Bipolar)', image: '/images/byj48.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define DEC_STEPPER_SPR 2048.0f'], condition: "($stepperlib != N)" },
             { 
                 key: 'N9', 
                 value: 'NEMA 17, 0.9°/step', 
@@ -200,6 +199,7 @@ export const createDECStepperStep = () => ({
                 condition: "($tracker == OAM)",
                 additionalLines: ['#define DEC_STEPPER_SPR                (200 * 9)']
             },
+            { key: 'BY', value: 'Modded 28BYJ-48 (Bipolar)', image: '/images/byj48.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define DEC_STEPPER_SPR 2048.0f'], condition: "($stepperlib != N)" },
         ]
     },
     postamble: [{
@@ -208,7 +208,7 @@ export const createDECStepperStep = () => ({
     }],
 });
 
-// DEC Driver step (OAT/OAM)
+// DEC Driver step (OAT/OAM/OAE)
 export const createDECDriverStep = () => ({
     id: 'DDT',
     title: 'DEC Driver',
@@ -219,9 +219,9 @@ export const createDECDriverStep = () => ({
     control: {
         type: 'radioimg',
         choices: [
-            { key: 'A', value: 'Generic A4988', image: '/images/a4988.png', defineValue: 'DRIVER_TYPE_A4988_GENERIC' },
             { key: 'TU', value: 'TMC2209-UART', image: '/images/tmc2209.png', defineValue: 'DRIVER_TYPE_TMC2209_UART' },
             { key: 'TS', value: 'TMC2209-Standalone', image: '/images/tmc2209.png', defineValue: 'DRIVER_TYPE_TMC2209_STANDALONE' },
+            { key: 'A', value: 'Generic A4988', image: '/images/a4988.png', defineValue: 'DRIVER_TYPE_A4988_GENERIC' },
         ]
     },
 });
@@ -297,12 +297,12 @@ export const createInfoDisplayStep = () => ({
         ]
     },
     postamble: [
-        { literal: ['#define INFO_DISPLAY_I2C_ADDRESS   0x3C'] },
-        { literal: ['#define INFO_DISPLAY_I2C_SDA_PIN   20'] },
-        { literal: ['#define INFO_DISPLAY_I2C_SCL_PIN   21'] },
+        { literal: ['#define INFO_DISPLAY_I2C_ADDRESS   0x3C'], condition: "($infodisplay == OLED)" },
+        { literal: ['#define INFO_DISPLAY_I2C_SDA_PIN   20'], condition: "($infodisplay == OLED)" },
+        { literal: ['#define INFO_DISPLAY_I2C_SCL_PIN   21'], condition: "($infodisplay == OLED)" },
         {
             literal: ['// Note that the E1 port is not usable since I2C requires pin 21!'],
-            condition: "($board == M10) OR ($board == M20) OR ($board == M21)",
+            condition: "($board IN [M10,M20,M21]) AND ($infodisplay == OLED)",
         },
     ],
 });
@@ -424,11 +424,11 @@ export const createFocuserSteps = () => [
         control: {
             type: 'radioimg',
             choices: [
-                { key: 'BY', value: 'Modded 28BYJ-48 (Bipolar)', image: '/images/byj48.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define FOCUS_STEPPER_SPR 2048.0f'] },
                 { key: 'N9', value: 'NEMA 17, 0.9°/step', image: '/images/nema17.png', defineValue: 'STEPPER_TYPE_ENABLED' },
                 { key: 'N8', value: 'NEMA 17, 1.8°/step', image: '/images/nema17.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define FOCUS_STEPPER_SPR 200.0f'] },
                 { key: 'N49', value: 'NEMA 14, 0.9°/step', image: '/images/nema14.png', defineValue: 'STEPPER_TYPE_ENABLED' },
                 { key: 'N48', value: 'NEMA 14, 1.8°/step', image: '/images/nema14.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define FOCUS_STEPPER_SPR 200.0f'] },
+                { key: 'BY', value: 'Modded 28BYJ-48 (Bipolar)', image: '/images/byj48.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define FOCUS_STEPPER_SPR 2048.0f'] },
             ]
         },
     },

src/modules/configurations/base/sharedDefaults.js

@@ -46,5 +46,10 @@ export const Defaults = {
     OAMSpeed: { N9: 2.0, N8: 2.0, N9O: 2.0, N8O: 2.0, rastpr: { N9: 2.0, N8: 2.0, N9O: 2.0, N8O: 2.0 }, decstpr: { N9: 2.0, N8: 2.0, N9O: 2.0, N8O: 2.0 } },
     OAMAcceleration: { N9: 2.0, N8: 2.0, N9O: 2.0, N8O: 2.0, rastpr: { N9: 2.0, N8: 2.0, N9O: 2.0, N8O: 2.0 }, decstpr: { N9: 2.0, N8: 2.0, N9O: 2.0, N8O: 2.0 } },
     OAMMicrostepping: { N9: 128, N8: 128, N9O: 128, N8O: 128, rastpr: { N9: 128, N8: 128, N9O: 128, N8O: 128 }, decstpr: { N9: 128, N8: 128, N9O: 128, N8O: 128 } },
-    RAHallSensorPin: { tracker: 18 }
+    RAHallSensorPin: { OAT: 53, OAM: 27, OAE: 27 },
+    DECHallSensorPin: { OAT: 52, OAM: 29, OAE: 29 },
+    OAEPowerRating: { N9: 2000, N8: 2000, N9O: 2000, N8O: 2000 },
+    OAEPowerUtilization: { N9: 50, N8: 50, N9O: 50, N8O: 50 },
+    OAESlewMicrostepping: { N9: 4, N8: 4, N9O: 16, N8O: 16 },
+    OAETrackMicrostepping: { N9: 256, N8: 256, N9O: 256, N8O: 256 }    
 };

src/modules/configurations/oae/oaeSteps.js

@@ -52,8 +52,8 @@ export const getOAESteps = () => [
                 '#define RA_DRIVER_TYPE DRIVER_TYPE_TMC2209_UART',
                 '',
                 '// Define some RA stepper motor settings',
-                '#define RA_MOTOR_CURRENT_RATING       1200 // mA',
-                '#define RA_OPERATING_CURRENT_SETTING  80 // %',
+                '#define RA_MOTOR_CURRENT_RATING       2000 // mA',
+                '#define RA_OPERATING_CURRENT_SETTING  50 // %',
                 '#define RA_SLEW_MICROSTEPPING         4',
                 '#define RA_TRACKING_MICROSTEPPING     256',
                 '',
@@ -65,10 +65,10 @@ export const getOAESteps = () => [
                 '',
                 '// Define some RA stepper motor settings',
                 '',
-                '#define RA_SLEWING_SPEED_DEGREE 3',
-                '#define RA_ACCEL_SecToFullSpeed 1  // Seconds to reach full slewing speed',
+                '#define RA_SLEWING_SPEED_DEGREE 4',
+                '#define RA_ACCEL_SecToFullSpeed 1.5  // Seconds to reach full slewing speed',
                 '',
-                '#define RA_STEPPER_SPR (400 * 9)   // change to (200 * 9) for 1.8° stepper',
+                '#define RA_STEPPER_SPR (400 * 9)           // change to (200 * 9) for 1.8° stepper',
                 '#define DEC_STEPPER_SPR (200 * 50 * 4.5f)  // change "200" to "400" for 0.9° stepper, change "50" to different value depending on worm gear used',
                 '',
                 '// Using the 16 tooth gear (recommended) for RA belt',
@@ -89,15 +89,15 @@ export const getOAESteps = () => [
                 '',
                 '// Define some DEC stepper motor settings',
                 '#define DEC_MOTOR_CURRENT_RATING       2000 // mA',
-                '#define DEC_OPERATING_CURRENT_SETTING  60 // %',
-                '#define DEC_SLEW_MICROSTEPPING         32',
+                '#define DEC_OPERATING_CURRENT_SETTING  50 // %',
+                '#define DEC_SLEW_MICROSTEPPING         16',
                 '#define DEC_GUIDE_MICROSTEPPING        256',
                 '',
                 '// TMC2209 Stealth Mode (spreadCycle) - When set to 0, tracking is more precise, but noisy (high-pitched sound). When set to 1, they are silent.',
                 '#define DEC_UART_STEALTH_MODE          1',
                 '',
                 '// Is it going the wrong way?',
-                '#define DEC_INVERT_DIR  0',
+                '#define DEC_INVERT_DIR  1',
                 '',
                 '#define DEC_SLEWING_SPEED_DEGREE RA_SLEWING_SPEED_DEGREE',
                 '#define DEC_ACCEL_SecToFullSpeed RA_ACCEL_SecToFullSpeed',
@@ -110,15 +110,15 @@ export const getOAESteps = () => [
                 '// AZ Stepper Configuration',
                 '#define AZ_STEPPER_SPR 2048 // 28BYJ-48',
                 '#define AZ_MICROSTEPPING 1',
-                '#define AZ_STEPPER_SPEED 1200',
-                '#define AZ_STEPPER_ACCELERATION 3000',
+                '#define AZ_STEPPER_SPEED 800',
+                '#define AZ_STEPPER_ACCELERATION 2000',
                 '',
                 '////////////////////////////////',
                 '// ALT Stepper Configuration',
                 '#define ALT_STEPPER_SPR 2048    // 28BYJ-48',
                 '#define ALT_MICROSTEPPING 1',
                 '#define ALT_STEPPER_SPEED 800',
-                '#define ALT_STEPPER_ACCELERATION 3000',
+                '#define ALT_STEPPER_ACCELERATION 2000',
                 '',
                 '////////////////////////////////',
                 '// Display configuration ',
@@ -130,11 +130,11 @@ export const getOAESteps = () => [
                 '// Define whether we have the GPS addon or not. Currently: No GPS',
                 '#define USE_GPS 0',
                 '',
-                '// Using the NEMA 17, 0.9°/step stepper for AZ',
+                '// Using a 28BYJ-48 stepper for AZ and ALT',
                 '#define AZ_STEPPER_TYPE STEPPER_TYPE_ENABLED',
                 '#define ALT_STEPPER_TYPE STEPPER_TYPE_ENABLED',
                 '',
-                '// Using the TMC2209-UART driver for AZ stepper motor',
+                '// Using the A4988 driver for AZ and ALT stepper motors',
                 '#define AZ_DRIVER_TYPE DRIVER_TYPE_A4988_GENERIC ',
                 '#define ALT_DRIVER_TYPE DRIVER_TYPE_A4988_GENERIC ',
                 '',

src/modules/configurations/oam/oamSteps.js

@@ -223,7 +223,7 @@ export const getOAMSteps = () => [
     {
         id: 'ZAO',
         title: 'Azimuth Always On',
-        label: 'It is possible to keep the azimuth motor energized at all times to prevent any shifting in position. This is not necessarily needed for 28BYJ motors, however it is recommended for NEMAs when using AutoPA V2.0.',
+        label: 'It is possible to keep the azimuth motor energized at all times to prevent any shifting in position. It is recommended for NEMAs when using AutoPA V2.0.',
         variable: 'azalwayson',
         condition: "($autopa == Y)",
         preamble: ['// Define AZ always-on'],
@@ -236,7 +236,81 @@ export const getOAMSteps = () => [
             ]
         },
     },
-
+    {
+        id: 'LST',
+        title: 'Altitude Stepper',
+        label: 'Which stepper motor are you using for the Altitude:',
+        variable: 'alt',
+        condition: "($autopa == Y)",
+        preamble: ['// Using the {v} stepper for ALT'],
+        define: 'ALT_STEPPER_TYPE',
+        control: {
+            type: 'radioimg',
+            choices: [
+                { key: 'N9', value: 'NEMA 17, 0.9°/step', image: '/images/nema17.png', defineValue: 'STEPPER_TYPE_ENABLED' },
+                { key: 'N8', value: 'NEMA 17, 1.8°/step', image: '/images/nema17.png', defineValue: 'STEPPER_TYPE_ENABLED', additionalLines: ['#define ALT_STEPPER_SPR 200.0f'] },
+            ]
+        },
+    },
+    {
+        id: 'LD',
+        title: 'Altitude Driver',
+        label: 'Which driver board are you using to drive the Altitude stepper motor:',
+        variable: 'altdrv',
+        condition: "($autopa == Y)",
+        preamble: ['// Using the {v} driver for ALT stepper motor'],
+        define: 'ALT_DRIVER_TYPE',
+        control: {
+            type: 'radioimg',
+            choices: [
+                { key: 'TU', value: 'TMC2209-UART', image: '/images/tmc2209.png', defineValue: 'DRIVER_TYPE_TMC2209_UART' },
+                { key: 'TS', value: 'TMC2209-Standalone', image: '/images/tmc2209.png', defineValue: 'DRIVER_TYPE_TMC2209_STANDALONE' },
+            ]
+        },
+    },
+    {
+        id: 'LA',
+        title: 'Altitude Advanced Settings',
+        label: 'These are some advanced settings you may want to override. The defaults are set already. Please only change them if you are sure what they do and what their valid ranges are. Enter the ALT stepper specs and desired settings:',
+        variable: 'altpower',
+        condition: "($altdrv == TU)",
+        preamble: ['// Define ALT stepper motor power settings'],
+        define: '',
+        control: {
+            type: 'textinput',
+            choices: [
+                { key: 'P', label: 'Power rating in mA', defaultValue: '{Defaults.PowerRating.alt}', defineLine: '#define ALT_MOTOR_CURRENT_RATING      {0} // mA' },
+                { key: 'O', label: 'Operating percentage', defaultValue: '{Defaults.PowerUtilization.alt}', defineLine: '#define ALT_OPERATING_CURRENT_SETTING {0} // %' },
+                { key: 'S', label: 'Microstepping setting', defaultValue: '{Defaults.AZALTMicrostepping.alt}', defineLine: '#define ALT_MICROSTEPPING             {0} // steps' },
+                { key: 'H', label: 'Hold current percentage (0 to power down)', defaultValue: '{Defaults.HoldPercentage.alt}', defineLine: '#define ALT_MOTOR_HOLD_SETTING        {0} // %' },
+            ]
+        },
+        postamble: [{
+            literal: [
+                '#define ALT_STEPPER_SPEED             1500',
+                '#define ALT_STEPPER_ACCELERATION       500',
+                '',
+                '// Is it going the wrong way?',
+                '#define ALT_INVERT_DIR 0'
+            ]
+        }]
+    },
+    {
+        id: 'LAO',
+        title: 'Altitude Always On',
+        label: 'It is possible to keep the altitude motor energized at all times to prevent any shifting in position. This is usually not needed.',
+        variable: 'altalwayson',
+        condition: "($autopa == Y)",
+        preamble: ['// Define ALT always-on'],
+        define: 'ALT_ALWAYS_ON',
+        control: {
+            type: 'radioimg',
+            choices: [
+                { key: 'Y', value: 'Yes', image: '/images/none.png', defineValue: '1' },
+                { key: 'N', value: 'No', image: '/images/none.png', defineValue: '0' },
+            ]
+        },
+    },
     createStepperStealthModeStep(),
     createDisplayStep(),
     createInfoDisplayStep(),
@@ -268,7 +342,7 @@ export const getOAMSteps = () => [
         control: {
             type: 'textinput',
             choices: [
-                { key: 'P', label: 'Pin that sensor is attached to', defaultValue: '29', defineLine: '#define DEC_HOMING_SENSOR_PIN            {0}' },
+                { key: 'P', label: 'Pin that sensor is attached to', defaultValue: '{Defaults.DECHallSensorPin.tracker}', defineLine: '#define DEC_HOMING_SENSOR_PIN            {0}' },
                 { key: 'S', label: 'Number of degrees to search for sensor', defaultValue: '10', defineLine: '#define DEC_HOMING_SENSOR_SEARCH_DEGREES {0}' },
             ]
         },