System Requirements

YILDIRIM BEYAZIT UNIVERSITY FACULTY OF ENGINEERING AND NATURAL SCIENCES ELECRICAL AND ELECTRONICS ENGINEERING DEPARTMENT

Software Requirements Specification for SNMP FM/TV TRANSMITTER CONTROL VIA WEB INTERFACE VCO & ANALOG FRONT-END AND STERIO ENCODER CONTROL VIA MICROCONTROLER

Version 1.0 approved

Prepared by

GALLIMARD YVAN NYATCHOU NGASSA & ZIA SIDIQI

İDİL PRODÜKSYON

18/12/2017

Software Requirements Specification for <Project>

Page

Table of Contents Table of Contents ........................................................................................................................... i Revision History ...............................................................................................................................

1. Introduction ..............................................................................................................................1 1.1 1.2 1.3 1.4 1.5

Purpose............................................................................................................................................. 1 Document Conventions .................................................................................................................... 1 Intended Audience and Reading Suggestions .................................................................................. 1 Product Scope .................................................................................................................................. 1 References ........................................................................................................................................ 1

2. Overall Description ..................................................................................................................2 2.1 2.2 2.3 2.4 2.5 2.6 2.7

Product Perspective.......................................................................................................................... 2 Product Functions ............................................................................................................................ 2 User Classes and Characteristics ..................................................................................................... 3 Operating Environment .................................................................................................................... 3 Design and Implementation Constraints .......................................................................................... 3 User Documentation ........................................................................................................................ 3 Assumptions and Dependencies ...................................................................................................... 3

3. External Interface Requirements ...........................................................................................4 3.1 3.2 3.3 3.4

User Interfaces ................................................................................................................................. 4 Hardware Interfaces ......................................................................................................................... 4 Software Interfaces .......................................................................................................................... 4 Communications Interfaces ............................................................................................................. 4

4. System Features .......................................................................................................................5 4.1 System Feature 1 .............................................................................................................................. 5 4.2 System Feature 2 (and so on) ..........................................................Error! Bookmark not defined.

5. Other Nonfunctional Requirements .......................................................................................5 5.1 5.2 5.3 5.4 5.5

Performance Requirements .............................................................................................................. 5 Safety Requirements ........................................................................................................................ 5 Security Requirements ..................................................................................................................... 5 Software Quality Attributes ............................................................................................................. 5 Business Rules ................................................................................................................................. 5

6. Other Requirements .................................................................. Error! Bookmark not defined.

Appendix A: Glossary...................................................................... Error! Bookmark not defined.

Appendix B: Analysis Models ......................................................... Error! Bookmark not defined.

Appendix C: To Be Determined List .............................................. Error! Bookmark not defined.

Revision History Name

Date

Reason For Changes

Version

Software Requirements Specification for <Project>

1.

Introduction

1.1

Purpose

Page 1

This product is SNMP FM/TV TRANSMITTER CONTROL VIA WEB INTERFACE and VCO & ANALOG FRONT-END AND STERIO ENCODER CONTROL VIA MICROCONTROLER We will cover the software and hardware parts of the product.

1.2

Document Conventions

every requirement statement is to have its own priority.

1.3

Intended Audience and Reading Suggestions

The document is intended for, engineers, graduate students, academicians, coders, marketers, salesman, developers, project managers, marketing staff, users, testers, and documentation writers.

Sequence for reading the document. begin with the overview sections and proceeding through the sections that are most pertinent to you.

1.4

Product Scope

This software is a system for distance communication using development and embedded engineering.

Purpose: Distance Communication Benefit: Productivity, security, reliable Communication, Researchâ&#x20AC;Ś Objectives: Help the users to remotely control his/her device from the net Goals: Give an alternative or a plus to the deviceâ&#x20AC;&#x2122;s interface control Business strategy: Propose a better control system with low price and optimized quality Internal Scope: Refer to the author

1.5

References

user interface style guides: https://msdn.microsoft.com/enus/library/windows/desktop/ff728821(v=vs.85).aspx https://msdn.microsoft.com/enus/library/windows/desktop/ff728831(v=vs.85).aspx contracts: No contract

