RICM4 2017 2018 - UltraTeamMV : SRS

This document is inspired of the IEEE/ANSI 830-1998 Standard.

=Introduction=

Purpose of the requirements document
This Software Requirements Specification (SRS) identifies the requirements for project UltraTeamMV project.

It will present our solution's functionalities and problem solved but also list our system requirements.

Scope of the product
This project consists of : This project should allow a hikers team to localise each other in real time.
 * a LoRa and BLE protocol conception a and implementation,
 * a web application development.

It should be really easy to add new members (Numeric code, QRCode, NFC, …).

The system should work whether or not there is a 2G/3G/4G or LoRa connection.

Definitions, acronyms and abbreviations

 * LoRa = Long Range : Low powered radio based communication technology
 * LoRaWAN = Long Range Wide Area Networks : LoRa overlayer to ease (& securise) LoRa communication implementation
 * LPWAN = Low Powered Wide Area Networks
 * BLE = Bluetooth Low Energy
 * GPS = Global Positioning System

Overview of the remainder of the document
=General description=

Product perspective
The product is supposed to be an open source.

It is a web based system implementing client-server model. The UltraTeamMV System provides simple mechanism for outdoor geolocation in white & gray network areas.

Product functions
This system should allow low energy cost localisation.

It should be decentralized as 2G/3G/4G network is sporadic in such environnement.

It should also centralize all data to allow sending it to appropriate services (rescue team for instance).

User characteristics
Hikers team, comfortable with using a smartphone but not a technology expert.

No financial criteria other than having a smartphone as an ESP32 costs about 5€.

About age group, anyone that is comfortable with using a smartphone (hence ~15-70).

General constraints
The system should work whether or not there is a 2G/3G/4G connection

Limited localisation accuracy : GPS.

Assumptions and dependencies
As few environnement assumptions as possible.

A team needs at least 1 smartphone (with GPS connection) and 1 ESP32 per hiker.

=Specific requirements=

This section is supposed to describe two types of requirements :  A structured document setting out detailed descriptions of the system’s functions, services and operational constraints. Defines what should be implemented so may be part of a contract between client and contractor.
 * System requirements

Statements in natural language plus diagrams of the services the system provides and its operational constraints. Written for customers.
 * User requirements

Those user requirements are described in use case section of the UML page of the project.

Requirement 1 : BLE connection establishment
Function: BLE connection establishment.

Description: Establish a BLE connection between a smartphone and an ESP32.

Inputs: Smartphone.

Source: None.

Outputs: An established BLE connection between ESP & smartphone.

Destination: None.

Action:
 * 1) Identify which devices to connect via smartphone.
 * 2) Connect the two devices.

Non functional requirements: Connection should be established in less than 1 min.

Pre-condition:
 * ESP32 & Smartphone are on, with BLE running,
 * ESP32 & Smartphone are near enough to communicate via BLE.
 * BLE on ESP32 & smartphone should be technologically able to communicate

Post-condition: ESP32 and smartphone are connected via BLE.

Side-effects: None.

Requirement 2 : Distress signal transmission (ESP32 → smartphone)
Function: Distress signal transmission from ESP32 to smartphone via BLE.

Description: As an ESP32 detects a distress signal, it should immediately be transferred to user's smartphone.

Inputs: A distress signal.

Source: User's ESP32.

Outputs: A distress signal. Destination: User's smartphone.

Action:
 * 1) Detect distress signal,
 * 2) Parse distress signal (is it from user's ESP or from another ESP ? Which is the corresponding location and UID ?),
 * 3) Forge corresponding BLE packet,
 * 4) Send said packet.

Non functional requirements: This transmission should be above all in BLE communication priority.

Pre-condition: ESP32 & Smartphone should be connected via BLE.

Post-condition: Both smartphone and ESP32 are aware of the other user's distress state.

Side-effects: None.

Requirement 3 : Distress signal transmission (smartphone → ESP32)
Function: Distress signal transmission from smartphone to ESP32 via BLE.

Description: As a smartphone detects a distress state, a signal should immediately be transferred to user's ESP32.

Inputs: A distress signal.

Source: User's smartphone.

Outputs: A distress signal. Destination: User's ESP32.

Action:
 * 1) Detect distress signal,
 * 2) Parse distress signal (which is the corresponding location and UID ?),
 * 3) Forge corresponding BLE packet,
 * 4) Send said packet.

Non functional requirements: This transmission should be above all in BLE communication priority.

Pre-condition: ESP32 & Smartphone should be connected via BLE.

Post-condition: Both smartphone and ESP32 are aware of the other user's distress state.

