Difference between revisions of "TiLDA MK3/Firmware Update"

Latest revision as of 13:36, 2 September 2018

Update your Tilda Mk3

This guide will help you to update your Tilda Mk3 badge. Be careful, following these instructions will delete all files and setting on your badge, so make sure you have copies of everything!

If you're having trouble following these instructions or updating your badge, please get in touch and we'll do our best to help.

Before you start

You need to put your badge into DFU mode. This activates a USB bootloader stored in ROM on the STM32 processor.

To enter DFU mode: Switch on the badge. Press the center joystick button while at the same time quickly pushing the reset button on the back of the badge.

In some cases this seems to require a few attempts. You can also try unplugging the battery, and holding down the center button while plugging in USB.

OSX

Prerequisites needed for Mac OS X

1. XCode (from App Store)

2. Python & pip

Homebrew method
1. Install Homebrew and Pip

2. brew install libusb lsusb

3. pip install libusb1 pyusb
MacPorts method
1. Install MacPorts and Pip

2. sudo port install usbutils py-pip
usbutils provides e.g. lsusb, useful for knowing if the badge is connected in DFU mode

3. sudo pip install libusb1 pyusb

3. Check that you're connected in DFU mode:

lsusb

Should output something like:

Bus 020 Device 002: ID 0483:df11 STMicroelectronics STM Device in DFU Mode

4. wget https://update.badge.emfcamp.org/update.py

5. sudo python update.py

6. To get a shell: screen /dev/tty.usbmodem*

Troubleshooting

If you get the error Error: No backend available then python cannot find the USB library. Please Repeat steps 2 and 3 above, see https://github.com/walac/pyusb/issues/120 for more details.

Linux

Install prerequisites if required:

sudo apt install python-usb

Open a terminal and execute this line:

curl --silent --show-error --retry 5 https://update.badge.emfcamp.org/update.py | python

If you get an error saying ImportError: No module named core then the python-usb package in your distribution is too old. On Debian, you should be able to fix it using pip instead:

sudo apt install python-pip

sudo pip install --upgrade pyusb

Windows

WARNING: There have been reports of badges being bricked when flashed from windows. They can be recovered using the OSX/Linux update procedure. We are looking for alternative ways of updating using Windows.

On a Windows PC, you will need to download the STMicroelectronics DfuSe USB device firmware updater software http://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-programmers/stsw-stm32080.html and use the 'Upgrade or Verify Action' part of the GUI to update the firmware instead.

Install the STMMicroelectronics utility from the link above.
Download the firmware.dfu file from https://update.badge.emfcamp.org/firmware.dfu and save it.
With the badge plugged into the computer, hold the centre joystick button and press reset. The badge should now boot into the bootloader, and be detected as a 'STM Device in DFU Mode'.
Start up DfuSeDemo.exe, and click the 'Choose' button - select the firmware.dfu file and then hit 'Upgrade'
Your firmware will now be updated.

Other Operating systems

To update your badge please download the following script and run it via python: update.py

If you know how to flash the badge yourself you can also download the DFU binary directly: firmware.dfu

Build your own version

If you want to build your own version of the firmware have a look here

@@ Line 1: / Line 1: @@
 == Update your Tilda Mk3==
-This websites will help you to update your Tilda Mk3 badge. But be careful, following these instructions will delete all files and setting on your badge, so make sure you have copies of everything!
+This guide will help you to update your Tilda Mk3 badge. Be careful, following these instructions will delete all files and setting on your badge, so make sure you have copies of everything!
+If you're having trouble following these instructions or updating your badge, [mailto:badge@emfcamp.org please get in touch] and we'll do our best to help.
 == Before you start==
-You need to put your badge into DFU mode. To do this please press down the joystick button in the center while at the same time quickly pushing the reset button at the back.
+You need to put your badge into DFU mode. This activates a USB bootloader stored in ROM on the STM32 processor.
-Your screen should go white and then you'll now be ready to update your badge. Note: screen does not always go white, but should go into DFU mode, so if you do the right button presses try it and see.
+'''To enter DFU mode:''' Switch on the badge. Press the center joystick button while at the same time quickly pushing the reset button on the back of the badge.
+In some cases this seems to require a few attempts. You can also try unplugging the battery, and holding down the center button while plugging in USB.
 ==OSX==
 '''Prerequisites needed for Mac OS X'''
