Difference between revisions of "Proj-2013-2014-SmartCitizen2014/SRS"

From air
Jump to navigation Jump to search
Line 6: Line 6:
 
|-
 
|-
 
|
 
|
!scope="col"| Version
+
!scope="col"| 0.1
!scope="col"| Date
+
!scope="col"| 27/01/2014
!scope="col"| Authors
+
!scope="col"| Labat Paul, Fréby Rodolphe
!scope="col"| Description
+
!scope="col"| SRS of SmartCitizen project
 
!scope="col"| Validator
 
!scope="col"| Validator
 
!scope="col"| Validation Date
 
!scope="col"| Validation Date
Line 45: Line 45:
 
==3.1 Requirement X.Y.Z (in Structured Natural Language)==
 
==3.1 Requirement X.Y.Z (in Structured Natural Language)==
 
'''Function''':
 
'''Function''':
  +
* Gather information from several sensors and a Twitter steam
  +
* Post information on a map, available from a browser
   
 
'''Description''':
 
'''Description''':
   
 
'''Inputs''':
 
'''Inputs''':
  +
* Json data from Twitter
  +
* MQTT data from sensors
   
 
'''Source''':
 
'''Source''':
  +
* Twitter stream
  +
* Sensors
   
 
'''Outputs''':
 
'''Outputs''':
  +
* A web site
   
 
'''Destination''':
 
'''Destination''':
  +
* Citizen
  +
* Town hall
   
 
'''Action''':
 
'''Action''':
  +
* Store information from sensors and Twitter into a database
* Natural language sentences (with MUST, MAY, SHALL)
 
* Graphical Notations : UML Sequence w/o collaboration diagrams, Process maps, Task Analysis (HTA, CTT)
 
* Mathematical Notations
 
* Tabular notations for several (condition --> action) tuples
 
   
 
'''Non functional requirements''':
 
'''Non functional requirements''':
   
 
'''Pre-condition''':
 
'''Pre-condition''':
  +
  +
* Hardware:
  +
::- Intel Galileo
  +
::- Senors with MQTT compatibility
  +
  +
  +
*Software:
  +
::- Nodejs
  +
::- Red-node
  +
::- Mongodb
  +
::- Mosquitto
  +
   
 
'''Post-condition''':
 
'''Post-condition''':

Revision as of 13:30, 27 January 2014

The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.


Document History
0.1 27/01/2014 Labat Paul, Fréby Rodolphe SRS of SmartCitizen project Validator Validation Date
0.1.0 TBC TBC TBC TBC TBC


1. Introduction

1.1 Purpose of the requirements document

1.2 Scope of the product

1.3 Definitions, acronyms and abbreviations

1.4 References

1.5 Overview of the remainder of the document

2. General description

2.1 Product perspective

2.2 Product functions

2.3 User characteristics

2.4 General constraints

2.5 Assumptions and dependencies

3.Specific requirements, covering functional, non-functional and interface requirements

  • document external interfaces,
  • describe system functionality and performance
  • specify logical database requirements,
  • design constraints,
  • emergent system properties and quality characteristics.

3.1 Requirement X.Y.Z (in Structured Natural Language)

Function:

  • Gather information from several sensors and a Twitter steam
  • Post information on a map, available from a browser

Description:

Inputs:

  • Json data from Twitter
  • MQTT data from sensors

Source:

  • Twitter stream
  • Sensors

Outputs:

  • A web site

Destination:

  • Citizen
  • Town hall

Action:

  • Store information from sensors and Twitter into a database

Non functional requirements:

Pre-condition:

  • Hardware:
- Intel Galileo
- Senors with MQTT compatibility


  • Software:
- Nodejs
- Red-node
- Mongodb
- Mosquitto


Post-condition:

Side-effects:

4. Product evolution

5. Appendices

6. Index