System and Software Architecture Description (SSAD)

Size: px

Start display at page:

Download "System and Software Architecture Description (SSAD)"

Harriet Gwendoline Garrison
5 years ago
Views:

1 System and Software Architecture Description (SSAD) Mission Science irobots 12/06/2014 Team 07 Ashwini Ramesha Chen Li Farica Mascarenhas Jiashuo Li Ritika Khurana Siddhesh Rumde Sowmya Sampath Yun Shao OCE, Requirements Engineer Requirements Engineer, Feasibility Analyst IV&V, Quality Analyst Prototyper, Software Architect Project Manager Life Cycle Planner, Requirements Engineer Software Architect, Prototyper Feasibility Analyst, OCE

2 System and Software Architecture Description (SSAD) Template Version 2.1 Version History Date Author Version Changes made Rationale 08/25/05 PA 1.0 Original template for use with Instructional ICM-Sw v1.0 Initial draft for use with Instructional ICM-Sw v1.0 10/11/14 SS /18/14 SS /26/14 SS /06/14 SS 2.1 Updating the document with use case Diagram, system context diagram. Fixed comments from ARB meeting Update the document with detailed architecture Fixed Comments from ARB meeting Updating the document with use case diagram, system context diagram Fixed comments from ARB meeting Update the document with detailed architecture. Fixed Comments from ARB ii Version Date: 12/06/14

3 Table of Contents System and Software Architecture Description (SSAD)... i Version History... ii Table of Contents... iii Table of Tables... iv Table of Figures... v 1. Introduction Purpose of the SSAD Status of the SSAD System Analysis System Analysis Overview System Analysis Rationale Technology Independent Model Technology Specific System Design Design Overview Design Rationale Architectural Styles, Patterns and Frameworks iii Version Date: 12/06/14

4 Table of Tables Table 1: Actors Summary... 3 Table 2: Process Description... 4 Table 3: Typical Course of Action... 5 Table 4: Alternate Course of Action... 5 Table 5: Hardware Component Description...14 Table 6: Software Component Description...14 Table 7:Design Class Description...16 Table 8: Architectural Styles, Patterns and Frameworks...19 iv Version Date: 12/06/14

5 System and Software Architecture Description (SSAD) Version no 2.1 Table of Figures Figure 1: System Context Diagram... 2 Figure 2: Process Diagram... 4 Figure 3: Hardware Component Class Diagram...13 Figure 4: Software Component Class Diagram...13 Figure 5:Deployment Diagram...14 Figure 6: Design Class Diagram...15 Figure 7: Process Realization Diagram...17 v Version Date: 12/06/14

6 1. Introduction 1.1 Purpose of the SSAD The purpose of the SSAD is to document the results of the object-oriented analysis and design (OOA&D) of the system being developed. It is used by the team as reference to the system architecture. It makes sure that the system adheres to the architecture specified. It helps the clients to understand the structure of the system once the proposed system is delivered. 1.2 Status of the SSAD The document is updated with the comments from ARB meeting. 1

7 2. System Analysis 2.1 System Analysis Overview The primary purpose of the system is to increase the probability of Elementary School Students pursuing careers in STEM(Science Technology Engineering Mathematics).A drag and drop GUI enables the students to program irobot in a more efficient way with set of instructions to perform navigation, sensing activity, turn off/on led lights, compose a song. The elementary school kids get the concept of logic and control systems. It helps in improving the funding opportunities for the Mission Science thus promoting the program System Context Figure 1: System Context Diagram 2

8 Table 1: Actors Summary Actor Description Responsibilities Elementary School Student User of irobotgui who can instruct the irobot to perform tasks. Give Instruction through irobot GUI Compiling the code Loading it to the Micro Controller Insert the Micro Controller into the irobot and make it run. Undergraduate Student User of irobot GUI who provide demos to the teachers. Provide demos to the teachers The low level responsibilities include giving instructions in GUI, compiling the code, loading to Microcontroller, inserting it to the micro controller and make it run. WinAVR It is a component that is integrated with GUI to compile C code to executable program. Compiles the C code generated from GUI into hex code that can be loaded into Micro Controller. irobot The actual robot to test the GUI. Executes the program developed using GUI Artifacts & Information Our interface does not replace any artifacts. There are no artifacts that are produced or consumed by this new system. It only provides an alternate way of operating irobot by eliminating the need to learn C programming Behavior 3

9 Navigation Capability Figure 2: Process Diagram Table 2: Process Description: Create Navigation Instructions Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-1 Create Navigation Instructions Enable the Elementary School Student to create navigation instructions such as moving forward, backward, turn left or right based on the angle specified. To be able to program irobot with instructions to move forward, backward, turn left /right. Resolving of Incompatible navigation instructions, frequency of checking the angle of turning so as to perform accurately. Knows about the parameters for each navigation Give meaningful Navigation instructions. 4

