Deep Trekker BRIDGE API - v1.0.3
    Preparing search index...

    Type Alias Sonar

    Sonar

    type Sonar = {
        active?: boolean;
        enabled?: boolean;
        frequency?: SonarFrequency;
        gain?: number;
        ip?: string;
        lowPower?: boolean;
        macAddressId?: string;
        maxRange?: number;
        model?: SonarModel;
        pitch?: number;
        range?: number;
        salinity?: number;
    }
    Index

    Properties

    active? enabled? frequency? gain? ip? lowPower? macAddressId? maxRange? model? pitch? range? salinity?

    Properties

    active?: boolean

    Indicates if the device is currently sending frames to the web app when set to true the backend will create a datachannel called "SONAR_DATA_CHANNEL" to send sonar images

    use enabled property.

    enabled?: boolean

    If true, then the sonar is actively sending data to the webapp. If false, the sonar is available on the network but isn't connected to the webapp specifically.

    frequency?: SonarFrequency

    The frequency of the device

    gain?: number

    The gain of the sonar

    ip?: string

    The dynamic IP address of the sonar. This is the IP address assigned to the sonar by the network's DHCP server. It can change over time, especially if the sonar is restarted or the network configuration changes.

    lowPower?: boolean

    The low power state of the device

    macAddressId?: string

    The sonar's unique identifier, typically a MAC address. This is used to identify the sonar in the network.

    maxRange?: number

    Maximum range that the sonar can be configured to.

    model?: SonarModel

    The model of the sonar

    pitch?: number

    The pitch angle of the sonar in degrees

    range?: number

    The range of the sonar

    salinity?: number

    The salinity of the water that the sonar is operating in. Helps decide the speed of sound.

    Settings

    Member Visibility

    On This Page

    Properties