Proj-2015-2016-IndoorGeoloc/SRS

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
 * IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998

=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. The Arduino measures the BLE signals. Data is sent to a server which will compute a distance.
 * Raw data : Data returned by the sensor sent to the server computing the distance.

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
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
The product is meant to be enabling people to locate things into a building. The user interface will contain a list of emitting beacons, a map where these beacons are located. The hardware interface contains a flow of data that a server receives and use in order to mesure the RSSI distance of the object. The freshly computed position is saved into a databased which is accessible from another side of the server. That server will send the data to Android clients via the MQTT protocol.

2.2 Product functions

 * Locate objects on a map
 * Locate people on a map
 * Find a way to get to the located object

2.3 User characteristics
The application can be used by anyone who wants to locate things emitting bluetooth (BLE) waves. The user has to be connected to internet. The user must have an Android smartphone (version 4.4.4 KitKat minimum), but we hope that in the future this application can be developped for any smartphone OS.

2.4 General constraints

 * The use of the STM32 board are a constraint, they can detect only BLE waves.
 * Developped in Java
 * Network connexion strong and unfiltering the opening of ports

=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 1 : acquisition of data with computation of distance
Function: measuring, computing and storing of the data received from the STM32 boards into distance saved in a database.

Description: all the signals received from the BLE emitting beacon are used to compute a distance for a given beacon. The distance is then stored into a databse where an identifier, a date and the location of the object are added.

Inputs: BLE signals

Source: TI beacons, iTag

Outputs: database with distance computation for a beacon

Destination: the database will be used by a server which will send the last position (or any position at a given time) to an android client

Action:
 * acquisition of data with computation of distance

Non functional requirements: none

Pre-condition: identifiers between beacons must be unique

Post-condition:

Side-effects:

3.2 Requirement 2 : Sending the location of a device from the server to the Android client
Function: fetching data from the database, sending it to the rightful device

Description:

Inputs:

Source:

Outputs:

Destination:

Action:

Non functional requirements:

Pre-condition:

Post-condition:

Side-effects:

3.3 Requirement 3 : Rendering the received data on a map on Android smartphone
Function: using the received data ton display the information into a map

Description:

Inputs:

Source:

Outputs:

Destination:

Action:

Non functional requirements:

Pre-condition:

Post-condition:

Side-effects:

=4. Product evolution=

=5. Appendices= =6. Index=