Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hari9-9/scalable_usecase_group_4

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/hari9-9/scalable_usecase_group_4
Owner: hari9-9
Created: 2024-11-17T21:01:07.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-11-18T02:57:53.000Z (3 months ago)
Last Synced: 2024-11-18T03:34:44.269Z (3 months ago)
Language: Python
Size: 1000 Bytes
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# **Scalable Usecase System (Group 4)**

## **Overview**
The Scalable Usecase System simulates a forest fire monitoring system with the following components:
- **Sensors**: Collect environmental data (e.g., temperature, smoke level) and send it to satellites.
- **Satellites**: Relay data from sensors to a ground station, broadcast data to other satellites, and prioritize critical data.
- **Ground Station**: Processes and stores received data locally, triggers alerts for fire detection.

This project is built using Python and employs RSA encryption for secure message transfer.

---

## **Project Structure**

```plaintext
Scalable_usecase_group_4/
├── README.md # Project documentation
├── components/
│ ├── groundstation/
│ │ └── ground_station.py # Ground station logic
│ ├── satellites/
│ │ └── satellite.py # Satellite logic
│ └── sensors/
│ └── sensor.py # Sensor logic
├── protocol/
│ ├── crypto/
│ │ ├── private_key.pem # RSA private key
│ │ └── public_key.pem # RSA public key
│ ├── discovery/
│ │ └── adjacency_list.json # Adjacency list for routing
│ └── jarvis.py # Core protocol implementation
├── run_sensor.py # Run the sensor component
├── run_satellite.py # Run the satellite component
├── run_ground_station.py # Run the ground station component
├── runme.sh # Orchestrates running all components
├── generate_keys.py # Script to generate RSA keys
```

---
### Instrucitons To Run

Please Note running this project requires the following 7 raspberry PI's
"10.35.70.7"
"10.35.70.4":
"10.35.70.27"
"10.35.70.3"
"10.35.70.25"
"10.35.70.28"
"10.35.70.17"

Please Clone this Github repository in all the above mentioned PI's and then run the following command to enable the script:
```bash
chmod +x runme.sh
./runme.sh
```
The script will auto detect the PI and based on the host IP will either start a satellite/ground station/sensor.

### Component
```mermaid
graph LR
subgraph Forest [forest]
direction TB
S1[Sensor_1]
S2[Sensor_2]
S3[Sensor_3]
S4[Sensor_4]
S5[Sensor_5]
S6[Sensor_6]
S7[Sensor_7]
S8[Sensor_8]
S9[Sensor_9]
S10[Sensor_10]
end

subgraph Sky [space]
direction LR
LEO1[Satellite_1]
LEO2[Satellite_2]
LEO3[Satellite_3]
LEO4[Satellite_4]
LEO5[Satellite_5]
end

subgraph Ground [ground]
GS[Ground Station]
end

%% Sensor to Satellite
S1 -- data --> LEO1
S2 -- data --> LEO1
S3 -- data --> LEO2
S4 -- data --> LEO3
S5 -- data --> LEO3
S6 -- data --> LEO4
S7 -- data --> LEO4
S8 -- data --> LEO5
S9 -- data --> LEO5
S10 -- data --> LEO2

%% Satellite to Satellite Hopping
LEO1 -- relay data --> LEO2
LEO2 -- relay data --> LEO3
LEO3 -- relay data --> LEO4
LEO4 -- relay data --> LEO5

%% Satellite to Ground Station
LEO1 -- priority data --> GS
LEO2 -- priority data --> GS
LEO3 -- priority data --> GS
LEO4 -- priority data --> GS
LEO5 -- priority data --> GS

```
## **Setup**

### 1. **Install Dependencies**
This project requires Python 3. Install the dependencies:
```bash
pip install cryptography
```

### 2. **Generate RSA Keys**
Run the `generate_keys.py` script to generate RSA key files:
```bash
python3 generate_keys.py
```
The keys will be saved in the `protocol/crypto/` directory:
- `private_key.pem`
- `public_key.pem`

### 3. **Verify Adjacency List**
Ensure the `protocol/discovery/adjacency_list.json` contains valid JSON:
```json
{
"S1": {"LEO1": 1},
"S2": {"LEO1": 1},
"LEO1": {"GS": 1},
"LEO2": {"GS": 1}
}
```

---

## **Running the System**

### 1. **Run All Components**
Use the `run.sh` script to start all components:
```bash
./run.sh
```

### 2. **Run Components Individually**
You can run each component separately for debugging or testing:
- **Sensor**:
```bash
python3 run_sensor.py
```
- **Satellite**:
```bash
python3 run_satellite.py
```
- **Ground Station**:
```bash
python3 run_ground_station.py
```

---

## **Features**
1. **Secure Communication**:
- Messages are encrypted using RSA.
- Integrity is verified using CRC32 checksums.

2. **Routing and Relaying**:
- Sensors send data to linked satellites.
- Satellites broadcast to other satellites and relay to the ground station.

3. **Fire Detection**:
- Alerts are triggered if thresholds for temperature or smoke levels are exceeded.

4. **Data Storage**:
- The ground station stores all received data locally in JSON format.

---

## **Future Enhancements**
1. **Dynamic Routing**: Implement adaptive routing based on network conditions.
2. **Fault Tolerance**: Add retry mechanisms for failed transmissions.
3. **Dashboard**: Develop a web-based interface to visualize data and alerts.

---