Home Appliance Control System

(1)

Home Appliance Control System

Object-Oriented Analysis & Design

Project Phase 1

CS 6359 Object-Oriented Analysis and Design

Dr Lawrence Chung

Summer 2005 Section 581

Group Members:

Uttama Shakya:

http://www.utdallas.edu/~uxs023000/

Pooja Mohan:

http://www.utdallas.edu/~pxm034000/

Kelly Allison:

http://www.utdallas.edu/~kaa024000/

(2)

Revision History

Date Version Number Reason Author

06/11/05 Version 1.0 Primary requirements and analysis

document Team

06/14/05 Version 1.1 Complete diagrams Team

(3)

Figures

Figure 1. Depict the overall system...2

Figure 2. A summary of each team member’s responsibilities...4

Figure 3. Use Case Diagram of HACS...8

Figure 4. Use Case Sequence Diagram: Authenticate User...10

Figure 5. Use Case Collaboration Diagram: Authenticate User...10

Figure 6. Use Case Sequence Diagram: View and monitor status of devices...11

Figure 7. Use Case Collaboration Diagram: View and monitor status of devices...11

Figure 8. Use Case Sequence Diagram: Set AC Options...13

Figure 9. Use Case Collaboration Diagram: Set AC Options...14

Figure 10. Use Case Sequence Diagram: Set Microwave Options...15

Figure 11. Use Case Collaboration Diagram: Set Microwave Options...16

Figure 12. Use Case Sequence Diagram: Set Security System...17

Figure 13. Use Case Collaboration Diagram: Set Security Systems...18

Figure 14. Use Case Sequence Diagram: Configure Devices...21

(6)

(7)

Chapter 1 HACS Overview

i. Introduction

It’s morning and rush hour traffic. You are in your car on your way to work; perhaps almost there. Something doesn’t feel right. You start doubting your actions. “Did you turn off the iron? What about the stove? Did you close the garage door?” You are so unsure that you simply must turn around, go home and check. Sure enough, it’s a good thing you went back. You left a burner on the stove on, but now you’ll be late for that meeting. Wouldn’t it be convenient if you could call your home and request that it check for you rather than wasting your time driving back. When you arrive at work, you could connect through the internet to display results of your query and other system status.

You’ve been away from home for a few days. You turned down the heat and turned off most of the lights before you left home. You are returning to a cold and dark home. Wouldn’t it be nice to call home with the instructions to turn the heat to a warm and cozy degree and light those dark rooms for safety and convenience?

How about a refrigerator that emails you when the kids drink the last of the milk or juice? You could pick some up on the way home from work. How about a microwave that knows how and when to heat your meal and then keeps it warm until you get home?

May we suggest to you the new home local network for the digital home which links appliances to a central control system and allows those appliances to communicate between themselves. This network allows you complete control at home and away from home through your phone/palm-top or over the internet for a convenient and comfortable living environment. No more nagging doubts with the home appliance control system (HACS). Just phone home or log in to your system over the net and ask it those questions or give it those commands and keep it programmed for maximum comfort, safety and efficiency 24 / 7.

(8)

Figure 1. Depict the overall system.

ii. Purpose and Scope

The purpose of this document is to provide an analysis and design of a portion of the HACS system. Here we will examine the central controller and three appliances: the microwave, air heating and cooling system, and the security system as it pertains to lights, doors, and alarms. Class-Responsibility-Collaborator (CRC) cards are used as an aid to establish class responsibilities and collaborators during analysis to identify interactions among objects / classes during group brainstorming sessions (sequence diagrams for groups).

Furthermore, this document will include use case diagrams, class diagrams and interaction diagrams (both sequence diagrams and collaboration diagrams). The functional model shall be depicted by use cases. These diagrams shall include use cases, actors and their relationships important in organizing and modeling the behaviors of the system.

The analysis object model (the concepts visual to the user) shall be depicted with class diagrams. These diagrams depict the static design of the system using classes, interfaces, collaborations and their relationships.

The dynamic model which focuses on the behavior / interaction of the system shall be depicted with sequence and collaboration diagrams. These diagrams show an interaction between

Remote Interface

Security Login/Out Monitor and Control Subsystem Microwave Security Alarms Lights and Doors Messages HAVC