10 Table 3: Typical Course of Action 1 Drag and drop any of the navigation instruction icon to the canvas. 2 The canvas displays the drag and dropped instruction 3 Specifies the value of parameter for each instruction such as distance, time, angle for turning. Table 4:Alternate Course of Action 1 Drag and drop the navigation instruction icons such as turn left and right to the canvas. 2 The system says that instructions are invalid. 3 Drag and drop valid sequence of instructions. 4 The system displays the dragged and dropped instruction. 5 Specify the parameter for the instruction Sensing Capability: Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-2 Create Sensor Instructions Enable the Elementary School Student to create sensor instructions to detect cliffs, bumps, find the elapsed time and distance covered. To be able to program sensor instructions so as to detect cliffs or bumps, calculate time and distance. Intervals of checking for the time and distance sensors. Knows about the purpose of each sensor. Appropriate Sensor instructions based on the requirement. 5

11 1 Drag and drop sensor instruction to the canvas. 2 The canvas displays the sensor instruction. 3 Specifies the value for parameters such as frequency of sensing Sound Capability: Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-3 Create Sound Instructions Enable the Elementary School Student to compose a song To be able to compose a song. None. Knows how to use GUI. Set of Musical notes forms a song. 1 Drag and drop music instruction to the canvas. 2 The canvas displays the music instruction Light Capability: Identifier UC-4 Create Light Instructions Purpose Enable the Elementary School Student to give instructions to turn light on / off Requirements To be able to give instructions to switch on / off led lights. Development None. Risks Pre-conditions Knows how to use the drag and drop GUI Post-conditions Turning on / off lights as per the requirements. 1 Drag and drop led light on/off instruction to the canvas. 2 The canvas displays the led light instruction. 6

12 File opening Capability: Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-5 Open New / Existing File Enable the Elementary School Student to create a new program or open an existing program created To be able to create a new program with set of instructions or to open an existing file. Opening an existing file requires it to be loaded into the canvas from memory. Knows how to use the drag and drop GUI. If a new file is created, program instructions can be given, to open an existing file, the file should exist. 1 Select Option File->New 2 A new File is created. 3 Select Option File->Open 4 Select the file that is previously saved and click Open 5 The selected file is opened Saving File Capability: Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-6 Saves a File Enable the Elementary School Student to save the file with instructions created. To be able to save the created file. Store the created file in the memory so as to retrieve it when needed. Knows how to use the drag and drop GUI. If a GUI is saved, it can be opened later for re-use. 7

13 1 Select Option File->Save 2 System asks for the filename with extension. 3 Specify the filename with extension and destination location. 4 Validates the filename and saves it. Alternate course of action 1 Select Option File->Save 2 System asks for the filename with extension. 3 Specify the filename with extension and destination location. 4 Validates the filename and finds that filename already exists. Specifies the right filename Saves the file Translating Capability: Identifier UC-7 Translate to C Purpose Enable the Elementary School Student to Compile the program created using GUI. Requirements To be able to compile the program of instructions without any error. Development Risks Generating a C code for the respective GUI instructions, calling the C API functions accordingly and compiling the code. Pre-conditions Knows how to use the drag and drop GUI Post-conditions If a GUI is compiled, it can be loaded to the micro controller. 1 Select Build -> Compile 2. System responds with the message "Compiled Successfully". Alternate Course of Action. 1 Select Build-> Compile 8

14 2. System responds with errors and warnings. 3 Correct the errors and compile again. 4 System responds with the message "Compiled Successfully" Compi ling Capability: Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-8 Compile Enable the Elementary School Student to compile the instructions with WinAVR that is executable in irobot. To be able to compile with WinAVR. None. Should have the generated C code from GUI instructions. If the compilation is successful,it can be loaded into the micro controller. 1 Select Compile from the Menu 2 System compiles the C code and displays the progress of compiling in a window. Alternate Course of Action: 1 Select Compile from the Menu 2 System compiles the C code and displays error. 3 Checks the graphical instructions again and correct it Loading Capability: Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC-9 Loads the executable file Enable the Elementary School Student to load the compiled file into the Micro Controller Chip. To be able to load the executable file in the micro controller. None. Should have the executable file. If a program is loaded, it can be inserted into the irobot. 9

15 1 Attach the micro controller chip with a USB port to the laptop. 2 Select Build->Load. 3 System responds with message "Loaded successfully" Demo GUI: Identifier UC-10 Compile Purpose Enable the Elementary School Teachers to know about the working of drag and drop GUI Requirements To train the elementary school teachers on how to use th GUI system. Development None. Risks Pre-conditions Knows how to use the drag and drop GUI Post-conditions The teachers know how to use the GUI. 1 Explains the teachers on how to use the GUI to program irobot with the sample programs involving all instructions. 2 The program compiles and runs successfully Modes of Operation The irobotgui system for the irobot operates only in one mode of operation 10

