Climaps API  version 1
Static Public Member Functions | List of all members
sensors Class Reference

Static Public Member Functions

static getSensorsByStationId ()
 

Detailed Description

This class lets you retrieve information about sensors.

The terminology is as follows:

A sensor can return multiple measurements (a Sensirion SHT75 returns both the air temperature and the air humidity). Each tuple {sensor, measurement} has a unique id, i.e., the temperature returned by a Sensirion SHT75 has a different id from the temperature returned by a Decagon VP-3.

Member Function Documentation

static sensors::getSensorsByStationId ( )
static

Get the list of sensors installed on a station during a given time interval.

Parameters
intstationIdStation Id
intfromBegining of the time interval in epoch time
inttoEnd of the time interval in epoch time
Returns

An array of objects such as:

Property Type Description
id int Measurement id
catId int Id of the category the measurement falls in (e.g., data::CAT_HEALTH_SYSTEM)
slot int Number of the slot the sensor is installed on
sensor string Name of the sensor (e.g., "Apogee SI-11")
name string Name of the measurement (e.g., "temperature")
order int Preferred display order of the measurement for that sensor (lower value is higher priority)
visible boolean Whether the measurement is visible to the user (e.g., see account::setOwnMeasurementHidden)
units string Units of the sensor (e.g., "°C")
Note
The array is sorted by (category, slot, sensor, order, name).
The name of the measurements are automatically translated into the the user's current language (see account::getOwnSettings).