(9)

an interaction diagram that emphasizes the time-ordering of messages. A collaboration diagram is an interaction diagram that emphasizes the structural organization of the objects that send and receive messages.

It will also briefly address the requirements which define the key features of the HACS system. These requirements will then be used as a means to communicate the understanding of the HACS system. There will also be a section in this document providing the basis of the software and hardware design and will later be used to ensure that the final product is implemented as specified by the requirements set herein.

In general, this document will only be used to provide information for a portion of the HACS system. The entire implementation and design of the HACS system will be outside of the scope of this document.

Moreover, the team architecture and each member’s role in creating the HACS system will be discussed in this document. This will describe how the team members were divided up in carrying out the design tasks and why each person was assigned that role.

Chapter 2 Process Architecture

i.

Organization

Our team has been divided into four groups, since there are four members in our team. The roles are as follows:

- The analyst is the application domain expert responsible for detailing use cases. - The architect unifies the use cases from a system point of view.

- The document editor is responsible for low-level integration of and overall format of the document.

- The configuration manager is responsible for revision history. - The reviewer validates correctness.

(10)

Figure 2. A summary of each team member’s responsibilities.

Team Member Responsibility Description

Uttama Shakya Project Management _• Project Analysis

• Project Specifications

• System Analysis

• Diagrams

• Review

Kelly Allison

Systems Development _• Initial document editor

• Class diagrams

• Review

Pooja Mohan

Systems Development _• Second document editor

• Describe diagrams

(11)

ii. Relationships and Team Work

We have maintained a professional relationship throughout the course of the project. There is also a great team effort to get the project completed. Then again, we have held brainstorming sessions to come up with various ideas to reach the most desirable solution. Everyone has willingly helped each other out when additional help is needed.

Because there were only four people on the team, we were able to work more closely with each other and it was much easier to communicate to one another if any changes needed to be made. Many times, we would work independently on our individual tasks. Once our task has been completed, then we would get together to integrate the solution.

Most of our communications were exchanged via the yahoo group

http://groups.yahoo.com/group/OOADSummer05/. It is easier to communicate this way, since we would be able to post any concerns or questions and the other person would respond when they got a chance. We found this to be the most convenient way to communicate and, it has worked well with the size of our team.

iii. Meetings

Meetings are usually held on weekends or before class, since it was the best time for everyone to meet. These meetings were used to discuss the status of the project and for resolving any issues that may arise.

(12)

Chapter 3 Requirements Specifications

i. Functional Requirements

The purpose of the HACS system is to accept the user’s input to control, monitor, and coordinate home appliances. It must address the following system requirements.

System Requirements

• The heart of the home network is the control system written using J2EE.

• The central control system (CCS) shall provide secure login to the system. Users are identified with a username and password.

• It shall accept instructions locally or remotely and communicate those instructions to the appropriate devices within the home.

• Devices / appliances within the network shall have the capability to communicate between themselves as necessary and coordinate their process activity.

• It shall allow the user to activate and deactivate the system.

• It shall allow the system to start, stop and display current status without interfering with normal operations of the devices.

• It shall allow the user to add or remove, modify the behavior of and view the status of devices.

• It shall control, monitor, and coordinate appliances as programmed.

• It shall be adaptable. Detects events that change the environment and respond.

• It shall encapsulate lower-level functions to allow algorithms to vary independently.

• It shall accept information from the appliances, decisions made and appropriate messages generated based upon the decistion (i.e. alarms, dial 911).

ii. Non-Functional Requirements

Portability

The system should be able to work on any machine with Java Virtual Machine installed.

(13)

The system should be able to handle multiple requests without failure. It should be able to detect and handle faults within a given time frame. The system should be available 99.9 percent of the time.

User friendliness

The system should be usable by non-experts, in which the user can learn to operate, prepare inputs for and interpret outputs of a system component.

Flexibility

The system should be automatically and manually adaptive and able to detect the various settings and accommodate to the changes accordingly, real-time.

Performance

The elapsed time between the submission of a request and the computation time should be minimal.

Supportability

The system should be able to handle new changes to the system including upgrades or changes to the existing system. It should b easily modified to accommodate enhancements and repairs.

(14)

