URCA CAN Tooling ✨ #176
URCA CAN Tooling ✨ #176
Conversation
dchansen06
added
Documentation
dchansen06
added
the
1 URGENT
| inc/ | ||
| !inc/output.dbc | ||
|
|
||
| # CANfigurator | ||
| Autogen/CAN/Inc/can_msg_ids.h | ||
| Autogen/CAN/Inc/CANDler.h | ||
| Autogen/CAN/Inc/Custom_CAN_ID.h | ||
| Autogen/CAN/Inc/GR_IDS.h | ||
| Autogen/CAN/Inc/output.dbc | ||
| Autogen/CAN/Src/output.dbc | ||
| Autogen/CAN/Doc/output.dbc |
There was a problem hiding this comment.
In it's current form I think the full paths will not work (off of memory) but also this can be simplified greatly
| inc/ | |
| !inc/output.dbc | |
| # CANfigurator | |
| Autogen/CAN/Inc/can_msg_ids.h | |
| Autogen/CAN/Inc/CANDler.h | |
| Autogen/CAN/Inc/Custom_CAN_ID.h | |
| Autogen/CAN/Inc/GR_IDS.h | |
| Autogen/CAN/Inc/output.dbc | |
| Autogen/CAN/Src/output.dbc | |
| Autogen/CAN/Doc/output.dbc | |
| Doc/*.dbc | |
| Inc/*.h |
There was a problem hiding this comment.
This file is an extraneous duplicate of the one in Autogen/CAN/Inc
There was a problem hiding this comment.
This file is an extraneous duplicate of the one in Autogen/CAN/Inc
There was a problem hiding this comment.
This file is an extraneous duplicate of the one in Autogen/CAN/Inc
There was a problem hiding this comment.
This file is an extraneous duplicate of the one in Autogen/CAN/Inc
| use File::Basename; | ||
| use File::Path qw(make_path); | ||
| my $yaml_file = $ARGV[0] // 'format.CANdo'; | ||
| my $output_file = $ARGV[1] // 'can_msg_ids.h'; |
There was a problem hiding this comment.
Please pick a capitalization format and stick to it for all of them
There was a problem hiding this comment.
CANDler.h is a reserved name, please call it something else (maybe GRCAN_MSG_DATA.h or similar)
|
Please use the
|
# Implement Perl Critic ## Problem and Scope Trying to resolve issue #174 for CAN URCA, who are writing in Perl. A Perl::Critic implementation was desired for verifying commits. ## Description Added a minimal Perl::Critic file with an appropriate GitHub Action in a .yml file, which is named similarly. Outputs to `$GITHUB_STEP_SUMMARY` and as GitHub annotations within the PR context ## Gotchas and Limitations A .perlcritic file allows for a range of harshness when it comes to checking, as well as how descriptive it is in describing errors. This ranges from 1-5 and 1-11, respectively. ## Testing - [x] HOOTL testing - [ ] HITL testing - [x] Human tested ### Testing Details Tested by copying current Perl code in and checking output of action by hand ## Larger Impact Will help Perl code be nicely written ## Additional Context and Ticket Resolves #174 Helps #176 Parallel to #185 --------- Co-authored-by: Daniel Hansen <dchansen06@gmail.com>
| - name: Install YAML::XS | ||
| uses: perl-actions/install-with-cpanm@v1 | ||
| with: | ||
| install: YAML::XS |
There was a problem hiding this comment.
Consider switching to one that provides caching for faster runtimes
| - name: Install YAML::XS | |
| uses: perl-actions/install-with-cpanm@v1 | |
| with: | |
| install: YAML::XS | |
| - name: Setup Perl | |
| uses: shogo82148/actions-setup-perl@v1 | |
| with: | |
| install-modules: 'YAML::XS' |
5 participants
URCA Can Tooler
Problem and Scope
Last year CAN ID updating very painful and sad -- manual downloading/parsing of google sheet per change.
Description
ID Constants to autogenerate header files upon compile from custom yaml format to enums/structs/as needed.
Gotchas and Limitations
No nice UI, single raw huge yaml file. Other stuff.
Testing
Lots of it. Error handling for all incorrect input, testing with last year's data spreadsheet
Testing Details
Yes
Larger Impact
Reduce data->code conversion errors, less manual human labor & upkeep needed to manage IDs.
Additional Context and Ticket