annotate wiki/Make Firmware File.md @ 589:8d95bab5bf6a

Minor: Update the documentation for building the code
author heinrichsweikamp
date Thu, 17 Dec 2020 10:58:28 +0100
parents 0e7c16dd774d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
489
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
1 # How to Make an Uploadable Firmware File for the OSTC4 #
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
2
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
3 Generated BIN files from the SMT32 Workbench need modification in order to be installed via the OSTC Companion onto the OSTC4.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
4
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
5 ## Build Command Line Tools ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
6
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
7 These can be found in /ostc4pack (For Windows, CPP sources available)
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
8
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
9 ## Run the Tools Manually ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
10
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
11 1. Copy generated BIN files (From the Release or debug directory) into /ostc4pack. Or: Modify .bat files to point to your Release or debug directory.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
12 2. run step1_create_OSTC_RTE_upload.bat and/or step1_create_OSTC4_firmware_upload_bin.bat (Depending on which part you made changes)
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
13 3. run step2_create_OSTC4update_bin.bat to create final OSTC4update_xxxxxx.bin, with xxxxxx being the current date in YYMMDD format. This will add important checksums required for the OSTC4's bootloader to accept the file.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
14
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
15 ## Upload this file with the OSTC Companion software to the OSTC4 ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
16
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
17 See http://forum.heinrichsweikamp.com/read.php?7,19186 on how to get and use the "OSTC companion"