appChart.js

"use strict";

import {
  BASE_URL,
  QUERY_PARAMS_COMBINED,
} from "./src_modules/baseUrlPlusQueryParams.mjs";

import {
  formatSensorThingsApiResponseForLineChart,
  drawLineChartHighcharts,
} from "./src_modules/chartLine.mjs";

import {
  formatSensorThingsApiResponseForHeatMap,
  drawHeatMapHighcharts,
} from "./src_modules/chartHeatmap.mjs";

import {
  formatSensorThingsApiResponseForScatterPlot,
  drawScatterPlotHighcharts,
} from "./src_modules/chartScatterPlot.mjs";

import {
  formatAggregationResultForColumnChart,
  drawColumnChartHighcharts,
} from "./src_modules/chartColumn.mjs";

import {
  formatDatastreamMetadataForChart,
  extractPropertiesFromFormattedDatastreamMetadata,
  getMetadataPlusObservationsFromSingleOrMultipleDatastreams,
} from "./src_modules/fetchData.mjs";

import { calculateVorlaufMinusRuecklaufTemperature } from "./src_modules/calculateTemperatureDiff.mjs";

import {
  calculateSumOfObservationValuesWithinInterval,
  extractUniqueCalendarDatesFromTimestamp,
  extractUniqueCalendarMonthsFromCalendarDates,
  calculateAverageOfObservationValuesWithinInterval,
} from "./src_modules/aggregate.mjs";

/**
 * Test plotting of temp difference (dT) using heatmap
 */
const drawHeatmapHCUsingTempDifference = async function () {
  const [observationsTemperatureDiff225Arr, metadataTemperatureDiff225Arr] =
    await calculateVorlaufMinusRuecklaufTemperature(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      "225",
      "60min"
    );

  // We want to have nested arrays, so as to mimick the nested responses we get from fetching observations + metadata
  const observationsTemperatureDiff225NestedArr = [
    observationsTemperatureDiff225Arr,
  ];

  const metadataTemperatureDiff225NestedArr = [metadataTemperatureDiff225Arr];

  // Format the observations
  const formattedTempDiff225NestedArr =
    observationsTemperatureDiff225NestedArr.map((obsArr) =>
      formatSensorThingsApiResponseForHeatMap(obsArr)
    );

  // Format the metadata
  const formattedTempDiff225MetadataNestedArr =
    metadataTemperatureDiff225NestedArr.map((metadataObj) =>
      formatDatastreamMetadataForChart(metadataObj)
    );

  // Extract the formatted metadata properties
  const extractedFormattedTempDiff225Properties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedTempDiff225MetadataNestedArr
    );

  // First need to extract the formatted observations from the nested array
  // Heatmap only needs one set of formatted observation values
  drawHeatMapHighcharts(
    ...formattedTempDiff225NestedArr,
    extractedFormattedTempDiff225Properties
  );
};

/**
 * Test drawing of scatter plot chart
 */
const drawScatterPlotHCTest2 = async function () {
  const sensorsOfInterestNestedArr = [
    ["225", "vl", "60min"],
    // ["125", "rl", "60min"],
    ["weather_station_521", "outside_temp", "60min"],
  ];

  const observationsPlusMetadata =
    await getMetadataPlusObservationsFromSingleOrMultipleDatastreams(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      sensorsOfInterestNestedArr
    );

  // Extract the combined arrays for observations and metadata
  const [observationsNestedArr, metadataNestedArr] = observationsPlusMetadata;

  // Create formatted array(s) for observations
  // This function expects two arguments, these are unpacked using the spread operator
  const formattedObservationsArr = formatSensorThingsApiResponseForScatterPlot(
    ...observationsNestedArr
  );

  // Create formatted array(s) for metadata
  const formattedMetadataNestedArr = metadataNestedArr.map((metadataObj) =>
    formatDatastreamMetadataForChart(metadataObj)
  );

  // Extract the formatted metadata properties
  const extractedFormattedDatastreamProperties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedMetadataNestedArr
    );

  drawScatterPlotHighcharts(
    formattedObservationsArr,
    extractedFormattedDatastreamProperties
  );
};

/**
 * Test drawing of line chart with multiple series
 */
