Refactor ci #3

calvinmorrow · 2024-03-15T03:03:03Z

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Addresses # (issue)

Dependencies

List any dependencies that are required for this change, including a full list of libraries required, especially if it is a new or otherwise unused library in the OpenHornet software.

Type of change

New software module (new software module for slave)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update outside of the automatically-generated doxygen documentation.

Checklist:

My code follows the (style guidelines)[https://jrsteensen.github.io/OpenHornet-Software/d4/d46/md__2github_2workspace_2_s_t_y_l_e_g_u_i_d_e.html] of this project
(I have complied with the software manual)[https://jrsteensen.github.io/OpenHornet-Software/d7/d78/md__software_manual.html] for this project
I have performed a self-review of my own code
I have commented my code fully with Doxygen compatible comments, particularly in hard-to-understand areas
I have made corresponding changes to non-Doxygen generated documentation
My changes generate no errors on compile in Arduino IDE
My changes generate no new warnings on compile in Arduino IDE
Any dependent changes have been merged and published in downstream modules

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

I have tested the sketch in-circuit in DCS with DCS-BIOS and outputs (displays, LEDs, etc.) function as expected.
I have tested the sketch in-circuit in DCS with DCS-BIOS and HID inputs (switchs, pots, etc.) function as expected, with switches moving the correct direction.
I have tested the sketch in-circuit in DCS with DCS-BIOS and any logic in the sketch has been tested and functions as expected.
This code has not yet been tested in-circuit.
This code has not yet been tested in DCS-BIOS.

Description

Test Configuration

Firmware version:
Hardware:
Toolchain:
SDK:

WIP

…cation

Github CI

Added `@details` tag for doxygen header. Changed license from BY-NC-SA 3.0 to Apache 2 in file header. Closes jrsteensen#13

Broke Doxygen Workflow into two separate workflows: Main branch workflow generates doxygen and deploys it to gh-page, while develop branch workflow just generates the docs to the ./docs/html folder.

Buuuuut....it helps if the develop branch workflow doesn't deploy to gh-pages...

Non-Release Merge of Develop to Main for testing.

Reverted some changes to include more information in the template and not break doxygen docs.

Update OHSketchTemplate.ino

Fixed `Doxygen` typo.

Moved contributing info to wiki.

Updated repo templates Updated repo readme Moved contributing to wiki Updated sketch template Integrated Sandra's Master Arm panel code into the example one. Co-Authored-By: Calvin Morrow <[email protected]> Co-Authored-By: Sandra Carroll <[email protected]>

Latest Develop to Master

Diagnosing why the sketch is not populating in doxygen when the template is.

Got it showing doxygen and both file's info. (Local testing is important boys and girls!)

Updated doxygen and fixed files to display appropriately.

Deleting erroneous files.

Updated 1A6-SPIN_RCVY_PANEL.ino with the latest style guide for comments and naming standard.

Updated comments per the latest template for docs.

Added logo to header Updated title Updated description Added version number (which stays the same until release.)

Mostly just still experimenting with header and logo stuff.

Fixed logo link.

Added a couple helpful links

Made spelling corrections throughout. No changes to code itself. (Mostly just testing cLion IDE.) Signed-off-by: John Steensen <[email protected]>

For general shared IDE configuration as desired moving forward. Signed-off-by: John Steensen <[email protected]>

Signed-off-by: John Steensen <[email protected]>

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A7A1-COMM_PANEL New sketch for the comm panel. * Update 4A7A1-COMM_PANEL.ino added attention note on spinning the ILS rotary.

Attribution was misspelled as `Atribution`. Signed-off-by: John Steensen <[email protected]>

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * Feature New Sketch 4A4A2-EXT_LIGHTS_PANEL New sketch for the 4A4A2-EXT_LIGHTS_PANEL * Update 4A4A2-EXT_LIGHTS_PANEL.ino updated comments * Update 4A4A2-EXT_LIGHTS_PANEL.ino updated description as reqeusted.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A5A2-APU_PANEL New sketch for the 4A5A2-APU_PANEL with mag switch logic. * Update 4A5A2-APU_PANEL.ino fixed code layout for doxygen docs.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A5A1-FUEL_PANEL New sketch for the 4A5A1-FUEL_PANEL, with fuel dump mag-switch logic.

Fixed spelling throughout sketches. No change to programming, version number not incremented. Signed-off-by: John Steensen <[email protected]>

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A6A1-FCS_PANEL New sketch for the FCS panel.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A7A2-OBOGS_PANEL New sketch for the OBOGS panel.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Skectch 5A10-DEFOG_PANEL New sketch for the 5A10-DEFOG_PANEL with Joystick Library added as a new submodule.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL. * New Sketch 3A2A1-SEAT_CONTROLS New sketch for the seat.

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL. * New Sketch 5A9A1-KY58_PANEL.ino New sketch for the 5A9A1-KY58_PANEL

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL. * New Sketch 5A6A1-INTR_LT_PANEL.ino New sketch for the 5A6A1-INTR_LT_PANEL

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL. * New Sketch 5A7A1-SNSR_PANEL 5A7A1-SNSR_PANEL.ino * Refactored Sensor Sketch Panel Updated the code to use similar logic to DcsBios::SwitchMultiPosition to add in debounce logic. Also created a switch specific class to handle the radar switches pull logic so it can get into and out of EMERG with the wiring as specified in the interconnect diagram. * Just had ChatGPT comment the header file. Signed-off-by: John Steensen <[email protected]> --------- Signed-off-by: John Steensen <[email protected]> Co-authored-by: John Steensen <[email protected]>

…R instead of relative directories

…causing errors with arduino joystick

calvinmorrow and others added 30 commits October 12, 2023 17:18

Add distributed Make system for recursive sketch compilation

75e1bd2

Update CONTRIBUTING.md

da4a33d

WIP

Add Makefile, CI, and Git Submodule additions to Manual. Update Makefile

b613060

Add artifact release steps

5b9a3bb

Use CI workflow on main and develop branches

9677615

Update docs

aaf2682

Add esp32 build support. Refactor makefile includes

0188ba6

Update Github Actions CI workflow to install esp32 tools

067477f

Update docs

dcc35be

Update CI workflow to cache esp32 downloads and install to correct lo…

f82fb32

…cation

Merge branch 'develop' into github-ci

987fe29

Merge pull request jrsteensen#12 from calvinmorrow/github-ci

ddc53ae

Github CI

Update OHSketchTemplate.ino

7f6b19e

Added `@details` tag for doxygen header. Changed license from BY-NC-SA 3.0 to Apache 2 in file header. Closes jrsteensen#13

Adjusted Workflows

db7f659

Broke Doxygen Workflow into two separate workflows: Main branch workflow generates doxygen and deploys it to gh-page, while develop branch workflow just generates the docs to the ./docs/html folder.

Update develop-generate-doxygen-docs.yaml

08b3c85

Buuuuut....it helps if the develop branch workflow doesn't deploy to gh-pages...

Fixing workflows

6c27bfe

Merge pull request jrsteensen#14 from jrsteensen/develop

126a02e

Non-Release Merge of Develop to Main for testing.

Update OHSketchTemplate.ino

3b191e8

Reverted some changes to include more information in the template and not break doxygen docs.

Merge pull request jrsteensen#15 from jrsteensen/develop

8508485

Update OHSketchTemplate.ino

Update OHSketchTemplate.ino

f6a6a10

Fixed `Doxygen` typo.

Update SoftwareManual.md

0768e79

Update CONTRIBUTING.md

f4ddac2

Moved contributing info to wiki.

Merge pull request jrsteensen#16 from jrsteensen/develop

84e71c4

Latest Develop to Master

Doxygen diagnostics

a92cb1b

Diagnosing why the sketch is not populating in doxygen when the template is.

Merge branch 'main' of https://github.com/jrsteensen/OpenHornet-Software

7af7948

Updated doxygen and fixed files to display appropriately.

7025f10

Got it showing doxygen and both file's info. (Local testing is important boys and girls!)

Merge pull request jrsteensen#22 from jrsteensen/develop

39993ac

Updated doxygen and fixed files to display appropriately.

Deleting erroneous files.

da248c7

Merge pull request jrsteensen#23 from jrsteensen/develop

9442b84

Deleting erroneous files.

Arribe and others added 30 commits March 2, 2024 21:49

refactor-1A6-SPIN_RCVY_PANEL (jrsteensen#73)

2b635b5

Updated 1A6-SPIN_RCVY_PANEL.ino with the latest style guide for comments and naming standard.

refactored_comments-1A7-HUD_PANEL (jrsteensen#74)

8667b8c

Updated comments per the latest template for docs.

Update header information for the doxygen docs

ca719ba

Added logo to header Updated title Updated description Added version number (which stays the same until release.)

Updating Readme and Doxyfile

225a887

Mostly just still experimenting with header and logo stuff.

Update README.md

67d6bcb

Fixed logo link.

Update Doxyfile

ad29cb6

Update LICENSE.md

a8888a7

Update STYLEGUIDE.md

1920e83

Update STYLEGUIDE.md

43880af

Added a couple helpful links

Spelling corrections throughout

9a2179e

Made spelling corrections throughout. No changes to code itself. (Mostly just testing cLion IDE.) Signed-off-by: John Steensen <[email protected]>

Adding cLion IDE repository information

80da4f0

For general shared IDE configuration as desired moving forward. Signed-off-by: John Steensen <[email protected]>

Adding some project-based IDE code analysis.

7f50cf3

Signed-off-by: John Steensen <[email protected]>

[NEW SKETCH]: 4A7A1-COMM_PANEL.ino (jrsteensen#75)

6799515

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A7A1-COMM_PANEL New sketch for the comm panel. * Update 4A7A1-COMM_PANEL.ino added attention note on spinning the ILS rotary.

Updated file header

adfe58e

Attribution was misspelled as `Atribution`. Signed-off-by: John Steensen <[email protected]>

[NEW SKETCH]: 4A5A1-FUEL_PANEL.ino (jrsteensen#78)

1eb1145

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A5A1-FUEL_PANEL New sketch for the 4A5A1-FUEL_PANEL, with fuel dump mag-switch logic.

Spelling Corrections

0850ee9

Fixed spelling throughout sketches. No change to programming, version number not incremented. Signed-off-by: John Steensen <[email protected]>

Merge remote-tracking branch 'origin/develop' into develop

3fa4d7d

Spelling Corrections

f39c8e1

Fixed spelling throughout sketches. No change to programming, version number not incremented. Signed-off-by: John Steensen <[email protected]>

[NEW SKETCH]: 4A6A1-FCS_PANEL.ino (jrsteensen#79)

8f8c3b4

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A6A1-FCS_PANEL New sketch for the FCS panel.

[NEW SKETCH]: 4A7A2-OBOGS_PANEL.ino (jrsteensen#81)

967cb34

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 4A7A2-OBOGS_PANEL New sketch for the OBOGS panel.

[NEW SKETCH]: 5A10-DEFOG_PANEL.ino (jrsteensen#83)

508b0a7

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Skectch 5A10-DEFOG_PANEL New sketch for the 5A10-DEFOG_PANEL with Joystick Library added as a new submodule.

[NEW SKETCH]: 5A8A1-SIM_CNTL_PANEL.ino jrsteensen#58 (jrsteensen#84)

27cbf3f

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL.

5A6A1-INTR_LT_PANEL (jrsteensen#88)

1881e99

* refactored_comments-1A7-HUD_PANEL Updated comments per the latest template for docs. * New Sketch 5A8A1-SIM_CNTL_PANEL New sketch for the 5A8A1-SIM_CNTL_PANEL. * New Sketch 5A6A1-INTR_LT_PANEL.ino New sketch for the 5A6A1-INTR_LT_PANEL

Update Makefile to conform to OpenHornet directory layout. Use ROOTDI…

0e5f3af

…R instead of relative directories

Fix faulty boards.txt setting clobbering the arduino ide version and …

9336b37

…causing errors with arduino joystick

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor ci #3

Refactor ci #3

calvinmorrow commented Mar 15, 2024

Refactor ci #3

Are you sure you want to change the base?

Refactor ci #3

Conversation

calvinmorrow commented Mar 15, 2024

Description

Dependencies

Type of change

Checklist:

How Has This Been Tested?

Description

Test Configuration