Chapter 4 Use Case Diagram and Descriptions

Authenticate User Set AC Options

<<uses>>

Set Microwave Options

<<uses>>

Set Intrusion System

<<uses>>

Set Fire Alarm Options

<<uses>>

Home Owner

Perform Diagnostics Configure Users View and Monitor Status of

Devices Technical Support Configure Devices <<uses>> <<uses>> <<uses>> <<uses>>

Every use case has to use the authentication process

Technical Support for HACS

Figure 3. Use Case Diagram of HACS

(15)

. Use Case Name: Authenticate User

Flow of events:

 Precondition: Each user has a unique username and a password to logon to HACS.

 Main Flow:

1. The user enters the username and password on the remote device. The remote access system contacts the HACS system to login.

2. The HACS system verifies the username and password.

3. On verifying the user information, the HACS system authenticates the user and displays the system information.

 Exceptional flow:

3. On failure to login, the system displays the login prompt again. This step is repeated maximum of three times.

4. On failure to provide correct username and password, the system locks up for a pre-set length of time.

 Post condition: On validation, the trusted user is given access to the HACS system.

a. Sequence Diagram: Authenticate User

: Home Owner : Remote Access System : HACS : Authentication Process

1: login(Username, password)

2: login(username, password)

Every user Remote Access sytem is the

medium through which the user contacts HACS. e.g. phone, computer, PDA, etc.

(16)

Figure 4. Use Case Sequence Diagram: Authenticate User

b. Collaboration Diagram: Authenticate User

: HACS : Authentication Process : Remote Access System : Home Owner 3: verify(username, password) 4: success 2: login(username, password) 5: displaySystemInformation() 1: login(username, password) HACS uses Authentication Process to validate the user.

Figure 5. Use Case Collaboration Diagram: Authenticate User

. Use Case Name: View and Monitor Status of devices

Flow of events:

 Precondition: The user is logged on to the HACS system.

 Main Flow:

1. When the user wishes to view the status of individual devices, he chooses “View Status” option from the menu tab.

2. HACS retrieves the current status of appliances.

3. HACS will display the status of all configured appliances on user’s request.

 Exceptional flow: If no appliance is registered in the system, the system shows the appropriate result.

 Post condition: The user can view the information on the current status of all the appliances.

(17)

: Home Owner : Remote Access System : HACS 1: viewStatus() 2: viewStatus() retrieveStatus() retrieves the latest status HACS has received from each of the appliances in ...

3: retrieveStatus()

4: status info

Figure 6. Use Case Sequence Diagram: View and monitor status of devices

d. Collaboration Diagram: View and monitor status of devices

: Remote Access System : HACS : Home Owner 2: viewStatus() 3: status info 1: viewStatus() 4: retrieveStatus()

HACS retrieves the latest information on all appliances.

(18)

1. The user chooses to set AC options makes a request to the HACS system via the Remote Access System.

2. The HACS system retrieves and shows available options to adjust the AC system.

3. The user chooses to turn ON the AC from the options. 4. The HACS sends the message to the AC turning it ON.

5. Air Conditioner sends the updated status information to the HACS 6. The HACS displays the updated status on the remote device.  Alternative flow:

3. The user chooses to adjust the temperature of AC.

4. The user enters the new temperature value on the remote access system.

5. The new temperature value request is sent to the HACS, which invokes new temperature settings on the AC.

6. The AC sets the temperature and sends updated status information to the HACS. 7. The HACS displays the updated status information on the remote device.

The user enters temperature value which is out of preset range.

HACS displays an error message and prompts the user to re-enter the temperature value.

 Post condition: The room temperature is modified.

(19)

: Home Owner : Remote Access System : HACS : Air Conditioner 1: setACOptions() 2: setACOptions() 7: turnOn/OffAC(status) 8: Updated Status 9: Updated Status 4: displayAvailableOptions() 5: turnOn/OffAC(status) 6: turnOn/OffAC(status) 10: AdjustTemp(temperature) 11: AdjustTemp(temperature) 12: AdjustTemp(temperature) 3: getAvailableOptions()

User may choose any available options. In this case, may be turn on/ off AC or Adjust Temperature opt [Opt = Power] opt [Opt = Power] opt [Opt = temperature]

