Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thotypous/mikroe-uhb

USB HID Bootloader programming tool for devices manufactured by MikroElektronika
https://github.com/thotypous/mikroe-uhb

bootloader development-kit embedded flash-memory microcontroller

Last synced: 2 months ago
JSON representation

USB HID Bootloader programming tool for devices manufactured by MikroElektronika

Awesome Lists containing this project

README 

        
mikroe-uhb

==========



Open-source cross-platform USB HID Bootloader programming tool for devices manufactured by MikroElektronika.



Supported devices

-----------------



### ARM devices



This project was tested with a **Mikromedia for STM32** development kit. However, from what I understand of the bootloader source code and by reverse engineering the mikroBootloader application supplied by the manufacturer, I believe it should work for any ARM-based development kit currently available from MikroElektronika.



If you plan to test this application using any development kit different from the STM32 ones, please be prepared to use JTAG if something goes wrong (although the bootloader itself has a protection code which should bar most mistakes).



### PIC18 devices



This project was tested with a **PIC18F4550** device. Many thanks to Kerekes Szilard for providing USB captures and further information.



### dsPIC and PIC24 devices



This project was tested with a **Mikromedia for dsPIC33EP** development kit. Many thanks to Toni Petrovič for providing USB captures and further information.



PIC24 devices were still not tested, but should also be supported by the same backend, as the architectures are much similar and reverse engineering revealed almost identical handling of them by mikroBootloader.



### PIC32 devices



This project was tested with a **MultiMedia Board for PIC32MX7** development kit. Many thanks to John Comeau for implementing the support and providing us with patches and testing data. It is also reported to work with **Mikroelektronika Mini-32**.



How to install

--------------



### On Linux



First, you need to check if you have `python-setuptools` installed.

Then, just run:



```

make && sudo make install

```



This application is compatible both with Python 2.7 and with Python 3. The `pyudev` module is required, but will be installed automatically if it is not already present.



### On Windows



We provide standalone binary releases [here](https://github.com/thotypous/mikroe-uhb/releases). Just download the executable and use it. Take a look at the [wiki](https://github.com/thotypous/mikroe-uhb/wiki/Creating-a-standalone-executable-for-Windows) if you want to build your own executable.



### On other operating systems



Other operating systems were not tested yet, but the tool should work on any OS supported by cython-hidapi, like OSX and FreeBSD. Try to run `python setup.py install`. If other steps are needed, please contact us so that the documentation can be updated.



How to use

----------



### Printing information about the device



If you just want to see information about a development kit, without programming anything, run:



```

mikroe-uhb

```



You need to unplug/plug or reset the kit after issuing the command above, because this application is solely able to talk with the bootloader firmware, which runs only when the device is starting up.



### Programming the device



To program a hex file to the device, call:



```

mikroe-uhb -v file.hex

```



Then plug the device to the USB port, or press its reset button if it is already plugged to USB.



The `-v` option is meant to print debugging information during the programming process. It can be ommited if you prefer the programming process to be silent.



How to contribute

-----------------



### Support for other devices



I do not own development kits from MikroElektronika other than the Mikromedia for STM32, so I cannot test this project with other devices. However, support for them is certainly welcome.



Code should be self-documenting. There are also some useful tools for dealing with USB captures made with Wireshark under the `devtools` directory. Please read the comments.



If you cannot contribute with code, providing USB capture dumps is very useful. They can be obtained the following way:



* Install this application in your computer, or at least copy the `conf/mikroe-uhb.conf` file to `/etc/modprobe.d`. It is meant to prevent your system from detecting the USB HID Bootloader as a usbtouchscreen and messing things up.

* Install mikroBootloader in a Windows VM inside VirtualBox or other virtualization software with decent USB emulation support.

* Load the `usbmon` module (`modprobe usbmon`) and use Wireshark to start a USB capture. Then, fire mikroBootloader and program your device.

* Please provide me with the capture file saved by Wireshark and with the hex file you used to program your device.



You can also take USB captures directly on Wireshark for Windows if you install the [usbpcap driver](http://desowin.org/usbpcap) and follow the instructions in its website. Please do not forget to use a Wireshark version able to support the driver.



### Testing with another development kits



Contributions have helped us to implement support for almost every device currently manufactured by MikroElektronika, but more testing is needed. Please report if you test the tool with another development kit besides the ones enumerated in this document.