Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fb/estebanways #490

Merged
merged 58 commits into from
May 26, 2024
Merged

Fb/estebanways #490

merged 58 commits into from
May 26, 2024

Conversation

estebanways
Copy link
Member

Enhancing Commbase: A Comprehensive Overview

  • The repository underwent a merge from the main branch, likely incorporating crucial updates or feature additions.
  • Script descriptions were added to enhance clarity and usability.
  • New files were introduced to implement a command option for setting pyttsx3 TTS engine voice index and displaying voice index details.
  • Permissions were granted to specific files for execution purposes.
  • Automatic recording initiation was facilitated upon availability of the recorder device after a single key press.
  • Processing time calculation and display were integrated into the reactive STT engine, improving user visibility.
  • Enabling the visibility of processing time involved adjusting a configuration variable.
  • Optional serial hardware interaction was introduced, enhancing versatility.
  • A new option was added to display the full Commbase log in the apps pane, improving monitoring capabilities.
  • Several new routines and files were introduced, expanding functionality and organizational structure.
  • Logging processes underwent significant enhancements, including standardized formatting and improved timestamp handling.
  • Language files were updated to incorporate new phrases and translations.
  • Installation and configuration guides were updated to reflect changes and provide comprehensive instructions.
  • The restructuring of the project directory aimed to enhance clarity and organization.
  • Redundant or obsolete files were removed from the repository.
  • Lowercasing of local log variables likely aimed at standardizing coding practices.
  • The user guide was enriched with additional information about the apps pane, enhancing user understanding.
  • Overall, these changes signify a concerted effort to improve functionality, user experience, and code maintainability within the Commbase project.

@estebanways
Merge pull request #351 from mydroidandi/development
18b86cb 
Development
@estebanways
Merge pull request #353 from mydroidandi/development
6752de1 
Development
@estebanways
Merge pull request #355 from mydroidandi/development
f5d3060 
Development
@estebanways
Merge pull request #357 from mydroidandi/development
99d4882 
Development
@estebanways
Merge pull request #359 from mydroidandi/development
f79b413 
Development
@estebanways
Merge pull request #361 from mydroidandi/development
bda36b8 
Development
@estebanways
Merge pull request #363 from mydroidandi/development
00ef25e 
Development
@estebanways
Merge pull request #373 from mydroidandi/development
60b48c8 
Development
@estebanways
Merge pull request #375 from mydroidandi/development
2c7f7fe 
Development
@estebanways
Merge pull request #379 from mydroidandi/development
ca873af 
Development
@estebanways
Merge pull request #381 from mydroidandi/development
cb1c2ca 
Development
@estebanways
Merge pull request #383 from mydroidandi/development
18ee4f6 
Development
@estebanways
Merge pull request #385 from mydroidandi/development
f380816 
Development
@estebanways
Merge pull request #388 from mydroidandi/development
f19a1e8 
Development
@estebanways
Merge pull request #392 from mydroidandi/development
239727d 
Development
@estebanways
Merge pull request #394 from mydroidandi/development
3eeb920 
Development
@estebanways
Merge pull request #397 from mydroidandi/development
96c2eea 
Development
@estebanways
Merge pull request #399 from mydroidandi/development
043fc11 
Development
@estebanways
Merge pull request #401 from mydroidandi/development
e59717f 
Development
@estebanways
Merge pull request #403 from mydroidandi/development
67cd537 
Development
@estebanways
Merge pull request #405 from mydroidandi/development
de7b038 
Development
@estebanways
Merge pull request #407 from mydroidandi/development
a189bd4 
Development
@estebanways
Merge pull request #411 from mydroidandi/development
ca460ec 
Development
@estebanways
Merge pull request #413 from mydroidandi/development
e4c4025 
Development
@estebanways
Merge pull request #416 from mydroidandi/development
93430fa 
Development
@estebanways
Merge pull request #418 from mydroidandi/development
c2569a8 
Development
@estebanways
Merge pull request #422 from mydroidandi/development
2d32520 
Development
@estebanways
Merge pull request #424 from mydroidandi/development
c771b2f 
Development
@estebanways
Merge pull request #426 from mydroidandi/development
b2d875c 
Development
@estebanways
Merge pull request #428 from mydroidandi/development
04e4174 
Development
@estebanways
Merge pull request #433 from mydroidandi/development
d492e4d 
Development
@estebanways
Merge pull request #435 from mydroidandi/development
711be3a 
Development
@estebanways
Merge pull request #437 from mydroidandi/development
bb26ec9 
Development
@estebanways
Merge pull request #439 from mydroidandi/development
1502682 
Development
@estebanways
Merge pull request #441 from mydroidandi/development
bb83d22 
Development
@estebanways
Merge pull request #443 from mydroidandi/development
a7e6645 
Development
@estebanways
Merge pull request #445 from mydroidandi/development
8766066 
Development
@estebanways
Merge pull request #448 from mydroidandi/development
7d0ee9c 
Development
@estebanways
Merge pull request #450 from mydroidandi/development
1d4bc93 
Development
@estebanways
Merge pull request #452 from mydroidandi/development
9546817 
Development
@estebanways
Merge pull request #454 from mydroidandi/development
cd4fb7c 
Development
@estebanways
Merge pull request #456 from mydroidandi/development
9c630b1 
Development
@estebanways
Merge pull request #458 from mydroidandi/development
c2cbad9 
Development
@estebanways
Merge pull request #460 from mydroidandi/development
fcbd8f7 
Development
@estebanways
Merge pull request #462 from mydroidandi/development
df3acea 
Development
@estebanways
Merge pull request #464 from mydroidandi/development
86a8fba 
Development
@estebanways
Merge pull request #467 from mydroidandi/development
cba02ae 
Development
@estebanways
Merge pull request #469 from mydroidandi/development
ff3fe77 
Development
@estebanways
Merge pull request #471 from mydroidandi/development
0e85b00 
Development
@estebanways
Merge pull request #473 from mydroidandi/development
8f6f692 
Development
@estebanways
Merge pull request #476 from mydroidandi/development
98b722b 
Development
@estebanways
Merge pull request #478 from mydroidandi/development
93b5888 
Development
@estebanways
Merge pull request #480 from mydroidandi/development
a676607 
Development
@estebanways
Merge pull request #482 from mydroidandi/development
352828a 
Development
@estebanways
Merge pull request #484 from mydroidandi/development
6f58099 
Development
@estebanways
Merge pull request #487 from mydroidandi/development
865cfcf 
Development
@estebanways
Merge pull request #489 from mydroidandi/development
dc65930 
Development
@estebanways
Consolidating Changes: Modifications, Additions, Movements, and Delet…
14e7811 
…ions