const testLineChartMultipleSeries = async function () {
  const sensorsOfInterestNestedArr = [
    ["225", "vl", "60min"],
    ["125", "rl", "60min"],
    ["weather_station_521", "outside_temp", "60min"],
  ];

  const observationsPlusMetadataArr =
    await getMetadataPlusObservationsFromSingleOrMultipleDatastreams(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      sensorsOfInterestNestedArr
    );

  // Extract the observations and metadata arrays of arrays
  const [observationsNestedArr, metadataNestedArr] =
    observationsPlusMetadataArr;

  // Format the observations
  const formattedObservationsNestedArr = observationsNestedArr.map(
    (observationsArr) =>
      formatSensorThingsApiResponseForLineChart(observationsArr)
  );

  // Format the metadata
  const formattedMetadataNestedArr = metadataNestedArr.map((metadataArr) =>
    formatDatastreamMetadataForChart(metadataArr)
  );

  // Extract the formatted metadata properties
  const extractedFormattedDatastreamProperties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedMetadataNestedArr
    );

  drawLineChartHighcharts(
    formattedObservationsNestedArr,
    extractedFormattedDatastreamProperties
  );
};

/**
 * Test drawing of column chart using aggregation / sum result - monthly
 */
const drawColumnChartMonthlySumTest = async function () {
  const sensorsOfInterestNestedArr = [
    ["125", "vl", "60min"],
    ["225", "vl", "60min"],
  ];

  const observationsPlusMetadata =
    await getMetadataPlusObservationsFromSingleOrMultipleDatastreams(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      sensorsOfInterestNestedArr
    );

  // Extract the observations and metadata for each sensor
  // Array elements in same order as input array
  const [observationsNestedArr, metadataNestedArr] = observationsPlusMetadata;

  // Unique calendar dates
  const uniqueCalendarDatesNestedArr = observationsNestedArr.map(
    (observationsArr) =>
      extractUniqueCalendarDatesFromTimestamp(observationsArr)
  );

  // Unique calendar months
  const uniqueCalendarMonthsNestedArr = uniqueCalendarDatesNestedArr.map(
    (uniqueCalendarDatesArr) =>
      extractUniqueCalendarMonthsFromCalendarDates(uniqueCalendarDatesArr)
  );

  // Calculate sum of values of observations - monthly
  const observationsSumMonthlyNestedArr =
    calculateSumOfObservationValuesWithinInterval(
      observationsNestedArr,
      "60min",
      uniqueCalendarMonthsNestedArr,
      "monthly"
    );

  // Format the observations
  const formattedObservationsSumMonthlyNestedArr =
    observationsSumMonthlyNestedArr.map((obsSumMonthlyArr, i) =>
      formatAggregationResultForColumnChart(
        uniqueCalendarMonthsNestedArr[i],
        obsSumMonthlyArr
      )
    );

  // Format the metadata
  const formattedMetadataNestedArr = metadataNestedArr.map((metadataObj) =>
    formatDatastreamMetadataForChart(metadataObj)
  );

  // Extract the formatted metadata properties
  const extractedFormattedDatastreamProperties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedMetadataNestedArr
    );

  drawColumnChartHighcharts(
    formattedObservationsSumMonthlyNestedArr,
    extractedFormattedDatastreamProperties
  );
};

/**
 * Test drawing of column chart using aggregation / sum result - daily
 */
const drawColumnChartDailySumTest = async function () {
  const sensorsOfInterestNestedArr = [
    ["125", "vl", "60min"],
    ["225", "vl", "60min"],
  ];

  const observationsPlusMetadata =
    await getMetadataPlusObservationsFromSingleOrMultipleDatastreams(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      sensorsOfInterestNestedArr
    );

  // Extract the observations and metadata for each sensor
  // Array elements in same order as input array
  const [observationsNestedArr, metadataNestedArr] = observationsPlusMetadata;

  // Unique calendar dates
  const uniqueCalendarDatesNestedArr = observationsNestedArr.map(
    (observationsArr) =>
      extractUniqueCalendarDatesFromTimestamp(observationsArr)
  );

  // Calculate sum of values of observations - daily
  const observationsSumDailyNestedArr =
    calculateSumOfObservationValuesWithinInterval(
      observationsNestedArr,
      "60min",
      uniqueCalendarDatesNestedArr,
      "daily"
    );

  // Format the observations - daily
  const formattedObservationsSumDailyNestedArr =
    observationsSumDailyNestedArr.map((obsSumDailyArr, i) =>
      formatAggregationResultForColumnChart(
        uniqueCalendarDatesNestedArr[i],
        obsSumDailyArr
      )
    );

  // Format the metadata
  const formattedMetadataNestedArr = metadataNestedArr.map((metadataObj) =>
    formatDatastreamMetadataForChart(metadataObj)
  );

  // Extract the formatted metadata properties
  const extractedFormattedDatastreamProperties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedMetadataNestedArr
    );

  drawColumnChartHighcharts(
    formattedObservationsSumDailyNestedArr,
    extractedFormattedDatastreamProperties
  );
};

