Latest revision as of 15:50, 23 March 2015

1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) identifies the requirements for the iRock project. This document is a guideline about the functionalities offered and the problems that the system solves.

1.2 Scope of the product

The purpose of this project is to allow its users to predict and detect landslides and based on information sent by a number of sensors and radios embedded to microcontrollers.

We can calculate the position of sensor by triangulation with signal radio strength

The code used in this project is extensible and open-source.

1.3 Definitions, acronyms and abbreviations

LORA : 2-way wireless solution that complements M2M cellular infrastructure, and provides a low-cost way to connect battery operated and mobile devices to the network infrastructure
SX1276 : A stable implementation of LORA
Mbed : A platform and operating system for internet-connected devices based on 32-bit ARM Cortex-M microcontrollers
STM32 Nucleo : An affordable and flexible way for users to try out new ideas and build prototypes with any STM32 microcontroller line, choosing from the various combinations of performance, power consumption and features.
Keil : Complete software development environment for a wide range of ARM, Cortex-M, and Cortex-R based microcontroller devices.

1.4 References

Page of the project : IRock

1.5 Overview of the remainder of the document

The rest of the SRS examines the specifications of the IRock project in details. Section two of the SRS presents the general features of the FollowME extension. Section three outlines the detailed, specific and functional requirements, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

2. General description

2.1 Product perspective

Monitor changes in environment such as temperature, movement, humidity and radio signal in order to detect landslides and predict the possibility of lanslides based on history

2.2 Product functions

The product has a built in relay infrastructure that transfer environmental data from the micro-controllers to a backend processing unit that stores the data in a time-based database. Analysis and prediction can be made based on this database, which is visualised in time graphs on Grafana.

2.3 User characteristics

The user does not need to be familiar with coding or computer science. But preliminary knowledge on geotechnical aspects of landslides is prefered to interpret the history of environmental data. He want have files of data to reuse it

2.4 General constraints

Communication based only on LoRA technology
Deployment on non snowy terrain
The user need to have a standard internet browser
Alarm notification system is not included in the scope of our project

2.5 Assumptions and dependencies

Product availability/uptime depends on backend host provider
The area where rock are left must stay the same

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)

Requirement : Grafana and InfluxDB installed on selected server hosting provider with enough bandwidth to accomodate the incoming data.

Function: allow user to visualise environmental data sent over a long distance by LoRA Technology, and then predict landslides occurences.

Description: Using LoRA enabled radio and sensors embedded to various microcontrollers (STM32 Nucleo STM32 F3, STM32 F4), we will get environmental data such as temperature, humidity, and land movement relayed to a time-based database and from theron, analyse the data and predict lanslides.

Inputs: environmental data such as temperature, humidity and movement

Source: STM32 Nucleo, F3 F4 and LoRA radio module

Outputs: Time-based graphs and MS Excel files

Destination: User and prediction algorithm

Action:

Deploy iRocks evenly over a terrain the size of a football field
Start Grafana and InfluxDB
If applicable, start prediction algorithm on output (Grafana or Excel files)

Non functional requirements:

Pre-condition:

materials conditions:
- At least 5 microcontrollers (mix of STM32 Nucleo, F3 , F4)
- Mbed module for LoRA
- Sparkfun weather station
- Raspberry PI as the access point
- Battery power for a span of a year or 2.

Software conditions:
- Keil MDK 4 or 5 to debug and flash micro-controllers (discovery board)
- Mbed compiler to debug and flash micro-controllers (nucleo board)
- Grafana and InfluxDB association
- Appropriate relay program flashed on each micro-controller

Post-condition:

Side-effects:

4. Product evolution

Use the updated version of LoRA
Use STM Cube for future development
Improve detection and prediction algorithme
Implement an alarm system
Enable reprogramming of micro-controllers from the backend
Add a system to dowload the Excel File from an internet browser

5. Appendices

5.1. SRS structure

The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard. References:

5.2 Sources

SmartCampus 2015 group for LoRA

5.3 Licensing Requirements

XBMC extension (or more precisly FollowMe) will be released under a GNU/GPL licence

@@ Line 5: / Line 5: @@
 ==1.2   Scope of the product==
