chasemapper/static/js/sondehub.js

//
//   Project Horus - Browser-Based Chase Mapper - SondeHub Data Scraping
//
//   Copyright (C) 2021  Mark Jessop <vk5qi@rfhead.net>
//   Released under GNU GPL v3 or later
//


// URL to scrape recent vehicle position data from.
var sondehub_vehicle_url = "https://api.v2.sondehub.org/listeners/telemetry?duration=1h";


// Not really sure if this is necessary.
var sondehub_request_running = false;

var temp_sondehub = null;

function process_sondehub_vehicles(data){
	// Check we have a 'valid' response to process.
	if (data === null ||
        data === {}) {
		sondehub_request_running = false;
		return;
	}

    // Now iterate over all the callsigns in the response.
	Object.keys(data).forEach(function(vcallsign){
        // Skip over our own data.
        if (vcallsign.startsWith(chase_config.habitat_call)){
            return;
        }

        if( (data[vcallsign] === null) || (data[vcallsign] == {})){
            // No data. This shouldn't happen, as the DB shouldn't give us empty results.
            return;

        }else{
            // Array of times for each callsign
            _position_times = Object.keys(data[vcallsign]);
            // Get last position, which should be the latest.
            _last_position = data[vcallsign][_position_times[_position_times.length - 1]];

            // Check if the vehicle is marked as a 'mobile' station
            if (_last_position.hasOwnProperty('mobile')){
                if(_last_position['mobile'] == true){
                    // We have found a mobile station!
                    //console.log(_last_position);

                    // Extract position.
                    var v_lat = parseFloat(_last_position.uploader_position[0]);
                    var v_lon = parseFloat(_last_position.uploader_position[1]);
                    var v_alt = parseFloat(_last_position.uploader_position[2]);
                    
                    // If the vehicle is already known to us, then update it position.
                    // Update any existing entries (even if the range is above the threshold)
                    if (chase_vehicles.hasOwnProperty(vcallsign)){

                        // Only update if the position ID of this position is newer than that last seen.
                        if (chase_vehicles[vcallsign].position_id !== _last_position.ts){
                            //console.log("Updating: " + vcallsign);
                            // Update the position ID.
                            chase_vehicles[vcallsign].position_id = _last_position.ts;

                            // Since we don't always get a heading with the vehicle position, calculate it.
                            var old_v_pos = {lat:chase_vehicles[vcallsign].latest_data[0],
                                lon: chase_vehicles[vcallsign].latest_data[1], 
                                alt:chase_vehicles[vcallsign].latest_data[2]};
                            var new_v_pos = {lat: v_lat, lon:v_lon, alt:v_alt};
                            chase_vehicles[vcallsign].heading = calculate_lookangles(old_v_pos, new_v_pos).azimuth;

                            // Update the position data.
                            chase_vehicles[vcallsign].latest_data = [v_lat, v_lon, v_alt];

                            // Update the marker position.
                            chase_vehicles[vcallsign].marker.setLatLng(chase_vehicles[vcallsign].latest_data).update();

                            // Rotate/replace the icon to match the bearing.
                            var _car_heading = chase_vehicles[vcallsign].heading - 90.0;
                            if (_car_heading<=90.0){
                                chase_vehicles[vcallsign].marker.setIcon(habitat_car_icons[chase_vehicles[vcallsign].colour]);
                                chase_vehicles[vcallsign].marker.setRotationAngle(_car_heading);
                            }else{
                                // We are travelling West - we need to use the flipped car icon.
                                _car_heading = _car_heading - 180.0;
                                chase_vehicles[vcallsign].marker.setIcon(habitat_car_icons_flipped[chase_vehicles[vcallsign].colour]);
                                chase_vehicles[vcallsign].marker.setRotationAngle(_car_heading);
                            }
                            return;
                        }

                        // No need to go any further.

                        return;
                    }

                    // Otherwise, we need to decide if we're going to add it or not.
                    // Determine the vehicle distance from our current position.
                    var v_pos = {lat: v_lat, lon:v_lon, alt:v_alt};
                    if (chase_car_position.marker === "NONE"){
                        var my_pos = {lat:chase_config.default_lat, lon:chase_config.default_lon, alt:0};
                    }else{
                        var my_pos = {lat:chase_car_position.latest_data[0], lon:chase_car_position.latest_data[1], alt:chase_car_position.latest_data[2]};
                    }
                    var v_range = calculate_lookangles(my_pos, v_pos).range/1000.0;

                    // If the range is less than the threshold, add it to our list of chase vehicles.
                    if(v_range < vehicle_max_range){
                        //console.log("Adding: " + vcallsign);
                        chase_vehicles[vcallsign] = {};
                        // Initialise a few default values
                        chase_vehicles[vcallsign].heading = 90;
                        chase_vehicles[vcallsign].latest_data = [v_lat, v_lon, v_alt];
                        chase_vehicles[vcallsign].position_id = _last_position.ts;

                        // Get an index for the car icon. This is incremented for each vehicle,
                        // giving each a different colour.
                        chase_vehicles[vcallsign].colour = car_colour_values[car_colour_idx];
                        car_colour_idx = (car_colour_idx+1)%car_colour_values.length; 

                        // Create marker
                        chase_vehicles[vcallsign].marker = L.marker(chase_vehicles[vcallsign].latest_data,
                            {title:vcallsign, 
                            icon: habitat_car_icons[chase_vehicles[vcallsign].colour], 
                            rotationOrigin: "center center"})
                                        .addTo(map);
                        // Keep our own record of if this marker has been added to a map,
                        // as we shouldn't be using the private _map property of the marker object.
                        chase_vehicles[vcallsign].onmap = true;

                        // Add tooltip, with custom CSS which removes all tooltip borders, and adds a text shadow.
                        chase_vehicles[vcallsign].marker.bindTooltip(vcallsign, 
                            {permanent: true,
                                direction: 'center',
                                offset:[0,25],
                                className:'custom_label'}).openTooltip();
                    }
                }

            }
        }

    });
	
	sondehub_request_running = false;
}

