Skip to content

update READMEs and make targets consistent #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZeroChaos- merged 1 commit into from
Jul 4, 2026
Merged

update READMEs and make targets consistent #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ RF CTF Fox code


|Hardware |Bluetooth iBeacon |Bluetooth Classic Discoverable |Wifi AP |Client |
|------------------- | :---------: | :------: | :---------------------------: | :-----: |
|------------------- | :---------: | :------: | :-----: | :-----: |
|M5Stack Atom-lite |✅|✅|✅|✅|
|M5Stack AtomS3-lite |✅|❌|✅|✅|
|M5Stack StampS3 |✅|❌|✅|✅|
|Arduino Nano ESP32 |✅|❌|✅|❌|
|Seeed XIAO ESP32C5 |❌|❌|✅|❌||
|Seeed XIAO ESP32C5 |❌|❌|✅|❌|

We will accept PRs to extend support to other platformio supported hardware.

Expand Down
46 changes: 7 additions & 39 deletions bluetooth/classic_discoverable/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,55 +6,23 @@ Difficulty levels are defined as PlatformIO Environments:
$ platformio run --list-targets
Environment Group Name Title Description
------------- -------- ----------- --------------------------- ----------------------
m5atom-easy Platform buildfs Build Filesystem Image
m5atom-easy Platform erase Erase Flash
m5atom-easy Platform size Program Size Calculate program size
m5atom-easy Platform upload Upload
m5atom-easy Platform uploadfs Upload Filesystem Image
m5atom-easy Platform uploadfsota Upload Filesystem Image OTA
m5atom-hard Platform buildfs Build Filesystem Image
m5atom-hard Platform erase Erase Flash
m5atom-hard Platform size Program Size Calculate program size
m5atom-hard Platform upload Upload
m5atom-hard Platform uploadfs Upload Filesystem Image
m5atom-hard Platform uploadfsota Upload Filesystem Image OTA
m5atoms3-easy Platform buildfs Build Filesystem Image
m5atoms3-easy Platform erase Erase Flash
m5atoms3-easy Platform size Program Size Calculate program size
m5atoms3-easy Platform upload Upload
m5atoms3-easy Platform uploadfs Upload Filesystem Image
m5atoms3-easy Platform uploadfsota Upload Filesystem Image OTA
m5atoms3-hard Platform buildfs Build Filesystem Image
m5atoms3-hard Platform erase Erase Flash
m5atoms3-hard Platform size Program Size Calculate program size
m5atoms3-hard Platform upload Upload
m5atoms3-hard Platform uploadfs Upload Filesystem Image
m5atoms3-hard Platform uploadfsota Upload Filesystem Image OTA
m5stamps3-easy Platform buildfs Build Filesystem Image
m5stamps3-easy Platform erase Erase Flash
m5stamps3-easy Platform size Program Size Calculate program size
m5stamps3-easy Platform upload Upload
m5stamps3-easy Platform uploadfs Upload Filesystem Image
m5stamps3-easy Platform uploadfsota Upload Filesystem Image OTA
m5stamps3-hard Platform buildfs Build Filesystem Image
m5stamps3-hard Platform erase Erase Flash
m5stamps3-hard Platform size Program Size Calculate program size
m5stamps3-hard Platform upload Upload
m5stamps3-hard Platform uploadfs Upload Filesystem Image
m5stamps3-hard Platform uploadfsota Upload Filesystem Image OTA
m5atom-easy Platform upload Upload
m5atom-hard Platform upload Upload
```

|Hardware |Supported |Tested |Serial console during sleep |
|------------------- | :---------: | :------: | :---------------------------: |
|------------------- | :---------: | :------: | :-------: |
|M5Stack Atom-lite |✅|✅|✅|
|M5Stack AtomS3-lite |❌|✅|❌|
|M5Stack StampS3 |❌|✅|❌|
|Arduino Nano ESP32 |❌|✅|❌|
|Seeed XIAO ESP32C5 |❌|✅|❌|

To use:
- [Install PlatformIO](https://platformio.org/install/cli)
- Create a conference specific file header file e.g. `src/defcon31.h` and symlink it to `src/current_conf.h`
- Modify variables in your conference specific file e.g. ['src/conferences/defcon31.h](./src/conferences/defcon31.h) for each of the difficulty levels
- Select your difficulty level with the `-e` argument to `platformio run`, options are [easy, hard]
- **Note:** You can specify a target device serial port with argument `--upload-port` to avoid automatic detection.
- For example, to build and upload Easy: `platformio run -e BOARDNAME-easy --target upload`
- **Note:** To build without upload execute `platformio run -e BOARDNAME-easy`
- For example, to build and upload Easy: `platformio run -e m5atom-easy --target upload`
- **Note:** To build without upload execute `platformio run -e m5atom-easy`
37 changes: 19 additions & 18 deletions bluetooth/iBeacon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,27 @@ Target hardware and difficulty levels are defined as PlatformIO Environments:
$ platformio run --list-targets
Environment Group Name Title
------------------------- -------- ------------- -------------------------------------------
arduino_nano_esp32-easy Platform upload Upload
arduino_nano_esp32-hard Platform upload Upload
arduino_nano_esp32-medium Platform upload Upload
m5atom-easy Platform upload Upload
m5atom-hard Platform upload Upload
m5atom-medium Platform upload Upload
m5atoms3-easy Platform upload Upload
m5atoms3-hard Platform upload Upload
m5atoms3-medium Platform upload Upload
m5stamps3-easy Platform upload Upload
m5stamps3-hard Platform upload Upload
m5stamps3-medium Platform upload Upload
arduino-nano-esp32-easy Platform upload Upload
arduino-nano-esp32-hard Platform upload Upload
arduino-nano-esp32-medium Platform upload Upload
m5atom-easy Platform upload Upload
m5atom-hard Platform upload Upload
m5atom-medium Platform upload Upload
m5atoms3-easy Platform upload Upload
m5atoms3-hard Platform upload Upload
m5atoms3-medium Platform upload Upload
m5stamps3-easy Platform upload Upload
m5stamps3-hard Platform upload Upload
m5stamps3-medium Platform upload Upload
```

