Docstoc

Software Requirements Specifications

Document Sample
Software Requirements Specifications Powered By Docstoc
					Software Design Specifications

IPCON Alarm and Protection System (IAPS)

SIPS-03-2003

Version 1.0

Date 29.01.2003

Author Tommy Kjelsrud Magne Gabrielsen Ronny Hulthin

Contents
1 Introduction ........................................................................................................................ 3 1.1 Scope .......................................................................................................................... 3 1.2 Definitions, Acronyms and Abbreviations ................................................................. 3 1.3 Reference .................................................................................................................... 3 1.4 Overview .................................................................................................................... 3 2 System Architecture Description ....................................................................................... 4 2.1 Overview of Modules / Components ......................................................................... 4 2.1.1 Hardware modules/components ......................................................................... 4 2.1.2 Software modules/components .......................................................................... 4 2.2 Structures and relationships ....................................................................................... 5 2.2.1 Safety zones ........................................................................................................ 5 2.2.2 Censor location ................................................................................................... 6 2.2.3 Flanks of IPCON ................................................................................................ 7 3 Detailed description of components ................................................................................... 8 3.1 Component template description ................................................................................ 8 3.2 Censors ....................................................................................................................... 8 3.3 MIT Handyboard with Expansion Board ................................................................... 9 3.4 IPCON ........................................................................................................................ 9 3.5 Startup of IAPS .......................................................................................................... 9 3.6 Censor-thread ........................................................................................................... 10 3.7 Calibration control of IPCON .................................................................................. 10 3.8 Operational mode of IPCON .................................................................................... 10 3.9 Alarming IPCON ...................................................................................................... 11 3.10 Emergency shutdown of IPCON .............................................................................. 11 3.11 Shutdown of IAPS .................................................................................................... 11 3.12 Analyzing measurements ......................................................................................... 12 4 Appendix .......................................................................................................................... 13 4.1 Change History ......................................................................................................... 13 4.2 Traceability Matrix ................................................................................................... 13 4.3 Data-flow diagram .................................................................................................... 14 4.4 Module Depandancy Matrix..................................................................................... 14

1

Introduction
We are developing a system that’s going to make sure that it’s safe to use IPCON. By this, we meen that the safety of the persons using IPCON, should be preserved and that IPCON itself won’t be damaged during usage of IPCON. This document will be read and used by:  The client  Developers of the IAPS and IPCON software  Future users of IPCON and IAPS

1.1 Scope

1.2 Definitions, Acronyms and Abbreviations
Word Extension Board IAPS IPCON MIT Handyboard SPMP SRS SDS LCD-screen Explanation Additional card for the MIT Handyboard. Provides increased functionality. IPCON Alarm and Protection System Inverted Pendulum CONtrol System Massachusetts Institute of Technology Handyboard. Computer that controls all IAPS-functions Software Project Management Plan Software Requirements Specification Software Design Spesification

1.3 Reference
SPMP v1.0 SRS v1.0

1.4 Overview
This document contains 4 main parts:  Introduction – Contains a short description of the system and this document  Architectural design – Contains an overview of modules and components in the system, and how they work together  Detailed design – Contains a detailed description of all the system components and how the software is going to be implemented  Appendix – Contains various models and other stuff assisting us in writing this document

2

System Architecture Description

2.1 Overview of Modules / Components
2.1.1 Hardware modules/components Censors Our system will use a number of different censor types to determine whether there are people or objects that are potential threats to the system safety. In this version of the SDS these won’t be specified exactly. MIT Handyboard with Expansion Board This is the computer that IAPS uses. All censors will be connected to the handyboard. IPCON The system that IAPS protects. A software system that controls an inverted pendulum. 2.1.2 Software modules/components Startup of IAPS Activated by the startup of IPCON. Starts the censor-thread that runs while the system is running. Censor-thread Checking if all censors are ok. A continous check of the censor-values. Calibration-control of IPCON Allows IPCON to calibrate when it’s supposed to. Operational mode of IPCON Normal run mode in which IPCON is balancing its inverted pendulum. IAPS registers movement/objects in all safety perimeter zones. Alarming IPCON Notifies IPCON when there are possible safety hazards threatening the operability of IPCON. Emergency shutdown of IPCON If there is movement/objects in safety perimeter zone 1 or 3, the emergency shutdown system is activated and IPCON is being forced, by IAPS, to stop. Shutdown of IAPS Activated by the shutdown of IPCON. Analyzing measurements If there are any censors that aren’t working properly, this module shall analyze what, if any, measurements are needed.

2.2 Structures and relationships
2.2.1 Safety zones The red lines describe where we will have sensors to detect whether the pendulum has entered safety-zone 1 or 2. The blue line describes a sensor that calculates the distance and the speed of the pendulum.

