E.E. Contributing Documentation
When making changes to this project, please first discuss the changes you wish to make with the Electrical Engineering team.
- Join the project Slack
- Give a brief introduction about yourself and your skills in #team-intro and tag @ngwood111 to be assigned to an E.E. project.
- Join the overview trello board
- Join the E.E. Trello Board
Development is done from the top-down:
- The overall project requirements are well-defined by various health organizations around the world.
- Requirements are broken down into a list of deliverables.
- Deliverables are hashed out by the team leads and subject experts into more specific functions of the device.
- Functions are broken down into the components required to provide that function.
- Overview Tasks are created for the design of these components and pushed to the trello overview board.
- Overview tasks are broken down into sub tasks on the proper trello board (for us, that means the E.E. board) in the "To-Do" list.
- Team Leads move some tasks to the "Daily Task" list on Trello based on what is most time-critical for the day.
- Non-time-critical tasks that are being worked on are moved to the "Doing" list.
- Once a task in the "Doing" list is finished, it is moved to the "Ready To Review" list.
- Hardware tasks in the "Ready To Review" list of the E.E. Trello board may be reviewed by any electrical engineer but must not be reviewed by the same who completed the task. The task is then moved to "Testing" if the item is hardware or to "Done" if it's a non-hardware deliverable (i.e. documentation)
- "Testing" tasks may be tested by anyone with the equipment to do so. The Hardware Testing Document supplies the required test information and deliverable forms. Once completed, these tasks move to the "Done" list.
Each hardware task shall have the following information:
- Number I/o
- Expected I/o
- Power specification (Voltage/Amperage/Wattage)
- Required Functionality
- RTL Logic (optional)
- Combinatorial Logic (optional)
- Safety Requirements
Number of I/o: 5 Power Specification: 3.3v, 0.1a, 33mw Required Functionality: Return HIGH always
Safety Requirements: Should automatically pull O2 LOW if O1 goes LOW Overvoltage and overcurrent protection