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

Static Public Member Functions

static getPicture ()
 
static getPictures ()
 

Detailed Description

This class lets you download the pictures taken by Sensorcam pictures, as long as you have at least the view permission on the station the Sensorcam is installed on.

Member Function Documentation

static sensorcam::getPicture ( )
static

Get a link to a picture sent by a station.

Parameters
intstationIdStation id
intslotThe slot the camera is plugged in
intepochEpoch time of the picture, 0 to get the most recent picture received
Returns

An array such as:

Property Type Description
success boolean Whether the picture could be found
error string An error message in case of failure
picture object Picture object

A picture is an object such as:

Property Type Description
URL string URL to the full-size picture
URLThumbnail string URL to the thumbnail picture
epoch int Epoch time of the picture
size int Size in bytes of the picture
static sensorcam::getPictures ( )
static

Retrieve a set of pictures sent by a station.

Parameters
intstationIdStation id
intslotThe slot the camera is plugged in
intfromBegining of the time interval in epoch time
inttoEnd of the time interval in epoch time
Returns

An object such as:

Property Type Description
success boolean Whether the picture could be found
error string An error message in case of failure
baseURL string The base URL of all pictures retrieved
pictures array An array of picture objects

A picture is an object such as:

Property Type Description
full string Name of the full-size picture (URL is baseURL + '/' + full)
small string Name of the thumbnail picture (URL is baseURL + '/' + small)
epoch int Epoch time of the picture
size int Size in bytes of the picture
width int Width of the picture in pixels
height int Height of the picture in pixels