aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ed29e87c14d2f4359ef596535d6609d246d595fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

iot-onair-sign

ESP32 firmware project for an on-air sign controlled from a smartphone over BLE.

Dependencies

Required tools: - esp-idf (v5.x+) - direnv

Note: ESP-IDF provides the required build toolchain (including CMake, Ninja, and compiler tools), so these do not need separate system installation.

This repo includes a .envrc file that loads ESP-IDF for this project only.

  1. Install and enable direnv in your shell.
  2. From the project root, allow the environment once:
direnv allow

After that, entering this directory will automatically load ESP-IDF variables.

Build

  1. Enter the project directory (direnv will auto-load the environment).
  2. Set the target (first time only):
idf.py set-target esp32
  1. Build:
idf.py build

Flash and monitor

idf.py -p /dev/ttyUSB0 flash monitor

(Adjust serial port as needed.)

Run unit tests (host)

cmake -S host_tests -B build_host_tests
cmake --build build_host_tests
ctest --test-dir build_host_tests --output-on-failure