RICM4 2017 2018 - IGreenHouse / SRS: Difference between revisions

From air
Jump to navigation Jump to search
(Created page with "The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard. '''Read first:''' * http://www.cs.st-an...")
 
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.


'''Read first:'''
* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
* http://en.wikipedia.org/wiki/Software_requirements_specification
* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]

{|class="wikitable alternance"
{|class="wikitable alternance"
|+ Document History
|+ Document History
Line 20: Line 12:
!scope="row" |
!scope="row" |
| 0.1.0
| 0.1.0
| TBC
| 05/02/2018
| SURIER GAROFALO Aurélien, FERREIRA Joffrey, OZENDA Thomas
| TBC
| TBC
| TBC
| TBC
| TBC
Line 31: Line 23:
=1. Introduction=
=1. Introduction=
==1.1 Purpose of the requirements document==
==1.1 Purpose of the requirements document==

This Software Requirements Specification (SRS) identifies the requirements for the project [[I-Greenhouse]] : [[Serre connectée aquaponie]]. This document is a guideline about the functionalities offered and the problems that the system solves.

==1.2 Scope of the product==
==1.2 Scope of the product==

The goal of this project is to connect an aquaponic greenhouse by using LoRa tecnology. Broadly speaking, it involves places different sensors in the greenhouse and take some measures to inform the farmer about the state of his crops.

==1.3 Definitions, acronyms and abbreviations==
==1.3 Definitions, acronyms and abbreviations==

* Greenhouse: an area, usually chiefly of glass, in which the temperature is maintained within a desired range, used for cultivating tender plants or growing plants out of season.
* LoRa: Long Range and low energy radio RF technology developed by Semtech. It's an open-source technology.

==1.4 References==
==1.4 References==

* '''Follow-up sheet:''' [[ RICM4_2017_2018_-_IGreenHouse ]]
* '''Subject:''' [[ I-Greenhouse]] : [[Serre connectée aquaponie ]]

==1.5 Overview of the remainder of the document==
==1.5 Overview of the remainder of the document==
General description of the project followed by all its requirements and the product evolution.

=2. General description=
=2. General description=

==2.1 Product perspective==
==2.1 Product perspective==

==2.2 Product functions==
==2.2 Product functions==

1 - Node at gateway to send datas on internet

2 - Database of datas

3 - Gui using the database

==2.3 User characteristics==
==2.3 User characteristics==

It can be someone who do not know the technos and the GUI has to as simple as possible.

==2.4 General constraints==
==2.4 General constraints==

LoRa limit us because It is impossible to send a lot of data with It (legislation).

The gateway (LoRa to web) is shared with 2 others group, so we have to work together.

==2.5 Assumptions and dependencies==
==2.5 Assumptions and dependencies==

=3.Specific requirements, covering functional, non-functional and interface requirements=
=3.Specific requirements, covering functional, non-functional and interface requirements=
* document external interfaces,
* document external interfaces,
Line 49: Line 75:


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

'''Function''':
'''Function''':



Latest revision as of 07:09, 12 February 2018

Document History
Version Date Authors Description Validator Validation Date
0.1.0 05/02/2018 SURIER GAROFALO Aurélien, FERREIRA Joffrey, OZENDA Thomas TBC TBC TBC


1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) identifies the requirements for the project I-Greenhouse : Serre connectée aquaponie. This document is a guideline about the functionalities offered and the problems that the system solves.

1.2 Scope of the product

The goal of this project is to connect an aquaponic greenhouse by using LoRa tecnology. Broadly speaking, it involves places different sensors in the greenhouse and take some measures to inform the farmer about the state of his crops.

1.3 Definitions, acronyms and abbreviations

  • Greenhouse: an area, usually chiefly of glass, in which the temperature is maintained within a desired range, used for cultivating tender plants or growing plants out of season.
  • LoRa: Long Range and low energy radio RF technology developed by Semtech. It's an open-source technology.

1.4 References

1.5 Overview of the remainder of the document

General description of the project followed by all its requirements and the product evolution.

2. General description

2.1 Product perspective

2.2 Product functions

1 - Node at gateway to send datas on internet

2 - Database of datas

3 - Gui using the database

2.3 User characteristics

It can be someone who do not know the technos and the GUI has to as simple as possible.

2.4 General constraints

LoRa limit us because It is impossible to send a lot of data with It (legislation).

The gateway (LoRa to web) is shared with 2 others group, so we have to work together.

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:

Description:

Inputs:

Source:

Outputs:

Destination:

Action:

  • 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:

Pre-condition:

Post-condition:

Side-effects:

4. Product evolution

5. Appendices

6. Index