Proj-2014-2015-Ext XBMC/SRS - Revision history

RICM4-prj14-grp7: /* 1.3 Definitions, acronyms and abbreviations */

2015-03-11T14:07:29Z

1.3 Definitions, acronyms and abbreviations

← Older revision		Revision as of 14:07, 11 March 2015
Line 10:		Line 10:

	==1.3 Definitions, acronyms and abbreviations==		==1.3 Definitions, acronyms and abbreviations==
	*''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		* '''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
			* '''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]

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

RICM4-prj14-grp7: Change XBMC by Kodi, correct some kodi into Kodi

2015-03-11T14:05:23Z

Change XBMC by Kodi, correct some kodi into Kodi

← Older revision		Revision as of 14:05, 11 March 2015
Line 1:		Line 1:
	=1. Introduction=		=1. Introduction=
	==1.1 Purpose of the requirements document==		==1.1 Purpose of the requirements document==
	This Software Requirements Specification (SRS) identifies the requirements for the ~~xbmc/~~Kodi extension development project. This document is a guideline about the functionalities offered and the problems that the system solves.		This Software Requirements Specification (SRS) identifies the requirements for the Kodi(former XBMC) extension development project. This document is a guideline about the functionalities offered and the problems that the system solves.

	==1.2 Scope of the product==		==1.2 Scope of the product==

	* The purpose of this project is to allow a user, playing files with ~~xbmc~~, to have an experience of mobility while watching a film or listening to music, thanks to numerous computers with ~~xbmc~~ on it and sharing of files over the network.		* 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 code used in this project is extensible and open-source.		* The code used in this project is extensible and open-source.
Line 21:		Line 21:
	=2. General description=		=2. General description=
	==2.1 Product perspective==		==2.1 Product perspective==
	Play video or music on various screen/~~kodi~~ application according to the location of the main user.		Play video or music on various screen/Kodi application according to the location of the main user.
	==2.2 Product functions==		==2.2 Product functions==
	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.		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.
Line 27:		Line 27:

	==2.3 User characteristics==		==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 on ~~xbmc~~.		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.

	==2.4 General constraints==		==2.4 General constraints==
	* Possece a kinect for the kinect mode		* Possece a kinect for the kinect mode
Line 37:		Line 36:

	==2.5 Assumptions and dependencies==		==2.5 Assumptions and dependencies==
	*The android device used as remote controller have a wi-fi access to the network in order to control the ~~xbmc~~ instances		*The android device used as remote controller have a wi-fi access to the network in order to control the Kodi instances
	*The ~~xbmc~~ instances are runned on computers on the same network with shared library contaning files that will be resumed.		*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=		=3.Specific requirements, covering functional, non-functional and interface requirements=
Line 48:		Line 47:

	==3.1 Requirement X.Y.Z (in Structured Natural Language)==		==3.1 Requirement X.Y.Z (in Structured Natural Language)==
	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 ~~wifi~~, a network between computers and android device, kinect sdk installed on the computers used with kinect mode, NFC tags, files shared on the network		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 change screen while watching a movie or listening to music with Kodi, with minimum interaction and resuming the media
Line 73:		Line 72:
	'''Pre-condition''':		'''Pre-condition''':
	*materials conditions:		*materials conditions:
	** Android device with ~~wifi~~ and NFC		** Android device with Wi-Fi and NFC
	** NFC tags		** NFC tags
	** computers with screens		** computers with screens
Line 82:		Line 81:
	** netwotk between coputers used as screens and android device		** netwotk between coputers used as screens and android device
	** shared media files on the network between machines		** shared media files on the network between machines
	** same version of ~~kodi~~ on every computers used as screeens		** same version of Kodi on every computers used as screeens
	** our ~~kodi~~ Addon installed on the computers used as scrrens		** our Kodi Addon installed on the computers used as scrrens
	** our remote control android applciation installed on the Android device		** our remote control android applciation installed on the Android device
	** kinect sdk installed on computer(s) where the kinect(s) is(are) connected		** kinect sdk installed on computer(s) where the kinect(s) is(are) connected
