Skip to content

Commit c295e45

Browse files
committed
Update README. Add new images
1 parent a373ab4 commit c295e45

14 files changed

+47
-13
lines changed

README.md

Lines changed: 47 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you need to install the application, see the [Installation Section](#installa
2727
* Attach the Artemis target board over USB
2828
* Select the COM port from the dropdown menu
2929
* Adjust the Baud Rate as desired
30-
* Click the ```Upload Firmware``` Button in the lower left of the app.
30+
* Click the ```Upload Firmware``` Button in the lower right corner of the app.
3131

3232
The selected firmware is then uploaded to the connected SparkFun Artemis product. Upload information and progress are displayed in the output portion of the interface.
3333

@@ -52,33 +52,68 @@ Installation binaries are available for all major platforms (macOS, Window, and
5252
* This results in the application executable, *ArtemisUploader.exe*
5353
* Double-click *ArtemisUploader.exe* to start the application
5454

55-
![macOS Artemis Uploader](images/artemis-windows.png)
55+
![Artemis Uploader on Windows](images/artemis-windows.png)
56+
57+
* The Windows EXE isn't signed, so you will see the following warning. Click **More info**:
58+
59+
![Artemis Uploader on Windows - Warning 1](images/artemis-windows-1.png)
60+
61+
* Click **Run anyway** to start the GUI:
62+
63+
![Artemis Uploader on Windows - Warning 2](images/artemis-windows-2.png)
5664

5765
### macOS
66+
67+
* Check that you have the latest WCH drivers installed for the CH340 interface chip.
68+
* Full instructions can be found in our [CH340 Tutorial](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all#mac-osx)
69+
* Here is a link to the WCH downloads page for the [CH340 / CH341 macOS driver](https://www.wch-ic.com/downloads/CH341SER_MAC_ZIP.html)
70+
* The Zip file contains more instructions: CH34X_DRV_INSTAL_INSTRUCTIONS.pdf
71+
5872
* Download the [github release](https://github.com/sparkfun/Artemis-Firmware-Upload-GUI/releases) file - *ArtemisUploader.dmg*
59-
* Double click on the file to unzip the file to *ArtemisUploader.dmg*
60-
* Double click the *ArtemisUploader.dmg* file to mount the disk image.
73+
* Click on the downloads icon
74+
* Click the *ArtemisUploader.dmg* file to mount the disk image
6175
* The following Finder window, with the contents of the file will open
6276

6377
![Artemis Uploader macOS Finder](images/macos-finder.png)
6478

65-
* Install the *ArtemisUploader.app* by dragging it on the *Applications* in the ArtemisUploader Finder Window, or copying the file to a desired location.
66-
* Once complete, unmount the ArtemisUploader disk image by right-clicking on the mounted disk in Finder and ejecting it.
79+
* Install the *ArtemisUploader.app* by dragging it onto the *Applications* icon in the ArtemisUploader Finder Window, or copying the file to a desired location.
80+
* Once complete, unmount the ArtemisUploader disk image by clicking on the disk eject in Finder.
81+
82+
![Artemis Uploader macOS Finder](images/artemis-macos-install-1.png)
6783

6884
To launch the Artemis Uploader application:
85+
6986
* Double-click ArtemisUploader.app to launch the application
70-
* The ArtemisUploader.app isn't signed, so macOS won't run the application, and will display a warning dialog. Dismiss this dialog.
71-
* To approve app execution bring up the macOS *System Preferences* and navigate to: *Security & Privacy > General*.
72-
* On this page, select the *Open Anyway* button to launch the ArtemisUploader application.
7387

88+
![Artemis Uploader macOS Finder](images/artemis-macos-install-2.png)
89+
90+
* The ArtemisUploader.app isn't signed, so macOS won't run the application, and will display a warning dialog. Click **Done**.
91+
92+
![Artemis Uploader macOS Finder](images/artemis-macos-install-3.png)
7493

75-
![macOS Security](images/macos-security.png)
94+
* To approve app execution bring up the macOS *System Settings* and navigate to *Privacy & Security*.
95+
* On this page, select the **Open Anyway** button to launch the ArtemisUploader application.
7696

77-
* Once selected, macOS will present one last dialog. Select *Open* to run the application. The ArtemisUploader will now start.
97+
![Artemis Uploader macOS System Settings](images/artemis-macos-install-4.png)
7898

79-
![macOS Artemis Uploader](images/artemis-macos.png)
99+
* Once selected, macOS will present one last dialog. Select **Open Anyway** to run the application.
100+
101+
![Artemis Uploader macOS System Settings](images/artemis-macos-install-5.png)
102+
103+
* Enter your password and click The ArtemisUploader will now start.
104+
105+
![Artemis Uploader macOS System Settings](images/artemis-macos-install-6.png)
106+
107+
* Ensure you select the correct *COM Port*. The port name should begin with **cu.wchusbserial**.
108+
109+
![macOS Artemis Uploader](images/artemis-macos-1.png)
110+
111+
* When you select the *Firmware File*, click **Allow** to allow the app to open the file.
112+
113+
![macOS Artemis Uploader](images/artemis-macos-2.png)
80114

81115
### Linux
116+
82117
* Download the [github release](https://github.com/sparkfun/Artemis-Firmware-Upload-GUI/releases) file - *ArtemisUploader.linux.gz*
83118
* Unzip the release file - *ArtemisUploader.linux.gz*
84119
* Un-gzip the file, either by double-clicking in on the desktop, or using the `gunzip` command in a terminal window. This results in the file *ArtemisUploader*
@@ -87,7 +122,6 @@ To launch the Artemis Uploader application:
87122

88123
![Linux Artemis Uploader](images/artemis-linux.png)
89124

90-
91125
### Python Package
92126
The Artemis Uploader App is also provided as an installable Python package. This is advantageous for platforms that lack a pre-compiled application.
93127

images/artemis-macos-1.png

108 KB
Loading

images/artemis-macos-2.png

108 KB
Loading

images/artemis-macos-install-1.png

73.7 KB
Loading

images/artemis-macos-install-2.png

218 KB
Loading

images/artemis-macos-install-3.png

213 KB
Loading

images/artemis-macos-install-4.png

190 KB
Loading

images/artemis-macos-install-5.png

251 KB
Loading

images/artemis-macos-install-6.png

237 KB
Loading

images/artemis-macos.png

-133 KB
Binary file not shown.

images/artemis-windows-1.png

450 Bytes
Loading

images/artemis-windows-2.png

477 Bytes
Loading

images/artemis-windows.png

-23 KB
Loading

images/macos-security.png

-242 KB
Binary file not shown.

0 commit comments

Comments
 (0)