This figure shows the three safety zones from above. We have three safety-zone 1 (marked with red colour), two on the track (the outer), and one in front of of the table. The yellow zones shows the two safety-zones 2. Both are on the inner side of safetyzone 1 on the track

2.2.2 Censor location This figure shows where the light-sensors will be placed, and their direction (marked with red colour). If any of theese sensors detect objects crossing theese lights, IAPS will stop the pendulum at once.

This figure is the same as the previous one, but seen from a different angle (above). From above, the lowest sensor outside the table cannot be seen.

2.2.3 Flanks of IPCON This figure shows the four declarated flanks.

3

Detailed description of components

3.1 Component template description
Component name Type of component Description Functionality Here we write the name of the component. For referance purposes. These names must be unique. What type of component is this? Examples: Subsystem, prosedure, module, class, file etc. What purpose does it serve? What does the component do? The processes in the different transformations, the specific input processed, algorithms used, produced output, location of stored information, what data is changed. Does this component have any subordinate components? Which ones? Is this a subordinate component? What components are superior? Detailed description of all external and internal interfaces, as well as all mechanisms for communications through messages, parameters, or shared data. All errors shall be identified. All screen resolutions, interactive messages and other GUIcomponents should be given here. A description of representation, input and output, start-values and type of data.

Subordinates Dependencies Interface

Data structure

3.2 Censors
Component name Type of component Description Censors Hardware Our system will use a number of different censor types to determine whether there are people or objects that are potential threats to the system safety. In this version of the SDS these won’t be specified exactly. Registers objects. No input, output consisting of 0 (no objects) or 1 (objects). Thread -Integer 0 or 1 as output. No input.

Functionality Subordinates Dependencies Interface Data structure

3.3 MIT Handyboard with Expansion Board
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure MIT Hardware, computer This is the computer that IAPS uses. All censors will be connected to the handyboard. Processes all data for the system All software modules -Messages can be written on the LCD-screen --

3.4 IPCON
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure IPCON Hardware, external software system The system that IAPS protects. A software system that controls an inverted pendulum. --- (Since IAPS is independant) IAPS must be operative -Messages to IAPS, messages from IAPS, data-type not yet decided.

3.5 Startup of IAPS
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure Main Module Activated by the startup of IPCON. Starts the censor-thread that runs while the system is running. Activates all software modules according to system status All software modules -Sends messages to MIT

3.6 Censor-thread
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure Thread Module Checking if all censors are ok. A continous check of the censorvalues. Updates the system status Main Main, Censors -Updates one or more global integer variables

3.7 Calibration control of IPCON
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure CalCon Module Allows IPCON to calibrate when it’s supposed to. Too early IPCON Main, Thread Too early Too early

3.8 Operational mode of IPCON
Component name Type of component Description OpMode Module Normal run mode in which IPCON is balancing its inverted pendulum. IAPS registers movement/objects in all safety perimeter zones. Checks the global variable for the system status -Main, Thread Too early Too early

Functionality Subordinates Dependencies Interface Data structure

3.9 Alarming IPCON
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure Alarm Module Notifies IPCON when there are possible safety hazards threatening the operability of IPCON. Sends alarm-message to IPCON when there is a possible safety hazard -Main, Thread Too early Too early

3.10 Emergency shutdown of IPCON
Component name Type of component Description Emergency Module If there is movement/objects in safety perimeter zone 1 or 3, the emergency shutdown system is activated and IPCON is being forced, by IAPS, to stop. Terminates the IPCON cart powersource -Main, thread Too early Too early

Functionality Subordinates Dependencies Interface Data structure

3.11 Shutdown of IAPS
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure Shutdown Module Activated by the shutdown of IPCON. Terminates IAPS -Main, Thread -Too early

3.12 Analyzing measurements
Component name Type of component Description Functionality Subordinates Dependencies Interface Data structure Analyzer Module If there are any censors that aren’t working properly, this module shall analyze what, if any, measurements are needed. Analyzes the consequences of corrupt censors -Main, Thread Too early Too early

4

Appendix
None in this version

4.1 Change History 4.2 Traceability Matrix
SDS-ID Analyzer Alarm CalCon Censors Emergency IPCON Main MIT OpMode Shutdown Thread SRS-ID 8 3,17 9,10,11,18 1,2,4,5,7,8,10,11,12,13,14, 15,18, 20,21,22,23,25 4,10,14,16,19 3,5,6,7,9,10,13,25 1,2,3,5,6,7,9,13,17,30,31 26,27,28,29,30,31,33,34,35 13,14,15 -1,2,4,5,7,8,10,11,12,13,14, 15,18,25

Requirements not included in matrix: 24,32,36

4.3 Data-flow diagram

4.4 Module Depandancy Matrix
To be included in future version


				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:33
posted:11/9/2009
language:English
pages:14