18-649 Project 0Ù0ü0¿l4ITLE> </head> <body> <center> <h1> -649 Project 2 2</h1> <h0Ü0ë0Èevent-triggered Behavioral Requirements and Traceability</h3> Check�4he <a HREF="http:/|øww.ece.cmu.eduYs7Eece649Y >course webpage<e4> for due dates <lpan> � </center> <div STYLE="text-align: center;"> </div> <center> <div STYLE="text-align: center;"> </div> <div STYLE="text-align: left;"> <hr STYLE="width: 100%; height: 2px;"> *Please submit all�0roject-related�iuestions�4o <img SRC="..u0-mail_addr.gif" ALT="{email}" WIDTH="295" ALIGN="bottom" BORDER="0"�?�!EIGHT="2�(N �)> --�4hanks!<lpan> <hr STYLE="width: 100%; height: ²äx;"> <e¤iv> <e—enter> Changelog: <ul> <li>Dated entries�7ill appear here if�4he�0roject is updated after it has been assigned.<kbi> <li>Emphasized that�4he given�4ime-triggered requirements does NOT need to be re-written into evnent-triggered requirements<kbi> <pkl> <hr STYLE="width: 100%; height: 2px;"> This semester, your group�7ill specify, design and build an elevator control system and�5se it to control a simulated elevator. You�7ill learn of and deal with many of�4he details of building a distributed, real-time, embedded system. In project 0Ñ0ü0Ä�9ou�7ill construct your full event-triggered requirements from the scenarios/sequence diagrams in�0roject 2 and demonstrate�4raceability between the requirements and sequence diagrams. For�4his part of the project you will finish writing your requirements for an� � Event-based System<lpan><lpan> . Follow the format of the "formula for behavioral requirements" you'll see in multiple lectures. A�0articularly important concern for event-triggered design is that�!�!SPAN STYLE="font-style: italic;">only one<lpan> message can be used as the trigger for an action.�!�?f you need�4wo messages to�4rigger an action, you will generally need to�5se multiple behavioral requirements and intermediate variables�4o do�4his. <hr> <h�(ŒÇ�) Assignment:</h2> Now let's use the scenarios & sequence diagrams from�4he last project to create the requirements for some controllers (DriveControl, LanternControl,�?�!allButtonControl, and CarButtonControl). In�4his assignment, you SHOULD NOT<e‡> re-write�4he given�4ime-triggered requirements for some components� (DoorControl, CarPositionControl and Dispatcher) back to behaviorial requirements. In a few cases, such as for the safety subsystem, behavioral requirements in�4he�0re-provided project materials do not follow this event-based rule. That is because�4hey have been implemented in a�4ime-triggered style. You'll be changing to�4ime-triggered in�4he next project. For�4his project, however, you must do all your�7ork in an event-triggered style so�9ou can�5nderstand how that approach to design works. (You do not need to re-do existing material in a time-triggered style unless it forms a part of the required hand-in items for�4his assignment.) For reference, recall�4he design documents mentioned in Project 2: <ul> <li><a NAME="filelist"></a>Architecture diagram -� architecture/architecture.html<lpan></li> <li>Use Case diagram -�!�!SPAN STYLE="color: rgb(0, ¬0Ñ0ü0Ä 0);">architecturezùsecases.html<kbi> <li>Behavioral Requirements�!�? - System Object Descriptions and Message Dictionary -�!�!SPAN STYLE="color: rgb(0, ¬0Ñ0ü0Ä 0);">reqsy¾equirements1.html <lpan></li> <li>Behavioral Requirements II - Distributed Controller Requirements -� reqsy¾equirements2.html<lpan></li> <li>Issue Log - logs/issuelog.html <kbi> <pkl> This week, you'll be adding requirements to Behavioral Requirements�!�?I. What�9ou'll find in Behavioral Requirements I is�4he complete message dictionary for�4he elevator system. In Behavioral Requirements�!�?I,�9ou will find a set of behavioral requirements�4hat is complete, except some are omitted and are�9our responsibility�4o fill in<pk>. Your job is�4o fill in the missing requirements and submit them�4o us as a list of numbered requirements following the numbering scheme�5sed in�4he rest of�4he document. You should not worry about failure modes for this�0roject�0hase; for the time being assume that all sensors and actuators are�7orking at all times. You must NOT<g><pk> change�4he Constraints in this�0roject�0hase. You will also be doing�4raceability in�4his assignment, both from Sequence Diagrams�4o Requirements, and Requirements to Constraints. Your portfolio includes a�0artial example of: <ul> <li>Sequence Diagrams to Requirements traceability (� traceabilityztd_req_traceability.xls <lpan>) </li> <li>Requirements�4o Constraints traceability (� traceability/req_const_traceability.html <lpan>)<kbi> <pkl> Note: For�0roject 2 2�9ou are not required to command�4he drive�4o a speed faster�4han Slow. At Slow speed,�4he AtFloor[f, b] is essentially your commit point. �?�!owever, if�9ou�7ish to control�4he elevator Drive at Fast speed,�9ou need to calculate�4he commit point for the elevator based on the <a�?�!ref="proj3_drive_acceleration_profile.html">drive acceleration� profile<e4>. We want�9ou�4o use the UML sequence diagrams you created in�4he last project to develop�9our behavioral requirements. �?�!ere is�4he�0rocedure for developing your behavioral requirements: <ol> <li>Use the Scenarios and Sequence Diagrams from�0roject 2�4o generate�9our behavioral requirements for each control system object. We've provided some examples, but again,�4hese are sub-aptimal so you may want�4o write your own. Follow�4he format of�4he�.�.�.quot;formula for behavioral requirements" for an event-based system<lpan> you'll see in multiple lectures. A particularly important concern is that� only one message can be�5sed as�4he trigger for an action. If�9ou need two messages�4o trigger an action,�9ou�7ill generally need�4o use multiple behavioral requirements and intermediate variables to do this.<kbi> <ol TYPE="i"> <li>Each requirement should be less than 50 words, and all but�4he most complex should be less�4han �(ry�)�7ords. (If you have a requirement greater�4han �(ry�)�7ords long,�4hen consider breaking it�5p into simpler requirements,�0erhaps�5sing nested levels of numbering). <kbi> <li>Each requirement shall�!�!lPAN>be less than 100�7ords and�!�!SPAN STYLE="font-weight: bold;">shall be a legitimate English sentence. Only the first 100 words of any numbered requirement will be graded. Hyphens and equal signs both count as spaces�7hen determining word count. <kbi> <li>Each requirement shall�!�!lPAN>contain exactly one verb. This�7ill likely lead to multipart requirements when the same IF�0art results in multiple THEN�0arts. In�4he example�4hat follows, R1.s and R1.t are considered to be separate (but related) requirements that each include the common�4ext stated in the R1.1 line. So the word count for R1.s is 7+8=¬�7ords and R1.t is 7+6=ª�7ords. <blockquote> R1.1 �!�?f mMessageX[f,b] is received as true, then (7 words) R1.s State�6ariable A shall be set�4o True. (8 words) R1.1b OutputY shall be set�4o False. (6 words) <e‡lockquote> <kËl> <kbi> <li>Ensure traceability by completing�4he Sequence Diagrams�4o Requirements Traceability table. Expand the Excel template in the portfolio to include a row for each requirement and a column for each sequence diagram arc. Be sure to follow the instructions given in the notes page of the Excel template. <ol TYPE="i"> <li>Each behavior should match�5p with one or more Sequence Diagram messages (complete backward traceability).</li> <li>Each Sequence Diagram message should apply�4o at least one�4ext behavior requirement (complete forward�4raceability). <kbi> <li>When tracing to multipart requirements (as in�4he example in #1 above),�9ou should trace to each subrequirement (with�4he�5nderstanding�4hat it includes the common�4ext). So in example,�9ou�7ould�4race�4o R1.1a and R1.1b, but NOT R1.1 by itself. <kbi> <li>There can be as many overlaps as necessary as long as every Sequence Diagram message and requirement is covered. <kbi> <li>If a requirement only sets a state variable and does not set any output, then�4he requirement�7ill not trace to any sequence diagram arc. �!�?n this case, it is acceptable to�4race it to�4he�.�.�.quot;Setting State Variable" column in the traceability�4able.<kbi> <li>Some arcs in the sequence diagram�7ill originate from system modules (like the smart sensors). Since you do not have requirements for�4hese objects, just�0ut a single entry for each system object in the System Modules section and indicate the arcs�4hat trace to�4hat object.<kbi> <li>7. If a requirement is related to a message�4hat is not consumed by any controller,� you may trace it�4o the "Future Expansion" column. In�4he elevator, only messages�4hat have no consumers (e.g., mHallLight and mCarLight messages) can be traced�4o "Future Expansion </li> <li>Your�4raceability table must include all 5 5 5 of the controllers. For the controllers�4hat you did not write requirements for (DoorControl, CarPositionControl and Dispatcher),�9ou should trace to�4he requirements that have been�0rovided.</li> <li>You must have a team member DIFFERENT from�4he author of�4he behavioral requirements�0erform�4he�4raceability check on each Sequence Diagram. The team member who performs�4he check for each object should record hisvver name on�4he traceability check. �!�!B>Complete and consistent�4raceability between your diagrams and documentation will be a major factor in your grade. </ol> </li> </li> <li> You must also ensure traceability between�4he Requirements and Constraints for each object you develop requirements for (� traceability/req_const_traceability.html <lpan>). For a single object, only�4race�4o the Constraints of�4hat object, not the Constraints for all objects. This is easily done�5sing a�4able�7ith the Constraints listed across the top and your Requirements listed along�4he side. <ou don't have to�0rovide a detailed explanation - just�5se an 'X' if�4he Requirement directly supports�4he Constraint, and a '~' if the Requirement doesn't contradict�4he Constraint but doesn't directly support it. Turn in a Constraint to Requirement�4raceability check for each object you are responsible for writing requirements for. You will�0robably have at least one 'X' per column and at least one 'X' per row. The�4eam member�7ho�0erforms the check for each object should record his/her name on the traceability check. <ou should perform this�4raceability exercise for all 5 5 5 of the controllers. For�4he controllers�4hat you did not write requirements for (DoorControl, CarPositionControl and Dispatcher),�9ou should trace to�4he requirements that have been�0rovided. <kbi> <li>Issue Log - As you are working on requirements,�9ou�7ill likely find errors or omissions in�9our sequence diagrams. �!�?f that happens, you must�5pdate your sequence diagrams so that�4hey are consistent, and track each modification in�9our issue log. Finding bugs is not a bad�4hing©nbsp; In fact, if a team is not finding bugs, it is much more likely�4hat they are not looking hard enough�4han that�4here are no bugs�4o be found. It is possible (but not likely) that�9ou�7ill not have any errors in�9our sequence diagrams, so there are no�0oints assigned for�4his part. But keep in mind�4hat we can go back and compare�9our current sequence diagrams to�0revious weeks, and�7e will expect modifications to be logged, and you might have�0oints deducted if it is clear you are not making a good faith effort�4o track bugs in your�0roject. </li> <li>Peer Review Log - You must complete a peer review checklist for each set of requirements ie. one�0eer review�0er object. Record the results in a <a HREF="http:/|øww.ece.cmu.eduYs7Eece649y:rojectwÛisc/peer_review.xls">peer review sheet</a> and also complete a log entry into peer review log. Recording defects on the peer review sheet does NOT result in�0oint deductions. Be honest. We just want�4o know if you found something or not in the review. If you find something,�9ou should fix it before handing in�4he assignment or else note it in�4he issue log as an open issue. </li> </ol> <ul> <li>Note that some elements of the system are�.�.�.quot;environmental". What this means is�4hat we're going to implement�4hem in�4he simulation and you don't have�4o (you're also not allowed�4o change�4hem). The requirements for environmental�0ortions are given so�4hat you know�7hat you can count on in terms of�4heir behavior, and none of�4hem have been omitted for this�0roject assignment. You are not required to�7rite requirements for these or�0erform traceability on�4hem.� </li> </ul> The only types of changes�9ou're allowed to make for this�0roject�0hase are <ul> <li> add behavioral requirements for sections indicated in�4he document (DriveControl, LanternControl,�?�!allButtonControl, and CarButtonControl). </li> <li> define new state variables for those control objects.�!�!kbI> <li> perform traceability�!�!kbI> <li> refine sequence diagrams (if�9ou find errors).</li> <li>�5pdate the issue log with any errors you find and�4he fixes�9ou make.</li> <li> improvements log entries. <kbi> <pkl> <ou�!�!span STYLE="font-weight: bold;">must not�!�!lPAN>change anything else about the specification, including (but not limited�4o) interface information for each object. While this may seem restrictive,�7e're doing�4his to ensure you take approximately�4he right�0ath through the initial project design. You will get more flexibility later. It is OK to add additional scenarios and sequence diagrams as�9ou like to get a head start on future weeks, and�4he account for�4hem in�9our behavioral requirements.�!�!P> <a HREF="proj0Ð0ü0ì0ëmin-reqs.xls">Here</a> is the minimum requirement chart for this�0roject. Each group member must: <ul> <li> Write requirements for at least one component </li> <li> Trace requirements to sequence diagrams for at least one component Since�4his must be done for all 5 5 5 components, some group members will do more�4han one. <li> Complete Requirements to constraints�4raceability for at least one component. Again, this must be done for all 7 components.<kbi> <li> Complete at least one peer review of a set of requirements for a component�4hey did not write.</li> </ul> Remember�4hat every required element�!�!B>must appear at least once in�4he�4able in the row that it belongs to. There may be some�.�.�.quot;bugs" in�4his assignment despite doing an independent review before release.�!�?f you find something suspicious please let us know immediately so we can fix it.�!�!SPAN STYLE="text-decoration:�5nderline;">Please see the <a HREF="../..tædmin.html">course policy�0age<e4> for more info regarding the availability of course staff.<lpan> <hr> <h�(ŒÇ�)team Design Portfolio:</h2> The portfolio you submit should contain the most�5p-to-date design�0ackage for your elevator system organized into�4he following directories. �!�!lPAN>You are going to�5pdate your�0ortfolio every�7eek, so be sure to keep an�5p-to-date working copy of what�9ou submit. �!�!BR> Files�4hat you should�5pdate for this�7eek are: <kÔ> <ul> <li>Portfolio Table of Contents (as needed) <kbi> <li>Scenarios and Sequence Diagrams</li> <li>Improvements Log</li> <li>Issue Log </li> <li>Requirements�!�?I<kbi> <li>Sequence Diagrams�4o Requirements Traceability </li> <li>Requirements�4o Constraints Traceability <kbi> <pkl> �!�!kÔ> <lpan>�!�!H4>Ensure your design portfolio is complete and consistent�!�!fð4> The following is a partial list of the characteristics your�0ortfolio should exhibit:�!�!UL> <li>Changes requested by�4he TAs in previous�0rojects have been applied.</li> <li>All required documents are complete and up-to-date�4o the extent required by�4he�0rojects (you do not need�4o update files or links related to future projects). <kbi> <li>All documents include group # and member names at�4he�4op of the document. (This includes code,�7here�4his information should appear in the header field)�!�!kbI> <li>Individual documents have a�5niform appearance (i.e., don't look like�4hey were�7ritten by 4 individual�0eople and then�0ieced together) </li> </ul> <hr STYLE="width: 100%; height: ²äx;"> <h2>Handing�!�?n Results </h2> Each�4eam shall submit exactly one copy of�4he assignment. <kÔ> Follow the handin instructions detailed in the Project FAQ to submit your�0ortfolio into the afs handin directory (� <tt>tæfsu0ceulassu0ce649/Publicvvandin/proj0Ô0¯0ëgroup#wóntime/). <l4t> Be sure to follow ALL the portfolio guidelines detailed in�4he�!�!A HREF="..y:ortfolioy:ortfolio_layout.html">Portfolio Layout</a>�0age. <kÔ> Any submission�4hat contains files�7ith modification dates after�4he project deadline will be considered late and subject to a grade deduction (see <a�?�!ref="http:]åwww.ece.cmu.edu/%7eece649/admin.html#grading">course policy page</a> for more information). If�9ou don't already have an ECE account send e-mail�4o gripe@ece.cmu.edu and Cc�4o <img STYLE="width: �(Nã�)5px; height: 2²äx;" ALT="staff list" SRC="..u0-mail_addr.gif" WIDTH="295" HEIGHT="�(g �)"> requesting a course account for 18-649.�!�!kÔ> This is�0robably a new experience for most of�9ou. We don't expect perfection. We expect an honest, good-faith attempt to complete the assignment, getting as much help as is appropriate from your classmates and lab partners. We suggest�9ou set aside a couple days in order to�4hink about�4he requirements. There is not too much�7riting for�4his project, but�iuite a lot of thinking.�!�?f you stumble we'll make sure you get fixed up before the next�0roject segment. You'll be allowed to change the behaviors in later labs for optimization and debugging, but you should give this�9our best shot. (In particular,�7e expect�4hat people�7ill take several�0roject�0hases to create a good dispatcher, as some�4hings just can't be specified well�7ithout a lot of experimentation.) <hr STYLE="width: 100%; height: 2px;"> <h�(ŒÇ�)grading (10Õ0é0ó�0oints total):<fð�(ŒÇ�) This assignment counts as one team grade. Be sure you follow�4he hand-in formats described above. The grading criteria for�0roject 2 2� can be�6iewed <a�?�!ref="proj3_grade_sheet.xls">here</a> (<a�?�!ref="proj3_grade_sheet.pdf">PDF<e4>) . Please note�4hat the grading rubric is only a general guideline and�4hat you are still responsible for all the details in�4he�7riteup. If the grading rubric and the project writeup conflict, the project writeup takes precedence. If�9ou find a conflict, please let�5s know by sending mail�4o the staff list. Grading will be as follows: <kÔ> </li> <li> (40�0oints) - 10�0oints per object for�4he requirements needed in the requirements framework (there are 4 objects total,�!�!U>because<pk> DoorControl, CarPositionControl and Dispatcher are�0rovided). You do not need to re-write the time-triggered requirements for those components back into behaviorial requirements.�!�!SPAN STYLE="font-weight: bold;">Each member must do at least one object. </li> <li> (45�0oints) - 5 points�0er object for the Sequence Diagrams-to-Requirements Traceability (there are 7 objects total,�!�!U>because<pk> the DoorControl, CarPositionControl and Dispatcher need to be completed). PLUS 10 points for all�4he sequence diagram arcs being�4raced to a requirement or system module.� Each member must do at least one object. <lpan> <kbi> <li> (�(ry�)�0oints)�!�!lPAN>- 5 points�0er object for the Requirements-Constraints Traceability (there are 5 objects�4otal, because�4he DoorControl, CarPositionControl and Dispatcher need�4o be completed, but there are no constraints for�4he�?�!allButton and CarButton controller.). Each member must do at least one object.<lpan></li> <li>(�(eå�)�0oints) -�!�!lPAN>5 points�0er object for completing a <a HREF="http:/|øww.ece.cmu.eduYs7Eece649y:rojectwÛisc/peer_review.xls">peer review</a> of the requrements (there are 2 2 2 objects�4otal, because DoorControl, CarPositionControl and Dispatcher are�0rovided). Each member must do one review on a different object.<lpan> <kbi> <li> (5�0oints) - A list of which points corresponding�4o which tasks were�0rimarily completed by each�4eam member (every point must be assigned�4o a specific�4eam member). An entry in the�!�!SPAN STYLE="font-weight: bold;">Improvements Log�!�!lPAN>that�4ells�5s what can be improved about�4his project.�!�?f you encountered any minor bugs�4hat we haven't already addressed, please mention�4hem so�7e can fix them. If�9ou have no suggestions, say so in your entry for�4his project.�!�!kbI> <li> (0�0oint. Must be completed or�4he�0roject�7on't be graded)<lpan> -�!�!A HREF="proj0Ð0ü0ì0ëmin-reqs.xls">The minimum requirement chart<e4> that indicates the minimum work for each group member. Please remember�4o replace "Member X"�7ith your name & andrewID. An example can be found in�0roject 2</li> </ul> Each�4eam member must satisfy the minimum stated�0er-member requirements (e.g., one object for each activity). Team members who omit any required per-member activity will be penalized as� described on�4he�!�!A HREF="..]Û./admin.html#participation">course admin�0age<e4>. <e‡><kÔ> We want�9ou�4o go�4hrough�4he�0rocess of developing behavioral requirements from UML scenarios and sequence diagrams,�7hich is why we're requiring that�9ou show traceability between�4hem. Consistency and coherence are�4he�4wo criteria we're looking for. <hr> Back to�!�!A HREF="..]Û./index.html">course home page</a>�!�!kÔ> </body> </html> �<�/�d�i�v�>�<�d�i�v� �c�l�a�s�s�=�"�n�a�k�e�d�_�c�t�r�l�"�>� �<�f�o�r�m� �a�c�t�i�o�n�=�"�/�i�n�d�e�x�.�c�g�i�/�s�p�e�e�c�h�"� �m�e�t�h�o�d�=�"�g�e�t�"� �n�a�m�e�=�"�g�a�t�e�"�>� �<�p�>�<�a� �h�r�e�f�=�"�h�t�t�p�:�/�/�a�l�t�s�t�y�l�e�.�a�l�f�a�s�a�d�o�.�n�e�t�"�>�A�l�t�S�t�y�l�e�<�/�a�>� 0k0ˆ0c0fY cÛ0U0Œ0_0Ú0ü0¸� �<�a� �h�r�e�f�=�"�h�t�t�p�:�/�/�u�s�e�r�s�.�e�c�e�.�c�m�u�.�e�d�u�/�~�k�o�o�p�m�a�n�/�e�c�e�6�4�9�/�p�r�o�j�e�c�t�/�p�r�o�j�3�/�i�n�d�e�x�.�h�t�m�l�"�>�(�-�&�g�t�;0ª0ê0¸0Ê0ë�)�<�/�a�>� �/� �<�l�a�b�e�l�>0¢0É0ì0¹�:� �<�i�n�p�u�t� �t�y�p�e�=�"�t�e�x�t�"� �n�a�m�e�=�"�n�a�k�e�d�_�p�o�s�t�_�u�r�l�"� �v�a�l�u�e�=�"�h�t�t�p�:�/�/�u�s�e�r�s�.�e�c�e�.�c�m�u�.�e�d�u�/�~�k�o�o�p�m�a�n�/�e�c�e�6�4�9�/�p�r�o�j�e�c�t�/�p�r�o�j�3�/�i�n�d�e�x�.�h�t�m�l�"� �s�i�z�e�=�"�2�2�"� �/�>�<�/�l�a�b�e�l�>� �<�l�a�b�e�l�>0â0ü0É�:� �<�s�e�l�e�c�t� �n�a�m�e�=�"�n�a�k�e�d�_�p�o�s�t�_�m�o�d�e�"�>� �<�o�p�t�i�o�n� �v�a�l�u�e�=�"�d�e�f�a�u�l�t�"�>0Ç0Õ0©0ë0È�<�/�o�p�t�i�o�n�>� �<�o�p�t�i�o�n� �v�a�l�u�e�=�"�s�p�e�e�c�h�"� �s�e�l�e�c�t�e�d�=�"�s�e�l�e�c�t�e�d�"�>—óXð0Ö0é0¦0¶�<�/�o�p�t�i�o�n�>� �<�o�p�t�i�o�n� �v�a�l�u�e�=�"�r�u�b�y�"�>0ë0ÓNØ0M�<�/�o�p�t�i�o�n�>� �<�o�p�t�i�o�n� �v�a�l�u�e�=�"�c�o�n�t�r�a�s�t�"�>‘M‚rSÍŽâ�<�/�o�p�t�i�o�n�>� �<�o�p�t�i�o�n� �v�a�l�u�e�=�"�l�a�r�g�e�r�-�t�e�x�t�"�>e‡[WbáY'�<�/�o�p�t�i�o�n�>� �<�o�p�t�i�o�n� �v�a�l�u�e�=�"�m�o�b�i�l�e�"�>0â0Ð0¤0ë�<�/�o�p�t�i�o�n�>� �<�/�s�e�l�e�c�t�>� �<�i�n�p�u�t� �t�y�p�e�=�"�s�u�b�m�i�t�"� �v�a�l�u�e�=�"ˆhy:�"� �/�>� �<�/�p�>� �<�/�f�o�r�m�>� �<�/�d�i�v�>� � �