Side-effects: None.

Requirement 4 : Distress signal forwarding (ESP32 ⇶)
Function: Distress signal forwarding via broadcast by ESP32.

Description: An ESP21 detects a distress signal, it should immediately be broadcasted to other users' ESP32.

Inputs: A distress signal.

Source: User's ESP32.

Outputs: A distress signal. Destination: Other users' ESP32.

Action:
 * 1) Detect distress signal,
 * 2) Parse distress signal (which is the corresponding location and UID ?),
 * 3) Forge corresponding BLE packet,
 * 4) Send said packet.

Non functional requirements: This transmission should be above all in LoRa communication priority. ESP can send signal more than 1% of the time via LoRa.

Pre-condition: None.

Post-condition: None.

Side-effects: None.

Requirement 5 : Geolocation signal broadcasting (ESP32 ⇶)
Function: Geolocation signal broadcasting from ESP32 via LoRa

Description: To be known from other ESP32, a geolocation must be broadcasted via LoRa.

Inputs: A geolocation information.

Source: ESP32.

Outputs: A geolocation signal.

Destination: LoRa broadcast.

Action:
 * 1) Forge LoRa packet,
 * 2) Send LoRa packet.

Non functional requirements: ESP can send signal more than 1% of the time via LoRa.

Pre-condition: ESP32 has a geolocation information to send.

Post-condition: None.

Side-effects: None.

Requirement 6 : Geolocation signal transmission (Smartphone → ESP32)
Function: Geolocation signal transmission from smartphone to ESP32 via BLE.

Description: To be able to send geolocation information, ESP32 must be aware of it. Thus, user's smartphone should be able to transmit it to ESP32 via BLE.

Inputs: A geolocation information.

Source: User's smartphone.

Outputs: A geolocation information.

Destination: User's ESP32.

Action:
 * 1) Forge BLE packet,
 * 2) Send BLE packet.

Non functional requirements: None.

Pre-condition: A geolocation information is available on smartphone.

Post-condition: None.

Side-effects: None.

Requirement 7 : Information upload (Smartphone → server)
Function: User's smartphone information upload to server via HTTP (RESTful API)

Description: To transfer information via 3G/4G, smartphone should be able to send information to server. It is done via a RESTful API.

Inputs: A list of users (UID, name, Geolocation, potential distress state).

Source: User's smartphone.

Outputs: An update on users list. Destination: Server.

Action:
 * 1) List every changes since last update.
 * 2) For each, forge an API request.
 * 3) Send requests.

Non functional requirements: None.

Pre-condition: Smartphone should have a working 3G/4G connection.

Post-condition: None.

Side-effects: None.

Requirement 8 : Distress signal transmission (Smartphone → server)
Function: Distress signal transmission from smartphone to server via HTTP (RESTful API).

Description: A distress signal should be, if possible, transferred via 3G/4G. It is done via a RESTful API.

Inputs: A distress signal.

Source: User's smartphone.

Outputs: A distress signal. Destination: Server.

Action:
 * 1) Detect distress signal,
 * 2) Parse distress signal (which is the corresponding location and UID ?),
 * 3) Forge corresponding BLE packet,
 * 4) Forge an API request,
 * 5) Send request.

Non functional requirements: None.

Pre-condition: Smartphone should have a working 3G/4G connection.

Post-condition: None.

Side-effects: None.

Requirement 9 : Server information download
Function: Server information download by smartphone via HTTP (RESTful API)

Description: To be able to receive 3G/4G-transmitted information, user's smartphone should be able to receive updates from server.

Inputs: A list of users (UID, name, Geolocation, potential distress state).

Source: Server.

Outputs: A user(s) update.

Destination: Smartphone.

Action:
 * 1) Smartphone forges an update API request,
 * 2) Server sends update as request response,
 * 3) Smartphones parses response.

Non functional requirements: None.

Pre-condition: Smartphone should have a working 3G/4G connection.

Post-condition: None.

Side-effects: None.

Requirement 10 : Geolocation information retrievement
Function: Geolocation information retrievement on smartphone via GPS.

Description: To be able to locate its device, one's smartphone should be able to retrieve its geolocation. It is done via GPS.

Inputs: None.

Source: Satellite.

Outputs: Geolocation information.

Destination: Smartphone.

Action:
 * 1) Smartphone retrieves its geolocation via GPS communication with satellite.

Non functional requirements: None.

Pre-condition: None.

Post-condition: None.

Side-effects: None.

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

=Product evolution=

=Appendices= SRS related documents used to establish this page:
 * 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