microReticulumTbeam/exercises/README.md

88 lines
4 KiB
Markdown
Raw Normal View History

## Buttons
There are three buttons
![T-Beam SUPREME](../img/20260212_182225_Thu.png)
![](../img/20260212_182300_Thu.png)
Listed in order from Antenna to USB port:
1) RESET
2) POWER
3) BOOT
![](../img/20260212_184521_Thu.png)
## RESET
The RESET button only needs to be depressed for less than 1 second. Doing so will cause the unit to reboot. If you have a "screen" monitor on the USB device, it will be disconnected. A good way to capture boot posting messages from within the unit is to have your command in a console ready to execute by depressing the RETURN key and you depress RETURN immediately after you depress the unit's RESET button, possibly allowing 1/2 second to allow kernel to recognize the new USB device, i.e. /dev/ttyACM0
## POWER
If your unit is powered OFF, simply depress the POWER button will start the unit. If the unit is powered ON, then depressing the POWER button and holding it down for 6 second will cause the unit to power down. The OLED display will go dark when the unit has successfully been powered down.
## BOOT
A) TODO: what happens when unit is powered ON and you depress BOOT?
B) TODO: what happens when unit is powered OFF and you depress BOOT?
C) To upload new binary image: depress the BOOT button and hold down, then while holding down the BOOT button disconnect the USB line and then reconnect the USB line and then lift up on the BOOT button. This sequence will cause the unit to await an upload of an image over USB to be stored in its FLASH memory. You can place the unit in this mode and then several minutes later perform the upload from your console, the unit will duly await an upload session. See further how to flash a new image in the section "Flashing Binary". Note: although the uploader may state it is trying to reset after successful installation of the new image, it seems that software attempt does not work and you have to manually depress the unit's RESET button to force a RESET. Remember, if you want to see the boot's posting, you should have your terminal ready to run "screen" so you capture the initial postings after you click RESET.
# Button Protocol For Uploading New Image
Pushing BOOT when the unit is currently running will not do anything. You have to shut the unit down first. So:
1) Depress POWER button for 6 seconds
2) Depress BOOT button and while depressed, click RESET button
3) Lift up BOOT button
The unit is now waiting for the serial console so commence an upload. You are not time restricted, so you can go through the above 3 steps and then 5 minutes later proceed with an upload in the command console.
# Exercises
These are progressve tests you can run to confirm how to access the unit's functionality and validate your workbench. Each exercise has it's own README.md
Exercise 00: 00_usb_radio_check
Exercise 01: ASCII ping-pong over LoRa (serial only). Using two units, each sends a message to the other and you monitor both units through two screen consoles.
Exercise 02: Add OLED display
Exercise 03: Add SD logging
Exercise 04: Replace ASCII payload with microR packets
Exercise 05: SD provisioning with identity.bin, peer list, beacon
Each exercise is self-contained:
its own platformio.ini
its own src/main.cpp
its own README.md with exact commands
To clean:
pio run -t clean
Nuclear option:
rm -rf .pio
Rebuild:
pio run -e node_a
pio run -e node_b
## Upload existing firmware (will not recompile if unchanged)
### Upload node A (set your port)
pio run -e node_a -t upload --upload-port /dev/ttyACM0
### Upload node B
pio run -e node_b -t upload --upload-port /dev/ttyACM1
To monitor both:
screen /dev/ttyACM0 115200
screen /dev/ttyACM1 115200
Attach antennas (transmitting without antenna will cause power feedback and likely destroy your circuits)
Keep boards at least ~30 cm apart so you dont desense the receivers.
shared board pin headers in one place:
shared/
boards/
tbeam-s3-core_pins.h
# Features
## SD Card
You can read and write to SD cards that are FAT formatted. (Can they be Linux formatted?)
## Real Time Clock ("RTC")
## Microphone