/**
 * Test drawing of line chart using aggregation / average result - monthly
 */
const drawLineChartMonthlyAverageTest = async function () {
  const sensorsOfInterestNestedArr = [
    ["125", "vl", "60min"],
    ["225", "vl", "60min"],
  ];

  const observationsPlusMetadata =
    await getMetadataPlusObservationsFromSingleOrMultipleDatastreams(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      sensorsOfInterestNestedArr
    );

  // Extract the observations and metadata for each sensor
  // Array elements in same order as input array
  const [observationsNestedArr, metadataNestedArr] = observationsPlusMetadata;

  // Unique calendar dates
  const uniqueCalendarDatesNestedArr = observationsNestedArr.map(
    (observationsArr) =>
      extractUniqueCalendarDatesFromTimestamp(observationsArr)
  );

  // Unique calendar months
  const uniqueCalendarMonthsNestedArr = uniqueCalendarDatesNestedArr.map(
    (uniqueCalendarDatesArr) =>
      extractUniqueCalendarMonthsFromCalendarDates(uniqueCalendarDatesArr)
  );

  // Calculate average of values of observations - monthly
  const observationsAverageMonthlyNestedArr =
    calculateAverageOfObservationValuesWithinInterval(
      observationsNestedArr,
      "60min",
      uniqueCalendarMonthsNestedArr,
      "monthly"
    );

  // Format the observations
  const formattedObservationsAverageMonthlyNestedArr =
    observationsAverageMonthlyNestedArr.map((obsAverageMonthlyArr, i) =>
      formatAggregationResultForColumnChart(
        uniqueCalendarMonthsNestedArr[i],
        obsAverageMonthlyArr
      )
    );

  //  Format the metadata
  const formattedMetadataNestedArr = metadataNestedArr.map((metadataObj) =>
    formatDatastreamMetadataForChart(metadataObj)
  );

  // Extract the formatted metadata properties
  const extractedFormattedDatastreamProperties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedMetadataNestedArr
    );

  drawLineChartHighcharts(
    formattedObservationsAverageMonthlyNestedArr,
    extractedFormattedDatastreamProperties
  );
};

/**
 * Test drawing of line chart using aggregation / average result - daily
 */
const drawLineChartDailyAverageTest = async function () {
  const sensorsOfInterestNestedArr = [
    ["125", "vl", "60min"],
    ["225", "vl", "60min"],
  ];

  const observationsPlusMetadata =
    await getMetadataPlusObservationsFromSingleOrMultipleDatastreams(
      BASE_URL,
      QUERY_PARAMS_COMBINED,
      sensorsOfInterestNestedArr
    );

  // Extract the observations and metadata for each sensor
  // Array elements in same order as input array
  const [observationsNestedArr, metadataNestedArr] = observationsPlusMetadata;

  // Unique calendar dates
  const uniqueCalendarDatesNestedArr = observationsNestedArr.map(
    (observationsArr) =>
      extractUniqueCalendarDatesFromTimestamp(observationsArr)
  );

  // Calculate average of values of observations - daily
  const observationsAverageDailyNestedArr =
    calculateAverageOfObservationValuesWithinInterval(
      observationsNestedArr,
      "60min",
      uniqueCalendarDatesNestedArr,
      "daily"
    );

  // Format the observations - daily
  const formattedObservationsAverageDailyNestedArr =
    observationsAverageDailyNestedArr.map((obsAverageDailyArr, i) =>
      formatAggregationResultForColumnChart(
        uniqueCalendarDatesNestedArr[i],
        obsAverageDailyArr
      )
    );

  // Format the metadata
  const formattedMetadataNestedArr = metadataNestedArr.map((metadataObj) =>
    formatDatastreamMetadataForChart(metadataObj)
  );

  // Extract the formatted metadata properties
  const extractedFormattedDatastreamProperties =
    extractPropertiesFromFormattedDatastreamMetadata(
      formattedMetadataNestedArr
    );

  drawLineChartHighcharts(
    formattedObservationsAverageDailyNestedArr,
    extractedFormattedDatastreamProperties
  );
};

// drawScatterPlotHCTest2();
// drawHeatmapHCUsingTempDifference();
// testLineChartMultipleSeries();
// drawColumnChartMonthlySumTest();
// drawColumnChartDailySumTest();
// drawLineChartMonthlyAverageTest();
// drawLineChartDailyAverageTest();