semvec/pypi-packages huggingface dataset:
ifcclient 0.0.6
Python client for Infinite Flight Connect API v1/2
License: Apache 2.0

# Infinite Flight Connect API Client

Using python to connect the Infinite Flight Connect API v1/v2.

## Installation

```sh
pip3 install ifcclient
```

## Usage

Before getting started, make sure to enable the Infinite Flight Coneect in the app `Settings > General > Enable Infinite Flight Connect`

First, import the module in Python and discover devcies in the same network, you can use duration to specific the time to discover, you can use duration=0 to return the first device you discovered.
```py
import ifcclient
devices = ifcclient.IFCClient.discover_devices(duration=0)
```

### API V2
Init the client object.
```py
ifc = ifcclient.IFClient.connect(devices[0], version=2) # version is 2 by default
```
There are three ways to use the Infinite Flight Connected API V2, GetState, SetState, RunCommand. You can check Infinite Flight website for the detail of API.

#### GetState
To get a state from the API, send a get_state_by_name() request as follows:
```py
ifc.get_state_by_name(name)
# For example
ifc.get_state_by_name('aircraft/0/systems/flaps/state')
```

#### SetState
To set states -- assigning new values to them -- through the API by sending a request as outlined below.

However, not all states can be set and the manifest offers no indication of which states can be set and which can't. The only way to determine this is trial-and-error and some common sense.
```py
ifc.set_state_by_name(name, value)
# For example
ifc.set_state_by_name('aircraft/0/systems/flaps/state', 2)
```

#### RunCommand
To execute a command through the API, send a run_command_by_name() request.
```py
ifc.run_command_by_name(command)
# For example
ifc.run_command_by_name('commands/NextCamera')
```

### API V1
Init the client object for V1.
```py
ifc = ifcclient.IFClient.connect(devices[0], version=1)
```
With V1, to send a command, use the `send_command` function. The first parameter is the command, the second parameter are the parameters passed to Infinite Flight while the third parameter determines whether to wait for a response or not. Await response is false by default although it must be enabled when expecting a response.
```py

ifc.send_command("{CommandName}", [Parameters], await_response=True)
ifc.send_command("{CommandName}", [Parameters]) # await_response is False by default
# For example
ifc.send_command("airplane.getstate", [], await_response=True)
ifc.send_command("flightplan.get", [], await_response=True)
```

### functions share with v1/v2
Two commonly used operations, one is to get the state of the aircraft, the other is to get the flightplan, these two methods, get_aircraft_state() and get_flightplan() which can be used in both V1/V2. It also provides a function display_commands() to list all the avaliable commands.
```py 
ifc.get_aircraft_state()
ifc.get_flightplan()
ifc.display_command()
```

## Future updates

- [ ]