Skip to content

Commit 4583246

Browse files
committed
[MP1] Append sketch name to run_arduino helper script
Signed-off-by: Frederic Pillon <[email protected]>
1 parent 4c99297 commit 4583246

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

platform.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,4 +209,4 @@ tools.remoteproc_gen.busybox.windows={path}/win/busybox.exe
209209
tools.remoteproc_gen.script=run_arduino_gen.sh
210210
tools.remoteproc_gen.upload.params.verbose=
211211
tools.remoteproc_gen.upload.params.quiet=
212-
tools.remoteproc_gen.upload.pattern="{busybox}" sh "{path}/{script}" generate "{build.path}/{build.project_name}.elf" "{build.path}/run_arduino.sh"
212+
tools.remoteproc_gen.upload.pattern="{busybox}" sh "{path}/{script}" generate "{build.path}/{build.project_name}.elf" "{build.path}/run_arduino_{build.project_name}.sh"

variants/STM32MP157_DK/README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -19,43 +19,43 @@ __Note that the first two OSes should select `stm32mp157c-dk2-m4-examples-sdcard
1919

2020
After Verify and Upload, you will see a message similar to the following in Arduino IDE:
2121

22-
<Arduino build output path>/run_arduino.sh generated successfully.
22+
<Arduino build output path>/run_arduino_<sketch name>.sh generated successfully.
2323
This file should be uploaded manually by SCP, SFTP, Kermit, or etc.
24-
Then run "sh ./run_arduino.sh start" command in the board's console.
24+
Then run "sh ./run_arduino_<sketch name>.sh start" command in the board's console.
2525
For detailed instructions, please visit:
2626
https://github.com/stm32duino/Arduino_Core_STM32/tree/master/variants/STM32MP157_DK/README.md
2727

28-
In this example, the user **must** upload `<Arduino build output path>/run_arduino.sh` file manually. Uploading instruction is described later in the [Uploading](#Uploading) section.
28+
In this example, the user **must** upload `<Arduino build output path>/run_arduino_<sketch name>.sh` file manually. Uploading instruction is described later in the [Uploading](#Uploading) section.
2929

30-
After uploading the user can use `sh run_arduino.sh start` in the console of host Linux via either SSH or Serial Console, to run the Arduino firmware.
30+
After uploading the user can use `sh run_arduino_<sketch name>.sh start` in the console of host Linux via either SSH or Serial Console, to run the Arduino firmware.
3131

32-
Note: `sh run_arduino.sh start` is a one-shot command: the Arduino firmware only runs for the current boot. If you want to make it run after reboot, you need to use `sh run_arduino.sh install` command.
32+
Note: `sh run_arduino_<sketch name>.sh start` is a one-shot command: the Arduino firmware only runs for the current boot. If you want to make it run after reboot, you need to use `sh run_arduino_<sketch name>.sh install` command.
3333

34-
`run_arduino.sh` help page summary:
34+
`run_arduino_<sketch name>.sh` help page summary:
3535

36-
Usage: sh run_arduino.sh [start|stop|restart|generate|install|uninstall]
36+
Usage: sh run_arduino_<sketch name>.sh [start|stop|restart|generate|install|uninstall]
3737

38-
run_arduino.sh is a helper script that helps managing an Arduino binary
38+
run_arduino_<sketch name>.sh is a helper script that helps managing an Arduino binary
3939
file for the coprocessor using remoteproc framework.
4040

41-
sh run_arduino.sh start
41+
sh run_arduino_<sketch name>.sh start
4242
Upload the binary to the coprocessor then start it.
4343
This command must be executed while the script contains the binary
4444
after generate command is run.
4545

46-
sh run_arduino.sh install
46+
sh run_arduino_<sketch name>.sh install
4747
Run the binary on boot automatically by installing a systemd service.
4848

49-
sh run_arduino.sh uninstall
49+
sh run_arduino_<sketch name>.sh uninstall
5050
Uninstall the autostart service.
5151

52-
sh run_arduino.sh stop
52+
sh run_arduino_<sketch name>.sh stop
5353
Stop the coprocessor.
5454

55-
sh run_arduino.sh restart
55+
sh run_arduino_<sketch name>.sh restart
5656
Restart the coprocessor.
5757

58-
See the source code for the full help page and the more details about [run_arduino.sh].
58+
See the source code for the full help page and the more details about [run_arduino_<sketch name>.sh].
5959

6060
## Pin mapping
6161

@@ -96,7 +96,7 @@ There are additional pins for LEDs and buttons.
9696

9797
## Uploading
9898

99-
As mentioned above `run_arduino.sh` file have to be uploaded manually from the PC to the board's Linux file system in order to be executed on the board directly through the board's Linux console. There are many ways to upload the file.
99+
As mentioned above `run_arduino_<sketch name>.sh` file have to be uploaded manually from the PC to the board's Linux file system in order to be executed on the board directly through the board's Linux console. There are many ways to upload the file.
100100

101101
### Over Network
102102

@@ -152,7 +152,7 @@ And then the Device Tree should enable TIM1 for the coprocessor, although this d
152152
[Balena OS]: https://github.com/kbumsik/balena-st-stm32mp
153153
[ST Wiki page on boot mode]: https://wiki.st.com/stm32mpu/wiki/STM32CubeMP1_Package#Getting_started_with_STM32CubeMP1_Package
154154

155-
[run_arduino.sh]: https://github.com/stm32duino/Arduino_Tools/blob/master/linux/run_arduino_gen.sh
155+
[run_arduino_<sketch name>.sh]: https://github.com/stm32duino/Arduino_Tools/blob/master/linux/run_arduino_gen.sh
156156

157157
[The ST Wiki page on C-Kermit]: https://wiki.st.com/stm32mpu/wiki/How_to_transfer_a_file_over_serial_console
158158
[a bug in OpenSTLinux]: https://community.st.com/s/question/0D50X0000B9vHa4/cannot-get-download-a-file-using-kermit

0 commit comments

Comments
 (0)