-* The purpose of this project is to allow a user, playing files with Kodi, to have an experience of mobility while watching a film or listening to music, thanks to numerous computers with Kodi on it and sharing of files over the network.
+* The purpose of this project is to allow its users to predict and detect landslides and based on information sent by a number of sensors and radios embedded to microcontrollers.
+* We can calculate the position of sensor by triangulation with signal radio strength
 * The code used in this project is extensible and open-source.
 ==1.3   Definitions, acronyms and abbreviations==
+* '''LORA''' :  2-way wireless solution that complements M2M cellular infrastructure, and provides a low-cost way to connect battery operated and mobile devices to the network infrastructure
-* '''NFC''' : Near Field Communication  is a technology that enables devices to establish radio communication with each other by touching them together or bringing them into proximity
+* '''SX1276''' : A stable implementation of LORA
-* '''XBMC''' : former name of the media center software Kodi, in this document references to XBMC or Kodi designe the same software : [http://kodi.tv/ Kodi]
+* '''Mbed''' : A platform and operating system for internet-connected devices based on 32-bit ARM Cortex-M microcontrollers
+* '''STM32 Nucleo''' : An affordable and flexible way for users to try out new ideas and build prototypes with any STM32 microcontroller line, choosing from the various combinations of performance, power consumption and features.
+* '''Keil''' : Complete software development environment for a wide range of ARM, Cortex-M, and Cortex-R based microcontroller devices.
 ==1.4   References==
-*Page of the project : [[Extensions XBMC Sujet 2015]]
+*Page of the project : [[IRock]]
-*Last year project : [[Extensions XBMC Sujet 2014]]
 ==1.5   Overview of the remainder of the document==
-The rest of the SRS examines the specifications of the Extensions XBMC 2015 project in details. Section two of the SRS presents the general features of the FollowME extension. Section three outlines the detailed, specific and functional requirements, system and other related requirements of the project. Supporting information about appendices is provided in Section three.
+The rest of the SRS examines the specifications of the IRock project in details. Section two of the SRS presents the general features of the FollowME extension. Section three outlines the detailed, specific and functional requirements, system and other related requirements of the project. Supporting information about appendices is provided in Section three.
 =2.   General description=
 ==2.1   Product perspective==
+Monitor changes in environment such as temperature, movement, humidity and radio signal in order to detect landslides and predict the possibility of lanslides based on history
-Play video or music on various screen/Kodi application according to the location of the main user.
 ==2.2   Product functions==
+The product has a built in relay infrastructure that transfer environmental data from the micro-controllers to a backend processing unit that stores the data in a time-based database. Analysis and prediction can be made based on this database, which is visualised in time graphs on Grafana.
-This Kodi Addon called FollowMe allow user to change screen while watching a movie or listening to music with Kodi, with minimum interaction and resuming the media.
-Furthermore, the remote control Android application enable user to add host for the remote only taging NFC tags. It also allow user to write his own tags with host information.
 ==2.3   User characteristics==
-The user does not need to be familiar with coding or computer science. The only requierement is to be able to share files on a network and to install Addon for Kodi.
+The user does not need to be familiar with coding or computer science. But preliminary knowledge on geotechnical aspects of landslides is prefered to interpret the history of environmental data. He want have files of data to reuse it
 ==2.4   General constraints==
+* Communication based only on LoRA technology
-* Possece a kinect for the kinect mode
+* Deployment on non snowy terrain
-* The device used as remote controller have to :
+* The user need to have a standard internet browser
-**run on Android 4.0+
+* Alarm notification system is not included in the scope of our project
-**be NFC compatible
-**have wi-fi antenna (mostly all the android devices)
 ==2.5   Assumptions and dependencies==
+*Product availability/uptime depends on backend host provider
-*The android device used as remote controller have a wi-fi access to the network in order to control the Kodi instances
+*The area where rock are left must stay the same
-*The Kodi instances are runned on computers on the same network with shared library contaning files that will be resumed.
 =3.Specific requirements, covering functional, non-functional and interface requirements=
@@ Line 48: / Line 52: @@
 ==3.1 Requirement X.Y.Z (in Structured Natural Language)==
+Requirement : Grafana and InfluxDB installed on selected server hosting provider with enough bandwidth to accomodate the incoming data.
-Requirement : same version of Kodi (former XBMC) installed on the computers used as screens, our Addon installed on these computers, our version of the remote control application installed on an android device with NFC technology and Wi-Fi, a network between computers and android device, kinect sdk installed on the computers used with kinect mode, NFC tags, files shared on the network
-'''Function''': allow user to change screen while watching a movie or listening to music with Kodi, with minimum interaction and resuming the media
+'''Function''': allow user to visualise environmental data sent over a long distance by LoRA Technology, and then predict landslides occurences.
-'''Description''': an android application and a Kodi Addon to
+'''Description''': Using LoRA enabled radio and sensors embedded to various microcontrollers (STM32 Nucleo STM32 F3, STM32 F4), we will get environmental data such as temperature, humidity, and land movement relayed to a time-based database and from theron, analyse the data and predict lanslides.
+'''Inputs''': environmental data such as temperature, humidity and movement
-'''Inputs''': options in the Addon, options in the Android application, number of person in front of a screen, "position" of the user
+'''Source''': STM32 Nucleo, F3 F4 and LoRA radio module
-'''Source''': keyboard or mouse in the Addon option menu in Kodi, ouch screen on the Android device, kinect, NFC tags for the "position"
-'''Outputs''': video or sound, depending of the media played
+'''Outputs''': Time-based graphs and MS Excel files
-'''Destination''': user(s)
+'''Destination''': User and prediction algorithm
 '''Action''':
+* Deploy iRocks evenly over a terrain the size of a football field
-* play media using network shared files
+* Start Grafana and InfluxDB
-* resume play of media on various screen
+* If applicable, start prediction algorithm on output (Grafana or Excel files)
-* automatically add host on the remote control Android applicaion thanks to NFC tags
 '''Non functional requirements''':
@@ Line 73: / Line 75: @@
 '''Pre-condition''':
 *materials conditions:
+** At least 5 microcontrollers (mix of STM32 Nucleo, F3 , F4)
-** Android device with Wi-Fi and NFC
+** Mbed module for LoRA
-** NFC tags
+** Sparkfun weather station
-** computers with screens
+** Raspberry PI as the access point
-** network
+** Battery power for a span of a year or 2.
-** kinect (optionnal)
 *Software conditions:
+** Keil MDK 4 or 5 to debug and flash micro-controllers (discovery board)
-** netwotk between coputers used as screens and android device
+** Mbed compiler to debug and flash micro-controllers (nucleo board)
-** shared media files on the network between machines
+** Grafana and InfluxDB association
-** same version of Kodi on every computers used as screeens
+** Appropriate relay program flashed on each micro-controller
-** our Kodi Addon installed on the computers used as scrrens
-** our remote control android applciation installed on the Android device
-** kinect sdk installed on computer(s) where the kinect(s) is(are) connected
 '''Post-condition''':
@@ Line 93: / Line 93: @@
 =4. Product evolution=
-* Use of Bluetooth instead of/with the NFC tags
+* Use the updated version of LoRA
+* Use STM Cube for future development
-* Find a way to avoid installing Kinect sdk to use the Addon
+* Improve detection and prediction algorithme
-* Play (a movie or a music) on the remote between two screens using an elegant method
+* Implement an alarm system
+* Enable reprogramming of micro-controllers from the backend
+* Add a system to dowload the Excel File from an internet browser
 =5. Appendices=
@@ Line 106: / Line 109: @@
 ==5.2  Sources==
+* SmartCampus 2015 group for LoRA
-* The other groups who work on Kodi/XBMC extensions
-* [http://www.microsoft.com/en-us/kinectforwindows/develop/learn.aspx  www.microsoft.com/en-us/kinectforwindows]
-* [http://developer.android.com/index.html  developer.android.com]
-* [https://www.python.org/doc/  www.python.org]
-* [http://mirrors.xbmc.org/docs/python-docs/14.x-helix/  mirrors.xbmc.org/docs/]
 ==5.3  Licensing Requirements==

Difference between revisions of "Proj-2014-2015-iRock/SRS"