(20)

f. Collaboration Diagram: Set AC Options

: Home Owner : Air Conditioner : Remote Access System : HACS 1: setACOptions() 4: turnOn/OffAC(status) 2: setACOptions() 5: turnOn/OffAC(status) 3: displayAvailableOptions() 8: updated status 6: turnOn/OffAC(Status) 7: updated status 9: getAvailableOptions() This is the collaboration diagram of the system when the user chooses to turn on/off AC

Figure 9. Use Case Collaboration Diagram: Set AC Options

. Use Case Name: Set Microwave Options

Flow of events:

 Precondition: The user is logged into the HACS system.

 Main Flow:

1. The user chooses to set microwave options via the Remote Access System.

2. The HACS system retrieves available microwave options and displays the available options.

3. The user chooses the option to turn ON the microwave.

4. The HACS sends the message to the microwave turning it ON.

5. Microwave sends the updated status information to the HACS 6. The HACS displays the updated status on the remote device.  Alternative flow:

3. The user chooses the option to set the heating parameters like temperature, power and time.

4. The user enters the new heating parameter on the remote access system and submits the information.

5. The new settings request is sent to the HACS, which invokes changes on the microwave. 6. The microwave sends updated status information to the HACS.

7. The HACS displays the updated status information on the remote device.

The user enters wrong values for the heating parameters.

HACS displays an error message and prompts the user to re-enter the parameter value.

(21)

: Home Owner : Remote Access System : HACS : Microwave : setMicrowaveOptions() 1 : TurnOn/Off(status) 5

: SetHeatingParameters(temperature, power, time) 10 : setMicrowaveOptions() 2 : TurnOn/Off(status) 6 : displayAvailableOptions() 4 : Updated Status 9 : TurnOn/Off(status) 7 : Updated Status 8 : retriveAvailableOptions() 3

The user may choose to turn/off microwave or set heating parameters. opt [Opt = Power] opt [Opt = Heating Parameters]

(22)

h. Collaboration Diagram: Set Microwave Options

: Home Owner : Remote Access System : HACS : Microwave 1: setMicrowaveOptions() 2: setMicrowaveOptions() 3: retrieveAvailableOptions() 4: displayAvailableOptions() 5: turnOn/Off(status) 6: turnOn/Off(status) 7: turnOn/Off(status) 8: updated status 9: updated status

This diagram shows the scenario of turning on/off microwave.

Figure 11. Use Case Collaboration Diagram: Set Microwave Options

. Use Case Name: Set Security System

Flow of events:

 Precondition: The user is logged in to the HACS System.

 Main Flow:

1. The user chooses to set the security options.

2. The HACS system retrieves the available security options and displays them to the user.

3. The user chooses to set the fire alarm settings.

4. The user sets the threshold temperature value and forwards the request to the HACS. 5. The HACS system triggers the necessary action on the Home Security system.

6. The Home Security System sends the updated status to the HACS. 7. The HACS displays the updated status on the remote access device.

 Alternative flow:

3. The user chooses to change the intrusion alarm options.

4. The user chooses new settings for the intrusion alarm system and submits the information. 5. The HACS system triggers the necessary action on the Home Security system.

6. The Home Security System sends the updated status to the HACS. 7. The HACS displays the updated status on the remote access device.

 Exceptional flow: None

 Post condition: On validation, the changes are applied to the home security system.

(23)

The diagram shows only the scenario where the user chooses to set fire alarm options. Setting intrusion alarm system is not shown in the diagram. : Home Owner

: Remote Access System

: HACS : Home Security System 1: setSecurityOptions() 2: setSecurityOptions() 9: Updated Status 7: AdjustFireAlarmSettings() 8: Updated Status 4: displayAvailableOptions()

5: SetFireAlarmOptions (Threshold Temperature)

6: SetFireAlarmOptions(Threshold Temperature) 3: retrieveAvailableOptions()

Figure 12. Use Case Sequence Diagram: Set Security System

(24)

: Home Owner : Remote Access System : HACS : Home Security System 3: retrieveAvailableOptions() 1: setSecurityOptions()

5: SetFireAlarmOptions (Threshold Temperature)

