Introduction :

A time series is a series of numerical values representing the evolution of a specific quantity over time. this API allows easy management of these data.

Usage :

To use the spinalTimeSeries API, you must :

Install :

Installation

npm install --save https://github.com/spinalcom/spinal-models-timeSeries.git

Import and instantiate

Import and Instantiate

var TimeSeries = require("spinal-models-timeSeries").TimeSeries; // import

var timeSeries = new TimeSeries(); // instantiate

Methods :

addToTimeSeries(value)

takes as parameter a number (data to save ) and saves an object of type {date: saveDate, value: dataToSave} in timeSeries data.

Param	Type	Description	Mandatory
Value	number	Value To save	yes

getTimeSeriesCurrentValue()

Not Takes a param and returns an object that contains the date and value of current timeSeries.

getTimeSeriesBetweenDates(argBeginDate, argEndDate)

Takes as parameters two dates (in millisecond or a date string in a valid format, preferably "year-month-day hours:minutes:seconds" for example : 2018-10-25 16:26:30 ) and returns a Array of all timeSeries between the two dates.

It returns an array of all timeSeries between argBeginDate and argEndDate

Param	Type	Description	Mandatory
argBeginDate	`Date`	Must be a date in milisecond or in year-month-day hours:minutes:seconds form	yes
argEndDate	`Date`	the last date in milisecond or in year-month-day hours:minutes:seconds format	No

getDateValue(argDate)

It Takes a date as params and return the data corresponding to this date, it returns an empty object if no data is associated with the date.

returns an object that contains the date and data corresponding to argDate.

Param	Type	Description	Mandatory
argDate	`Date`	Must be a date in milisecond or in year-month-day hours:minutes:seconds format	yes

removeDate(dateToRemove)

It takes a date as a params and remove and returns the data corresponding to this date. It returns the data corresponding to this date, returns undefined if no data found.

Param	Type	Description	Mandatory
dateToRemove	`Date`	Must be a date in milisecond or in year-month-day hours:minutes:seconds format	yes

archiveDate(beginDate, [endDate])

this function takes as parameters two date (one optional), if both dates are given it archives all date between both (they even included) else it archives the date given.

Param	Type	Description	Mandatory
beginDate	`Date`	Must be a date in milisecond or in year-month-day hours:minutes:seconds format	yes
[endDate]	`Date`	Optional, must be a date in milisecond or in year-month-day hours:minutes:seconds format	No

getDateArchived()

this function allows to get all data archived, it returns a Promise.

archiveDataPerDay()

this function allows to archive the data of the timeSeries, by changing the attribute archiveTime you change the archiving frequency.

TimeSeries API