### Install wb-config Tool

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/install-wb-config-tool

Installs the latest version of the wb-config tool by downloading and executing an installation script from GitLab. This command requires root privileges.

```bash
curl -sL https://gitlab.com/wingbits/config/-/raw/master/wb-config/install.sh | sudo bash
```

--------------------------------

### Install Wingbits Software

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/setup-steps-guide

This command downloads and executes the Wingbits installation script via SSH. It installs necessary software and configures the Raspberry Pi based on station-specific information like latitude and longitude. Ensure you copy the exact command provided on the dashboard.

```shell
curl <your_wingbits_install_script_url> | bash
```

--------------------------------

### Restart Raspberry Pi

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/setup-steps-guide

After the Wingbits software installation script completes, restart your Raspberry Pi device to apply the changes and ensure all services start correctly.

```shell
sudo reboot
```

--------------------------------

### Run wb-config Tool

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/install-wb-config-tool

Executes the wb-config tool after it has been installed. This command launches the text-based user interface for station configuration and management.

```bash
sudo wb-config
```

--------------------------------

### Get Wingbits Client Version

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/installing-the-client

Retrieves the current version of the Wingbits client, including its build hash and build timestamp. This command is useful for identifying the specific build you are running and for support purposes.

```cli
wingbits -v
```

--------------------------------

### GEODNET Onboarding Guide

Source: https://docs.wingbits.com/get-started/hardware-needed/wingbits-onboarding

Provides instructions for onboarding a base station to the GEODNET console. Users who purchased devices capable of mining GEOD tokens, such as the HYFIX MGW310, can follow this external guide.

```APIDOC
GEODNET Onboarding:
  Follow the guide on the GEODNET documentation website to add a base station to the console.
  URL: https://docs.geodnet.com/geodnet-console-platform-basics/add-a-base-station-to-console
  Purpose: Enables mining of GEOD tokens for compatible devices.
```

--------------------------------

### Install New Wingbits Client

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/installing-the-client

Installs the new Wingbits client by downloading and executing a script from a specified URL. This client enhances security using GeoSigner and GPS coordinates, and uses outgoing port 443.

```sh
curl -sL https://gitlab.com/wingbits/config/-/raw/master/install-client.sh | sudo bash
```

--------------------------------

### Check Wingbits Client and GeoSigner Status

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/installing-the-client

Verifies the operational status of the Wingbits service, data input, connection, and the GeoSigner. The output indicates if the GeoSigner is connected and the number of satellites it has acquired.

```sh
sudo wingbits status
```

--------------------------------

### Troubleshoot GeoSigner Flash

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/installing-the-client

Resolves issues where the GeoSigner is not available or detected. This involves stopping the Wingbits and readsb services, flashing the GeoSigner firmware, and then restarting the services.

```sh
sudo systemctl stop wingbits readsb && sudo wingbits geosigner flash
```

```sh
sudo systemctl start wingbits readsb
```

--------------------------------

### Check Wingbits Client Version

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/geosigner-faq

Commands to verify the installed version of the Wingbits client software. This is useful for confirming if an update has been successfully applied, especially after the GeoSigner compatibility update.

```shell
cat /etc/wingbits/version
```

```shell
sudo wb-config
```

--------------------------------

### Optional Software Recommendations

Source: https://docs.wingbits.com/project/wingbits-approved-hardware-program

Several optional software components are highly recommended to enhance device functionality, including local web visualization interfaces, performance graphing tools, and configuration management interfaces.

```APIDOC
Optional Software:
  - tar1090 or similar: Local web visualization interface.
  - graphs1090 or similar: Performance graphs.
  - Web interface: For changing tuner gain and other configurable settings.
  - Debugging logs: Availability of debugging logs and other information for support.
```

--------------------------------

### Set Location for Wingbits Station

Source: https://docs.wingbits.com/wingbits-byod-english/byod-faq

