watonomous.github.io

[ Electrical Division : Onboarding ]

Created by [ Rowan Dempster], last modified by [ Avery Chiu] on Jan 08, 2021

Introduction

Hello, welcome to Telemetry! Below you will find resources to help you get familiar with our workflow, and hopefully better prepare you for the term to come :)

Onboarding Checklist for W21

Below is a checklist for onboarding for Winter 2021. You should have completed these tasks before or on the dates listed below. Most of the links you will need are located in the setup section. If you run into trouble you can message the [tech support channel for any platform issues, the telemetry/CAN channels for technical advice,]{.inline-comment-marker data-ref=”4b64bc8e-b96c-4c9d-8361-69c3efa441fb”} or me Avery Chiu{.confluence-userlink .user-mention}, the telemetry manager for W21 via Discord.

Sun, Jan 3: Attend the Software Onboarding
Wed Jan 6: Set up tools for communication, namely Discord, GSuite, Gitlab, Jira, and Confluence. Make sure you have logged onto these platforms and have created an account for them. If you are not familiar with these tools, take the time to explore them.
Thurs Jan 7: Install Git on your machine and go through the Gitlab tutorial if you need to.
Thurs Jan 7: Attend the knowledge transfer session.
Fri Jan 7: Prepare your development environment by making sure you can ssh into WATO's servers. The guide to set this up is located here: WATO Mono-repo. Try out some ROS Tutorials within the servers to learn how ROS works.
Mon Jan 11: Read through the following links: CSS Electronics, CAN Bus Intro to understand CAN at a high level, Intro to CAN document to learn more about the inner-workings of CAN. This is important to understand how we interact with the vehicle.

See the setup section for links to these resources.

Setup

Follow the links below to set up everything you need to be an effective member of the electrical team. Below are things you will need to install/configure.

Platform Onboarding: provides you information with all the different tools we use to communicate and organize everything.
Git and Gitlab Tutorial: provides information on installing/using Git. Make sure to install Git Bash.
[Telemetry Repo]{.inline-comment-marker data-ref=”dbba4f65-7f1c-4ea0-a5cf-89be1c159c19”}[:]{.inline-comment-marker data-ref=”dbba4f65-7f1c-4ea0-a5cf-89be1c159c19”} Link to telemetry repo that you should clone
CAN Interface Repo: Link to the CAN interface repo, note that most of the files are located in the other branches in this repo.
WATO Mono-repo: Where all our code will end up being stored.

Workflow of the Team

Typically, the team meets once a week to discuss the progress of the project and work on the tasks for the week. Any questions can generally be directed to the acting manager. Our team uses JIRA to keep track of weekly and ongoing tasks - click here to see the JIRA workflow for electrical.

Using GitLab

WATO uses GitLab for its version control, and the Telemetry repo can be found here. Below are some instructions for interacting with the Telemetry repo.

For more information about our conventions with git, click here.

Important things to know

The telemetry team uses a few different technologies in its day to day development. Although you will learn a lot about them on the team, it may be useful to look into them outside of work sessions.

Most of our code is written in [python]
We work with the [CAN bus] inside the car to read data about the battery
Our car's computer runs [Ubuntu] so it is useful to be familiar with the command line

Document generated by Confluence on Nov 28, 2021 22:40

Atlassian