Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chorwaitong/jarvis
The project Jarvis is a long-term personal project aimed at controlling/ automating virtually everything, currently includes computer/browser controls, simple MQTT IoT Device control, email management/automation. Using Gmail API, Gemini LLM, MQTT Integration.
https://github.com/chorwaitong/jarvis
assistant automation gemini gemini-api gmail jarvis langchain llm mqtt
Last synced: about 15 hours ago
JSON representation
The project Jarvis is a long-term personal project aimed at controlling/ automating virtually everything, currently includes computer/browser controls, simple MQTT IoT Device control, email management/automation. Using Gmail API, Gemini LLM, MQTT Integration.
- Host: GitHub
- URL: https://github.com/chorwaitong/jarvis
- Owner: chorwaitong
- License: mit
- Created: 2024-12-22T13:11:09.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-02-09T23:00:16.000Z (1 day ago)
- Last Synced: 2025-02-09T23:25:29.629Z (1 day ago)
- Topics: assistant, automation, gemini, gemini-api, gmail, jarvis, langchain, llm, mqtt
- Language: Python
- Homepage:
- Size: 200 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jarvis
Watch a simple demo in Youtube:
[](https://www.youtube.com/watch?v=gwRaSlDPZv8&ab_channel=ChorWT)
The project **Jarvis** is a long-term personal project aimed at controlling/ automating virtually everything. In this humble beginning, the current focuses includes the following features with Gemini LLM-based LangChain, Gmail API, MQTT, and Python.
---
## Features
- Desktop/computer controls such as opening music, apps, searching via web browser, etc.
- MQTT IoT Device control, a simple one (relay control light) for now.
- Intelligent email automation using Gemini LLM.
- Integration with Gmail API.
- Modular and extensible design for future automation features.
---
## Getting Started
### Hardware:
- ESP8266 + Relay = Bought from ([Tao Bao](https://e.tb.cn/h.TkVHVR1RKvf5a5o?tk=tzGLedFIfD3))
### Software:
- Download ([ffmpeg](https://www.ffmpeg.org/download.html)), then extract into the folder `tools\`
- Follow the steps below to set up and run the project.
#### 1. Create the Environment
To ensure compatibility and reproducibility, create a virtual environment using the provided `environment.yml` file.
##### Steps:
1. Clone this repository:
```bash
git clone https://github.com/chorwaitong/jarvis.git
cd jarvis
```
[Guide to install Git](https://github.com/git-guides/install-git)
to update:
```bash
git pull origin main
```
3. Create the environment (I'm using Anaconda):
```bash
conda env create -f environment.yml -n
```
P.S.: For Ana(conda) users, if you encounter some conda verification or corrupt error, ```conda clean --all ``` might help.
4. Activate the environment:
```bash
conda activate
```
#### 2. Follow the following instructions for setting up stuffs
- Gmail and Gemini API Access: Refer to ([README_GMailAPI](https://github.com/chorwaitong/jarvis/blob/main/README_GMailAutomate.md))
- For MQTT-based control of IoT devices, sign up for an MQTT Broker account, I am using HiveMQ Cloud: Refer ([HiveMQ Cloud](https://docs.hivemq.com/hivemq-cloud/quick-start-guide.html)). Next, store the credentials as environment variables as `MQTT_USERNAME` and `MQTT_PASSWORD`.
- Update the following configuration line in the `main.py` .
```bash
intel['mqtt_broker'] = # The Broker url here, e.g., 'xxx.s1.eu.hivemq.cloud'
```
#### 3. Run the Main Program
Once the setup is complete, run `python main.py` from the console,
or
edit the following lines of the `run.bat` file (to match with the python environment), and run it:
```bash
set CONDA_PATH1=[if using conda, the path of the conda.exe, e.g., C:\Anaconda\condabin\conda]
SET PYTHON_PATH1=[path to the python.exe of your environment, e.g., C:\Anaconda\envs\jarvis\python.exe]
```
---
## Future Scope
- Expand automation capabilities to handle calendar scheduling, task management, and data analysis.
- Integrate additional APIs and frameworks.
- Improve the learning and adaptability of Jarvis through advanced AI techniques.
---
## Credits
- Referencing design of ([python-chat](https://github.com/burakorkmez/python-chat)) for the Jarvis app page.
---
## Contributing
Contributions are welcome! Feel free to fork the repository and submit a pull request.
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.