Projets-2016-2017-floatingimageUPnP/SRS - Revision history

Maxime.Dereymez: /* 3.1 Requirement 1 : Discover connected UPnP devices */

2017-02-05T18:22:06Z

3.1 Requirement 1 : Discover connected UPnP devices

Maxime.Dereymez at 18:19, 5 February 2017

2017-02-05T18:19:45Z

← Older revision		Revision as of 18:19, 5 February 2017
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 31:		Line 23:
	=1. Introduction=		=1. Introduction=
	==1.1 Purpose of the requirements document==		==1.1 Purpose of the requirements document==
	This document aims to define the goal of the project by giving a description of the software’s purpose and functionality. It lays out functional and non-functional requirements and may include a set of use cases that describe how users will use the software and also how the application will interact with other hardware and program		This document aims to define the goal of the project by giving a description of the software’s purpose and functionality. It lays out functional and non-functional requirements and may include a set of use cases that describe how users will use the software and also how the application will interact with other hardware and program.

	==1.2 Scope of the product==		==1.2 Scope of the product==
Line 57:		Line 49:
	For the moment, we could use the application to transform our Android device into a digital photo frame using limited feeds of source files (local files of the devices or social network).		For the moment, we could use the application to transform our Android device into a digital photo frame using limited feeds of source files (local files of the devices or social network).

	The update of the application consists of a new ~~possibility~~ to use the device as a digital photo frame at home by creating your "own database" on your dedicated media server. This will extends the possibility of the application's use (for example as a fixed photo frame at home)		The update of the application consists in a new way to use the device as a digital photo frame at home by creating your "own database" on your dedicated media server. This will extends the possibility of the application's use (for example as a fixed photo frame at home).

	==2.2 Product functions==		==2.2 Product functions==
Line 63:		Line 55:
	The user should be able to:		The user should be able to:

			* discover connected UPnP devices
	* add new ~~Upnp~~ feed		* add a new UPnP feed

	* choose the source file to display (~~Upnp~~ feed, phone, social networks...)		* choose the source file to display (UPnP feed, phone, social networks...)

	* display pictures		* display pictures

	* change settings of the display (speed, orientation, movements)		* change settings of the display (speed, orientation, movements)

Line 81:		Line 71:
	User side constraints:		User side constraints:

	* Need a smartphone		* Need an Android smartphone
	* Need a media server (free)		* Need a media server (free)
	* Need an internet connection for external ~~feed~~ (website, socials networks) or local connection (UPnP)		* Need an internet connection for external feeds (website, socials networks) or local connection (UPnP)

	Software side constraints:		Software side constraints:

	* Use and adapt the software application already in place		* Use and adapt the software application already in place
	* No documentation ~~and~~ ~~commentary~~ in the source code		* No documentation nor comments in the source code

	=3.Specific requirements, covering functional, non-functional and interface requirements=		=3.Specific requirements, covering functional, non-functional and interface requirements=
Line 140:		Line 130:
	* The image exists on the server.		* The image exists on the server.
	* The application can connect to the server.		* The application can connect to the server.

	==3.3 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=		=4. Product evolution=

Maxime.Dereymez: /* 3.1 Requirement 1 : Discover connected UPnP devices */

2017-02-05T18:12:52Z

3.1 Requirement 1 : Discover connected UPnP devices

← Older revision		Revision as of 18:12, 5 February 2017
Line 97:		Line 97:
	* emergent system properties and quality characteristics.		* emergent system properties and quality characteristics.
	==3.1 Requirement 1 : Discover connected UPnP devices==		==3.1 Requirement 1 : Discover connected UPnP devices==
	'''Description''': The application search for connected UPnP on the network and select those which can provide images		'''Description''': The application search for connected UPnP devices on the network and select those which can provide images

	'''Inputs''':		'''Inputs''':

Maxime.Dereymez: /* 3.2 Requirement X.Y.Z (in Structured Natural Language) */

2017-02-05T18:11:31Z

3.2 Requirement X.Y.Z (in Structured Natural Language)

