|
|
| (16 intermediate revisions by the same user not shown) |
| Line 25: |
Line 25: |
| | | | |
| | | | |
| − |
| |
| − | = LED Switch =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Work in groups of 2 and use existing API under '''gpio.hpp''':
| |
| − |
| |
| − | * Interface an external LED (such as P2.1) to "Board A", which we will refer to as "LED Board"
| |
| − | * Interface an external switch (such as P2.2) to "Board B", which we will refer to as "SW Board" (switch board)
| |
| − | * Connect the LED Board and SW Board together using "Port 2"
| |
| − | *: Example: P2.0 of LED board connects to P2.0 on the SW Board
| |
| − | *: Do not forget common ground
| |
| − | * LED board Software is simple, whenever P2.0 (which is interfaced to the SW Board) is detected HIGH, light up its LED (on P2.1), else turn it off
| |
| − | * On the SW Board, use "External Interrupt" API (eint.h) to detect when the switch gets pressed
| |
| − | *: The callback should simply turn a flag (global variable) to true
| |
| − | *: The callback '''''MUST NOT POLL''''', and '''''MUST NOT DELAY''''', and '''''EXIT IMMEDIATELY''''' since it is an interrupt function
| |
| − | *: Use period_init() function to initialize the callback. This initialization function is only called once before starting the RTOS
| |
| − | * On the SW Board, use the periodic callbacks, and when the flag is true, toggle the P2.0 for at least 500ms
| |
| − | *: Turn on the periodic scheduler at main.cpp
| |
| − | *: Deploy your code to periodic_callbacks.cpp (like 10Hz function)
| |
| − | * Bonus points: Use a binary semaphore in the interrupt, and have the 10Hz task wait on this semaphore with 0 ms block time. See the FreeRTOS video about the binary semaphore
| |
| − | *: Note that if you use a periodic callback, you will have to use zero block time for the semaphore since you do not want to block in a period function.
| |
| − | *: '''[https://www.youtube.com/watch?v=grXuVMttVuU: Binary Semaphores]'''
| |
| − |
| |
| − | For the demo:
| |
| − | * The SW Board should detect its switch press by an external interrupt and toggle its P2.0
| |
| − | * The LED Board should detect its own P2.0 and light up the LED
| |
| − |
| |
| − | This assignment demonstrates the use of external interrupts, and how to interface different boards together. Furthermore, you should have learned the concepts of different tasks that you can run in FreeRTOS. In general, you should never have to poll for events, and you should use interrupt functionality as much as possible. Turn in ONE SUBMISSION per group with the following:
| |
| − |
| |
| − | Only turn in the relevant source code, such as main.cpp
| |
| − | Indicate at the top of the file who you worked with. (Do not have the other person turn in anything)
| |
| − |
| |
| − | = Form Groups =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Communicate with one of the class ISA to setup your groups @ Canvas. Be sure to have your group name ready and use an appropriate group name.
| |
| − |
| |
| − | Failure to do so by the deadline will result in '''''zero points''''' for the assignment. Be sure to do this before leaving the class.
| |
| − |
| |
| − | Also, order CAN transceiver hardware for your entire team (1 per person)
| |
| − |
| |
| − | = Serial Communication =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Use either UART2 or UART3 to communicate between two boards. You can work in groups of 2.
| |
| − |
| |
| − | * Locate the UART pins on your board.
| |
| − | *: Use the schematic or Wikipedia board article.
| |
| − | * Interface to the UART pins on someone else's board.
| |
| − | *: If you use UART2, you cannot use UART2 on the 2nd board (use UART3 instead).
| |
| − | * Prove that both of your boards and communicate with each other.
| |
| − | * Bonus points for doing something creative, such as one board acting like a random sensor, and the second board outputting the sensor reading on the LED display.
| |
| − | * This assignment demonstrates how to communicate with another device using UART. The UART driver is based on queues, there is no need to poll for data to arrive, or for data to be sent. Size your queues appropriately and they shouldn't be too large or too small. For example, if you service the received data every 100ms, then your queues should only need to be as big as the number of characters you expect to receive within 100ms (38400bps can provide 400 chars in 100ms).
| |
| − |
| |
| − | Turn in ONE SUBMISSION per group with the following:
| |
| − | * Only turn in the relevant source code, such as main.cpp for both boards
| |
| − |
| |
| − | = Unit Testing =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Write unit test for motor_driver.h API that will require you to use a "mock" for the sensor.h
| |
| − |
| |
| − | '''Steps:'''
| |
| − | * Add to the CGreen Makefile motor_driver.c (follow the examples there)
| |
| − | * Follow the Unit-Test template below
| |
| − | * Add your new test to the test_main.cpp by #including "test_motor_driver.cpp"
| |
| − |
| |
| − |
| |
| − | <syntaxhighlight lang="c">
| |
| − | // --------------
| |
| − | // motor_driver.h
| |
| − | // --------------
| |
| − | #ifdef __cplusplus
| |
| − | extern "C" {
| |
| − | #endif
| |
| − |
| |
| − | // badly written code (doesn't follow TDD)
| |
| − | int get_motor_pwm(void);
| |
| − |
| |
| − | #ifdef __cplusplus
| |
| − | }
| |
| − | #endif
| |
| − |
| |
| − |
| |
| − | // --------------
| |
| − | // motor_driver.c
| |
| − | // --------------
| |
| − | #include "motor_driver.h"
| |
| − | #include "sensor.h"
| |
| − |
| |
| − | int get_motor_pwm(void)
| |
| − | {
| |
| − | const int sensor_value = get_sensor_value();
| |
| − | int value;
| |
| − |
| |
| − | if(sensor_value < 0 || sensor_value > 100) value = -1;
| |
| − | else if(sensor_value >= 0 && sensor_value < 50) value = 1;
| |
| − | else if(sensor_value >= 50 && sensor_value <= 100) value = 5;
| |
| − |
| |
| − | return value;
| |
| − | }
| |
| − |
| |
| − |
| |
| − | // --------------
| |
| − | // sensor.h
| |
| − | // --------------
| |
| − | #ifdef __cplusplus
| |
| − | extern "C" {
| |
| − | #endif
| |
| − |
| |
| − | int get_sensor_value(void);
| |
| − |
| |
| − | #ifdef __cplusplus
| |
| − | }
| |
| − | #endif
| |
| − |
| |
| − |
| |
| − | // --------------
| |
| − | // sensor.c
| |
| − | // --------------
| |
| − | int get_sensor_value(void)
| |
| − | {
| |
| − | return 0;
| |
| − | }
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | <HR>
| |
| − | <syntaxhighlight lang="c">
| |
| − | #include <stdio.h>
| |
| − | #include <cgreen/cgreen.h>
| |
| − | #include <cgreen/mocks.h>
| |
| − |
| |
| − | using namespace cgreen;
| |
| − |
| |
| − | // The file under test
| |
| − | #include "motor_driver.h"
| |
| − |
| |
| − | extern "C" int get_sensor_value(void)
| |
| − | {
| |
| − | return mock();
| |
| − | }
| |
| − |
| |
| − | Ensure(test_bad_values)
| |
| − | {
| |
| − | expect(get_sensor_value, will_return(-1));
| |
| − | assert_equal(get_motor_pwm(), -1);
| |
| − | }
| |
| − |
| |
| − | TestSuite *motor_driver_get_test_suite()
| |
| − | {
| |
| − | TestSuite *suite = create_test_suite();
| |
| − | add_test(suite, test_bad_values);
| |
| − | return suite;
| |
| − | }
| |
| − | </syntaxhighlight>
| |
| | | | |
| | = Project Setup = | | = Project Setup = |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | *Setup your Project Report Template
| |
| − | *Add information about the team members
| |
| − | *Add a link to your GITLAB project and add users who can access your project:
| |
| − | *: My GITLAB username is simply, "'''preet'''"
| |
| − |
| |
| − | To copy the project template, follow these steps:
| |
| − | * Go to your class webpage:
| |
| − | *: http://www.socialledge.com/sjsu/index.php?title=Realtime_OS_on_Embedded_Systems
| |
| − | * Go to "Project Template", click "Edit" and COPY the entire Wikipedia markup
| |
| − | *: Paste this template for your project, and work on setting weekly goals in your schedule section.
| |
| − |
| |
| − | = CAN Communication =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | You can work in groups of 2:
| |
| − |
| |
| − | *Build and interface the CAN transceiver with another person's CAN transceiver.
| |
| − | *Initialize the CAN Bus (read can.h in the drivers directory).
| |
| − | *Use a simple periodic message (every 100ms) that is sent from BoardA to BoardB.
| |
| − | *: For example, if BoardA senses a switch pressed, send a 1-byte message with 0xAA, otherwise send 0x00 if button is not pressed
| |
| − | *For robustness, if the CAN Bus turns off, simply turn it back on at 1Hz (every 1000ms)
| |
| − | *On BoardB, simply light up an LED (or otherwise turn it off) based on the CAN message data
| |
| − |
| |
| − |
| |
| − | This assignment gives you an overview of practical use of the CAN Bus, and later, by utilizing the DBC file and auto-generation of code, sending and receiving data becomes very easy.
| |
| − |
| |
| − | While this provides bare bones knowledge of how communication works, the future lectures will focus on the application layer while abstracting away the details of CAN messages' data encoding and decoding.
| |
| − |
| |
| − | Although the real-time periodic scheduler was not discussed, it might be worth your time to simply turn it on (using #define) since it can help you send periodic messages fairly easily. This will also help you prepare in advance for the future lectures.
| |
| − |
| |
| − | Only turn in the relevant source code, such as main.cpp for both boards.
| |
| − |
| |
| − | = Wiki Schedule =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Write a schedule that is a list of your team's milestones. This is a tool for you to assign responsibilities and deadlines for your project's milestones. In general, this should list out when the team as a whole expects a certain functionality to be delivered.
| |
| − |
| |
| − | The grading will depend on how well you have assigned your milestones and if the goals are measurable. For example, milestones such as "interface sensor and send sensor data over CAN messages" and "add a filter for the sensor data" are measurable goals, whereas, "interface sensor", and "send data" are too generic and un-measurable goals.
| |
| − |
| |
| − |
| |
| − |
| |
| − | = Periodic Scheduler =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | INDIVIDUAL HOMEWORK:
| |
| − |
| |
| − | Easy homework, use the periodic tasks to add two functions that they call, run your program, and then do the following:
| |
| − |
| |
| − | *Modify main.cpp to configure the periodic scheduler, and leave the terminal task present that you will use later in the assignment
| |
| − | *Design a Software based "filter". The simplest one could be to average a few readings but read and research more on Wikipedia (they even have Psuedocode)
| |
| − | *Add the two new "Sensor" periodic callbacks, one at 1Hz, the other at 10Hz
| |
| − | *: In the 10Hz callback, design a Software filter to filter the Light sensor readings
| |
| − | *: In the 1Hz callback, print out the filtered sensor reading.
| |
| − | *Do more experiments with the "Logging" capability
| |
| − | *: Log some data using LOG_INFO() or similar message from file_logger.h
| |
| − | *Use "info 5000" command to see CPU utilization for 5 seconds.
| |
| − | *Use "cat log.csv" to view the log file data.
| |
| − |
| |
| − | Attach your output to Canvas along with your code.
| |
| − |
| |
| − | = CAN TX / RX using Auto-gen code =
| |
| − |
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Work in groups of 2 by assuming one board is the DRIVER while the other board is the MOTOR or SENSOR.
| |
| − |
| |
| − | The objective of the assignment is to demonstrate CAN data handling using the auto-generated code. Follow these steps:
| |
| − |
| |
| − | *Define a DBC message that your controller sends (TX)
| |
| − | *Define a DBC message that your controller receives (RX)
| |
| − | *Attempt to recover the CAN Bus (from Bus OFF) at 1Hz (both Boards)
| |
| − | *Send the TX message from BoardA at a fixed frequency, such as 10Hz
| |
| − | *Attempt to receive the RX message (on BoardB) at the designated frequency, and light up an LED when the message enters the MIA state
| |
| − | *Prove that the MIA handling is occurring as intended (simple LED test by disconnecting the board that sends you a periodic message).
| |
| − | *Prove that valid data is being received and reacted upon (such as displaying received sensor reading on the LED display)
| |
| − |
| |
| − | This is a powerful assignment that demonstrates how to send and receive data using the auto-generated code that is derived from your DBC file. This will be the stepping stone of the overall CAN communication that will occur in your project.
| |
| | | | |
| | = Final Wiki Schedule = | | = Final Wiki Schedule = |
| − |
| |
| − | = DBC File =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Create your CAN communication format for each controller and link your DBC file to your Project report at your wikipedia page.
| |
| − |
| |
| − | Make sure that the auto-generated code is created as intended and that you don't run into a DBC or the auto-generation issue. In other words, the auto-generated code should compile on all controllers.
| |
| − |
| |
| − |
| |
| | | | |
| | = CAN Communication Demo = | | = CAN Communication Demo = |
| Line 322: |
Line 69: |
| | | | |
| | | | |
| − |
| |
| − | = Git =
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | Your GIT repositories will be audited to assess how much contribution you have made to your GIT project. At minimum, there should be something checked-into the main branch to demonstrate that you know how to use GIT.
| |
| − |
| |
| − |
| |
| − |
| |
| − | = Project Prototypes 2 =
| |
| − |
| |
| − |
| |
| − | === Assignment ===
| |
| − |
| |
| − | The second version of the project prototypes should demonstrate additional functionality from the first, such as:
| |
| − |
| |
| − | *Motor feedback being used to drive the car (the car should not get stuck on an up-hill ramp)
| |
| − | *Android/iOS app displaying useful data
| |
| − | *I/O board displaying useful data
| |
| − |
| |
| − |
| |
| − | = Project Final Demo =
| |
| − |
| |
| − | === Rubric ===
| |
| − |
| |
| − | {|class="wikitable"
| |
| − | |-
| |
| − | ! Criteria
| |
| − | ! colspan="2" | Ratings
| |
| − | ! Points
| |
| − | |-
| |
| − | | Obstacle Avoidance
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Mobile Application
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | LEDs and LCD display details
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Destination Reached
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | |colspan="4" align="right" | Total: 12.0
| |
| − | |}
| |
| − |
| |
| − | = Project Wiki =
| |
| − |
| |
| − | === Rubric ===
| |
| − |
| |
| − | {|class="wikitable"
| |
| − | |-
| |
| − | ! Criteria
| |
| − | ! colspan="2" | Ratings
| |
| − | ! Points
| |
| − | |-
| |
| − | | Project Abstract (Introduction)
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | DBC File
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Architecture and Diagrams
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Software Architecture
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Problem and Resolution
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Project Video
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | | Conclusion
| |
| − | | Full Marks
| |
| − | 3.0 pts
| |
| − | | No Marks
| |
| − | 0.0 pts
| |
| − | | 3.0 pts
| |
| − | |-
| |
| − | |colspan="4" align="right" | Total: 12.0
| |
| − | |}
| |
| | | | |
| | = Individual Contribution = | | = Individual Contribution = |
SUBMIT YOUR CODE online (copy/paste to Text Entry box). Or simply provide me a link if you use Gitlab or other online repository for your code submission.
In person demonstration should be given for this assignment and there is nothing to turn in otherwise.
You will be grading your group members based on how much or how little they contributed to the project. You must be ethical, and honest, and not go based on your "emotions".
Name Letter Grade Notes
Last1, First1 A This student was involved in all aspects of the project design and was present at all group meetings.
Last2, First2 C- This student contributed to writing the report but was absent for many group meetings.
