@betaflight/api-server/README.md

A GraphQL server to retreive data from betaflight flight controllers

# `@betaflight/api-server`
> Betaflight in a graph

A GraphQL server for querying, and mutatating betaflight flight controllers

[Try it out!](https://betaflight-mock-api.herokuapp.com/graphql)

## Usage

```bash
$ yarn add @betaflight/api-server graphql@14
```

```typescript
import { createServer } from "@betaflight/api-server";

createServer().listen({ port: 9000 })
```

Then, you can query the graph at `http://localhost:9000/graphql`

### Mocked mode

Mocked mode simulates a device and USB ports instead of actually
connecting to them. This way, software can be developed without having to
have a flight controller to hand.

```typescript
import { createServer } from "@betaflight/api-server";

// Start in mocked mode
createServer({ mocked: true }).listen({ port: 9000 })
```

### Ports

```graphql

query Ports {
    ports
}

```

### Connecting

```graphql
mutation Connect($port: String!) {
    connect(port: $port, baudRate: 115200) {
        id # the connectionId
        apiVersion # the api version of the flight controller
    }
}
```

### Listen for connection changes

```graphql
subscription OnChanged($id: ID!) {
    onConnectionChanged(connection: $id)
}
```

### Querying

```graphql
query Attitude($connection: ID!) {
    connection(connectionId: $connection) {
        device {
            attitude {
                roll
                pitch
                heading
            }
        }
        bytesRead
        bytesWritten
        packetErrors
    }
}
```

For more usage examples, please refer to [`@betaflight/configurator`](../configurator) which uses this package
to communicate with flight controllers

## Why?

GraphQL is a powerful langauge, and this structure would have had to be implemented in the configurator for client
state anyway. Splitting the flight controller graph into it's own API means we both create a segregated architecture
for the configurator and allow other people to use the API for other means.