Software Requirements Specification for <Project>

Page 2

standards: https://www.mikroe.com/blog/coding-standards-its-the-law https://docs.microsoft.com/en-us/cpp/visual-cpp-language-conformance vision and scope document : As defined here.

2.

Overall Description

2.1 Product Perspective

This an industrial based graduation projectâ&#x20AC;&#x2122;s product. This is a follow-on member product with optimized communication system and remote-control innovation.

2.2

Product Functions

Software Requirements Specification for <Project>

Page 3

1- Control 2- Device Management 3- Communication

2.3

User Classes and Characteristics

Users: Everybody can use this technology technical expertise: Web familiarity security or privilege level: Product Perspectives: High security level educational level, or experience: Any educational level

2.4

Operating Environment

Describe the environment in which the software will operate: hardware platform: FM/TV TRANSMITTER operating system and versions: MikroC, C#, ARM, Windows, Mac, Linux, Android, IOS… other software components or applications: Web based and electronic components

2.5

Design and Implementation Constraints

corporate or regulatory policies : International and National Policies hardware limitations (timing requirements, memory requirements): According to the customer interfaces to other applications. Enable databases to be used. Any (commonly : MySQL. Microsoft SQL Server) language requirements: English/ Turkish communications protocols: TCP/IP security considerations: Microsoft Security/ AEM security/ MikroC security design conventions or programming standards (the customer’s organization can be responsible for maintaining the delivered software).

2.6

User Documentation 1- https://www.visualstudio.com/wp-content/uploads/2017/03/Visual-Studio-2017-LicensingWhitepaper-March-2017.pdf 2- https://download.mikroe.com/documents/compilers/mikroc/pic/help/introduction_to_mikroc_ pro_for_pic.htm 3- https://www.w3.org/

2.7

Assumptions and Dependencies 1- ybu.edu.tr 2- iİdil Prodüksyon

Software Requirements Specification for <Project>

3.

External Interface Requirements

3.1

User Interfaces

Page 4

sample screen images: Phones, Computer and remote device GUI standards: Sensors, Graphical and alphanumerical screen layout constraints: https://docs.microsoft.com/en-us/windows/uwp/design/layout/layoutswith-xaml standard buttons and functions: https://msdn.microsoft.com/en-us/library/cc543558.aspx keyboard shortcuts. https://www.windowscentral.com/best-windows-10-keyboard-shortcuts error message display standards: https://msdn.microsoft.com/enus/library/windows/desktop/ms679325(v=vs.85).aspx software components for which a user interface is needed: Control and management Details of the user interface design should be documented in a separate user interface specification to be attached.

3.2

Hardware Interfaces

VCO & ANALOG FRONT-END AND STERIO ENCODER CONTROL VIA MICROCONTROLER

3.3

Software Interfaces

data items or messages coming into the system and purpose: Input for Control data items or messages going out and purpose: Output for Monitoring and security Data that will be shared across software components: implementation constraint.

3.4

Communications Interfaces

requirements associated with any communications functions required by this product: e-mail, web browser, network server communications protocols, electronic forms, and so on. communication standards that will be used: FTP or HTTP. communication security or encryption issues: https://msdn.microsoft.com/enus/library/ms836811.aspx synchronization mechanisms. automatic

Software Requirements Specification for <Project>

4.

System Features

4.1

System Feature 1

Page 5

4.1.1 Description and Priority Communication 4.1.2 Stimulus/Response Sequences Real time 4.1.3

Functional Requirements REQ-1: connectivity REQ-2: hardware requirements

5.

Other Nonfunctional Requirements

5.1

Performance Requirements

design choices. Industrial based

5.2

Safety Requirements

https://www.microsoft.com/en-us/safety https://validator.w3.org/about.html https://developer.android.com/training/safetynet/index.html

5.3

Security Requirements

https://docs.microsoft.com/en-us/windows-hardware/design/device-experiences/oem-highly-secure

5.4

Software Quality Attributes

Established

5.5

Business Rules

Established 6-

OTHER REQUÄ°REMENTS