16 2.2System Analysis Rationale Based on our analysis of how the users interact with the system, we have identified 4 classes of operational stakeholders. Elementary School Students: They are the actual users of the system who create programs for the irobot through drag and drop GUI. Elementary School Teachers: They are the users who help the students with the GUI and assign tasks to be done on it. Undergraduate Students: They are the users who demos how the GUI needs to be used. Elementary School IT Administrators: They are the users who troubleshoot the system based on the trouble shooting guide they are provided with by the developers. There are 4 external system actors that interface with Drag and Drop GUI System. They are: C APIs - Provide the back end functions that need to be called based on instructions given in GUI. Micro Controller - Enables to load the compiled programs into it and which when inserted into the irobot makes it run. Compiler - Converts C code to machine level code that can be loaded to Micro Controller. irobot - The system on which the programmed instructions through the GUI runs. 11

17 3.Technology-Independent Model As we have specific requirement from the Client about the platform as Windows, the WinAVR compiler for converting the C code to executable program, technology specific model is followed. We have developed our project in Visual Studio with C# as the programming language to develop the GUI after assessing the compatibility between Visual Studio and WinAVR. 12

18 4.Technology-Specific System Design 4.1 Design Overview 4.1.1System Structure Figure 3: Hardware Component Class Diagram Figure 4: Software Component Class Diagram 13

Figure 5: Deployment Diagram Table 5: Hardware Component Description Hardware Component Windows PC Micro Controller irobot Create Description It is the component where the actual irobotgui is used to

19 Figure 5: Deployment Diagram Table 5: Hardware Component Description Hardware Component Windows PC Micro Controller irobot Create Description It is the component where the actual irobotgui is used to create drag and drop instructions. It is the component where the executable program is loaded from the PC and inserted into the irobot to work on the created program It is the component on which the program created through irobotgui is run. Table 6: Software Component Description Software Component irobotgui WinAVR Description It is the component where the actual graphical instructions are created by drag and drop feature, which can then be translated to C code and compiled to executable code to run in irobot. It is the component that is used to compile the generated C code to the executable program that can be loaded into the micro controller. 14

20 4.1.2Design Classes Class Diagram Figure 6: Design Class Diagram 15

21 Table 7: Design Class Description Class Type Description GUI Form This is the GUI on which user performs drag and drop operations. Compiling is started by user clicking on the Build menu option Controller Conducts and controls and the checking and compiling workflow. Gives error information to GUI. After translation is done, it calls commands from WinAVR and finishes the compiling and loading process. Instruction Validator Checks if each instruction is valid. Conflict Detector Detects conflicting instructions within the program. Translator Translates Program to C File that can be compiled by WinAVR Program Contains instructions user composes using GUI. Instruction Contains opcode which denotes the instruction type and a parameter list for that instruction Process Realization 16

22 Figure 7: Process Realization Diagram 17

23 Alternate Cases: If the Instruction Validator class responds that they are not valid, the message is displayed in the GUI screen to the user and prompted to correct the instructions. If the Conflict Detector class responds that if any conflicts is found, message is displayed as which instruction is conflicting so that the user can correct it before compiling. If the Translator class responds that there is any exceptions involved or unable to translate a graphical instruction to C code, the error message is displayed and the user can correct it before compiling. 4.2Design Rationale The software and hardware components are high level diagrams as it cannot be broken down further. Deployment diagram shows system that the micro controller is loaded with the executable code of the instructions created through, which is then plugged into the irobot to test the working of the code. For design class diagram, we have included classes in the system, which will be mainly used for the complete flow. The sequence diagram shows the complete work flow of the application. 18

24 5.Architectural Styles, Patterns and Frameworks Table 8: Architectural Styles, Patterns, and Frameworks Name Description Benefits, Costs, and Limitations MVC Architecture Model :It is the actual Instruction set that is executable in the irobot. View: It is the actual GUI screen where the graphical instructions can be dragged and dropped, build them and see the result of compilation. Controller: The controller class is responsible for validating the instructions, checking for conflicting instructions, translate to C code and compiling to executable code. Benefits: 1.Separation of concerns: The separation of the three components, allows the re-use of the business logic across applications. 2.Developers focus on UI design the most as its the utmost requirement. Costs: No cost is involved. Limitations: 1. It may increase the complexity of the system because of decoupling. 2. Data access is in efficient in view. 19

System and Software Architecture Description (SSAD)

System and Software Architecture Description (SSAD) Mission Science irobots 11/26/2014 Team 07 Ashwini Ramesha Chen Li Farica Mascarenhas Jiashuo Li Ritika Khurana Siddhesh Rumde Sowmya Sampath Yun Shao