====TimeSummary====

Summarise the amount of time spent in different states.

===Parameters===

^Name^Default^Meaning^
|inside||The word used to describe the amount of time spent inside the current timeframes|
|outside||The word used to describe the time **not** within the current timeframes|
|splitby||The attribute to split the times across|
|where||Limit the //splitby// to only certain values.|

===Description===

This is most often used in performance, utilisation and OEE calculations, where you want to understand the total amount of time equipment has been active, available and running.

===Using 'Inside'===

If using //inside//, the total time spent in **any** time frame is added up and will be available as four attributes. If the value of //inside// was 'running', you'd get...

  * Running Seconds: xx
  * Running Percentage: xx
  * Not Running Seconds: xx
  * Not Running Percentage: xx

You can customise the name of 'Not Running' using the //outside// parameter. For example,  you could have 'Stopped' instead of 'Not Running'.

===Using 'splitby'===

When using 'split by' instead, the totals are taken based on //attributes of the frames//.

For example, you might have the following time frames...

^Start^End^Mode^
|10:00AM|11:00AM|Offline|
|11:00AM|12:00AM|Online|
|12:00PM|01:00PM|Error|
|01:00PM|02:00PM|Error|

If you chose to split this by **mode**, your results would be...

  * Offline Total & Percentage,
  * Online Total & Percentage,
  * Error Total & Percentage

===Example===

If the following frames are available...

^Start^End^Mode^
|10:00AM|11:00AM|Offline|
|11:00AM|12:00AM|Online|
|12:00PM|01:00PM|Error|
|01:00PM|02:00PM|Error|

<code javascript>
{
   "type": "timesummary",
   "splitby": "Mode"
}
</code>

The final results will be...

^Name^Value^
|StartTime|10:00AM|
|EndTime|02:00PM|
|Offline Seconds|3600|
|Offline Percentage|33%|
|Online Seconds|3600|
|Online Percentage|33%|
|Error Seconds|3600|
|Error Percentage|33%|