|Hardware |Supported |Correct MAC Address | Tested |Serial console during sleep |
| :-------------------: | :---------: | :-------------------: | :------: | :---------------------------: |
|M5Stack Atom-lite |✅|✅|✅|✅|
|M5Stack AtomS3-lite |✅|✅|✅|❌|
|M5Stack StampS3 |✅|✅|✅|❌|
|Arduino Nano ESP32 |✅|✅|✅|❌|
|Hardware |Supported | Tested |Serial console during sleep |
| :-------------------: | :-------------------: | :------: | :---------------------------: |
|M5Stack Atom-lite |✅|✅|✅|
|M5Stack AtomS3-lite |✅|✅|❌|
|M5Stack StampS3 |✅|✅|❌|
|Arduino Nano ESP32 |✅|✅|❌|
|Seeed XIAO ESP32C5 |❌|✅|❌|

To use:
- [Install PlatformIO](https://platformio.org/install/cli)
Expand Down
6 changes: 3 additions & 3 deletions bluetooth/iBeacon/platformio.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ build_flags = ${m5stamps3.board_flags} ${difficulty.medium}
extends = m5stamps3
build_flags = ${m5stamps3.board_flags} ${difficulty.hard}

[env:arduino_nano_esp32-easy]
[env:arduino-nano-esp32-easy]
extends = arduino_nano_esp32
build_flags = ${arduino_nano_esp32.board_flags} ${difficulty.easy}
[env:arduino_nano_esp32-medium]
[env:arduino-nano-esp32-medium]
extends = arduino_nano_esp32
build_flags = ${arduino_nano_esp32.board_flags} ${difficulty.medium}
[env:arduino_nano_esp32-hard]
[env:arduino-nano-esp32-hard]
extends = arduino_nano_esp32
build_flags = ${arduino_nano_esp32.board_flags} ${difficulty.hard}
92 changes: 19 additions & 73 deletions wifi/wifi_ap_client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,78 +6,24 @@ Difficulty levels are defined as PlatformIO Environments:
$ platformio run --list-targets
Environment Group Name Title Description
------------- -------- ----------- --------------------------- ----------------------
m5atom-easy-ap Platform buildfs Build Filesystem Image
m5atom-easy-ap Platform erase Erase Flash
m5atom-easy-ap Platform size Program Size Calculate program size
m5atom-easy-ap Platform upload Upload
m5atom-easy-ap Platform uploadfs Upload Filesystem Image
m5atom-easy-ap Platform uploadfsota Upload Filesystem Image OTA
m5atom-easy-client Platform buildfs Build Filesystem Image
m5atom-easy-client Platform erase Erase Flash
m5atom-easy-client Platform size Program Size Calculate program size
m5atom-easy-client Platform upload Upload
m5atom-easy-client Platform uploadfs Upload Filesystem Image
m5atom-easy-client Platform uploadfsota Upload Filesystem Image OTA
m5atom-hard-ap Platform buildfs Build Filesystem Image
m5atom-hard-ap Platform erase Erase Flash
m5atom-hard-ap Platform size Program Size Calculate program size
m5atom-hard-ap Platform upload Upload
m5atom-hard-ap Platform uploadfs Upload Filesystem Image
m5atom-hard-ap Platform uploadfsota Upload Filesystem Image OTA
m5atom-hard-client Platform buildfs Build Filesystem Image
m5atom-hard-client Platform erase Erase Flash
m5atom-hard-client Platform size Program Size Calculate program size
m5atom-hard-client Platform upload Upload
m5atom-hard-client Platform uploadfs Upload Filesystem Image
m5atom-hard-client Platform uploadfsota Upload Filesystem Image OTA
m5atoms3-easy-ap Platform buildfs Build Filesystem Image
m5atoms3-easy-ap Platform erase Erase Flash
m5atoms3-easy-ap Platform size Program Size Calculate program size
m5atoms3-easy-ap Platform upload Upload
m5atoms3-easy-ap Platform uploadfs Upload Filesystem Image
m5atoms3-easy-ap Platform uploadfsota Upload Filesystem Image OTA
m5atoms3-easy-client Platform buildfs Build Filesystem Image
m5atoms3-easy-client Platform erase Erase Flash
m5atoms3-easy-client Platform size Program Size Calculate program size
m5atoms3-easy-client Platform upload Upload
m5atoms3-easy-client Platform uploadfs Upload Filesystem Image
m5atoms3-easy-client Platform uploadfsota Upload Filesystem Image OTA
m5atoms3-hard-ap Platform buildfs Build Filesystem Image
m5atoms3-hard-ap Platform erase Erase Flash
m5atoms3-hard-ap Platform size Program Size Calculate program size
m5atoms3-hard-ap Platform upload Upload
m5atoms3-hard-ap Platform uploadfs Upload Filesystem Image
m5atoms3-hard-ap Platform uploadfsota Upload Filesystem Image OTA
m5atoms3-hard-client Platform buildfs Build Filesystem Image
m5atoms3-hard-client Platform erase Erase Flash
m5atoms3-hard-client Platform size Program Size Calculate program size
m5atoms3-hard-client Platform upload Upload
m5atoms3-hard-client Platform uploadfs Upload Filesystem Image
m5atoms3-hard-client Platform uploadfsota Upload Filesystem Image OTA
m5stamps3-easy-ap Platform buildfs Build Filesystem Image
m5stamps3-easy-ap Platform erase Erase Flash
m5stamps3-easy-ap Platform size Program Size Calculate program size
m5stamps3-easy-ap Platform upload Upload
m5stamps3-easy-ap Platform uploadfs Upload Filesystem Image
m5stamps3-easy-ap Platform uploadfsota Upload Filesystem Image OTA
m5stamps3-easy-client Platform buildfs Build Filesystem Image
m5stamps3-easy-client Platform erase Erase Flash
m5stamps3-easy-client Platform size Program Size Calculate program size
m5stamps3-easy-client Platform upload Upload
m5stamps3-easy-client Platform uploadfs Upload Filesystem Image
m5stamps3-easy-client Platform uploadfsota Upload Filesystem Image OTA
m5stamps3-hard-ap Platform buildfs Build Filesystem Image
m5stamps3-hard-ap Platform erase Erase Flash
m5stamps3-hard-ap Platform size Program Size Calculate program size
m5stamps3-hard-ap Platform upload Upload
m5stamps3-hard-ap Platform uploadfs Upload Filesystem Image
m5stamps3-hard-ap Platform uploadfsota Upload Filesystem Image OTA
m5stamps3-hard-client Platform buildfs Build Filesystem Image
m5stamps3-hard-client Platform erase Erase Flash
m5stamps3-hard-client Platform size Program Size Calculate program size
m5stamps3-hard-client Platform upload Upload
m5stamps3-hard-client Platform uploadfs Upload Filesystem Image
m5stamps3-hard-client Platform uploadfsota Upload Filesystem Image OTA
arduino-nano-esp32-easy-ap Platform upload Upload
arduino-nano-esp32-hard-ap Platform upload Upload
m5atom-easy-ap Platform upload Upload
m5atom-easy-client Platform upload Upload
m5atom-hard-ap Platform upload Upload
m5atom-hard-client Platform upload Upload
m5atoms3-easy-ap Platform upload Upload
m5atoms3-easy-client Platform upload Upload
m5atoms3-hard-ap Platform upload Upload
m5atoms3-hard-client Platform upload Upload
m5stamps3-easy-ap Platform upload Upload
m5stamps3-easy-client Platform upload Upload
m5stamps3-hard-ap Platform upload Upload
m5stamps3-hard-client Platform upload Upload
seeed-xiao-esp32c5-easy-ap Platform upload Upload
seeed-xiao-esp32c5-fiveeasy-ap Platform upload Upload
seeed-xiao-esp32c5-fivehard-ap Platform upload Upload
seeed-xiao-esp32c5-hard-ap Platform upload Upload
```

|Hardware |AP |client |Serial console during sleep |
Expand All @@ -86,7 +32,7 @@ m5stamps3-hard-client Platform uploadfsota Upload Filesystem Image OTA
|M5Stack AtomS3-lite |✅|✅|❌|
|M5Stack StampS3 |✅|✅|❌|
|Ardunio Nano ESP32 |✅|❌|❌|
|Seeed Xiao ESP32C5 |✅|❌||❌|
|Seeed Xiao ESP32C5 |✅|❌|❌|

To use:
- [Install PlatformIO](https://platformio.org/install/cli)
Expand Down
8 changes: 4 additions & 4 deletions wifi/wifi_ap_client/platformio.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,16 @@ extends = m5atom
build_flags = ${difficulty.hard} ${mode.client}

; Client mode gets the wrong mac address, not sure why
[env:arduino_nano_esp32-easy-ap]
[env:arduino-nano-esp32-easy-ap]
extends = arduino_nano_esp32
build_flags = ${difficulty.easy} ${mode.ap} ${arduino_nano_esp32.board_flags}
;[env:arduino_nano_esp32-easy-client]
;[env:arduino-nano-esp32-easy-client]
;extends = arduino_nano_esp32
;build_flags = ${difficulty.easy} ${mode.client} ${arduino_nano_esp32.board_flags}
[env:arduino_nano_esp32-hard-ap]
[env:arduino-nano-esp32-hard-ap]
extends = arduino_nano_esp32
build_flags = ${difficulty.hard} ${mode.ap} ${arduino_nano_esp32.board_flags}
;[env:arduino_nano_esp32-hard-client]
;[env:arduino-nano-esp32-hard-client]
;extends = arduino_nano_esp32
;build_flags = ${difficulty.hard} ${mode.client} ${arduino_nano_esp32.board_flags}

Expand Down