✏️ HW 1 Setting up CCS and Git#

📜 Agenda#

  • Create a Bitbucket repository.

  • Configure git repository.

  • Install Code Composer Studio.

  • Setup Code Composer Studio (CSS) integrated development environment (IDE).

  • Import CCS project files.

Note

Don’t worry if it doesn’t work right. If everything did, you’d be out of a job.

💻 Procedure#

Warning

The GIF animations provided on this page are intended to complement the main resources, rather than serve as the main source of information. It’s important to thoroughly read the text instructions in order to understand and follow the guidance. If the instructions are unclear, you can refer to the supplementary GIF animations for further clarity. However, solely relying on the animations without reading the accompanying text may make it difficult to accurately follow the instructions.

Create Bitbucket Repository#

  • Create a Bitbucket account if you don’t have one.

  • Log in Bitbucket.

  • Browse to https://bitbucket.org/stanbaek2/ece382_wksp/src/master/.

  • Click on the three dots (\(\cdots\)) on the top of the right-hand navigation for more options.

  • Select Fork this repository.

  • Enter “ECE382” for Project.

  • Name this new repository ECE382_LastName_FirstName.

  • Ensure the access level is Private repository.

  • Give both your instructor and the course director (Dr. Baek) read access: Click Invite and then click Add members. Provide them read access. The instructors’ Bitbucket email addresses are as follows:

    • Dr. Baek: baek

    • Dr. York: york

    • Maj Seery: seery

    • Capt Yarbrough: yarbrough


../_images/HW1_GitFork.gif

Important

Please name your repository as ECE382_LastName_FirstName. This will help instructors find your repository easily.

  • You may need to create a Bitbucket app password as follows.

  • Click Your Profile on the top of the right-hand navigation and then click Personal Settings.

  • Click App Passwords and then click Create app password.

  • Write your preferred label and select permissions as needed.

  • Click Create.

  • Save the password as you cannot view it after you create it.

../_images/HW1_BitbucketAppPassword2.gif

Install Git#

  • Browse to git-scm.com to download 64-bit Git for Windows setup

  • Install Git with the default settings. Git is already installed on Mac.

  • Create a folder named workspace under your home folder, e.g., C:\Users\stanley.baek\workspace.

  • Right-click the workspace folder and select Git Bash Here as shown below.

  • From your repository in Bitbucket, click Clone and copy the command that begins with git clone by clicking on the copy button as shown below.

  • Paste it within the Bash terminal (middle-click, right-click > Paste, or Shift+Ins to paste) and add a space followed by a period as shown below. The period at the end means that the destination is the current folder. Hit Enter.

  • If it asks for a password, enter the app password you saved in the previous step.

  • Notice that you have (master) at the end of the folder name.

../_images/HW1_GitClone.gif

  • The figure below shows an example of a local workspace folder on your computer.

../_images/HW1_Workspace.png

  • Go back to Git Bash. If you have already closed it, right-click on an empty space inside the workspace folder and select Git Bash Here.

  • Type git remote -v. It will return two lines showing that origin is your remote repository at bitbucket.org for both fetch and push.

  • Type git remote add upstream https://stanbaek2@bitbucket.org/stanbaek2/ece382_wksp.git (or copy & paste) and hit Enter.

  • Type git remote -v. It will now return four lines showing that upstream is the original instructor’s repository that you forked from.

../_images/HW1_GitAddUpstream.gif

  • Whenever there are any updates on the original code, you will be asked to run git fetch upstream to update your local files.

  • Your default push and pull repository is origin, which is your Bitbucket repository.

../_images/HW1_FetchUpstream.png
Image is sourced from Stakeoverflow

Install Code Composer Studio (CCS).#

  • Download Code Compose Studio 12.4.0 using one of the following methods

    • Go to https://www.ti.com/tool/download/CCSTUDIO/12.4.0 to download Windows on-demand installer for CCS IDE. For Mac users, download macOS on-demand installer for CCS IDE.

    • Go to Teams > General > Files > Class Materials > Software and download ccs_setup_12.x.x.xxxxx.exe.

  • Run the installer by double-clicking the ccs_setup_12.x.x.xxxxx.exe executable.

  • Begin the installation process, by default it will ask you to install under the C:\ti folder, which is recommended.

  • Select Custom Installation (Recommended)

  • Select the processor support for SimpleLink MSP432 MCUs.

  • Ensure the default Install debug probe is selected and leave the rest unselected.

  • Click Next until installation begins.

  • Click Finish and your installation should proceed to completion.

