Skip to content

A cross-platform GUI for uploading new firmware to an Artemis based device.

License

Notifications You must be signed in to change notification settings

sparkfun/Artemis-Firmware-Upload-GUI

Repository files navigation

SparkFun Artemis Uploader App

follow on Twitter

macOS Artemis Uploader

The Artemis Uploader App is a simple, easy to use method for updating the firmware and bootloader on SparkFun Artemis based products. Available on all major platforms, as well as a Python package, the Artemis Uploader App simplifies working with SparkFun Artemis.

If you need to install the application, see the Installation Section of this page.

Using the Artemis Uploader

Upload Firmware

  • Click Browse and select the firmware file you'd like to upload (should end in .bin)
  • Attach the Artemis target board over USB
  • Select the COM port from the dropdown menu
  • Adjust the Baud Rate as desired
  • Click the Upload Firmware Button in the lower left of the app.

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.

Firmware Upload

Update Bootloader

Clicking the Update Bootloader button on the lower left of the application will erase all firmware on the Artemis and load the latest bootloader firmware. This is helpful when SparkFun releases updates to the SVL.

Bootloader Upload

Note: the bootloader update sometimes fails to start correctly. You may need to repeat the update more than once until it succeeds.

Installation

Installation binaries are available for all major platforms (macOS, Window, and Linux) on the release page of the Artemis Uploader App github repository.

Artemis Uploader Release Page

Windows

  • Download the github release zip file - ArtemisUploader.win.zip
  • Unzip the release file - ArtemisUploader.zip
  • This results in the application executable, ArtemisUploader.exe
  • Double-click ArtemisUploader.exe to start the application

macOS Artemis Uploader

macOS

  • Download the github release file - ArtemisUploader.dmg
  • Double click on the file to unzip the file to ArtemisUploader.dmg
  • Double click the ArtemisUploader.dmg file to mount the disk image.
  • The following Finder window, with the contents of the file will open

Artemis Uploader macOS Finder

  • Install the ArtemisUploader.app by dragging it on the Applications in the ArtemisUploader Finder Window, or copying the file to a desired location.
  • Once complete, unmount the ArtemisUploader disk image by right-clicking on the mounted disk in Finder and ejecting it.

To launch the Artemis Uploader application:

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

macOS Security

  • Once selected, macOS will present one last dialog. Select Open to run the application. The ArtemisUploader will now start.

macOS Artemis Uploader

Linux

  • Download the github release file - ArtemisUploader.linux.gz
  • Unzip the release file - ArtemisUploader.linux.gz
  • 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
  • To run the application, the file must have execute permission. This is performed by selecting Properties from the file right-click menu, and then selecting permissions. You can also change permissions using the chmod command in a terminal window.
  • Once the application has execute permission, you can start the application a terminal window. Change directory's to the application location and issue ./ArtemisUploader

Linux Artemis Uploader

Python Package

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

To install the Python package:

  • Download the package file - artemis_uploader-3.0.0.tar.gz (note - the version number might vary)

At a command line - issue the package install command:

  • pip install artemis_uploader-3.0.0.tar.gz
  • Once installed, you can start the Artemis Uploader App by issuing the command ./artemis_upload at the command line. (To see the command, you might need to start a new terminal, or issue a command like rehash depending on your platform/shell)

Notes:

  • A path might be needed to specify the install file location.
  • Depending on your platform, this command might need to be run as admin/root.
  • Depending on your system, you might need to use the command pip3

The uploader is uninstalled by issuing this pip command:

  • pip uninstall artemis-uploader

Raspberry Pi

We've tested the GUI on 64-bit Raspberry Pi Debian. You will need to use the Python Package to install it.

Notes:

  • On 32-bit Raspberry Pi, with both Python 2 and Python 3 installed, use sudo pip3 install artemis_uploader-3.0.0.tar.gz
  • On 64-bit Raspberry Pi, use sudo pip install artemis_uploader-3.0.0.tar.gz
  • By default, the executable will be placed in /usr/local/bin
  • The sudo is required to let setup.py install python3-pyqt5 and python3-pyqt5.qtserialport using sudo apt-get install

Example Firmware

In the applications github repo, an example Blink.bin firmware file is included in the repo. This firmware will cause these LEDs to blink at 1Hz: