System Design Document

Page 1

Notes on accessibility: This template has been tested and is best accessible with JAWS 11.0 or higher. For questions about using this template, please contact CMS IT Governance).

ANKARA YILDIRIM BEYAZIT UNIVERSITY

SNMP FM/TV TRANSMITTER CONTROL VIA WEB INTERFACE VCO & ANALOG FRONT-END AND STERIO ENCODER CONTROL VIA MICROCONTROLER System Design Document

Version 1.0 01/10/2018

Document Number: <document’s configuration item control number> Contract Number: <ngassa2012utlook.com/ ziaoulrahman@outlook.com>


CMS XLC

Table of Contents

Table of Contents 1. Introduction .............................................................................................................. 1 1.1

Purpose of the SDD .......................................................................................... 1

2. General Overview and Design Guidelines/Approach ........................................... 3 2.1 General Overview ............................................................................................. 3 2.2 Assumptions/Constraints/Risks ........................................................................ 3 2.2.1 Assumptions ............................................................................................... 3 2.2.2 Constraints ................................................................................................. 3 2.2.3 Risks ........................................................................................................... 4 3. Design Considerations ............................................................................................ 5 3.1 3.2 3.3 3.4

Goals and Guidelines........................................................................................ 5 Development Methods & Contingencies ........................................................... 5 Architectural Strategies ..................................................................................... 6 Performance Engineering ................................................................................. 6

4. System Architecture and Architecture Design ...................................................... 7 4.1 Logical View ...................................................................................................... 7 4.2 Hardware Architecture ...................................................................................... 7 4.2.1 Security Hardware Architecture .................................................................. 7 4.2.2 Performance Hardware Architecture........................................................... 7 4.3 Software Architecture........................................................................................ 8 4.3.1 Security Software Architecture ................................................................... 8 4.3.2 Performance Software Architecture ............................................................ 8 4.4 Information Architecture .................................................................................... 8 4.4.1 Records Management ................................................................................ 8 4.5 Internal Communications Architecture .............................................................. 9 4.6 Security Architecture .......................................... Error! Bookmark not defined. 4.7 Performance ..................................................................................................... 9 4.8 System Architecture Diagram ........................................................................... 9 5. System Design ....................................................................................................... 10 5.1 Business Requirements .................................................................................. 10 5.2 Database Design ............................................................................................ 10 5.2.1 Data Objects and Resultant Data Structures ............................................ 10 5.2.2 File and Database Structures ...................... Error! Bookmark not defined. 5.3 Data Conversion ............................................................................................. 10 5.4 User Machine-Readable Interface .................................................................. 10 5.4.1 Inputs ........................................................................................................ 10 5.4.2 Outputs ..................................................................................................... 10 5.5 User Interface Design ..................................................................................... 11 5.5.1 Section 508 Compliance ........................................................................... 11

SDD Version X.X

ii

<Project and release name>


CMS XLC

Table of Contents

6. Operational Scenarios ........................................................................................... 12 7. Detailed Design .............................................................Error! Bookmark not defined. 7.1 7.2 7.3 7.4 7.5

Hardware Detailed Design .............................................................................. 12 Software Detailed Design ............................................................................... 12 Security Detailed Design .................................... Error! Bookmark not defined. Performance Detailed Design ......................................................................... 12 Internal Communications Detailed Design ...................................................... 12

8. System Integrity Controls ..................................................................................... 13 9. External Interfaces ................................................................................................. 14 9.1 9.2

Interface Architecture ...................................................................................... 14 Interface Detailed Design ................................................................................ 15

SDD Version X.X

iii

<Project and release name>


CMS XLC

Introduction

1.

Introduction

1.1

Purpose of the SDD

user interface (UI) WEB INTERFACE

MOBILE INTERFACE

SDD Version X.X

1

<Project and release name>


CMS XLC

SDD Version X.X

Introduction

2

<Project and release name>


CMS XLC

2.

General Overview and Design Guidelines/Approach

General Overview and Design Guidelines/Approach

This section describes the principles and strategies to be used as guidelines when designing and implementing the system.

2.1

General Overview

2.2

Assumptions/Constraints/Risks

2.2.1

Assumptions

Windows software Android tested Ethernet.

2.2.2 • • •

Constraints Tested on Acer and Smasung computers and Samsung phone Graduation project document Data repository : https://github.com/yvanss

SDD Version X.X

3

<Project and release name>


CMS XLC

• • •

2.2.3

General Overview and Design Guidelines/Approach

Oscillator : 8 MHZ Performance requirements : Intenet Network communications : TCP/IP enabled

Risks

Warning : Contact the owners before using the system

SDD Version X.X

4

<Project and release name>


CMS XLC

Design Considerations

3.

Design Considerations

3.1

Goals and Guidelines

Remote Control SNMP FM/TV TRANSMITTER CONTROL VIA WEB INTERFACE VCO & ANALOG FRONT-END AND STERIO ENCODER CONTROL VIA MICROCONTROLER

3.2

Development Methods & Contingencies

<html> <body>\ <form name=\"input\" method=\"get\"> <table align=center width=500 bgcolor= LightGray border=2> <tr> <td align=center colspan=2><font size=5 color=RoyalBlue face=\"verdana\"> <b>Web-Based Control and Monitoring with PIC Microcontroller</br></font></td> </tr> <tr> <td height="200" align=center bgcolor=LightGray><input name="TA" type="submit"value="TOGGLE RELAY A\"></td> <td height="200" align=center bgcolor=LightGray><input name="TB" type="submit"value="TOGGLE RELAY B"></td></tr><tr> <td align=center colspan=2><font size=2 color=RoyalBlue face="verdana"> <a href= "http://www.studentcompanion.net\"target=\"_blank\ </a> </br></font></td> </tr>\ </table> </form> </body> </html>"

