Initialize detective module structure and add core functionality

sergiudm · Dec 9, 2024 · c900066 · c900066
1 parent 323e881
commit c900066
Show file tree

Hide file tree

Showing 39 changed files with 209 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -19,21 +19,28 @@ detective是一款更适合中国宝宝的室友内卷监测工具，它可以
 - LED灯
 - 面包板
 
-## 安装依赖
-### 一键安装
+## 安装
+## pip安装
 ```bash
-./deploy.sh
-```
-### 手动安装
-创建虚拟环境
-```bash
-conda create -n your_env_name python=3.10
-conda activate your_env_name
+conda create -n <your_env_name> python=3.10
+pip install detective-pi
 ```
-安装依赖
+
+## 源码安装
+克隆仓库
 ```bash
 git clone https://github.com/sergiudm/detective.git
 cd detective
+```
+你可以使用`deploy.sh`脚本自动安装
+```bash
+sudo chmod +x deploy.sh
+./deploy.sh
+```
+或者手动安装
+```bash
+conda create -n <your_env_name> python=3.10
+conda activate <your_env_name>
 pip install -r requirements.txt
 ```
 

diff --git a/detective/LISCENSE b/detective/LISCENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Detective
+
+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.
+
+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.
diff --git a/controller/LED_control.py → detective/__init__.py b/controller/LED_control.py → detective/__init__.py
diff --git a/assets/videos/sit.mp4 → detective/assets/videos/sit.mp4 b/assets/videos/sit.mp4 → detective/assets/videos/sit.mp4
diff --git a/communication/README.md → detective/communication/README.md b/communication/README.md → detective/communication/README.md
diff --git a/communication/__init__.py → detective/communication/__init__.py b/communication/__init__.py → detective/communication/__init__.py
diff --git a/...tion/__pycache__/__init__.cpython-310.pyc → ...tion/__pycache__/__init__.cpython-310.pyc b/...tion/__pycache__/__init__.cpython-310.pyc → ...tion/__pycache__/__init__.cpython-310.pyc
diff --git a/...ation/__pycache__/mailbot.cpython-310.pyc → ...ation/__pycache__/mailbot.cpython-310.pyc b/...ation/__pycache__/mailbot.cpython-310.pyc → ...ation/__pycache__/mailbot.cpython-310.pyc
diff --git a/...ation/__pycache__/mailbot.cpython-312.pyc → ...ation/__pycache__/mailbot.cpython-312.pyc b/...ation/__pycache__/mailbot.cpython-312.pyc → ...ation/__pycache__/mailbot.cpython-312.pyc
diff --git a/...cation/__pycache__/server.cpython-310.pyc → ...cation/__pycache__/server.cpython-310.pyc b/...cation/__pycache__/server.cpython-310.pyc → ...cation/__pycache__/server.cpython-310.pyc
diff --git a/communication/client.py → detective/communication/client.py b/communication/client.py → detective/communication/client.py
diff --git a/communication/mailbot.py → detective/communication/mailbot.py b/communication/mailbot.py → detective/communication/mailbot.py
diff --git a/communication/server.py → detective/communication/server.py b/communication/server.py → detective/communication/server.py
diff --git a/controller/controller_engine.py → detective/controller/LED_control.py b/controller/controller_engine.py → detective/controller/LED_control.py
diff --git a/controller/README.md → detective/controller/README.md b/controller/README.md → detective/controller/README.md
diff --git a/resources/place_holder.txt → detective/controller/controller_engine.py b/resources/place_holder.txt → detective/controller/controller_engine.py
diff --git a/main.py → detective/main.py b/main.py → detective/main.py
diff --git a/modules/__init__.py → detective/modules/__init__.py b/modules/__init__.py → detective/modules/__init__.py
diff --git a/modules/__pycache__/__init__.cpython-312.pyc → ...ules/__pycache__/__init__.cpython-312.pyc b/modules/__pycache__/__init__.cpython-312.pyc → ...ules/__pycache__/__init__.cpython-312.pyc
diff --git a/modules/__pycache__/common.cpython-312.pyc → ...odules/__pycache__/common.cpython-312.pyc b/modules/__pycache__/common.cpython-312.pyc → ...odules/__pycache__/common.cpython-312.pyc
diff --git a/...__pycache__/detect_master.cpython-312.pyc → ...__pycache__/detect_master.cpython-312.pyc b/...__pycache__/detect_master.cpython-312.pyc → ...__pycache__/detect_master.cpython-312.pyc
diff --git a/modules/common.py → detective/modules/common.py b/modules/common.py → detective/modules/common.py
diff --git a/modules/detect_master.py → detective/modules/detect_master.py b/modules/detect_master.py → detective/modules/detect_master.py
diff --git a/modules/detect_others.py → detective/modules/detect_others.py b/modules/detect_others.py → detective/modules/detect_others.py
diff --git a/modules/device.py → detective/modules/device.py b/modules/device.py → detective/modules/device.py
diff --git a/modules/gesture.py → detective/modules/gesture.py b/modules/gesture.py → detective/modules/gesture.py
diff --git a/modules/utils.py → detective/modules/utils.py b/modules/utils.py → detective/modules/utils.py
diff --git a/detective/resources/place_holder.txt b/detective/resources/place_holder.txt
diff --git a/...es/store/Snipaste_2024-11-22_14-35-40.png → ...es/store/Snipaste_2024-11-22_14-35-40.png b/...es/store/Snipaste_2024-11-22_14-35-40.png → ...es/store/Snipaste_2024-11-22_14-35-40.png
diff --git a/resources/test.png → detective/resources/test.png b/resources/test.png → detective/resources/test.png
diff --git a/detective_pi.egg-info/PKG-INFO b/detective_pi.egg-info/PKG-INFO
@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: detective_pi
+Version: 0.1.0
+Summary: A versatile tool for daily use
+Home-page: https://github.com/sergiudm/detective
+Author: Sergiu Han
+Author-email: sergiudm@outlook.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: opencv-python
+Requires-Dist: opencv-python-headless
+Requires-Dist: mediapipe
+
+detective：一款更适合中国宝宝的室友内卷监测工具
+==================================================
+
+## 介绍
+
+detective是一款更适合中国宝宝的室友内卷监测工具，它可以帮助你监测室友的内卷行为，让你的寝室生活更加和谐。
+> TODO：demo
+
+## 环境要求
+| 环境   | 版本                         |
+| ------ | ---------------------------- |
+| OS     | Ubuntu22.04, Raspberry Pi OS, Window11, Debian 12|
+| Python | 3.10                         |
+
+## 硬件清单
+- Raspberry Pi 4B * 2
+- 摄像头 * 2
+- 蜂鸣器
+- LED灯
+- 面包板
+
+## 安装依赖
+克隆仓库
+```bash
+git clone https://github.com/sergiudm/detective.git
+cd detective
+```
+### 一键安装
+```bash
+./deploy.sh
+```
+### 手动安装
+创建虚拟环境
+```bash
+conda create -n <your_env_name> python=3.10
+conda activate <your_env_name>
+pip install -r requirements.txt
+```
+
+## 使用说明
+开始前，你需要配置`config.json`文件，
+以下是一个示例：
+```json
+{
+    "default_detect_mode": "others",
+    "use_camera": true,
+    "LED_pin": 18, # LED灯的引脚
+    "use_visualization": false, # 是否使用可视化
+    "server_email": "youremail@example.com",
+    "server_email_password": "your email password",# 请使用授权码
+    "target_email": [
+        "email1",
+        "email2"
+    ],
+    "smtp_server":"your smtp server",
+    "smtp_port": 587,
+    "video_path": "assets/videos/sit.mp4", # use_camera为false时，使用该视频
+    "image_path": "resources", # 邮件中的图片
+    "send_delay": 13,
+    "effective_detection_duration": 2,
+    "max_num_hands": 2,
+    "min_detection_confidence": 0.65,
+    "min_tracking_confidence": 0.65
+}
+```
+>[!CAUTION] 
+实际使用时，请删除`config.json`中的所有注释!
+
+Linux:
+```bash
+cd detective
+sudo chmod +x run.sh
+./run.sh
+```
+Windows:
+```bash
+cd detective
+python main.py
+```
+
+## 功能
+- 检测是否有室友在内卷
+    - 如果有，会自动响起警报，并且发微信通知你
+- 检测你是不是卷过头了
+    - 如果连续工作超过2小时（可在`config.json`中配置），会自动响起警报，并提醒你休息一下
+- to do list
+  - 检测 学习 与 玩游戏
+    - 肩部、髋部、膝盖 夹角； 手部 位置
+  - 报警：蜂鸣器（可换为便宜的喇叭）（直到结束学习才消失）、led、微信发消息
+  - 开关门检测
+    - 开关门 检测完成后： 人在寝室，才监控
+  - 不良坐姿的检测
+  - 魔术
+
+## 如何贡献
+本仓库仅使用了[mediapipe](https://github.com/google-ai-edge/mediapipe)中的人体姿态检测和手部检测功能，如果你有更多想法，欢迎：
+
+- 提交PR
+  - [插件指南]()
+- 提交Issue
+- 传播给更多的室友
+
+## Acknowledgement
+[mediapipe](https://github.com/google-ai-edge/mediapipe)
diff --git a/detective_pi.egg-info/SOURCES.txt b/detective_pi.egg-info/SOURCES.txt
@@ -0,0 +1,20 @@
+README.md
+setup.py
+detective/__init__.py
+detective/main.py
+detective/communication/__init__.py
+detective/communication/client.py
+detective/communication/mailbot.py
+detective/communication/server.py
+detective/modules/__init__.py
+detective/modules/common.py
+detective/modules/detect_master.py
+detective/modules/detect_others.py
+detective/modules/device.py
+detective/modules/gesture.py
+detective/modules/utils.py
+detective_pi.egg-info/PKG-INFO
+detective_pi.egg-info/SOURCES.txt
+detective_pi.egg-info/dependency_links.txt
+detective_pi.egg-info/requires.txt
+detective_pi.egg-info/top_level.txt
diff --git a/detective_pi.egg-info/dependency_links.txt b/detective_pi.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/detective_pi.egg-info/requires.txt b/detective_pi.egg-info/requires.txt
@@ -0,0 +1,3 @@
+opencv-python
+opencv-python-headless
+mediapipe
diff --git a/detective_pi.egg-info/top_level.txt b/detective_pi.egg-info/top_level.txt
@@ -0,0 +1 @@
+detective
diff --git a/dist/detective_pi-0.1.0-py3-none-any.whl b/dist/detective_pi-0.1.0-py3-none-any.whl
diff --git a/dist/detective_pi-0.1.0.tar.gz b/dist/detective_pi-0.1.0.tar.gz
diff --git a/received_image.png b/received_image.png
diff --git a/setup.py b/setup.py
@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="detective_pi",
+    version="0.1.0",  
+    author="Sergiu Han",  
+    author_email="sergiudm@outlook.com",  
+    description="A versatile tool for daily use",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/sergiudm/detective", 
+    packages=find_packages(include=["detective", "detective.*"]),
+    install_requires=[
+        "opencv-python",
+        "opencv-python-headless",
+        "mediapipe",
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License", 
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.10",  
+    entry_points={  
+    },
+)