../_images/HW1_CCS_Setup.gif

Import Project Files.#

Attention

The following steps are critical. If you make a mistake, it may take hours to fix the problem later this semester. Please follow the instructions carefully.

  • Open CCS.

  • When asked to Select a directory as workspace, select Browse and browse to your workspace folder. Select the Use this as the default and do not ask again check box. Click Launch

  • Import all the projects into CSS. File > Import… Choose Code Composer Studio > CCS Projects and click Next.

  • Select Search Directory and click the Browse... option. Browse to the workspace folder.

  • CCS should discover many projects inside the workspace folder. Click Select All (DO NOT check Automatically import... or Copy projects... options). This will have CCS reference the project from the original location and preserve the original directory structure required to build. Click Finish.

  • In Project Explorer, expand HW01_Git and double click test.txt to open. Edit the file and save. You can simply add “My name is …” as shown below.

../_images/HW1_CCS_Config.gif

Push Your Code.#

  • Go back to Git Bash. If you have already closed it, right-click on an empty space inside the workspace folder and select Git Bash Here.

  • Type git add -A or git add -all and hit Enter.

  • Type git commit -m "Homework 1" and hit Enter.

  • Type git push as shown below.

  • You can run git status to check the current status of your local repository.

  • Enter your username and password if prompted.

  • Refresh your Bitbucket repository and ensure your push has been made through.

../_images/HW1_GitPush.gif

  • In the future you will repeat these three steps when committing your changes:

    • git add -A

    • git commit -m “Comment”

    • git push

Attention

It is your responsibility to check your files have been successfully pushed to your Bitbucket repository. Always visit your Bitbucket repository after you push your assignments to the repository.

Tip

CCS comes with built-in GIT, and it can be opened from CCS menu > View > Other > Git > Git Staging. You can commit and push at the same time. There are also many third-party graphic user interface (GUI) clients. Check out https://git-scm.com/downloads/guis.

Unhide File Extensions#

  • Go to the workspace folder on your computer. Then, go to the inc folder.

  • Do you have files with the same names? If you have two files with the same name, one of them is a c source file (*.c) and the other is a header file (*.h). Windows hides file extensions unless you change its default setting.

  • If your Windows File Explorer displays file extensions such as .c and .h, skip this section.

  • Click Options and select View as shown in the gif anmination below.

  • Uncheck Hide extensions for known file types. You can also change some of the Windows default settings shown in the animation.

  • Click OK. Now you can see file extensions.

../_images/HW1_ShowFileExtensions.gif

Convert Tabs to Spaces#

  • Open CCS if it is closed.

  • Open Text Editors Settings. Window > Preferences > General > Editors > Text Editors.

  • Check Insert spaces for tabs and Remove multiple spaces on backspace/delete as shown below.

  • Click Apply and Close.

../_images/HW1_Tabs2Spaces.png

Hardware Diagnostics Tool#

  • Click 🙋 FAQ on the left sidebar of this website. If the sidebar is hidden, click the hamburger button (the triple bars ☰).

  • Go to How to run the hardware diagnostics tool for hardware issues on my robot? section and complete the hardware diagnotics.

  • While you are running the tool, take a picture of your robot. Your picture must show one of the tests on the LCD as shown below. Ensure you have a small AF symbol on each test screen.

  • Submit the picture in Gradescope.

../_images/HW1_HardwareDiagnostics.jpg

🚚 Deliverables#

Take screenshots of the following and submit them via Gradescope. Use Snip & Sketch (Win+Shift+S) on Windows 10/11 or Shift+CMD+4 on MacOS to take a screenshot. Save it in png or jpg.

Warning

Do NOT take pictures of your computer screen using your phone because (i) it can result in sampling aliasing, as explained in ECE215/ECE315, (ii) it will require more steps compared to a simple screen capture, and (iii) the resulting image will always be blurrier than a direct screen capture.

  • [5 Points] Provide a screenshot of your Bitbucket repository as shown below

../_images/HW1_Deliverable1.png

  • [5 Points] Go to Windows Settings > Apps. Click on Code Composer Studio and take a screenshot as shown below. For Mac users, it is in the Applications folder.

../_images/HW1_Deliverable2.png

  • [6 Points] While you are running the hardware diagnostics tool, take a picture of your robot and submit it in Gradescope.


  • [-10 Points] Take a picture of your screen with a mobile device or digital camera and submit it in Gradescope. Yes, I am serious…

Warning

You will receive a grade of -10 everytime you submit a picture of computer screen taken by your phone or mobile device.