// Request the latest vehicle positions from Sondehub
function get_sondehub_vehicles(){

	if(!sondehub_request_running){
		sondehub_request_running = true;
		console.log("Requesting vehicles from Sondehub...")
	    $.ajax({
	      url: sondehub_vehicle_url,
	      dataType: 'json',
	      timeout: 15000,
	      async: true,
	      success: function(data) {
            console.log(data);
	        process_sondehub_vehicles(data);
	      }
		});
	}
}


/* Habitat ChaseCar lib (copied from SondeHub Tracker)
 * Uploads geolocation for chase cars to habitat
 *
 * Author: Rossen Gerogiev / Mark Jessop
 * Requires: jQuery
 * 
 * Updated to SondeHub v2 by Mark Jessop
 */

ChaseCar = {
    db_uri: "https://api.v2.sondehub.org/listeners",   // Sondehub API
    recovery_uri: "https://api.v2.sondehub.org/recovered",
};

// Updated SondeHub position upload function.
// Refer PUT listeners API here: https://generator.swagger.io/?url=https://raw.githubusercontent.com/projecthorus/sondehub-infra/main/swagger.yaml
// @callsign string
// @position object (geolocation position object)
ChaseCar.updatePosition = function(callsign, position) {
    if(!position || !position.coords) return;

    // Set altitude to zero if not provided.
    _position_alt = ((!!position.coords.altitude) ? position.coords.altitude : 0);

    var _doc = {
        "software_name": "SondeHub Tracker",
        "software_version": "{VER}",
        "uploader_callsign": callsign,
        "uploader_position": [position.coords.latitude, position.coords.longitude, _position_alt],
        "uploader_antenna": "Mobile Station",
        "uploader_contact_email": "none@none.com",
        "mobile": true
    };

    // push the doc to sondehub
    $.ajax({
            type: "PUT",
            url: ChaseCar.db_uri,
            contentType: "application/json; charset=utf-8",
            dataType: "json",
            data: JSON.stringify(_doc),
    });
};


ChaseCar.markRecovered = function(serial, lat, lon, recovered, callsign, notes){

    var _doc = {
        "serial": serial,
        "lat": lat,
        "lon": lon,
        "alt": 0.0,
        "recovered": recovered,
        "recovered_by": callsign,
        "description": notes
    };

    $.ajax({
        type: "PUT",
        url: ChaseCar.recovery_uri,
        contentType: "application/json; charset=utf-8",
        dataType: "json",
        data: JSON.stringify(_doc),
    }).done(function(data) {
        console.log(data);
        alert("Recovery Reported OK!");
    })
    .fail(function(jqXHR, textStatus, error) {
        try {
            _fail_resp = JSON.parse(jqXHR.responseText);
            alert("Error Submitting Recovery Report: " + _fail_resp.message);
        } catch(err) {
            alert("Error Submitting Recovery Report.");
        }
    })

}