tylen/RSS_Management
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Vasily Davydov 2022-01-10 15:51:09 +02:00 committed by GitHub
parent cb27e880db
commit 4cb61c734e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -7,14 +7,14 @@ to it, so it would be acceptable for the particular course.
#### Controller side: #### Controller side:
- User has for states of a room: **Busy;Home;Come;Away** (Can be found in the [file](RoomyState/lcd.cpp)) - User has for states of a room: **Busy;Home;Come;Away** (Can be found in the [file](RoomyState/lcd.cpp))
- Each state is controllable with a **button** included in the circuit - Each state is controllable with a **button** included in the circuit
> When the **button** is pressed, it communicates with a [**Counter class**](RoomyState/Counter.h), which has an overflow feature making it really scalable for more - When the **button** is pressed, it communicates with a [**Counter class**](RoomyState/Counter.h), which has an overflow feature making it really scalable for more
states added in future. states added in future.
- Indicator LED of a particular state for tail-end with a button - Indicator LED of a particular state for tail-end with a button
- Indicating the current tempreature and humidity - Indicating the current tempreature and humidity
#### Computer side: #### Computer side:
- Reading the change of the state coming from an Arduino connected via USB - Reading the change of the state coming from an Arduino connected via USB
- Loading your configuration **XML** file, see example [here](RSS_Management/cmake-build-debug/config.xml) - Loading your configuration **XML** file, see example [here](RSS_Management/cmake-build-debug/config.xml)
- Logging the state change during the program is running, see example [here](RSS_Management/cmake-build-debug/Log_File.txt) //add later - Logging the state change during the program is running, see example [here](RSS_Management/cmake-build-debug/Log_File.txt)
- Sending the log file after closing the program with a telegram bot **NOT IMPLEMENTED** - Sending the log file after closing the program with a telegram bot **NOT IMPLEMENTED**
### Communication: ### Communication:
Running the program on a computer will read the configuration file and check if it is valid. In case the Controller is connected to Computer, the Computer will send a `#` message to Controller, if the Controller is able to read the signal, it will respond to the Computer. Computer will create a new `LOG_FL` (if user doesn't have one already) with a configuration data and will document the activity until the program is stopped manually or just exitted the **readMode**. Running the program on a computer will read the configuration file and check if it is valid. In case the Controller is connected to Computer, the Computer will send a `#` message to Controller, if the Controller is able to read the signal, it will respond to the Computer. Computer will create a new `LOG_FL` (if user doesn't have one already) with a configuration data and will document the activity until the program is stopped manually or just exitted the **readMode**.