Main Page

We should write a data sheet for each of our subsystems to make new member ramp up and handover of projects easier, this will also help us for demonstration of quality control during competition mile stones.

**Sections**

Changes

Changes from previous revision of this document to the current one

Overview

Overview of System, basically what does it do

Block diagram

Requirements

Requirements that put physical values to the overview Relevant DIETR requirements from the CSDC competition rules

Interface

External Interface

List all connections used in the Bus Connector and any wire connectors transitioning from the subsystem to other subsystems, each connection should be described by its logical function and its electrical function (ie open-collector, SPI (max Baud ), etc).

Any I2C or SPI interfaces should list all attached devices and their addresses or corresponding chip select pins.

List what major power consuming ICs in the System are connected to what power rail. List power consumption on each rail.

CAN Bus Commands

List all implemented CAN bus commands, what data they expect or provide, etc.

Indicate what variables or functions are called when a CAN bus command is received. Indicate what causes a CAN message to be transmitted.

Internal Interface

List all connections used internally to the subsystem, each connection should be described by its pin name (what firmware expects), logical function and its electrical function (ie open-collector, SPI (max Baud ), etc).

Any I2C or SPI interfaces should list all attached devices and their addresses or corresponding chip select pins.

List all non passive components Designators and the corresponding Manufacturers part number

Hardware Implementation

board design, simulations, descriptions etc.

Software Implementation

Data Flow between tasks for FreeRTOS based firmware, indicate all Mutexes, Semaphores, and queues.

Filter or specific function such as degaussing specifications.

List of Contributing Members

Anyone who has worked on the system and their contribution.

Known Issues

Any known issues with current hardware or software

Navigation
Print/export
QR Code
QR Code subsystem_data_sheets (generated for current page)