Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yaxsomo/nosql-project

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/yaxsomo/nosql-project
Owner: yaxsomo
Created: 2024-03-05T11:14:05.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-03-26T13:25:45.000Z (9 months ago)
Last Synced: 2024-04-09T13:33:10.642Z (9 months ago)
Language: JavaScript
Size: 2.9 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# NoSQL Project

## Table of Contents
1. [Overview](#overview)
2. [How to Launch the Project](#how-to-launch-the-project)
- [Requirements](#requirements)
- [Docker Container Execution](#docker-container-execution)
- [Node Program Execution](#node-program-execution)
- [Available Routes](#available-routes-db)
3. [Data Visualization](#data-visualization)
- [Available Routes](#available-routes-html)
4. [Sensors and Data Formats](#sensors-and-data-formats)
5. [Sensors Details](#sensors-details)
6. [Members of the Project](#members-of-the-project)

## Overview

This project involves generating dummy data for various sensors and storing it in a NoSQL database. Below are the sensors used in this project along with their data formats:

## How to launch the project

### Requirements
For this project you'll need to install :

- Docker Desktop
- Node.js
- MongoDB
- Cors
- Live Server Extension for VS Code

The 3 last packages can be installed via NPM.

### Docker container execution

First thing first, on the project's root folder, you have to create the docker container with this bash command :

```bash
docker compose up -d
```

The next thing to do, is to execute the Docker container with this command :

```bash
docker exec -it nosql-project-redis-1 /bin/bash
```

NOTE : If the command fails with the 'permission denied' error, just add 'sudo' before the command

Now your docker container is fired up!

### Node program execution

Once the container is active, you'll have to go into the /app folder and execute this command from another terminal instance :

```bash
node index.js
```

To make sure the program is executing correctly, you'll get this output on the terminal :

```bash
Server is running on port 3000
Redis is ready
```

### Available routes DB:

#### localhost:3000/measurements

Here you'll find all the Sensor data measurements Cache Database

#### localhost:3000/sensors

Here you'll find all the Sensors list Cache Database

#### localhost:3000/joint1

Perform the first aggregate operation. Regroups all the measurements by sensor ID and returns the result

#### localhost:3000/joint2/timestamp

Perform the second aggregate operation. Retreives all the measurements with the same timestamp and returns the result

Query exemple :
```bash
localhost:3000/joint2/2024-03-08T00:17:45.348Z
```

### Data Visualization :

This projects embeds HTML pages for a prettified visualization of the database queries.
For this functionnality, you have to use the Live Server Extension from VS Code. Once you launched the live session, you can access the available routes.

### Available routes HTML:

#### http://127.0.0.1:5500/app/measurements.html

Here you'll find all the Sensor data measurements Cache Database

#### http://127.0.0.1:5500/app/sensors.html

Here you'll find all the Sensors list Cache Database

#### http://127.0.0.1:5500/app/joint1.html

Perform the first aggregate operation. Regroups all the measurements by sensor ID and returns the result

#### http://127.0.0.1:5500/app/joint2.html?timestamp=TIMESTAMP_HERE

Perform the second aggregate operation. Retreives all the measurements with the same timestamp and returns the result

Query exemple :
```bash
http://127.0.0.1:5500/app/joint2.html?timestamp=2024-03-08T20:19:13.977Z
```

## Sensors and Data Formats

### Lidar (SICK TiM150-3010300)

```json
{
"sensor_id": 1,
"timestamp": "YYYY-MM-DDTHH:MM:SS",
"measurement": {
"distance": 25.3,
"angle": 45.6
}
}

```
### 9-Axis IMU (Bosh BNO055)
```json
{
"sensor_id": 2,
"timestamp": "YYYY-MM-DDTHH:MM:SS",
"measurement": {
"acceleration": {
"x": 0.1,
"y": 0.2,
"z": 9.8
},
"gyroscope": {
"x": -0.05,
"y": 0.03,
"z": -0.02
},
"magnetometer": {
"x": -23.1,
"y": 45.2,
"z": -12.5
}
}
}
```
### Barometer (Bosh BME680)
```json
{
"sensor_id": 3,
"timestamp": "YYYY-MM-DDTHH:MM:SS",
"measurement": {
"pressure": 1013.25,
"temperature": 23.5,
"humidity": 45.6,
"gas_resistance": 120.0
}
}

```
### GPS (SAM-M10Q-00B)
```json
{
"sensor_id": 4,
"timestamp": "YYYY-MM-DDTHH:MM:SS",
"measurement": {
"latitude": 37.7749,
"longitude": -122.4194,
"altitude": 50.0,
"speed": 0.0
}
}
```
### Ultrasonic Sensor (HC-SR04)
```json
{
"sensor_id": 5,
"timestamp": "YYYY-MM-DDTHH:MM:SS",
"measurement": {
"distance": 10.2
}
}
```

## Sensors Details
```json
[
{
"id": 1,
"name": "Lidar",
"type": "Distance Sensor",
"manufacturer": "SICK",
"model": "TiM150-3010300",
"details": {
"range": "0.1m to 10m",
"accuracy": "±0.1%"
}
},
{
"id": 2,
"name": "9-Axis IMU",
"type": "Inertial Measurement Unit",
"manufacturer": "Bosch",
"model": "BNO055",
"details": {
"axes": 9,
"communication": ["I2C", "SPI"]
}
},
{
"id": 3,
"name": "Barometer",
"type": "Atmospheric Pressure Sensor",
"manufacturer": "Bosch",
"model": "BME680",
"details": {
"measures": ["pressure", "temperature", "humidity", "gas resistance"]
}
},
{
"id": 4,
"name": "GPS",
"type": "Global Positioning System",
"manufacturer": "UBlox",
"model": "SAM-M10Q-00B",
"details": {
"tracking_channels": 22
}
},
{
"id": 5,
"name": "Ultrasonic Sensor",
"type": "Distance Sensor",
"manufacturer": "Unknown",
"model": "HC-SR04",
"details": {
"range": "2cm to 400cm",
"resolution": "0.3cm",
"accuracy": "±3mm"
}
}
]
```

## Members of the project

Yassine DEHHANI

Emile BAILEY

Baptiste GADEBILLE

Lucas TARAIRE

Bertil RANDONNET