SDD Version X.X

5

<Project and release name>


CMS XLC

3.3 • • • • • • • • • • •

3.4

Design Considerations

Architectural Strategies Use of a particular type of product (programming language, database, library, commercial off-the-shelf (COTS) product, etc.) : HTML,CSHARP,MIKROC Future plans for extending or enhancing the software : Development User interface paradigms (or system input and output models) : Web and mobile Error detection and recovery : Automatic Memory management policies : Proteus and MikroC restrictions External databases and/or data storage management and persistence : WEB Distributed data or control over a network : Internet Generalized approaches to control : Remote Concurrency and synchronization : Real time Communication mechanisms : TCP /IP Management of other resources : Students, Teacher, Company

Performance Engineering

Performance requirements are a contributing factor to system design. Performance requirements are the defined scalability or responsiveness expectations of specific workloads that process on a system.

SDD Version X.X

6

<Project and release name>


CMS XLC

4.

System Architecture and Architecture Design

System Architecture and Architecture Design

This section outlines the system and hardware architecture design of the system.

4.1

Logical View

Instructions: Insert any related logical views or provide a reference to where they are stored.

4.2

4.2.1

Hardware Architecture

Security Hardware Architecture

The design should be based on the designated system security level and provide adequate protection against threats and vulnerabilities.

4.2.2

Performance Hardware Architecture

clustering

SDD Version X.X

7

<Project and release name>


CMS XLC

4.3

4.3.1

System Architecture and Architecture Design

Software Architecture

Security Software Architecture

The company should have antivirus and the phone

4.3.2

Performance Software Architecture

clustering

4.4

Information Architecture

Program information will be stored in the system

4.4.1

Records Management

Federal regulations issued by the National Archives and Records Administration (NARA) are outlined in 36 Code of Federal Regulations (CFR) - Subchapter B - Records Management. Business owners must contact the Office of Strategic Operations and Regulatory Affairs (OSORA) to initiate the record management process.

4.4.1.1

Data

electronic data Input: HTML COMMAND 4.4.1.2

Master Files

Web database

SDD Version X.X

8

<Project and release name>


CMS XLC

4.5

System Architecture and Architecture Design

Internal Communications Architecture

Ethernet, hubs, routers, cabling, transmitters, firewalls, ports, Performance

4.6

System Architecture Diagram

SDD Version X.X

9

<Project and release name>


CMS XLC

System Design

5.

System Design

5.1

Business Requirements

OPEN

5.2

Database Design

DBMS Database Management System 5.2.1.1

Non-Database Management System Files

: •

5.3

Ram and rom

Data Conversion

Instructions: Insert any documents describing any necessary data conversions or provide a reference to where they are stored.

5.4 5.4.1

User Machine-Readable Interface Inputs

5.4.2

5.4.3 5.4.4

Outputs

SDD Version X.X

10

<Project and release name>


CMS XLC

5.5

5.5.1

System Design

User Interface Design

Section 508 Compliance

Instructions: Describe accessibility considerations in your user interface design and insert your section 508 compliance related documents or provide a reference to where they are stored.

SDD Version X.X

11

<Project and release name>


CMS XLC

6.

Operational Scenarios

Operational Scenarios

frequency . 8 MHZ

6.1 •

6.2 •

6.3 •

6.4 • •

Hardware Detailed Design Power input requirements for each component : vcc

Software Detailed Design Users/Interactions – input , output

Performance Detailed Design Performance expectations : Real time running

Internal Communications Detailed Design Number of servers and clients to be included on each area network : 1 LAN topology

SDD Version X.X

12

<Project and release name>


CMS XLC

7.

System Integrity Controls : FULL CODE

System Integrity Controls : FULL CODE

<html> <body>\ <form name=\"input\" method=\"get\"> <table align=center width=500 bgcolor= LightGray border=2> <tr> <td align=center colspan=2><font size=5 color=RoyalBlue face=\"verdana\"> <b>Web-Based Control and Monitoring with PIC Microcontroller</br></font></td> </tr> <tr> <td height="200" align=center bgcolor=LightGray><input name="TA" type="submit"value="TOGGLE RELAY A\"></td> <td height="200" align=center bgcolor=LightGray><input name="TB" type="submit"value="TOGGLE RELAY B"></td></tr><tr> <td align=center colspan=2><font size=2 color=RoyalBlue face="verdana"> <a href= "http://www.studentcompanion.net\"target=\"_blank\">Š 2017 Student Companion</a> </br></font></td> </tr>\ </table> </form> </body> </html>"

SDD Version X.X

13

<Project and release name>


CMS XLC

8.

External Interfaces

External Interfaces

https://www.cms.gov/Research-Statistics-Data-and-Systems/CMS-InformationTechnology/XLC/Downloads/InterfaceControlDocument.docx.

8.1

Interface Architecture : EXAMPLE OF BOARD

SDD Version X.X

14

<Project and release name>


CMS XLC

8.2

External Interfaces

Interface Detailed Design

SDD Version X.X

15

<Project and release name>


CMS XLC

SDD Version X.X

Error! No text of specified style in document.

16

<Project and release name>


Turn static files into dynamic content formats.

Create a flipbook
Issuu converts static files into: digital portfolios, online yearbooks, online catalogs, digital photo albums and more. Sign up and create your flipbook.