|
| 1 | +BSL430.NET.GUI App |
| 2 | +------------------ |
| 3 | +BSL430.NET.GUI App is .NET WPF app wrapping BSL430.NET functions with nice graphical interface. It is Windows only, so if you run Linux, you should check out [Console App](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.Console-App). For more details please read docs here at wiki [BSL430.NET Library](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.Library) or [FirmwareTools](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.FirmwareTools.Library), especially [**Device Set Up**](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.Library#Device-Set-Up), because each time you init communication with MCU, you need to correctly set device up (*MCU*, *InvokeMechanism*, *BaudRate*, *Password*). App functionality is split into *Views*: **Upload**, **Download**, **Erase** and **FW Tools**. There are also some nice *features* included, like integration with Windows Explorer (Shell) in form of **shell ext association** (firmware files double click open), or **shell extension** (right click menu). App **settings** are managed from tray icon. |
| 4 | + |
| 5 | +``` |
| 6 | +Note: This app packs all (un)managed libraries into single assembly. |
| 7 | + User settings, logs, log backup and exe shadow copy are stored at: |
| 8 | + C:\Users\<NAME>\AppData\Local\Jakub Parez\BSL430.NET.WPF\ |
| 9 | +``` |
| 10 | +- [System Requirements](#System-Requirements) |
| 11 | +- [Views](#Views) |
| 12 | + - [Scan](#Scan) |
| 13 | + - [**Upload**](#Upload) |
| 14 | + - [**Download**](#Download) |
| 15 | + - [**Erase**](#Erase) |
| 16 | + - [XML Log](#Erase) |
| 17 | + - [**Firmware Tools**](#Firmware-Tools) |
| 18 | + - [Convert](#Convert) |
| 19 | + - [Combine](#Combine) |
| 20 | + - [Validate](#Validate) |
| 21 | + - [Hex Edit](#Hex-Edit) |
| 22 | + - [Get Password](#Get-Password) |
| 23 | + - [About](#About) |
| 24 | +- [Features](#Features) |
| 25 | + - [**Tray Icon Settings**](#Tray-Icon-Settings) |
| 26 | + - [**Shell Integration**](#Shell-Integration) |
| 27 | + - [Shell Association](#Shell-Association) |
| 28 | + - [Shell Extension](#Shell-Extension) |
| 29 | + |
| 30 | +System Requirements |
| 31 | +------------------- |
| 32 | +BSL430.NET.WPF is built using **.NET Framework 4.6.1**. NET Core 3 (WPF) support is only experimental and would be interesting after .NET Core and WPF will go out better than today (.NET Core 3.0 Preview is first to implement WPF but not fully and without problems). Each architecture (x86, amd64) has its own build as unmanaged libraries are involved, but there are no significant differences when using x86 or amd64 build. |
| 33 | +- Framework |
| 34 | + - .NET Framework 4.6.1 |
| 35 | + - *.NET Core 3.0 (experimental)* |
| 36 | +- OS |
| 37 | + - Windows 7, 8, 8.1, 10 |
| 38 | + - x86 |
| 39 | + - amd64 |
| 40 | + |
| 41 | +Views |
| 42 | +----- |
| 43 | +### Scan |
| 44 | +Scan for available devices. It is important to have drivers installed for using FTDI devices (FTD2XX). If you dont want to or cant install them, please use libftdi. Other device types are USB or Serial (COM) port. |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | +### Upload |
| 49 | +Uploading code to micro is the most common way how use this library. First device needs to be set up (MCU family, Invoke Method, Baud Rate) according to [docs](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.Library#Device-Set-Up). Then You need to select **firmware file path** in formats Intel-HEX, TI-TXT, SREC or ELF. Password, key to unlock bootloader, is here optional, because mostly you want dont know it and also doesnt care about that data, because they are being overwriten with new one. However there are two use cases, when good password matters. First, you already uploaded main firmware to your device and now you want to upload only Info A memory (user settings, constants..). In this case you dont want to Erase MCU first, so you need to supply valid BSL password. Secondly, read warning below: |
| 50 | +``` |
| 51 | +Warning: Password is optional for Download, but if wrong password is entered, |
| 52 | + MCU takes it as an attack and erase all memory, executing Mass Erase. |
| 53 | + If modern 5xx/6xx micro is used, code is just wiped, but if old |
| 54 | + 1xx/2xx/4xx one is used and LOCK A bit is not set, also Info A mem |
| 55 | + is wiped, with factory calibration data. So please be careful. |
| 56 | +``` |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +### Download |
| 61 | +Downloading code from micro is useful only sometimes, like when solving a problem with some remote device. First device needs to be set up (MCU family, Invoke Method, Baud Rate) according to [docs](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.Library#Device-Set-Up). Then You need to select firmware destination path and output format. Also **Start Addr** and **Byte Size** settings are crucial, which are the address of the very first data node wanted, and the count of bytes downloaded. You can toggle the button **K/1** and switch between scaler of download range. If *1* is set, values are in standard decimal units 1:1, if *K* is set, values are multiplied by 1024. Password is key to unlock bootloader and needs to be set correctly, otherwise bad things happen. Read below. |
| 62 | +``` |
| 63 | +Warning: Password is needed for Download. If wrong password is entered, MCU |
| 64 | + takes it as an attack and erase all memory, executing Mass Erase. |
| 65 | + If modern 5xx/6xx micro is used, code is just wiped, but if old |
| 66 | + 1xx/2xx/4xx one is used and LOCK A bit is not set, also Info A mem |
| 67 | + is wiped, with factory calibration data. So please be careful. |
| 68 | +``` |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +### Erase |
| 73 | +Erasing micro is also sometimes needed and doesnt require any input data, nor it cares about set Baud Rate value. Just call this method and quickly all memory is erased. Device needs to be set up first (MCU family, Invoke Method, Baud Rate) according to [docs](https://github.com/parezj/BSL430.NET/wiki/BSL430.NET.Library#Device-Set-Up). |
| 74 | +``` |
| 75 | +Warning: If old 1xx/2xx/4xx MCU is used and LOCK A bit is not set **DONT** do it! |
| 76 | + Info A memory will be erased as well, with factory calibration data. |
| 77 | + This will also happen when incorrect password entered, so be careful. |
| 78 | + Or just dont use old micros and buy a new better one :) |
| 79 | +``` |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +### XML Log |
| 84 | +All main operations are logged into XML file located at *C:\Users\<NAME>\AppData\Local\Jakub Parez\BSL430.NET.WPF\*. You can open this log file by embedded explorer (AvalonEdit) by clicking *XML Log* or you cant just simply navigate into that folder by file explorer. If log file grows larger than 2MB, after app start you will be notified of moving this file to backup folder at same location and creating a new blank one. |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +### Firmware Tools |
| 90 | +This view implements all main functionality of sub-package **BSL430.NET.FirmwareTools**. These functions are universal except of *Get Password*, which is MSP430 specific. First there needs to be chosen (first) firmware file path. |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | +#### Convert |
| 95 | +Convert firmware TI-TXT, Intel-HEX or ELF format (auto detected) to firmware in TI-TXT, Intel-HEX or SREC format. There needs to be set output firmware format by combo-box and after clicking *Convert* button dialog windows opens. There is set output file path and optional check-box FillFF can be set (fill missing addr nodes with 0xFF and return monolithic piece of code). LineLength can be set via Tray Icon settings and it defines amount of data bytes per one text row. When = 0, default values are set (TI-TXT = 16, Intel-HEX = 32, SREC = 32). |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | +#### Combine |
| 100 | + |
| 101 | + |
| 102 | +#### Validate |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | +#### Hex Edit |
| 107 | + |
| 108 | + |
| 109 | + |
| 110 | +#### Get Password |
| 111 | + |
| 112 | + |
| 113 | +### About |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | +Features |
| 118 | +-------- |
| 119 | +### Tray Icon Settings |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | +### Shell Integration |
| 124 | +#### Shell Association |
| 125 | + |
| 126 | + |
| 127 | +#### Shell Extension |
| 128 | + |
0 commit comments