Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luni64/teensysharp
C# library for finding Teensies on the USB tree and upload firmware to PJRC Teensy boards
https://github.com/luni64/teensysharp
connected-teensies csharp-library firmware-upload hot-plug pjrc-teensy serial-port teensy upload upload-firmware usb-tree
Last synced: about 1 month ago
JSON representation
C# library for finding Teensies on the USB tree and upload firmware to PJRC Teensy boards
- Host: GitHub
- URL: https://github.com/luni64/teensysharp
- Owner: luni64
- License: mit
- Created: 2015-07-01T18:44:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-06-16T09:05:40.000Z (over 2 years ago)
- Last Synced: 2024-10-12T14:22:04.588Z (about 1 month ago)
- Topics: connected-teensies, csharp-library, firmware-upload, hot-plug, pjrc-teensy, serial-port, teensy, upload, upload-firmware, usb-tree
- Language: C
- Homepage:
- Size: 1.88 MB
- Stars: 23
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# This documentation is outdated and will be updated soon. Please use the Examples meanwhile
# TeensySharp
This library provides some helper classes for C# Windows applications which communicate to [PJRC Teensy](http://www.pjrc.com/teensy/index.html) boards. Currently the following common tasks are handled:
- Finding all Teensies on the USB tree. You get a list with entries for each found board containing its board type (e.g. Teensy 3.2, Teensy 4.1), its USB type (e.g. HID, Serial etc.) its serial number and the name of all virtual COM ports it exposes)
- Provide information when a Teensy is connected or removed from the USB Tree
- Resetting a board
- Starting the bootloader
- Uploading of firmware (iHex files) from within your dotnet user application.
# Installation
**TBD**
For easy installation TeensySharp is available as [nuget package](https://www.nuget.org/packages/lunoptics.TeensySharp/).
# Build
In case you don't want to include the nuget package you can of course include the sources in your project. TeensySharp was developed using Microsoft VisualStudio 2019 Community Edition. The corresponding .sln file is contained in the repo. A download of dependencies from NuGet should start automatically when you build the solution.
# Usage
## Finding Connected Teensies
### class TeensyWatcher
To obtain a list of all currently connected Teensies you can do the following:
```c#
var Watcher = new TeensyWatcher();
foreach (USB_Device Teensy in Watcher.ConnectedDevices)
{
Console.WriteLine("Serialnumber {0}", Teensy.Serialnumber);
}
```
If you are interested in all boards running in USB-Serial mode you can write
```c#
var Watcher = new TeensyWatcher();
foreach (USB_Device Teensy in Watcher.ConnectedDevices.Where(t=>t.Type == USB_Device.type.UsbSerial))
{
Console.WriteLine("Serialnumber {0}, on {1}", Teensy.Serialnumber, Teensy.Port);
}
```
The string *Teensy.Port* can then be used to construct a *SerialPort* object without having your users to guess which port number Windows assigned to your device today.
In case you are looking for a board with a running bootloader and serialnumber 8324210
```c#
var Watcher = new TeensyWatcher();
var Teensy = Watcher.ConnectedDevices.FirstOrDefault(t=>(t.Serialnumber==8324210 && t.Type==USB_Device.type.HalfKay ));
```
The list of connected boards will be updated in the background whenever a Teensy is connected or removed. If you need a notification when the list changes you also can attach an eventhandler to the watcher:
```c#
...
var Watcher = new TeensyWatcher();
Watcher.ConnectionChanged += ConnectedTeensiesChanged;
...
void ConnectedTeensiesChanged(object sender, ConnectionChangedEventArgs e)
{
string Port = e.changedDevice.Port;
string SN = e.changedDevice.Serialnumber;
}
```
The repo contains a simple console application (*TeensyWacherConsole*) which demonstrates the use of the *TeensyWatcher* class and the eventhandler in more detail.
## Firmware Uploading
### class SharpHexParser
The static *SharpHexParser* class is used to parse an Intel HEX stream and copy the result,i.e. the firmware into a flash image (which is a simple byte array). To generate an empty flash image with the correct size you can call a member of the SharpUploader as shown in the following code snippet. (*PJRC_Board* is an enum containing definitions for all supported PJRC Teensy Boards)
```c#
var Board = PJRC_Board.Teensy_31;
var FlashImage = SharpUploader.GetEmptyFlashImage(Board);
SharpHexParser.ParseStream(File.OpenText("firmware.hex"), FlashImage);
```
The flash image now contains the bytes to be uploaded to the board. The actual upload will be be done by the class *SharpeUploader*.
### class SharpUploader
To upload the flash image to the board you use the static *SharpUploader* class. You can start the bootloader by calling *StartHalfKay(uint Serialnumber)* (alternatively you can press the button on the board). After that you pass the flash image to the *Upload* member of the *SharpUploader* class. In the example below we upload the image to the first board we find.
```c#
...
USB_Device Teensy = Watcher.ConnectedDevices.FirstOrDefault();
SharpUploader.StartHalfKay(Teensy.Serialnumber);
int result = SharpUploader.Upload(FlashImage, Board, Teensy.Serialnumber, reboot: true);
```
The reboot parameter determines if the board shall be rebooted after the upload - which is what you usually want. The *Upload* function returns the following codes:
- **0** OK, upload finished without error
- **1** : No board with requested serialnumber and active HalfKay bootloader found
- **2** : Error during upload of the firmware-
The repo contains a console application (*FirmwareDownloadConsole*) which demomstrates the use of the *TeensyWatcher* class.
## Status
- Compatibilty to T3.5 and T3.6 added
** ToBeDone:** WPF example showing the usage in a more realistic scenario