Adityaj5: Adityaj5 moved page GitHub/ARGO-FW to Public:GitHub/ARGO-FW

2021-09-11T04:27:51Z

Adityaj5 moved page GitHub/ARGO-FW to Public:GitHub/ARGO-FW

Jonathan: Infobox

2020-10-04T18:32:37Z

Infobox

Jonathan: Created page with "{{GithubRepo|org=IlliniSolarCar|repo=ARGO-FW}} is the home of firmware for Argo. At this point firmware for Argo is maintenance only - changes won't really be..."

2020-09-24T03:12:43Z

Created page with "{{GithubRepo|org=IlliniSolarCar|repo=ARGO-FW}} is the home of firmware for Argo. At this point firmware for Argo is maintenance only - changes won't really be..."

New page

{{GithubRepo|org=IlliniSolarCar|repo=ARGO-FW}} is the home of firmware for [[Argo (2017)|Argo]]. At this point firmware for Argo is maintenance only - changes won't really be made aside from tweaks to keep it running as it is being used for events and such (such as changes to accommodate running on one motor). Branches previously were roughly following Gitflow (see [[GitHub/b-fw]]). As of now all changes can be considered "hot fixes" and therefore branched directly to/from master.

''Note: This repo began life as'' {{GithubRepo|org=IlliniSolarCar|repo=FW}}. ''That repo was archived and this created as a clean-up of lots of old code prior to ASC 2018 from the early testing days (i.e. stuff never used on a car or even a car like system) and as a preparation for the creation of'' {{GithubRepo|org=IlliniSolarCar|repo=b-fw}}

== Workflow ==
[[File:GitFlowHotfixBranch.png|thumb|Git Flow Example Diagram]]
Like other repos this has roughly followed Git Flow (pictured). However, now that it is in maintenance mode everything can essentially be considered a "hot fix" so all branches just go to/from master.

=== Repo Structure ===
There are two shared folders of code used by every project:
* <code>common</code> - shared base code for common hardware like Timers, CAN, etc.
* <code>mbed</code> - the OS for the car. This is a submodule of {{GithubRepo|org=CalSol|repo=mbed}} (specifically the Zephyr branch)
There are two template projects depending on which MCU the board is using:
* <code>mbed11c14_skelton</code> - for boards using the LPC 11C14 chip
* <code>mbed1549_skeleton</code> - for boards using the LPC1549 chip
There are 6 board projects:
* <code>BMS</code> - battery management system code
* <code>Lights</code> - code for Lights boards (note there are 4 on the car, they all share the same code)
* <code>MCC</code> - code for the Motor Controller Controller
* <code>PDS</code> - code for the power distribution system
* <code>Thermistors</code> - code for the thermistors board in the Battery
* <code>dashboard</code> - code the dashboard

=== Pull Requests ===
Pull Requests on Argo-FW at this time will pretty much all go into master. Code should be tested prior to merging and will be reviewed in the PR. Approval from a codeowner is required to merge a PR.

== Initial Setup ==
In order to get the code onto your computer, use <code>git clone --recursive <repo> <optional></code>. The <code>--recursive</code> option looks for submodules in the repo and clones them into the correct directory. If this option was omitted during the initial clone, run the command <code>git submodule update --init</code> to find any un-cloned submodules and clone them.

The submodules in this repo are our fork of Mbed. At this point Mbed for Argo won't be changing.

Once you have the FW cloned onto your computer, follow the instructions to set up [[MCUXpresso]]. Once this is done, you should be able to work on code.

To open code on another branch, such as a work in progress or a new feature that needs more testing, checkout the branch using <code>git checkout <branch> --recurse-submodules</code>. If you forget the submodule option, use <code>git submodule update</code> to get the correct version of mbed.

← Older revision		Revision as of 18:32, 4 October 2020
Line 1:		Line 1:
		+	{{Infobox GitHub Repo\|org=IlliniSolarCar\|repo=ARGO-FW\|status=Maintenance Only\|content=Firmware from Argo\|forkOrg=\|forkRepo=\|defaultBranch=master\|access=Private\|license=All Rights Reserved to ISC\|branching=Now - Hot Fix Only\|maintainer=Electrical Group\|checks=* Reviews Required}}
		+
	{{GithubRepo\|org=IlliniSolarCar\|repo=ARGO-FW}} is the home of firmware for [[Argo (2017)\|Argo]]. At this point firmware for Argo is maintenance only - changes won't really be made aside from tweaks to keep it running as it is being used for events and such (such as changes to accommodate running on one motor). Branches previously were roughly following Gitflow (see [[GitHub/b-fw]]). As of now all changes can be considered "hot fixes" and therefore branched directly to/from master.		{{GithubRepo\|org=IlliniSolarCar\|repo=ARGO-FW}} is the home of firmware for [[Argo (2017)\|Argo]]. At this point firmware for Argo is maintenance only - changes won't really be made aside from tweaks to keep it running as it is being used for events and such (such as changes to accommodate running on one motor). Branches previously were roughly following Gitflow (see [[GitHub/b-fw]]). As of now all changes can be considered "hot fixes" and therefore branched directly to/from master.

Public:GitHub/ARGO-FW - Revision history

Adityaj5: Adityaj5 moved page GitHub/ARGO-FW to Public:GitHub/ARGO-FW

Jonathan: Infobox

Jonathan: Created page with "{{GithubRepo|org=IlliniSolarCar|repo=ARGO-FW}} is the home of firmware for Argo. At this point firmware for Argo is maintenance only - changes won't really be..."