Difference between revisions of "Proj-2015-2016-IndoorGeoloc/SRS"

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...")
 
Line 20: Line 20:
 
!scope="row" |
 
!scope="row" |
 
| 0.1.0
 
| 0.1.0
| TBC
+
| 18/01/2016
  +
| STOIAN Diana, CRASTES DE PAULET Damien, FAURE Quentin, ARRADA Imad-Seddik
| TBC
 
  +
| Indoor geolocalisation application
| TBC
 
 
| TBC
 
| TBC
 
| TBC
 
| TBC
Line 31: Line 31:
 
=1. Introduction=
 
=1. Introduction=
 
==1.1 Purpose of the requirements document==
 
==1.1 Purpose of the requirements document==
  +
  +
This Software Requirements Specification (SRS) is designed to identify the requirements for our project called "GeoLoc Indoor". The main goal of the project is to provide a solution to indoor geolocalisation problem. We are bound to develop an application able to locate BLE beacon in a building.
  +
This is an open source project so that maybe people find an interest in our app in order to make it take a step further. This document is a guideline listing the functionalities offered by our application and the solutions that the system provides.
  +
  +
 
==1.2 Scope of the product==
 
==1.2 Scope of the product==
  +
  +
Geoloc Indoor is a project with several possibilities of use. One of them could be when someone, equipped with the app on its smartphones, is looking for an object (emitting bluetooth) or a person in a building where each room contains sensors. Those sensors are linked to server computing the distance from the emitting beacons to the sensors and gives a location (room, distance, route) to the user.
  +
  +
 
==1.3 Definitions, acronyms and abbreviations==
 
==1.3 Definitions, acronyms and abbreviations==
  +
  +
* OpenStreetMap (OSM) : is a collaborative project to create a free editable map of the world.
  +
* STM32 is a family of 32-bit microcontroller integrated circuits by STMicroelectronics. The STM32 chips are grouped into related series that are based around the same 32-bit ARM processor core, such as the Cortex-M7, Cortex-M4F, Cortex-M3, Cortex-M0+, or Cortex-M0. Internally, each microcontroller consists of the processor core, static RAM memory, flash memory, debugging interface, and various peripherals.
  +
* Arduino : Programmable microcontroller able to generate and analyse electric signals. For our project, the Arduino get the measures from the HB100 sensor. Once the voltage and frequency values are available, they are transformed into distance and speed values, and send to the Raspberry by serial link.
  +
* Raw data : Data returned by the sensor and send to the Arduino.
  +
 
==1.4 References==
 
==1.4 References==
  +
  +
* https://www.arduino.cc/
  +
* https://en.wikipedia.org/wiki/OpenStreetMap
  +
* http://www.st.com/web/en/home.html
  +
 
==1.5 Overview of the remainder of the document==
 
==1.5 Overview of the remainder of the document==
  +
In the rest of the document, we will describe our objectives, the way the system is supposed to work and the constraints the project implies.
  +
 
=2. General description=
 
=2. General description=
 
==2.1 Product perspective==
 
==2.1 Product perspective==
  +
  +
 
==2.2 Product functions==
 
==2.2 Product functions==
  +
  +
 
==2.3 User characteristics==
 
==2.3 User characteristics==
  +
  +
 
==2.4 General constraints==
 
==2.4 General constraints==
 
==2.5 Assumptions and dependencies==
 
==2.5 Assumptions and dependencies==

Revision as of 00:48, 6 April 2016

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


Read first:

Document History
Version Date Authors Description Validator Validation Date
0.1.0 18/01/2016 STOIAN Diana, CRASTES DE PAULET Damien, FAURE Quentin, ARRADA Imad-Seddik Indoor geolocalisation application TBC TBC


1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) is designed to identify the requirements for our project called "GeoLoc Indoor". The main goal of the project is to provide a solution to indoor geolocalisation problem. We are bound to develop an application able to locate BLE beacon in a building. This is an open source project so that maybe people find an interest in our app in order to make it take a step further. This document is a guideline listing the functionalities offered by our application and the solutions that the system provides.


1.2 Scope of the product

Geoloc Indoor is a project with several possibilities of use. One of them could be when someone, equipped with the app on its smartphones, is looking for an object (emitting bluetooth) or a person in a building where each room contains sensors. Those sensors are linked to server computing the distance from the emitting beacons to the sensors and gives a location (room, distance, route) to the user.


1.3 Definitions, acronyms and abbreviations

  • OpenStreetMap (OSM) : is a collaborative project to create a free editable map of the world.
  • STM32 is a family of 32-bit microcontroller integrated circuits by STMicroelectronics. The STM32 chips are grouped into related series that are based around the same 32-bit ARM processor core, such as the Cortex-M7, Cortex-M4F, Cortex-M3, Cortex-M0+, or Cortex-M0. Internally, each microcontroller consists of the processor core, static RAM memory, flash memory, debugging interface, and various peripherals.
  • Arduino : Programmable microcontroller able to generate and analyse electric signals. For our project, the Arduino get the measures from the HB100 sensor. Once the voltage and frequency values are available, they are transformed into distance and speed values, and send to the Raspberry by serial link.
  • Raw data : Data returned by the sensor and send to the Arduino.

1.4 References

1.5 Overview of the remainder of the document

In the rest of the document, we will describe our objectives, the way the system is supposed to work and the constraints the project implies.

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:

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