RflyADBLib Interface Documentation¶

Introduction¶

Overview: This file provides ADB connection, serial communication, and WiFi control functions required for UAV swarm communication, supporting connection management and command interaction with subordinate devices of swarm UAVs.

This module serves as the communication tool module for the RflySim UAV swarm simulation and real-flight system. It is developed specifically for unified management of multiple onboard devices in real-flight scenarios, encapsulating fundamental operations for different communication methods. It supports interfacing with onboard embedded devices via three mainstream communication methods: ADB, serial, and WiFi. Common operations such as device connection status detection, connection establishment and disconnection, network status detection, and device address identification can be performed, providing underlying communication support for subordinate device command issuance and status reporting in swarm missions.

This module is primarily applicable to device debugging and mission deployment scenarios for real-flight UAV swarms. Developers can quickly implement batch communication management for multiple onboard devices based on this module, without having to build the underlying logic for different communication methods from scratch, thus aligning with the RflySim platform’s swarm development workflow.

Quick Start¶

Minimal working example; copy and modify minimal configuration to run.

from RflySimSDK.swarm import RflyADBLib

# Custom command sending function; implementation can be adjusted according to actual ADB connection method
def my_send_command(cmd):
    """Example command sending function; replace with your own ADB command sending implementation in practice"""
    import subprocess
    result = subprocess.check_output(cmd, shell=True, text=True)
    print(f"Command output: {result}")
    return result

# 1. Initialize the WiFi command control object, passing in the custom command sending function
wifi_ctrl = RflyADBLib.wifi_command(send_command_function=my_send_command)

# 2. Turn on the onboard WiFi
wifi_ctrl.open_wifi()

# 3. Get current WiFi connection status
wifi_state = wifi_ctrl.statu_wifi()
print(f"Current WiFi status: {wifi_state}")

# 4. Print the name (SSID) of the currently connected WiFi
wifi_ctrl.current_wifi()

Environment and Dependencies¶

Python Environment: >= 3.8.10
Dependencies: os, ppadb.client, re, serial, signal, subprocess, sys, time
Prerequisites: Before calling this interface, ensure the device is correctly connected and the communication environment (e.g., serial, ADB, or Wi-Fi) has been properly configured.

Core Interface Description¶

The module RflyADBLib.py contains configuration variables, helper functions, and core business classes.

Global Constants and Enumerations¶

This section lists all globally accessible constants and enumerations defined in the module.

Standalone Constants¶

None

Global/Standalone Functions¶

`extract_specific_mac(text, interface_name="wlan0")`¶

Function Description: Extracts the MAC address corresponding to a specified network interface from the given text.
Parameters:

text (Any): Source text containing network interface information, typically the output of system network configuration queries.
interface_name (Any): Target network interface name; defaults to wlan0.

Return Value:

str | None: Returns the corresponding MAC address string if successfully extracted; returns None if not found.

Exceptions: None

`ping_ip(ip_address)`¶

Function Description: Checks whether the specified IP address is reachable via the ping command.
Parameters:

ip_address (Any): Target IP address whose connectivity is to be tested.

Return Value:

bool: Returns True if the ping succeeds; otherwise, returns False.

Exceptions: None

`start_adb(path)`¶

Function Description: Starts the ADB (Android Debug Bridge) service, allowing specification of the ADB executable’s directory path.
Parameters:

path (Any): Directory path where the ADB executable resides.

Return Value:

None: No return value.

Exceptions: None

`check_device_connected()`¶

Function Description: Checks whether any Android device is successfully connected via ADB.
Parameters:
None
Return Value:

bool: Returns True if a device is connected; otherwise, returns False.

Exceptions: None

`stop_adb()`¶

Function Description: Stops the ADB service and closes the connection.
Parameters:
None
Return Value:

None: No return value.

Exceptions: None

`signal_handler(sig, frame)`¶

Function Description: Signal handler function used to catch program exit signals, perform resource cleanup, and then terminate the program.
Parameters:

sig (Any): Signal number to be handled.
frame (Any): Current stack frame object.

Return Value:

None: No return value.

Exceptions: None

`SerialCommunication` Class¶

Enables serial communication between the drone and the computer, supporting serial command transmission, data reading, and serial port disconnection. Suitable for serial communication in RflySim cluster development scenarios.