Consolidating Changes from Original Repository

### Changes made in this repository

- Merge branch 'main' of github.com:estebanways/commbase
- Add script description
- Add new files libcommbase/interactive/terminal_set_pytts3_voice_index.sh, libcommbase/routines/display_any_pytts3_voice_index_details.py, and libcommbase/routines/display_total_number_of_pytts3_voice_indexes.py to implement new command option --set-pyttsx3-voice-index and be able to: set pyttsx3 TTS engine voice index, show current voice index, and display any pytts3 voice index details
- Give the file execution permissions
- Manage to automatically start recording when the recorder device is available after pressing the recording char key just one time
- Calculate and display the processing time in the reactive stt engine
- Change the STT_ENGINE_PROCESSING_TIME_VISIBLE_ON variable value to True to be able to calculate and display the processing time in the reactive stt engine
- Create optional serial hardware interaction with the reactive stt engine
- Add serial hardware related proactive stt engine file paths and functions to reactive stt engine
- Enable COMMBASE_HARDWARE_NOTIFICATIONS_ON to create serial hardware interaction with the reactive stt engine
- Add a new option --show-full-commbase-log to display the full Commbase log in the apps pane
- Add new file bundles/libcommbase/libcommbase/routines/assistant_discourse_with_external_capture_driving.sh
- Read the CHAT_LOG_FILE configuration variable without slash by adding the slash directly in the code
- Add the new terminal command --show-log-chat-log to display the log data/.chat_log.txt in the apps pane
- Remove the first slash from the variable CHAT_LOG_FILE to read the CHAT_LOG_FILE configuration variable without a slash
- Refactor the function toggle_capture_on-off.sh by writing logs to using the routines assistant_discourse and assistant_discourse_with_external_capture_driving instead of inner code
- Read the CHAT_LOG_FILE configuration variable without slash by adding the slash to the variable file_path
- Add the new discourses with keys default_microphone_is_mute_now and issue_with_the_microphone to the libcommbase translation files for toggle_capture_on-off.sh to used them
- Read the CHAT_LOG_FILE configuration variable without slash by adding the slash to the cp command
- Modify the assistant_discourse call and assistant_discourse.sh with the arguments: pane, i18n, origin, log_severity_level_1, and discourse_key to be able to standardize the log files content
- Read the CHAT_LOG_FILE configuration variable without slash by adding the slash to the function get_chat_log_file()
- Insert an empty line
- Modify the calls to the new version of the routine assistant_discourse.sh to comply with the standardization on how the chat participant's discourses are logged to the file data/.chat_log.txt
- Standardize how the chat participant's discourses are logged to the file data/.chat_log.txt using the log_severity_level_1. They look like this now: [2024-05-23 14:52:30] app: DEBUG: ✨ ASSISTANT: Mute the microphone to pause recording. [2024-05-23 14:52:47] stt-whisper-proactive: DEBUG: 🧑 END USER: Something about myself. The routine tail_chat_log.sh yet tailors the logs to show them in the chatroom
- Add more information about the apps pane to the User s Guide
- Add new routine log_command_with_timestamp.sh to create new command --show-log-commands to show log commands in the apps pane
- Lowercase local log variable
- Add the new option commbase --show-chatroom for the apps pane and reorganize the help menu
- Add new file tail_log_file.sh to create new commbase option 'commbase --show-log-messages'
- Reorganize project structure
- Log message with timestamp instead of with elapsed time
- Organize the content by index/key in alphabetical order
- Add i18n_number parameter for internationalization
- Create two separate routines based on log_message.sh: bundles/libcommbase/libcommbase/routines/log_message_with_elapsed_time.sh and bundles/libcommbase/libcommbase/routines/log_message_with_timestamp.sh
- Modify the libcommbase routine append_message_to_log_file.sh to log messages either to a specified log file or to the output and rename it as log_message.sh
- Add new libcommbase log_messages directory

