<
>
An open-source desktop assistant bot working on Large Language Model locally.
Video Demonstration and Explanation:
Our main aim for this bot was to run and integrate the quantized llm models locally instead of using an API. Moreover many functionalities like speech recognition is also being run locally.
The following are the features that are available for this release:
- Idleness Remainder - By default after 30 minutes the bot will give a reminder to get up and stretch.
- Emotion Detection - By default after 2 hours the bot will analyze your emotions and also check if you are drowsy and perform the necessary actions to wake you up.
- User Presence - By default after two minutes the bot will check if you are present in front of the computer. If user is not detected it will lock the system automatically.
- News - Scrapes the relevant websites and reads the headlines at the first boot each day.
- Note Maker - Create notes and read the previous notes.
- Scheduler - Creates and reminds you of your schedules like meetings or reminders.
- Curent Time and Date reading
- Play Music - Plays music based on four youtube playlists i.e classical, pop, techno and rock.
- Camera - Opens the custom camera and takes a picture either manually or by command.
- Play Games - At present it can play 2 games one is rock-paper-scissors using camera and other game is hangman.
- Image showing - Can show images scrapped from the website if LLM want to show it.
- Youtube Player - Based on LLM command can access and play a video on a particular topic.
- Timer - Sets a timer for a particular amount of time with a custom message for the timer.
Some functionalities have been hard coded to improve execution speed and quality, these are:
- Cyclops - The wake up word for the bot.
- What/Whats/What's the time - To tell the current time.
- What/Whats/What's the date - To tell the current date.
- Play classical/pop/techno/rock music - To play the respective playlist in the YouTube.
- Let's play a game/ Play games - To play games either hangman or rock-paper-scissors.
- How do I look - To open the camera module.
- Note engine/noting engine - To begin the noting process.
- Click a picture/take a picture - To take a picture and save it in the photos taken folder.
- What/Whats/What's the room temperature - Shows the room temperature and humidity using the DHT11 sensor.
- Typing mode - To take inputs and prompts using keyboard.
- Audio mode - To take inputs using mic or speech-to-text.
- Shutdown/shut down - To close all engines and terminate the program.
Check this Instructables link to find out how to make your own physical bot and interface it with the software.
Link : https://www.instructables.com/Cyclops-a-Personal-Desktop-Assistant-Bot/
- This software and hardware has been tested and created on Windows 11 and Python 3.10
- Browser path has to be changed according to the location of the browser you are using.
- Do not change the file structure or names.
- Make sure you have atleast 8 gb of RAM in your system.
- Some webscrapping scripts might become obsolete by the time you start making your own bot.
- Download the files from the following google drive link because llm models are too large and we were unable to add emotion recognition models as well. Link: https://drive.google.com/drive/folders/1X-ubLckjLJAn6dmfQuTygzYcOE_vS-ME?usp=sharing
- You can also 3d print the parts using the .stl files provided in the 3D Printing folder.
Copyright (c) [2024] [Mandred Tech]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Attribution Clause: Users of this software are required to include an attribution to Mandred Tech in any publication, distribution, or derivative works based on this software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.