← Older revision		Revision as of 18:11, 5 February 2017
Line 121:		Line 121:
	* Every device on the list can provide images to the application		* Every device on the list can provide images to the application

	==3.2 Requirement ~~X.Y.Z~~ ~~(in~~ ~~Structured~~ ~~Natural~~ ~~Language)~~==		==3.2 Requirement 2 : Request an image from a UPnP media server==
			'''Description''': The application requests an image from a server connected through UPnP.
	'''Function''':

			'''Inputs''': The image filename and location on the media server.
	'''Description''':

			'''Source''': The image display from the original application.
	'''Inputs''':

	'''~~Source~~''':		'''Outputs''': The image file.

			'''Destination''': The image display, where the requested image will be displayed.
	'''Outputs''':

	'''Destination''':

	'''Action''':		'''Action''':
			* The application sends a request to the media server with enough information to find the image file.
	* Natural language sentences (with MUST, MAY, SHALL)
			* The server reply with the file.
	* Graphical Notations : UML Sequence w/o collaboration diagrams, Process maps, Task Analysis (HTA, CTT)
			* The file is sent to the display to be displayed.
	* Mathematical Notations
	* Tabular notations for several (condition --> action) tuples

	'''Non functional requirements''':

	'''Pre-condition''':		'''Pre-condition''':
			* The image exists on the server.

			* The application can connect to the server.
	'''Post-condition''':

	'''Side-effects''':

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

Maxime.Dereymez: /* 3.Specific requirements, covering functional, non-functional and interface requirements */

2017-02-05T15:53:06Z

3.Specific requirements, covering functional, non-functional and interface requirements

@@ Line 96: / Line 96: @@
 * design constraints,
 * emergent system properties and quality characteristics.
 '''Function''':

Raphael.Fustes: /* 2.5 Assumptions and dependencies */

2017-02-04T17:15:09Z

2.5 Assumptions and dependencies

← Older revision		Revision as of 17:15, 4 February 2017
Line 90:		Line 90:
	* No documentation and commentary in the source code		* No documentation and commentary in the source code

	==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,

Raphael.Fustes: /* 2.4 General constraints */

2017-02-04T17:13:24Z

2.4 General constraints

@@ Line 78: / Line 78: @@
 ==2.4   General constraints==
 ==2.5   Assumptions and dependencies==
 =3.Specific requirements, covering functional, non-functional and interface requirements=

Raphael.Fustes: /* 2.3 User characteristics */

2017-02-04T17:03:28Z

2.3 User characteristics

← Older revision		Revision as of 17:03, 4 February 2017
Line 72:		Line 72:

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

			There is no specific type of user. Indeed, it is an application used for personal use or "Entertainment".

			* All users with a Smartphone

	==2.4 General constraints==		==2.4 General constraints==
	==2.5 Assumptions and dependencies==		==2.5 Assumptions and dependencies==

Raphael.Fustes: /* 1.4 References */

2017-02-04T16:57:29Z

1.4 References

← Older revision		Revision as of 16:57, 4 February 2017
Line 43:		Line 43:

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

			* [http://air.imag.fr/index.php/Floatingimage_UPnP_feed Subject]

	* [https://kodi.tv/ XBMC]		* [https://kodi.tv/ XBMC]

Raphael.Fustes: /* 2.2 Product functions */

2017-02-04T16:56:47Z

2.2 Product functions

← Older revision		Revision as of 16:56, 4 February 2017
Line 62:		Line 62:

	* add new Upnp feed		* add new Upnp feed

	* choose the source file to display (Upnp feed, phone, social networks...)		* choose the source file to display (Upnp feed, phone, social networks...)

	* display pictures		* display pictures

	* change settings of the display (speed, orientation, movements)		* change settings of the display (speed, orientation, movements)

← Older revision		Revision as of 18:22, 5 February 2017
Line 87:		Line 87:
	* emergent system properties and quality characteristics.		* emergent system properties and quality characteristics.
	==3.1 Requirement 1 : Discover connected UPnP devices==		==3.1 Requirement 1 : Discover connected UPnP devices==
	'''Description''': The application search for connected UPnP devices on the network and select those which can provide images		'''Description''': The application search for connected UPnP devices on the network and select those which can provide images.

	'''Inputs''':		'''Inputs''':
Line 93:		Line 93:
	'''Source''':		'''Source''':

	'''Outputs''': List of every connected UPnP devices which can provide images		'''Outputs''': List of every connected UPnP devices which can provide images.

	'''Destination''': List of feeds available to the user		'''Destination''': List of feeds available to the user.

	'''Action''':		'''Action''':
	* The user select ''UPnP'' as the image source		* The user select ''UPnP'' as the image source.
	* The application discover every UPnP devices on the network		* The application discover every UPnP devices on the network.
	* The application selects those providing media content		* The application selects those providing media content.
	* The list of those devices is displayed to the user		* The list of those devices is displayed to the user.

	'''Non functional requirements''':		'''Non functional requirements''':

	'''Pre-condition''':		'''Pre-condition''':
	* The smartphone is connected to a network		* The smartphone is connected to a network.

	'''Post-condition''':		'''Post-condition''':
	* Every device on the list can provide images to the application		* Every device on the list can provide images to the application.

	==3.2 Requirement 2 : Request an image from a UPnP media server==		==3.2 Requirement 2 : Request an image from a UPnP media server==