Requirements

[ArtLmkn]

Assignment

SmartHomeSim.pdf

[ArtLmkn]

Functional requirements

F1

• [x] The entities we are working with are house, window (+ outside blinds), floor in a house, sensor, device (=appliance), person, car, bike, pet of non-farm type, plus any other entities.

F2

• [x] Individual devices in the house have an API to control. Devices have a state that can be changed by the API to control it. Actions from the API are applicable according to the state of the device. Selected devices can also have content - a fridge has food, a CD player has CDs.

F3

• [x] Devices have their consumption in active state, idle state, off state.

F4

• [x] Individual devices have an API to collect data about that device. We collect data about the devices such as electricity, gas, water consumption and functionality (decreasing linearly with time).

F5

• [x] Individual people and animals can perform activities(actions) that have some effect on device or another person.

F6

• [x] Individual devices/persons are in one room at one time period (unless they are doing sports) and randomly generate events (an event can be important information or an alert).

F7

• [x] Events are picked up and handled by the appropriate person(s) or device(s).

F8

• [x] Generate reports:
  • HouseConfigurationReport: all house configuration data preserving the hierarchy plus what the residents of the house are.
  • EventReport: event report where we group events by type, event source and event target (what entity handled the event)
  • ActivityAndUsageReport: report of the actions (activities) of each person and animal, how many times which person used which facility.
  • ConsumptionReport: how much electricity, gas, water each appliance consumed. Including a financial quantification.

F9

• [x] When device breaks, home resident must examine the documentation for it - find the warranty card, review the repair manual, and take corrective action (e.g., self-repair, purchase new, etc.). Manuals take up a lot of space and take a long time to find.

F10

• [x] The family is active and spends leisure time in roughly the ratio of (50% using appliances in the house and 50% sports when using sports equipment bike or skis). When there is no spare appliance or sports equipment, the person waits.

[ArtLmkn]

Non-functional requirements

• [x] Class diagram

• [x] Use-case diagram

• [x] Description

• [x] Public API + Java Doc

• [x] No authentication or authorization required.

• [x] Application can only run in one JVM.

• [x] Write the application in such a way that methods and variables that should not be available to other classes. The generated javadoc should have as few public methods as possible and variables.

• [x] Reports are generated to a text file.

• [x] The configuration of the house, facilities and inhabitants of the house can be loaded directly from the class or an external file (json is preferred). 2 configurations (min: 6 people, 3 animals, 8 types of appliances, 20 appliances, 6 rooms, one ski, two bikes.)