modcarroll / cs-5394-project Goto Github PK

System statechart diagrams
Textual description of the structure of your system and implemented algorithms critical for the system's behavior

• Delete the row/frame that has the Control and Logs buttons

• Transform the current window into two tabs: Control and Logs. The UI that is populated now will live under "Control" and "Logs" will show a list of all the logs in the database (see issue #22)

It will look something like this: https://www.homeandlearn.uk/python-database-form-tabs.html#:~:text=TKinter%20Form%20Tabs&text=Tabs%20are%20called%20Notebooks%20in,add%20tabs%20to%20that%20Notebook.&text=In%20between%20the%20round%20rackets,object%20you%20want%20to%20add.

Only a half-page required

https://userweb.cs.txstate.edu/~rp31/Sample_SRS_ContentsSum09.html

To-Do:

• Table of contents
  Assignee: @modlanglais
• Introduction
  Purpose of the SRS
  Problem statement
  Assignee: @Anisamay2
• Statement of functional requirements
  functional requirements structured by tasks that can be accomplished by a user; description of each task should be accompanied by screenshots of the system's GUI as necessary
  Assignee: @modlanglais
• Non-functional requirements
  Non-functional qualitative requirements (Reliability, Robustness, Performance, Maintainability, Usability)
  Assignee: @PhilipFitzgerald
• Design/implementation constraints
  Standards compliance (if any)
  Development constraints (if any)
  Assignee: @carla-amerykaz
• References and sources of information
  Assignee: stephen

This doesn't have to be anything fancy. Just get all of the logs from the /alllogs endpoint and list them here. If there is time, maybe order them by date?

Make the buttons do stuff

• Lights on

• Lights off

• Lock

• Unlock

• Thermostat up

• Thermostat down

• Speakers up

• Speakers down

• Each click should also post to /logs endpoint

This is dependent on issue #19 (19 is done)
I added comments that say what each button should do. They just need to call out to the API

Each sequence should also post to the /logs endpoint. For the action, just put like sequence_home or sequence_away or whatever you think

For each device add a box/field beside it that will show the current status. For lightbulb, on or off, for temperature the current value, etc. (use the /devicestatus/:id endpoint)

• lightbulb

• doorlock

• speaker

• temperature

This will depend on everyone else finishing their code first, but given what you see in the current repo go ahead and start figuring out the best way to divide up the code into functions/classes as needed

If you need resources:
https://www.w3schools.com/python/python_functions.asp
https://www.w3schools.com/python/python_classes.asp

Add option to the API to set the temperature or volume to a specific number (this will only be used for sequences)