mirror of
https://github.com/ConnectedHumber/Air-Quality-Web
synced 2024-12-27 11:14:56 +00:00
41 lines
1.8 KiB
PHP
41 lines
1.8 KiB
PHP
<?php
|
|
|
|
namespace AirQuality\Repositories;
|
|
|
|
interface IMeasurementDataRepository {
|
|
/**
|
|
* Returns the specified reading type for all devices at the specified date
|
|
* and time.
|
|
* @param \DateTime $datetime The date and time to get the readings for.
|
|
* @param int $reading_type_id The reading type id to fetch.
|
|
* @return array The requested readings.
|
|
*/
|
|
public function get_readings_by_date(\DateTime $datetime, int $reading_type_id);
|
|
|
|
/**
|
|
* Gets the first and last DateTimes of the readings for a specified device.
|
|
* @param int $device_id The device id to fetch for.
|
|
* @return \DateTime[] The first and last DateTimes for which readings are stored.
|
|
*/
|
|
public function get_device_reading_bounds(int $device_id);
|
|
/**
|
|
* Gets the readings of a specified type for a specific device between the 2 given dates and times.
|
|
* @param int $device_id The id of the device to fetch data for.
|
|
* @param int $type_id The reading type to fetch.
|
|
* @param \DateTime $start The starting DateTime.
|
|
* @param \DateTime $end The ending DateTime.
|
|
* @param int $average_seconds The number of seconds to averageg the data over. For example a value of 3600 (1 hour) will return 1 data point per hour, with the value of each point an average of all the readings for that hour.
|
|
* @return array The requested data.
|
|
*/
|
|
public function get_readings_by_device(int $device_id, int $type_id, \DateTime $start, \DateTime $end, int $average_seconds = 1);
|
|
|
|
/**
|
|
* Retrieves a given number of the most recent readings for a specific device.
|
|
* @param int $device_id The id of the device to get recent readings for.
|
|
* @param int $type_id The id of the reading type to fetch data for.
|
|
* @param int $count The number of readings to return.
|
|
* @return array The requested data.
|
|
*/
|
|
public function get_recent_readings(int $device_id, int $type_id, int $count);
|
|
|
|
}
|