110 lines
4.7 KiB
Markdown
110 lines
4.7 KiB
Markdown
# ESP-WHO
|
|
|
|
ESP-WHO is a face detection and recognition platform that is currently based on Espressif Systems' [ESP32](https://espressif.com/en/products/hardware/esp32/overview) chip.
|
|
|
|
# Overview
|
|
ESP-WHO supports development of face detection and recognition applications based around Espressif Systems' [ESP32](https://espressif.com/en/products/hardware/esp32/overview) chip in the most convenient way. With ESP-WHO, you can easily build up face detection- and recognition-featured applications, for instance:
|
|
* A coffee machine that brews coffee according to your taste preference;
|
|
* Home applicance that will shut off the electricity automatically when unsupervised children are operating them;
|
|
* And other more applications that suit your needs.
|
|
|
|
In general, the ESP-WHO features will be supported as shown below:
|
|
|
|
|
|
|
|
In ESP-WHO, Detection, Recognition and Image Utility are at the core of the platform.
|
|
|
|
|
|
* **Image Utility** offers fundamental image processing APIs for ESP32.
|
|
|
|
* **Detection** takes images as input and give the position of face if there is a face. It is implemented with MTMN model, which refers to [MTCNN](http://cn.arxiv.org/abs/1604.02878) and [MobileNet](https://arxiv.org/abs/1801.04381). However, we replace CNN with MobileNet block and the model size is quite smaller than other face detection models.
|
|
|
|
* **Recognition** is to identify the particular person, and it needs the results of detection. It is implemented with MobileFace model.
|
|
|
|
|
|
Both input and output are flexible.
|
|
|
|
* Image sources could be **input** via camera. However, we don't provide many drivers right now, those for other camera modules will be released in the future.
|
|
|
|
* Results could be **output** and displayed through Command line, LCD or even website via Wi-Fi http service.
|
|
|
|
|
|
# Quick Start with ESP-WHO
|
|
|
|
## Hardware Preparation
|
|
|
|
To run ESP-WHO, you need to have a development board which integrates a **ESP32 module** that has sufficient GPIO pins and more than **4 MB** external SPI RAM. In this case, we take **ESP-WROVER-KIT** as the test board, which is highly recommended for getting started with ESP-WHO.
|
|
|
|
On how to configure ESP32 module for your applications, please refer to the README.md of each example.
|
|
|
|
## Software Preparation
|
|
|
|
### Image
|
|
|
|
The recommended resolution of input image is **QVGA (320x240)**.
|
|
|
|
As for choosing camera as an image offer, make sure that the ESP32 module you choose offers specific pins that your camera needs. If there are pin conflicts, please refer to the pin connection in README.md of each example.
|
|
|
|
By now, we have provided the driver of **OV2640**, which is highly recommended to get started with.
|
|
|
|
### ESP-WHO
|
|
Make sure you clone the project recursive:
|
|
|
|
```
|
|
git clone --recursive https://github.com/espressif/esp-who.git
|
|
```
|
|
|
|
If you clone project without `--recursive` flag, please go to the `esp-who` directory and run command `git submodule update --init` before doing anything.
|
|
|
|
### ESP-IDF
|
|
See setup guides for detailed instructions to set up the ESP-IDF:
|
|
|
|
* [Getting Started Guide for the stable ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/)
|
|
* [Getting Started Guide for the latest (master branch) ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/)
|
|
|
|
In this case, we take [ESP-IDF v3.1](https://github.com/espressif/esp-idf/releases/v3.1) as the test version.
|
|
|
|
|
|
# Components
|
|
|
|
Components is the main framework of the SDK, with camera driver and algorithm inside.
|
|
|
|
See the following sections for more details about components.
|
|
|
|
## Camera
|
|
|
|
The [camera](components/camera) component contains drivers for camera devices of ESP32. Now OV2640 is supported.
|
|
|
|
|
|
## esp-face
|
|
|
|
The [esp-face](components/esp-face) component contains the APIs of ESP-WHO neural networks, including face detection and recognition framework.
|
|
|
|
|
|
# Examples
|
|
The folder of [examples](examples) contains sample applications demonstrating the API features of ESP-WHO.
|
|
|
|
Take one Face Detection as an example.
|
|
|
|
1. Get into one example folder `esp-who/examples/single_chip/detection_with_command_line`.
|
|
```
|
|
cd esp-who/examples/single_chip/detection_with_command_line
|
|
```
|
|
|
|
2. Compile the project. You may run `make defconfig` before `make flash` to get the default configurations.
|
|
```
|
|
make defconfig
|
|
make flash
|
|
```
|
|
3. Advanced users can modify some options by using the command `make menuconfig`.
|
|
|
|
|
|
Check README.md of each example for more details.
|
|
|
|
|
|
# Resources
|
|
|
|
* [Check the Issues section on github](https://github.com/espressif/esp-who/issues) if you find a bug or have a feature request, please check existing Issues before opening a new one.
|
|
|
|
* If you're interested in contributing to ESP-WHO, please check the [Contributions Guide](https://esp-idf.readthedocs.io/en/latest/contribute/index.html).
|