#  LakiBeam HTTP Configuration

## Project profile

LakiBeam HTTP Configuration is an HTTP-based configuration management library specifically designed for radar devices. The library provides a complete set of device configuration reading, setup, and management interfaces over the standard HTTP protocol.

## Characteristics

### HTTP configuration management

- Based on RESTful HTTP interfaces

- Supports synchronous and asynchronous HTTP requests

- Provides read and write functions for device configuration

### Configure management scope

- Obtain firmware information

- System monitoring data

- Network configuration management

- Set sensor parameters

- Radar scanning parameter Settings

- Filter configuration

- Host network configuration

## HTTP interface design

### Interface type

- GET: obtains configuration information

- PUT: modifies configuration parameters

- DELETE: deletes a specific configuration

### Configure endpoint examples

- '/api/v1/system/firmware' : Obtain firmware information

- '/api/v1/system/monitor' : obtains system monitoring data

- '/api/v1/sensor/overview' : Get the sensor overview configuration

- '/api/v1/sensor/scan_range' : indicates the scanning range

## Environmental dependence

- Windows
- Python version ≥ 3.7

## Dependency library

- aiohttp

### Installing

You can install aiohttp using `pip`

```sh
$ pip install aiohttp
```

### Usage example

```python
from LakiBeamHTTP import LakiBeamHTTP, Firmware

# Create the HTTP configuration manager
laki_http = LakiBeamHTTP(
    local_ip="192.168.8.1",   # local ip
    local_port="8080",        # local port
    web_ip="192.168.8.2",     # device IP
    web_port="80"             # device port
)

# get firmware
firmware = Firmware("", "", "", "", "")
if await laki_http.get_firemware(firmware):
    print(f"设备型号: {firmware.model}")