signalk-weatherflow/dist/types.d.ts

SignalK plugin for WeatherFlow (Tempest) weather station data ingestion

export interface SignalKApp {
    debug: (msg: string) => void;
    error: (msg: string) => void;
    handleMessage: (pluginId: string, delta: SignalKDelta) => void;
    savePluginOptions: (options: Record<string, unknown>, callback: (err?: unknown) => void) => void;
    setProviderStatus: (msg: string) => void;
    getDataDirPath: () => string;
    subscriptionmanager: {
        subscribe: (subscription: SubscriptionRequest, unsubscribes: Array<() => void>, subscriptionError: (err: unknown) => void, dataCallback: (delta: SignalKDelta) => void) => void;
    };
    registerPutHandler: (context: string, path: string, handler: (context: string, path: string, value: unknown, callback?: (result: {
        state: string;
        statusCode?: number;
    }) => void) => {
        state: string;
        statusCode?: number;
    }, source?: string) => void;
    registerWeatherProvider: (provider: WeatherProvider) => void;
}
export interface SignalKPlugin {
    id: string;
    name: string;
    description: string;
    schema: Record<string, unknown>;
    start: (options: Partial<PluginConfig>) => void;
    stop: () => void;
    config?: PluginConfig;
}
export interface PluginConfig {
    stationId: number;
    vesselName?: string;
    apiToken: string;
    udpPort: number;
    enableWebSocket: boolean;
    enableForecast: boolean;
    forecastInterval: number;
    enableWindCalculations: boolean;
    deviceId: number;
    enablePutControl: boolean;
    webSocketControlPath: string;
    forecastControlPath: string;
    windCalculationsControlPath: string;
    stationLatitude?: number;
    stationLongitude?: number;
    setCurrentLocationAction?: {
        setCurrentLocation?: boolean;
    };
}
export type PutHandler = (context: string, path: string, value: unknown, callback?: (result: {
    state: string;
    statusCode?: number;
}) => void) => {
    state: string;
    statusCode?: number;
};
export interface PluginState {
    udpServer: any;
    wsConnection: any;
    forecastInterval: NodeJS.Timeout | null;
    windyInterval: NodeJS.Timeout | null;
    windCalculations: any;
    navigationSubscriptions: Array<() => void>;
    currentConfig?: PluginConfig;
    webSocketEnabled: boolean;
    forecastEnabled: boolean;
    windCalculationsEnabled: boolean;
    putHandlers: Map<string, PutHandler>;
    latestObservations: Map<string, any>;
    latestForecastData: ForecastData | null;
    stationLocation: Position | null;
    currentVesselPosition: Position | null;
}
export interface WeatherFlowMessage {
    type: string;
    serial_number?: string;
    hub_sn?: string;
    ob?: number[];
    obs?: number[][];
    evt?: number[];
    device_id?: number;
    source?: string;
}
export interface RapidWindData {
    type: 'rapid_wind';
    serial_number: string;
    hub_sn: string;
    ob: [number, number, number];
    device_id: number;
    source: string;
}
export interface TempestObservationData {
    type: 'obs_st';
    serial_number: string;
    hub_sn: string;
    obs: number[][];
    firmware_revision: number;
    device_id: number;
    source: string;
}
export interface AirObservationData {
    type: 'obs_air';
    serial_number: string;
    hub_sn: string;
    obs: number[][];
    firmware_revision: number;
    device_id: number;
    source: string;
}
export interface RainEventData {
    type: 'evt_precip';
    serial_number: string;
    hub_sn: string;
    evt: [number];
    device_id: number;
    source: string;
}
export interface LightningEventData {
    type: 'evt_strike';
    serial_number: string;
    hub_sn: string;
    evt: [number, number, number];
    device_id: number;
    source: string;
}
export interface HubStatusData {
    type: 'hub_status';
    serial_number: string;
    firmware_revision: string;
    uptime: number;
    rssi: number;
    timestamp: number;
    reset_flags: string;
    seq: number;
    fs: number[];
    radio_stats: number[];
    mqtt_stats: number[];
}
export interface DeviceStatusData {
    type: 'device_status';
    serial_number: string;
    hub_sn: string;
    timestamp: number;
    uptime: number;
    voltage: number;
    firmware_revision: number;
    rssi: number;
    hub_rssi: number;
    sensor_status: number;
    debug: number;
}
export interface ProcessedWindData {
    timeEpoch: number;
    windSpeed: number;
    windDirection: number;
    utcDate: string;
}
export interface ProcessedTempestData {
    timeEpoch: number;
    windLull: number;
    windAvg: number;
    windGust: number;
    windDirection: number;
    windSampleInterval: number;
    stationPressure: number;
    airTemperature: number;
    relativeHumidity: number;
    illuminance: number;
    uvIndex: number;
    solarRadiation: number;
    rainAccumulated: number;
    precipitationType: number;
    lightningStrikeAvgDistance: number;
    lightningStrikeCount: number;
    battery: number;
    reportInterval: number;
    localDailyRainAccumulation: number;
    rainAccumulatedFinal: number;
    localDailyRainAccumulationFinal: number;
    precipitationAnalysisType: number;
    utcDate: string;
}
export interface ProcessedAirData {
    timeEpoch: number;
    stationPressure: number;
    airTemperature: number;
    relativeHumidity: number;
    lightningStrikeCount: number;
    lightningStrikeAvgDistance: number;
    battery: number;
    reportInterval: number;
    utcDate: string;
}
export interface ProcessedRainData {
    timeEpoch: number;
    utcDate: string;
}
export interface ProcessedLightningData {
    timeEpoch: number;
    lightningStrikeAvgDistance: number;
    energy: number;
    utcDate: string;
}
export interface ProcessedHubStatusData {
    timeEpoch: number;
    serialNumber: string;
    firmwareRevision: string;
    uptime: number;
    rssi: number;
    resetFlags: string;
    sequence: number;
    radioStats: {
        version: number;
        rebootCount: number;
        busErrorCount: number;
        radioStatus: number;
        networkId: number;
    };
    utcDate: string;
}
export interface ProcessedDeviceStatusData {
    timeEpoch: number;
    serialNumber: string;
    hubSerialNumber: string;
    uptime: number;
    voltage: number;
    firmwareRevision: number;
    rssi: number;
    hubRssi: number;
    sensorStatus: number;
    debugEnabled: boolean;
    utcDate: string;
}
export interface WebSocketMessage {
    type?: string;
    device_id?: number;
    id?: string;
    summary?: unknown;
    status?: unknown;
    obs?: number[][];
    utcDate?: string;
}
export interface ForecastData {
    current_conditions?: CurrentConditions;
    forecast?: {
        hourly?: HourlyForecast[];
        daily?: DailyForecast[];
    };
}
export interface CurrentConditions {
    time?: number;
    conditions?: string;
    icon?: string;
    air_temperature?: number;
    feels_like?: number;
    relative_humidity?: number;
    wind_avg?: number;
    wind_direction?: number;
    wind_gust?: number;
    uv?: number;
    brightness?: number;
    solar_radiation?: number;
    lightning_strike_count_last_1hr?: number;
    lightning_strike_count_last_3hr?: number;
    lightning_strike_last_distance?: number;
    lightning_strike_last_epoch?: number;
    precip_accum_local_yesterday?: number;
    precip_accum_local_yesterday_final?: number;
    precip_analysis_type_yesterday?: number;
    pressure_trend?: string;
    station_pressure?: number;
    sea_level_pressure?: number;
}
export interface HourlyForecast {
    time?: number;
    conditions?: string;
    icon?: string;
    air_temperature?: number;
    feels_like?: number;
    relative_humidity?: number;
    wind_avg?: number;
    wind_direction?: number;
    wind_gust?: number;
    precip?: number;
    precip_probability?: number;
    precip_type?: string;
    uv?: number;
    sea_level_pressure?: number;
    station_pressure?: number;
    datetime?: string;
}
export interface DailyForecast {
    day_start_local?: number;
    day_num?: number;
    month_num?: number;
    conditions?: string;
    icon?: string;
    sunrise?: number;
    sunset?: number;
    air_temp_high?: number;
    air_temp_low?: number;
    precip_probability?: number;
    precip_icon?: string;
    precip_type?: string;
    wind_avg?: number;
    wind_direction?: number;
    day_start_local_iso?: string;
    sunrise_iso?: string;
    sunset_iso?: string;
}
export interface WindInput {
    windSpeed: number;
    windDirection: number;
    airTemperature?: number;
}
export interface ApparentWindData {
    windSpeed: number;
    windAngleRelative: number;
    windAngleRelativeRad: number;
    apparentTrueDeg: number;
    apparentMagneticDeg: number;
    apparentTrueRad: number;
    apparentMagneticRad: number;
    airTemperature: number;
}
export interface DerivedWindValues {
    speedApparent: number;
    angleApparent: number;
    angleTrueGround: number;
    angleTrueWater: number;
    directionTrue: number;
    directionMagnetic: number;
    speedTrue: number;
    windChill: number | null;
    heatIndex: number | null;
    feelsLike: number;
    timestamp: string;
    source: string;
}
export interface ConvertedValue {
    value: unknown;
    units: string | null;
}
export interface SignalKDelta {
    context: string;
    updates: SignalKUpdate[];
}
export interface SignalKUpdate {
    $source?: string;
    source?: {
        label: string;
        type?: string;
    };
    timestamp: string;
    values: SignalKValue[];
    meta?: SignalKMeta[];
}
export interface SignalKValue {
    path: string;
    value: unknown;
}
export interface SignalKMeta {
    path: string;
    value: {
        units?: string;
        description?: string;
    };
}
export interface SubscriptionRequest {
    context: string;
    subscribe: SubscriptionItem[];
}
export interface SubscriptionItem {
    path: string;
    policy: 'fixed' | 'ideal' | 'instant';
    period?: number;
    format: 'delta' | 'full';
}
export interface SubscriptionValue {
    path: string;
    value: unknown;
    timestamp: string;
    $source?: string;
}
export interface WeatherProvider {
    name: string;
    methods: WeatherProviderMethods;
}
export interface WeatherProviderMethods {
    pluginId?: string;
    getObservations: (position: Position, options?: WeatherReqParams) => Promise<WeatherData[]>;
    getForecasts: (position: Position, type: WeatherForecastType, options?: WeatherReqParams) => Promise<WeatherData[]>;
    getWarnings: (position: Position) => Promise<WeatherWarning[]>;
}
export interface Position {
    latitude: number;
    longitude: number;
    timestamp: Date;
}
export interface WeatherReqParams {
    maxCount?: number;
    startDate?: string;
}
export type WeatherForecastType = 'daily' | 'point';
export type WeatherDataType = WeatherForecastType | 'observation';
export interface WeatherData {
    description?: string;
    date: string;
    type: WeatherDataType;
    outside?: {
        minTemperature?: number;
        maxTemperature?: number;
        feelsLikeTemperature?: number;
        precipitationVolume?: number;
        absoluteHumidity?: number;
        horizontalVisibility?: number;
        uvIndex?: number;
        cloudCover?: number;
        temperature?: number;
        dewPointTemperature?: number;
        pressure?: number;
        pressureTendency?: TendencyKind;
        relativeHumidity?: number;
        precipitationType?: PrecipitationKind;
        precipitationProbability?: number;
        solarRadiation?: number;
        illuminance?: number;
        airDensity?: number;
        wetBulbTemperature?: number;
        wetBulbGlobeTemperature?: number;
        deltaT?: number;
    };
    water?: {
        temperature?: number;
        level?: number;
        levelTendency?: TendencyKind;
        surfaceCurrentSpeed?: number;
        surfaceCurrentDirection?: number;
        salinity?: number;
        waveSignificantHeight?: number;
        wavePeriod?: number;
        waveDirection?: number;
        swellHeight?: number;
        swellPeriod?: number;
        swellDirection?: number;
    };
    wind?: {
        speedTrue?: number;
        directionTrue?: number;
        gust?: number;
        gustDirection?: number;
        averageSpeed?: number;
        gustDirectionTrue?: number;
        directionCardinal?: string;
    };
    sun?: {
        sunrise?: string;
        sunset?: string;
    };
}
export interface WeatherWarning {
    startTime: string;
    endTime: string;
    details: string;
    source: string;
    type: string;
}
export type TendencyKind = 'steady' | 'decreasing' | 'increasing' | 'not available';
export type PrecipitationKind = 'reserved' | 'rain' | 'thunderstorm' | 'freezing rain' | 'mixed/ice' | 'snow' | 'reserved' | 'not available';
//# sourceMappingURL=types.d.ts.map