Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 3.25 KB

README.md

File metadata and controls

80 lines (62 loc) · 3.25 KB
Raw

AirSENSE-ESP32-IDF

This is main development repo for ESP32 device in 20221 semester - a simple buildable esp-idf example. For more information please contact Nhu Hai Long Nguyen or [Gmail]:[email protected]

🚀 Features

Feature Rich
It has all the features which you need in a IOT system: Read Sensor data, save data to micro SD card, publish data to MQTT server... To integrate AirSENSE into your project, all you need is an ESP32 Board, a computer with Visual Studio Code to run PlatformIO, usb capble for flashing.

Free and Portable

  • Support platformIO on Visual Studio Code.
  • Can be compiled to ESP32 for running freeRTOS OS.
  • Distributed under the MIT licence, so you can easily use it in commercial projects too.
  • Using ESP-IDF (In this project we use esp-idf version 5.1.2).

Docs, Tools, and Services

  • We are writing about documents.

❤️ Sponsor

AirSENSE - Facebook
AirSENSE

AirSENSE - Another Version
Another repositories

How to use project

We encourage the users to use the example as a template for the new projects. A recommended way is to follow the instructions on a docs page.

Project Structure
Below is short explanation of remaining files in the project folder.

├── component                   This is the folder store all component of project
│   ├─ BME280
│   │  ├─ bme280.h
│   │  ├─ bme280.c
│   │  ├─ CmakeLists.txt
│   │  ├─ component.mk
│   │  └─ Kconfig.projbuild
│   │
│   ├─ DataManager
│   ├─ DS3231
│   ├─ Filemanager
│   ├─ PMS7003
│   └─ SNTP_Sync
│
├── main
│   ├── CMakeLists.txt
│   ├── component.mk
│   ├── Kconfig.projbuild
│   └── main.c
│
├── server_certs                This is the folder store file .pem for update OTA
│
├── Test                        This is the folder store test tool(python file)
│
├── CmakeLists.txt
├── LICENSE
├── Makefile
└── README.md                   This is the file you are currently reading

Note:

  • Kconfig.projbuild is file to config number pin GPIO, parameters, frequency,... these values can be changed. Run the command idf.py menuconfig in the ESP-IDF terminal to change it to suit your hardware.
  • In this project, we used to use some libraries of github account: "UncleRus".

🌟 Contributing

AirSENSE is an open project and contribution is very welcome. There are many ways to contribute from simply speaking about your project, through writing examples, improving the documentation, fixing bugs or even hosting your own project under the AirSENSE organization.

Alot of people already left their fingerprint in AirSENSE. Be one them! See your here! 🙂

... and many other.