Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
instrumentation:cvl:initial_specification [2016/01/18 05:56] kluong [Deliverables] |
instrumentation:cvl:initial_specification [2021/09/19 21:59] (current) |
||
|---|---|---|---|
| Line 7: | Line 7: | ||
| The task at hand is to build a current and voltage data logger that will assist other students with their endeavors in the lab. Commercial, off the shelf data loggers exist but are often proprietary and closed source. We have a unique opportunity to build an open source data logging platform that can serve as an educational tool for other students in the future as well. | The task at hand is to build a current and voltage data logger that will assist other students with their endeavors in the lab. Commercial, off the shelf data loggers exist but are often proprietary and closed source. We have a unique opportunity to build an open source data logging platform that can serve as an educational tool for other students in the future as well. | ||
| - | ====== Hardware ====== | + | ====== Details ====== |
| + | |||
| + | ===== Hardware ===== | ||
| The CVL needs to have hardware that is able to collect current and voltage readings and transmit that data to a computer. | The CVL needs to have hardware that is able to collect current and voltage readings and transmit that data to a computer. | ||
| - | ====== Firmware ====== | + | Major blocks: |
| - | Firmware needs to be written that will allow on the on-board microcontroller to run during the data collection process. | + | * Microcontroller and supporting components |
| + | * Power circuits (regulators, etc.) | ||
| + | * Printed circuit board | ||
| + | * Data collection circuitry (op amps, external ADCs, cables, etc.) | ||
| + | * User interface components (buttons, switches, etc.) | ||
| + | |||
| + | ===== Firmware ===== | ||
| + | |||
| + | Firmware needs to be written that will allow on the on-board microcontroller to run during the data collection process. The firmware sits in-between the hardware and the software application that runs the CVL. | ||
| + | |||
| + | Here is what we need it to do: | ||
| + | |||
| + | * Accept commands from the CVL control application | ||
| + | * Run sampling subroutines | ||
| + | * Handle power management | ||
| + | * Send real-time sampling data to the CVL control application | ||
| The firmware is required to be posted on Github as an open sourced repository. | The firmware is required to be posted on Github as an open sourced repository. | ||
| - | ====== Software ====== | + | ===== Software ===== |
| - | The software component consists of the software that will sit on the user's | + | The software component of the CVL will run on a user's computer and act as the primary interface to the CVL. The following objectives must be accomplished: |
| - | The software is required to be posted on Github as an open sourced repository. | + | * Collect real-time data from the CVL hardware |
| + | * Display data after collection is complete | ||
| + | * Save, browse and collect datasets | ||
| + | * Select which type of data we want to collect (current, voltage, etc.) | ||
| + | * Select what kind of sampling rate we want | ||
| + | The software is required to be posted on Github as an open sourced repository. | ||
| ====== MVP ====== | ====== MVP ====== | ||
| - | Since the initial project is being done in one semester a minimum viable product (MVP) must be built instead of a more polished prototype. See this page for more details: https://en.wikipedia.org/wiki/Minimum_viable_product | + | Since the initial project is being done in one semester a **minimum viable product** (MVP) must be built instead of a more polished prototype. See this page for more details: https://en.wikipedia.org/wiki/Minimum_viable_product |
| Think about how we can build something that will be of benefit to the most people. Someone should ultimately at the end find some use out of the tool - polishing of the tool, regardless of hardware or software can be accomplished after we have something that is done. | Think about how we can build something that will be of benefit to the most people. Someone should ultimately at the end find some use out of the tool - polishing of the tool, regardless of hardware or software can be accomplished after we have something that is done. | ||
| + | |||
| + | ====== Expectations ====== | ||
| + | |||
| + | - Drive progress as a team (with help from mentors/advisers) | ||
| + | - Ask questions | ||
| + | - Consult with other teams | ||
| + | - Keep good documentation on the wiki | ||
| + | - Be honest | ||
| ====== Deliverables ====== | ====== Deliverables ====== | ||
| Line 35: | Line 65: | ||
| - A working prototype of the CVL | - A working prototype of the CVL | ||
| - A bill of materials (BOM) for the final prototype | - A bill of materials (BOM) for the final prototype | ||
| + | - User documentation for the CVL | ||
| - Various block diagrams | - Various block diagrams | ||
| - hardware block diagram | - hardware block diagram | ||
| Line 44: | Line 75: | ||
| - A final presentation in oral and PDF form | - A final presentation in oral and PDF form | ||
| - A final paper | - A final paper | ||
| + | |||
| + | Note that some of these things may overlap with each other. For example, user documentation is definitely something that can be included in the final paper. The various block diagrams will also be used for the presentations. | ||