@@ Line 20: / Line 19: @@
 . XCode (from App Store)
-. [http://docs.python-guide.org/en/latest/starting/install/osx/ Homebrew and Pip]
+. Python & pip
+* Homebrew method
+*: 1. [http://docs.python-guide.org/en/latest/starting/install/osx/ Install Homebrew and Pip]
+*: 2. <code>brew install libusb lsusb</code>
+*: 3. <code>pip install libusb1 pyusb</code>
+* MacPorts method
+*: 1. [http://johnlaudun.org/20150512-installing-and-setting-pip-with-macports/ Install MacPorts and Pip]
+*: 2. <code>sudo port install usbutils py-pip</code>
+*:: usbutils provides e.g. lsusb, useful for knowing if the badge is connected in DFU mode
+*: 3. <code>sudo pip install libusb1 pyusb</code>
-. You then need to (from the terminal) use homebrew to install libusb <code>brew install libusb</code> and pip to install libusb1 and pyusb <code>pip install libusb1 pyusb</code>
+. Check that you're connected in DFU mode:
+: <code>lsusb</code>
+: Should output something like:
+: <code>Bus 020 Device 002: ID 0483:df11 STMicroelectronics STM Device in DFU Mode</code>
-. You should be good to go!
+. <code>wget https://update.badge.emfcamp.org/update.py</code>
+. <code>sudo python update.py</code>
-Open a terminal and execute this line:
+. To get a shell: <code>screen /dev/tty.usbmodem*</code>
+'''Troubleshooting'''
-<code>curl --silent --show-error --retry 5 https://update.badge.emfcamp.org/update.py | python</code>
+If you get the error <code>Error: No backend available</code> then python cannot find the USB library.  Please Repeat steps 2 and 3 above, see https://github.com/walac/pyusb/issues/120 for more details.
 == Linux ==
+Install prerequisites if required:
+<code>sudo apt install python-usb</code>
 Open a terminal and execute this line:
 <code>curl --silent --show-error --retry 5 https://update.badge.emfcamp.org/update.py | python</code>
+If you get an error saying <code>ImportError: No module named core</code> then the python-usb package in your distribution is too old. On Debian, you should be able to fix it using pip instead:
+<code>sudo apt install python-pip</code>
+<code>sudo pip install --upgrade pyusb</code>
 == Windows ==
+'''<span style="color:red">WARNING</span>: There have been reports of badges being bricked when flashed from windows. They can be recovered using the OSX/Linux update procedure. We are looking for alternative ways of updating using Windows.'''
 On a Windows PC, you will need to download the STMicroelectronics DfuSe USB device firmware updater software http://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-programmers/stsw-stm32080.html and use the 'Upgrade or Verify Action' part of the GUI to update the firmware instead.
-* Install the STMMicroelectronics util from the link above.
+* Install the STMMicroelectronics utility from the link above.
-* Download the firmware.dfu file from https://update.badge.emfcamp.org/firmware.dfu and save it off.
+* Download the firmware.dfu file from https://update.badge.emfcamp.org/firmware.dfu and save it.
+* With the badge plugged into the computer, hold the centre joystick button and press reset. The badge should now boot into the bootloader, and be detected as a 'STM Device in DFU Mode'.
 * Start up DfuSeDemo.exe, and click the 'Choose' button - select the firmware.dfu file and then hit 'Upgrade'
 * Your firmware will now be updated.
@@ Line 53: / Line 78: @@
 If you know how to flash the badge yourself you can also download the DFU binary directly: [https://update.badge.emfcamp.org/firmware.dfu firmware.dfu]
 == Build your own version==
 If you want to build your own version of the firmware have a look [https://badge.emfcamp.org/wiki/TiLDA_MK3/build here]