Configures the geographical location for a Wingbits station using the `readsb-set-location` command. This command requires latitude and longitude values. It is noted that this functionality might be specific to standard Wingbits installations and may not work with third-party solutions.

```bash
sudo readsb-set-location <lat> <lon>
```

--------------------------------

### Manufacturing Data for Onboarding

Source: https://docs.wingbits.com/project/wingbits-approved-hardware-program

Specific manufacturing information is required for device onboarding to the Wingbits network. This data is ingested from a CSV file and must also be physically printed on the device label. Devices require backend whitelisting using this information.

```APIDOC
Manufacturing Data Requirements:
  - Public key from ECC keypair.
  - Animal name (generated from public key using angry-purple-tiger).
  - Ethernet MAC address.
  - WiFi MAC address (if available).
  - GPS chip serial number (if available).
  - Other identifiable hard-coded info from chips (if available).
  - Manufacturer specific serial number (optional).
  - Data Source: CSV file upload and physical device label.
```

--------------------------------

### Check GeoSigner Status via Command Line

Source: https://docs.wingbits.com/wingbits-byod-english/grandfathered-byod-diy-info/install-geosigner

This command checks the operational status of the GeoSigner on the station's command line. It verifies if the GeoSigner is recognized and functioning correctly, displaying '✓ Geosigner: OK' upon success.

```shell
sudo wingbits status

```

--------------------------------

### Grafana Alloy Configuration for Wingbits Metrics

Source: https://docs.wingbits.com/get-started/monitor-with-grafana-cloud

This configuration defines Prometheus scrape targets for Wingbits clients and sets up a remote write endpoint to send metrics to Grafana Cloud. It requires Grafana Alloy to be installed and configured with environment variables for Grafana Cloud credentials.

```yaml
prometheus.scrape "wingbits_hosts" {
    targets = [
        {__address__ = "192.168.10.1:8088", alias = "station1"},
        {__address__ = "192.168.10.2:8088", alias = "station2"},
    ]
    forward_to = [prometheus.remote_write.default.receiver]
}

prometheus.remote_write "default" {
    endpoint {
        url = sys.env("GCLOUD_HOSTED_METRICS_URL")
        basic_auth {
            username = sys.env("GCLOUD_HOSTED_METRICS_ID")
            password = sys.env("GCLOUD_RW_API_KEY")
        }
    }
}

```

--------------------------------

### Readsb Data Ingestion and Forwarding

Source: https://docs.wingbits.com/project/wingbits-approved-hardware-program

Devices must run ADS-B decoder software like readsb, outputting data to the Wingbits backend via a web socket. The current architecture uses Vector to ingest data from readsb in JSON format and forward it. This setup is required until the new on-device agent is released.

```APIDOC
Software Requirements:
  - Must be able to run readsb or equivalent ADS-B decoder software.
    - Output: Resulting data to Wingbits backend over a web socket.
  - Current Architecture (pre-new agent):
    - Client-side tool: Vector.
    - Ingestion: Data from readsb in JSON format.
    - Forwarding: To Wingbits backend.
  - JSON Format Reference: https://github.com/wiedehopf/readsb/blob/dev/README-json.md
```

--------------------------------

### HYFIX Antenna Upgrade Recommendation

Source: https://docs.wingbits.com/get-started/hardware-needed/hyfix-hardware-faq

Offers guidance on whether to upgrade the included ADS-B antenna. Explains the trade-offs between the 3dBi included antenna and higher gain antennas like 5dBi or 6dBi, considering project goals and potential signal loss from adapters.

```APIDOC
Antenna Upgrade Guidance:
  Official Recommendation: Use included 3dBi antenna for better reception from closer aircraft and alignment with project goals.
  Situational Use Case for 5dBi/6dBi: Locations with no nearby flight traffic requiring extended range.
  Considerations for Higher Gain Antennas:
    - May require adapters (e.g., N-Type) which can decrease signal strength.
    - Check compatibility and potential signal degradation.
```