Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rjrp44/ouchat-electronics
Part of Ouchat project 😺
https://github.com/rjrp44/ouchat-electronics
c cat esp32 ouchat
Last synced: 20 days ago
JSON representation
Part of Ouchat project 😺
- Host: GitHub
- URL: https://github.com/rjrp44/ouchat-electronics
- Owner: RJRP44
- License: gpl-3.0
- Created: 2022-06-23T12:46:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-05T19:04:14.000Z (8 months ago)
- Last Synced: 2024-05-05T20:23:12.327Z (8 months ago)
- Topics: c, cat, esp32, ouchat
- Language: C++
- Homepage:
- Size: 384 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ouchat Electronics
A project using [vl53l5cx](https://www.st.com/en/imaging-and-photonics-solutions/vl53l5cx.html) to detect the passage of the cat to the outside.
> **Warning**
> This Project **only** works on ESP32D with at least 8MB of flash size.
## 📌 Contents
* [How does it works ?](#how-does-it-works)
* [Settings](#settings)
* [Libraries](#libraries)
* [Structure](#structure)
---
### 💭 How does it works ?
The data processing will be detailed in four layers of data processing. First we need to prepare data, next analyze the data with the necessary calculations and finally determine the result.
#### Data Preparation
The raw data of the sensor as a major issue : the sensor is tilted by 60° then all values are not standardize, so we need to correct that with some math.
---
### ⚙ Settings
This project has 2 value that must be assigned to work properly.
In order to configure them, you must run this command in your project folder :
```bash
> idf.py menuconfig
```
Next go to `Ouchat Configuration` category.
The values to be assigned are :
- Ouchat Secret Key
- Ouchat Cat ID
---
### 💾 Libraries
This project is using my [V53L5CX-Library](https://github.com/RJRP44/V53L5CX-Library) for esp-idf framwork (all the source code is available on github).
---
### Structure
```
├── CMakeLists.txt
├── 📁 components /
│ └── 📁 ouchat /
│ ├── ouchat_api.c
│ ├── ouchat_ble.c
│ ├── ouchat_led.c
│ ├── ouchat_logger.c
│ ├── ouchat_processing.c
│ ├── ouchat_protocomm.c
│ ├── ouchat_sensor.c
│ ├── ouchat_utils.c
│ ├── ouchat_wifi.c
│ ├── ouchat_wifi_prov.c
│ └── 📁 include /
│ ├── ouchat_api.h
│ ├── ouchat_ble.h
│ ├── ouchat_led.h
│ ├── ouchat_logger.h
│ ├── ouchat_processing.h
│ ├── ouchat_protocomm.h
│ ├── ouchat_sensor.h
│ ├── ouchat_utils.h
│ ├── ouchat_wifi.h
│ └── ouchat_wifi_prov.c
├── 📁 main /
│ ├── CMakeLists.txt
│ ├── main.c
└── README.md
```
---
## 📝 License
Copyright © 2023 [RJRP44](https://www.github.com/RJRP44).
This project is [GNU GPL](https://www.gnu.org/licenses/gpl-3.0.fr.html) licensed.
## ✨ Show your support
Give a ⭐️ if this project helped you!
## 👤 Authors
- [@RJRP44](https://www.github.com/RJRP44)