2: setSecurityOptions() 6: SetFireAlarmOptions(Threshold Temperature) 4: displayAvailableOptions() 9: Updated Status 7: AdjustFireAlarmSettings() 8: Updated Status

Retrieving available options imply to getting the available options for user to choose from to set the security system. In our system, fire alarm system and intrusion detection system are included in Home security System.

Figure 13. Use Case Collaboration Diagram: Set Security Systems

. Use Case Name: Configure Appliances

Flow of events:

 Precondition: The user is logged on to the HACS.

 Main Flow:

1. The user chooses configure appliances options from the main menu.

2. The system checks the user privilege and displays the options to add, remove or modify the appliances.

3. The user chooses to add a new appliance.

4. The system presents the form to enter information on new appliance.

5. The user sends the new appliance information including the appliance name, the room in which the user has configured the appliance, preset settings for the appliance to the HACS.

6. The HACS verifies the appliance settings, adds the new appliance to the system and informs the user about successful addition of the appliance.

 Alternate flow:

o A. Removing the appliance from the system. 3. The user chooses to remove the existing appliance.

4. The system displays a list of existing appliances in the system. 5. The user chooses the appliance to be removed from the list.

6. The system removes the chosen appliance from the system and informs the user. o B. Modifying the appliance in the system.

3. The user chooses to modify the existing appliance.

4. The system displays a list of existing appliances in the system. 5. The user chooses the appliance to be modified from the list.

(25)

8. The system saves the modified information in the system and informs the user.

 Exceptional flow: If the user is not authorized to add/remove/modify appliances, HACS will

generate an error message and deny any changes.

 Post condition: On validation, the new device is added or the information on existing device is

modified or removed from the HACS system.

(26)

: Home Owner : Remote Access System : HACS : Appliance : addNewAppliance() 5 : addNewAppliance() 6 : getNewApplianceInfo() 7 : setNewApplianceInfo() 8 : setNewApplianceInfo() 9 : verifyNewApplianceInfo() 10 : success 13 : removeExistingAppliance() 14 : removeExistingAppliance() 15 : displayExistingAppliances() 17 : removeExistingAppliance(Appliance ID) 18 : removeExistingDevice(Appliance ID) 19 : configureAppliances() 1 : configureAppliances() 2 : checkUserPrivilege() 3 : displayConfigureOptions() 4 : addNewAppliance() 11 : displayExistingAppliances() 16 : create() 12 : destroy() 20

The user may choose to add new appliance, remove appliance and modify appliance (not shown in the diagram)

opt

[Opt = Add]

opt

(27)

Figure 14. Use Case Sequence Diagram: Configure Devices

l. Collaboration Diagram: Configure Appliances

: Home Owner : Remote Access System : HACS 3: checkUserPrivilege() 9: addNewAppliance() : Appliance 1: configureAppliances() 5: addNewAppliance() 7: setNewAppliancesInfo() 2: configureAppliances() 6: addNewAppliance() 8: setNewAppliancesInfo() 4: displayConfigurationOptions() 10: create() This diagram shows the

collaboration of the scenario in which the user chooses to add new appliance to the system.

Figure 15 Collaboration Diagram: Configure Appliances

Note: Collaboration diagrams for removing and modifying the appliances are not shown due to time constraints. Sequence diagram does not include modifying the appliance information due to the same reason.

. Use Case Name: Configure Users

(28)

3. The user chooses to remove an existing user account.

4. The HACS retrieves and presents a list of existing users.

5. The user chooses a user to be removed from the system.

6. HACS removes the user from the system.  Exceptional flow:

If the user is not authorized to add/remove users, HACS will generate an error message and deny any change.

 Post condition: On validation, the new user is added or an existing user is removed from the HACS

system.

(29)

: Home Owner : Remote Access System : HACS : User : addNewUser() 5 : addNewUser() 6 : getNewUserInfo() 7 : setNewUserInfo() 8 : setNewUserInfo() 9 : verifyNewUserInfo() 10 : success 13 : removeExistingUser() 14 : removeExistingUser() 15 : verifyUserPrivilege() 3 : configureUsers() 1 : configureUsers() 2 : displayConfigurationOptions() 4 : addNewUser() 11 : create() 12

Only users with administrative privileges may configure users. The user may choose

