- Notifications
You must be signed in to change notification settings - Fork 166
PlatformIO
Prerequisites: PlatformIO CLI
-
Open your terminal or command line interface and navigate to your root project directory
-
Upload the example firmware using the following command template:
EXAMPLE_DIR=[RELATIVE_EXAMPLE_PATH] platformio run -e [BOARD_ENVIRONMENT] -t uploadThe
-eflag allows you to pass the desired board environment. The-tflag is to pass in the task to execute, in this caseupload(default isbuild)Relative Paths for the Examples Included in the CDP:
Basic-Ducks/DuckLink Basic-Ducks/MamaDuck Basic-Ducks/PapaDuck Basic-Ducks/DetectorDuck Custom-Mama-Examples/Custom-Mama-Example Custom-Papa-Examples/AWS-PapaDuckIf you don't supply an
EXAMPLE_DIR=argument, it will default toBasic-Ducks/MamaDuckOfficially Supported Board Environments for the CDP:
Board names prefixed withlocal_will use your local version of the ClusterDuck Protocol. If you do not need to make any changes to the protocol, you should be usingprod_.prod_heltec_wifi_lora_32_V2 local_heltec_wifi_lora_32_V2 prod_heltec_wifi_lora_32_V3 local_heltec_wifi_lora_32_V3 prod_lilygo_t_beam_sx1276 local_lilygo_t_beam_sx1276 prod_lilygo_t_beam_sx1262 local_lilygo_t_beam_sx1262 prod_ttgo_lora32_v1_3 test_ttgo_lora32_v1_3For example, if you want to run the example DuckLink firmware using a Lilygo T-Beam with the sx1276 LoRa chip and production CDP, you would run this command:
EXAMPLE_DIR=Basic-Ducks/DuckLink platformio run -e prod_lilygo_t_beam_sx1276 -t uploadIf you are flashing from Windows, you may need to run the commands separately as below instead:
$env:EXAMPLE_DIR=Basic-Ducks/DuckLink platformio run -e prod_lilygo_t_beam_sx1276 -t upload -
If the upload was successful, you can view the serial log using this command:
platformio device monitor
ClusterDuck Protocol 2020-2024 https://www.clusterduckprotocol.org