### Changes by file

#### Update Installation Guide and Configuration

**Modifications:**
1. **INSTALL**
   - Added `bc` to required packages.
   - Updated installation commands.
   - Extended audio capture variable instructions.

2. **README.md**
   - Added `log_messages` directory.
   - Modified `scripts` directory structure.

3. **assets/docs/User's Guide.md**
   - Clarified Pane 1 functionality.
   - Enhanced logging configuration details.

4. **bundles/commbase-recorder-transmitter-b/reccomm.sh**
   - Added `CARD_INDEX` and `DEVICE_INDEX`.
   - Implemented audio device checks.
   - Improved cleanup function.

#### Refactor and enhance commbase STT whisper functionality

**Details:**
- Added timestamps to logs.
- Refactored logging functions.
- Improved hardware interaction.
- Added processing time visibility feature.

#### Added file_paths.py

**Details:**
- Fixed path construction in `get_chat_log_file`.
- Added functions for hardware paths.
- Updated `functions.py` with new functions.

#### Logging improvements and language file updates

**Details:**
- Added timestamp variable.
- Modified logging process.
- Removed redundant conditional blocks.
- Updated function call to `assistant_discourse`.

### Deleted Files

bundles/libcommbase/libcommbase/routines/append_message_to_log_file.sh

### New Files

bundles/libcommbase/libcommbase/interactive/terminal_set_pytts3_voice_index.sh
bundles/libcommbase/libcommbase/routines/assistant_discourse_with_external_capture_driving.sh
bundles/libcommbase/libcommbase/routines/display_any_pytts3_voice_index_details.py
bundles/libcommbase/libcommbase/routines/display_total_number_of_pytts3_voice_indexes.py
bundles/libcommbase/libcommbase/routines/log_command_with_timestamp.sh
bundles/libcommbase/libcommbase/routines/log_message_with_elapsed_time.sh
bundles/libcommbase/libcommbase/routines/log_message_with_timestamp.sh
bundles/libcommbase/libcommbase/routines/tail_log_file.sh

### Conclusion

These changes indicate a significant effort to enhance functionality, improve configuration options, and streamline logging processes within the Commbase project. The additions of new features, along with the structural and organizational improvements, mean a commitment to enhancing user experience and maintaining code clarity and efficiency.
@estebanways estebanways merged commit e54de7c into development May 26, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@estebanways