Line 106:		Line 105:

	==5.2 Sources==		==5.2 Sources==
	* The other groups who work on XBMC extensions		* 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://www.microsoft.com/en-us/kinectforwindows/develop/learn.aspx www.microsoft.com/en-us/kinectforwindows]
	* [http://developer.android.com/index.html developer.android.com]		* [http://developer.android.com/index.html developer.android.com]

RICM4-prj14-grp7: /* 1.3 Definitions, acronyms and abbreviations */

2015-03-11T14:01:38Z

1.3 Definitions, acronyms and abbreviations

← Older revision		Revision as of 14:01, 11 March 2015
Line 10:		Line 10:

	==1.3 Definitions, acronyms and abbreviations==		==1.3 Definitions, acronyms and abbreviations==
			*''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

	==1.4 References==		==1.4 References==
	*Page of the project : [[Extensions XBMC Sujet 2015]]		*Page of the project : [[Extensions XBMC Sujet 2015]]

RICM4-prj14-grp7: /* 2.2 Product functions */

2015-03-11T13:59:33Z

2.2 Product functions

← Older revision		Revision as of 13:59, 11 March 2015
Line 21:		Line 21:
	Play video or music on various screen/kodi application according to the location of the main user.		Play video or music on various screen/kodi application according to the location of the main user.
	==2.2 Product functions==		==2.2 Product functions==
			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==		==2.3 User characteristics==

RICM4-prj14-grp7: /* 3.1 Requirement X.Y.Z (in Structured Natural Language) */

2015-03-11T13:57:42Z

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

← Older revision		Revision as of 13:57, 11 March 2015
Line 47:		Line 47:
	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 wifi, a network between computers and android device, kinect sdk installed on the computers used with kinect mode, NFC tags, files shared on the network		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 wifi, 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 minimum interaction and resuming the media		'''Function''': allow user to change screen while watching a movie or listening to music with Kodi, with minimum interaction and resuming the media

RICM4-prj14-grp7: /* 3.1 Requirement X.Y.Z (in Structured Natural Language) */

2015-03-11T13:56:39Z

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

← Older revision		Revision as of 13:56, 11 March 2015
Line 61:		Line 61:
	'''Destination''': user(s)		'''Destination''': user(s)

	'''Action''': * play media using network shared files		'''Action''':
			* play media using network shared files
	* resume play of media on various screen		* resume play of media on various screen
	* automatically add host on the remote control Android applicaion thanks to NFC tags		* automatically add host on the remote control Android applicaion thanks to NFC tags

RICM4-prj14-grp7: /* 3.1 Requirement X.Y.Z (in Structured Natural Language) */

2015-03-11T13:56:15Z

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

← Older revision		Revision as of 13:56, 11 March 2015
Line 45:		Line 45:

	==3.1 Requirement X.Y.Z (in Structured Natural Language)==		==3.1 Requirement X.Y.Z (in Structured Natural Language)==
			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 wifi, 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''':

			'''Function''': allow user to change screen while watching a movie or listening to music, with minimum interaction and resuming the media

	'''Description''':

			'''Description''': an android application and a Kodi Addon to

	'''Inputs''':

			'''Inputs''': options in the Addon, options in the Android application, number of person in front of a screen, "position" of the user
	'''Source''':

			'''Source''': keyboard or mouse in the Addon option menu in Kodi, ouch screen on the Android device, kinect, NFC tags for the "position"
	'''Outputs''':

			'''Outputs''': video or sound, depending of the media played
⚫	'''Destination''':

		⚫	'''Destination''': user(s)

	'''Action''':		'''Action''': * play media using network shared files
			* resume play of media on various screen

			* automatically add host on the remote control Android applicaion thanks to NFC tags

	* 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''':		'''Non functional requirements''':

	'''Pre-condition''':		'''Pre-condition''':
			*materials conditions:
			** Android device with wifi and NFC
			** NFC tags
			** computers with screens
			** network
			** kinect (optionnal)

			*Software conditions:
			** netwotk between coputers used as screens and android device
			** shared media files on the network between machines
			** same version of kodi on every computers used as screeens
			** 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''':		'''Post-condition''':

RICM4-prj14-grp7: /* 4. Product evolution */

2015-03-11T13:21:18Z

4. Product evolution

← Older revision		Revision as of 13:21, 11 March 2015
Line 77:		Line 77:

	=4. Product evolution=		=4. Product evolution=

			* Use of Bluetooth instead of/with the NFC tags
			* Find a way to avoid installing Kinect sdk to use the Addon
			* Play (a movie or a music) on the remote between two screens using an elegant method

	=5. Appendices=		=5. Appendices=

RICM4-prj14-grp7: /* 5. Appendices */

2015-03-11T13:15:16Z

5. Appendices

← Older revision		Revision as of 13:15, 11 March 2015
Line 81:		Line 81:
	==5.1. SRS structure==		==5.1. SRS structure==
	The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.		The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

	'''References:'''		'''References:'''
	* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx		* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
Line 89:		Line 88:
	==5.2 Sources==		==5.2 Sources==
	* The other groups who work on XBMC extensions		* The other groups who work on XBMC extensions
	* [http://www.microsoft.com/en-us/kinectforwindows/develop/learn.aspx www.microsoft.com/en-us/kinectforwindows] ~~<br>~~		* [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] ~~<br>~~		* [http://developer.android.com/index.html developer.android.com]
	* [https://www.python.org/doc/ www.python.org] ~~<br>~~		* [https://www.python.org/doc/ www.python.org]
	* [http://mirrors.xbmc.org/docs/python-docs/14.x-helix/ mirrors.xbmc.org/docs/] ~~<br>~~		* [http://mirrors.xbmc.org/docs/python-docs/14.x-helix/ mirrors.xbmc.org/docs/]

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

RICM4-prj14-grp7: /* 5. Appendices */

2015-03-11T13:10:02Z

5. Appendices

← Older revision		Revision as of 13:10, 11 March 2015
Line 86:		Line 86:
	* http://en.wikipedia.org/wiki/Software_requirements_specification		* 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]		* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]

			==5.2 Sources==
			* The other groups who work on XBMC extensions
			* [http://www.microsoft.com/en-us/kinectforwindows/develop/learn.aspx www.microsoft.com/en-us/kinectforwindows] <br>
			* [http://developer.android.com/index.html developer.android.com] <br>
			* [https://www.python.org/doc/ www.python.org] <br>
			* [http://mirrors.xbmc.org/docs/python-docs/14.x-helix/ mirrors.xbmc.org/docs/] <br>