to add, modify or remove users. opt [Opt = Add] opt [Opt = Remove]

(30)

n. Collaboration Diagram: Configure Users

: Home Owner : Remote Access System : HACS : User 3: verifyUserPrivilege() 7: addNewUser() 1: addNewUser() 5: setNewUserInfo() 2: addNewUser() 6: setNewUserInfo() 4: getNewUserInfo() 9: success 8: create() The diagram shows

the scenario of adding a new user to the system.

Figure 17. Use Case Collaboration Diagram: Configure Users

. Use Case Name: Perform Diagnostics

Flow of events:

 Precondition: Technician is logged on to HACS. There is a software related problem in the HACS

system.

 Main Flow:

1. The technician enters the username and password on the remote device.

2. The technician chooses to check the status of appliances; He chooses “View Status” option from the menu tab.

3. HACS retrieves the current status of devices from the database

4. HACS will display the status of all configured devices on user’s request.

5. The technician determines a fault in one of the devices.

6. If the problem is software related, the technician applies software patches to HACS, it there exists one for the particular problem.

7. The system shows the updated status of all the appliances in the system.  Exceptional flow:

(31)

 Post condition: The software problem in HACS is resolved.

o. Sequence Diagram: Perform Diagnostics

: Technical Support : Remote Access System : HACS : Appliance 1: viewStatus() 2: viewStatus() 3: retrieveStatus() 4: displayStatus() 5: applySoftwarePatch() 6: applySoftwarePatch() 7: testAppliance() 8: updated status 9: updated status This scenario assumes the problem in HACS is due to software bugs.

(32)

: Technical Support : Remote Access System : HACS : Appliance 3: retrieveStatus() 1: viewStatus() 5: applySoftwarePatch() 2: viewStatus() 6: applySoftwarePatch() 4: displayStatus() 9: updated status 7: testAppliance() 8: updated status Refers to checking if the appliance is working right.

(33)

Chapter 6 Class Diagram and CRC Cards

Microwave powerSettings times setHeatingParameter() Air Conditioner tempSettings times

Home Security System alarmSettings times adjustFirealaramSettings() Home Owner username password Technician username password

Remote Access System IP Address userInfo accessDeviceType submitUserInput() Appliance applianceType create() delete() Authentication Process privileges authenticateUser() HACS sessionKey date time displaySystemInfo() addNewUser() login() logout() viewStatus() retrieveStatus() getAvailableOptions() displayAvailableOpitions() setACOptions() setMicrowaveOptions() setSecurityOptions() setFireAlarmOptions() displayExistingAppliances() configureAppliances() 1 1..* 1 1..* 1..* 1 1..* 1 1 1 1 1 User username password createUser() deleteUser() 1 0..* 1 0..* Remote Access can be from PDA, laptop, phone, etc.

(34)

CRC card for User class (superclass for homeOwner and Technician)

CRC card for Remote Access System class User

Responsibilities Collaborators

Collect input from User HACS

Forward input to HACS homeowner and technician Display response to User

Remote Access System

Establish and maintain session HACS Submit user input to HACS

(35)

CRC card for HACS class

HACS

Verify user privileges for user requests Remote Access System Configure users and devices Authentication Process Forward user requests to appliance Appliance

Coordinate system status requests User Log and report problems and user activity

Maintain session with remote systems

AuthenticationProcess

Authenticate user session privilege HACS Authenticate user action request privilege

(36)

CRC card for Appliance class

CRC card for Microwave, air conditioner and home security system class Appliance

Monitor device. Report trouble HACS

Handle appliance requests configured appliances Create and delete appliances

Microwave, Air Conditioner, Home Security System

Report trouble Appliance Accept user setting change requests

Perform diagnostic tests

(37)

References

Bruegge, Bernd and Dutoit, Allen H. ed. Object-Oriented Software Engineering: Using UML, Patterns, and Java. New Jersey: Pearson Education, Inc., 2004.

Garland, David and Shaw, Mary. Software Architecture: Perspectives on an Emerging Discipline. New Jersey: Prentice Hall, 1996.

Booch, Rumbaugh, Jacobson. The Unified Modeling Language User Guide. Massachusetts: Addison Wesley, 1999.

Home Appliance Control System