Skip to content

Commit 20a83aa

Browse files
Update README.md
1 parent f682aba commit 20a83aa

1 file changed

Lines changed: 100 additions & 39 deletions

File tree

README.md

Lines changed: 100 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,25 @@
2020
</div>
2121
<br>
2222

23+
---
24+
2325
# KIDA (v00): Kinetic Interactive Drive Automaton
2426

2527
A Raspberry Pi 3 robot is a small programmable robot powered by a Raspberry Pi 3 Model B, used as its main brain.
2628

29+
## Functions:
30+
31+
- 🎮 Remote Control
32+
- 🖥️ VNC Control
33+
- Web Control
34+
- 📸 Image Capture (Photograph)
35+
- 🎥 Video Recording
36+
- 📡 Ultrasonic Obstacle Detection
37+
- Line Following
38+
- 📺 Live Video Streaming
39+
- 🌈 RGB Lighting Control
40+
- Gender/Age Detection
41+
2742
## Related Projects
2843

2944
- [WHIP-Robot-v00](https://github.com/CursedPrograms/WHIP-Robot-v00)
@@ -32,43 +47,68 @@ A Raspberry Pi 3 robot is a small programmable robot powered by a Raspberry Pi 3
3247
- [ComCentre](https://github.com/CursedPrograms/ComCentre)
3348
- [RIFT](https://github.com/CursedPrograms/RIFT)
3449

35-
<br>
50+
---
51+
3652
<div align="center">
3753
<img src="images/bg.jpg" alt="KIDA Robot" width="400"/>
3854
</div>
39-
<br>
55+
<br>
4056

41-
- pip install flask picamera2 opencv-python psutil
42-
- python server.py
43-
- then open http://<pi-ip>:5000 on any device on your network
57+
## Prerequisites
58+
<details>
59+
<summary><b>View Prerequisites</b></summary>
4460

61+
### Software
62+
- [Raspberry Pi OS](https://www.raspberrypi.com/software/operating-systems/)
4563

46-
## Functions:
64+
## Hardware
4765

48-
- 🎮 Remote Control
49-
- 🖥️ VNC Control
50-
- Web Control
51-
- 📸 Image Capture (Photograph)
52-
- 🎥 Video Recording
53-
- 📡 Ultrasonic Obstacle Detection
54-
- Line Following
55-
- 📺 Live Video Streaming
56-
- 🌈 RGB Lighting Control
57-
- Gender/Age Detection
66+
### Compute
67+
| **Component** | **Details** |
68+
|-----------|---------|
69+
| Main Board | Raspberry Pi 5 (4GB) |
70+
| GPIO Hat | Freenove Tank Robot HAT v2 |
71+
72+
### Chassis & Motion
73+
| **Component** | **Details** |
74+
|-----------|---------|
75+
| Chassis | Robot Tank Chassis |
76+
| Motors | 2× 5v DC Motors |
77+
78+
### User Controllers
79+
| **Component** | **Details** |
80+
|-----------|---------|
81+
| Interface | PC, Android, iPhone |
82+
| Controller | Wireless Keyboard, IR remote |
83+
84+
### Cameras
85+
| **Component** | **Details** |
86+
|-----------|---------|
87+
| Camera 0 | Raspberry Pi Camera |
5888

59-
## 🧩 Hardware Components
89+
### Sensors
90+
| **Component** | **Details** |
91+
|-----------|---------|
92+
| Ultrasonic Sensors | HC-SR04|
93+
| Line Follower | 3-Channel Line Tracking Sensor |
6094

61-
- 🛞 Tank-Based Chassis
62-
- 🧠 Raspberry Pi 3
63-
- ⚙️ Freenove Robotics HAT
64-
- 📏 Ultrasonic Sensor
65-
- 📷 Raspberry Pi Camera Module
95+
### Power System
96+
| **Component** | **Details** |
97+
|-----------|---------|
98+
| Battery | 2s 18650|
6699

67-
# KIDA Pinout Configuration
100+
</details>
68101

69-
This document describes the GPIO pin assignments for the KIDA robot.
102+
# Schematics
103+
## ⚡ Technical Pinouts
104+
105+
> [!IMPORTANT]
106+
> This document describes the GPIO pin assignments for the KIDA robot.
70107
Uses the V2 robot Hat from the Freenove Tank Robot: https://github.com/Freenove/Freenove_Tank_Robot_Kit_for_Raspberry_Pi
71108

109+
<details>
110+
<summary><b>View Freenove Tank Robot HAT v2 Configuration</b></summary>
111+
72112
## Ultrasonic Sensor (HC-SR04)
73113

74114
| Signal | GPIO Pin |
@@ -104,38 +144,55 @@ Uses the V2 robot Hat from the Freenove Tank Robot: https://github.com/Freenove/
104144
| IN1 | 5 |
105145
| IN2 | 6 |
106146

147+
</details>
148+
107149
*Note:* These pins correspond to the constructor defaults:
108150

151+
---
152+
153+
## 🌐 Connectivity & Controls
154+
155+
<details>
156+
<summary><b>Connectivity & Controls</b></summary>
157+
158+
### Network Configuration
159+
| Parameter | Value |
160+
| :--- | :--- |
161+
| **SSID** | `NORA` |
162+
| **Password** | `12345678` |
163+
164+
* `localhost:5002`
165+
166+
### RIFT Integration
167+
To connect via [RIFT](https://github.com/CursedPrograms/RIFT), ensure KIDA01 is active on:
168+
* `localhost:5003`
169+
170+
<details>
171+
172+
---
173+
109174
## How to Run:
110175

111-
### Environment Setup/Install Dependencies
176+
### Environment Setup
177+
178+
<details>
179+
<summary><b>View Environment Setup</b></summary>
112180

113181
```bash
114182
python3 -m venv venv
115183
source venv/bin/activate
116184
pip install --upgrade pip
117185
pip install -r requirements.txt
118186
```
187+
188+
</details>
189+
119190
### Run run.py to run KIDA
120191

121192
```bash
122193
python run.py
123194
```
124195

125-
<br>
126-
127-
### Network Setup
128-
129-
<div align="center">
130-
<img src="images/screenshot.png" alt="KIDA Web Control" width="800"/>
131-
</div>
132-
133-
- 📡 SSID: KIDAv00
134-
- 🔒 Password: 12345678
135-
- 🌐 Access your site at: http://192.168.4.1:5000
136-
137-
<br>
138-
139196
```bash
140197
sudo apt update
141198
sudo apt install hostapd dnsmasq -y
@@ -199,6 +256,10 @@ sudo systemctl enable hostapd
199256
sudo systemctl enable dnsmasq
200257
```
201258

259+
- pip install flask picamera2 opencv-python psutil
260+
- python server.py
261+
- then open http://<pi-ip>:5000 on any device on your network
262+
202263
## Requirements:
203264

204265
```bash

0 commit comments

Comments
 (0)