`init(port, baudrate, debug_mode)`¶

Function Description: Initializes the serial communication object and opens a serial connection with the specified parameters.
Parameters (Args):

Parameter Name	Type	Required	Default Value	Description
`port`	`str`	No	`"COM4"`	Serial port device name; typically in `COMx` format on Windows, and `/dev/ttyUSBx` on Linux.
`baudrate`	`int`	No	`115200`	Baud rate for serial communication.
`debug_mode`	`bool`	No	`False`	Whether to enable debug mode; when enabled, communication debug information is printed.

Return Value (Returns):

Instance of SerialCommunication

Exceptions (Raises): None

`send_command(command)`¶

Function Description: Sends a specified command string via the serial port.
Parameters (Args):

Parameter Name	Type	Required	Default Value	Description
`command`	`str`	Yes	—	Serial command string to be sent.

Return Value (Returns):

None

Exceptions (Raises): None

`read_serial_data()`¶

Function Description: Reads response data returned from the serial port.
Parameters (Args):
None
Return Value (Returns):

str: The serial data string read from the port.

Exceptions (Raises): None

`close_serial()`¶

Function Description: Closes the currently open serial port connection and releases serial resources.
Parameters (Args):
None
Return Value (Returns):

None

Exceptions (Raises): None

Example:

# Initialize the serial communication object
serial_comm = SerialCommunication(port="COM4", baudrate=115200, debug_mode=True)
# Send an AT command
serial_comm.send_command("AT")
# Read the response data from the serial port
response = serial_comm.read_serial_data()
print(response)
# Close the serial port connection
serial_comm.close_serial()

---

### `adb_communication` Class

Implements drone device communication based on the ADB protocol, providing ADB command sending and communication management functionalities, suitable for interactive communication among mobile devices in multi-drone control scenarios.

#### `__init__(debug_mode=False)`

**Function Description**: Initializes the ADB communication object and configures the debug mode option.  
**Parameters (Args)**:

| Parameter Name | Type | Required | Default Value | Description |
| :--- | :--- | :---: | :--- | :--- |
| `debug_mode` | `bool` | No | `False` | Whether to enable debug mode; when enabled, additional debug log messages will be output |

**Return Value (Returns)**:

- Instance of `adb_communication`

**Exceptions (Raises)**:
- None

---

#### `send_command(cmd)`

**Function Description**: Sends a specified command to the connected ADB device and retrieves the command execution result.  
**Parameters (Args)**:

| Parameter Name | Type | Required | Default Value | Description |
| :--- | :--- | :---: | :--- | :--- |
| `cmd` | `str` | Yes | - | The ADB command string to be sent and executed |

**Return Value (Returns)**:

- `str`: Output result after executing the ADB command

**Exceptions (Raises)**:
- None

**Example**:

```python
# Initialize the ADB communication object
adb_comm = adb_communication(debug_mode=True)
# Send an ADB command to retrieve the device list
result = adb_comm.send_command("devices")
print(result)

`wifi_command` Class¶

Implements cluster drone command transmission management over WiFi channels, relying on an input callback function for command transmission.

`init(send_command_function)`¶

Function Description: Constructs a WiFi command transmission management object, accepting a callback function for command transmission. Parameters (Args):

Parameter Name	Type	Description
send_command_function	None	Callback function for actually sending WiFi commands, used to execute specific command transmission operations

Returns: No return value; constructs an object instance.
Raises: No exceptions thrown.

`open_wifi()`¶

Function Description: Opens the WiFi interface.
Parameters (Args): None
Returns: No return value
Raises: None

`current_wifi()`¶

Function Description: Checks the connection status of the wireless network interface (wlan0) and prints the name (SSID) of the currently connected wireless network.
Parameters (Args): None
Returns: No return value
Raises: None

`statu_wifi()`¶

Function Description: Retrieves the current WiFi status.
Parameters (Args): None
Returns: No return value
Raises: None

`close_wifi()`¶

Function Description: Closes the WiFi interface.
Parameters (Args): None
Returns: No return value
Raises: None

`get_ip()`¶

Function Description: Retrieves the IP address assigned to the connected WiFi interface.
Parameters (Args): None
Returns: No return value
Raises: None