# OpenFFBSharp

**Repository Path**: NOP404_admin/OpenFFBSharp

## Basic Information

- **Project Name**: OpenFFBSharp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-22
- **Last Updated**: 2025-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenFFBSharp - C# client for the OpenFFBoard

#### Designed to be used with an OpenFFBoard. More info at https://github.com/Ultrawipf/OpenFFBoard

## WIP - This project is not fully functional yet, so some commands and board classes may be missing

There are two methods of communication to an OpenFFBoard, HID and Serial. Each method has its own benefits and drawbacks, which you may wish to consider. Changing between the two communication methods requires very little code changes.

| Communication | Benefits | Drawbacks | General use case |
| ------------- | -------- | --------- | ---------------- |
| HID | Multiple simultaneous connections | Does not support some commands (help, class lists etc.) | Changing simple board parameters (power, rotation degrees etc.) |
| Serial | Supports all commands and data types | Single connection to one client | More advanced board settings |

### HID
Get a list of connected OpenFFBoards
```C#
var boards = await OpenFFBoard.Hid.GetBoardsAsync();
```
then you can declare a new OpenFFBoard object from the first connected board
```C#
OpenFFBoard.Board openFFBoard = new OpenFFBoard.Hid(boards[0]);
```

### Serial
Get a list of connected OpenFFBoards
```C#
var boards = OpenFFBoard.Serial.GetBoards();
```
then you can declare a new OpenFFBoard object from the first connected board
```C#
OpenFFBoard.Board openFFBoard = new OpenFFBoard.Serial(boards[0]);
```

## Initialisation

Once you have declared a board, you can connect to it
```C#
openFFBoard.Connect();
```

## Accessing Board Properties

Once this initialisation process has been followed, you can now access the board properties.

```C#
Console.WriteLine("Power: {0}", openFFBoard.Axis.GetPower());
```