UNPKG

barrageapi

Version:

A library for sending data to Barrage, an advanced streaming analytics service from MIOsoft

56 lines (32 loc) • 3.04 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
![Barrage logo](https://databarrage.com/img/BarrageLogoWaves.png) Barrage provides a way to look for interesting events in streaming sensor data and send detailed, real-time alerts when those events are found. Instead of using simple threshold-based event matching, Barrage uses *patterns*, which can describe an event using multiple characteristics of the data. # Getting started # To get started with Barrage: 1. Download **barrageapi**. 2. Sign up for a free Barrage account at [https://v1.databarrage.com/](https://v1.databarrage.com/). 3. Start building patterns and using **barrageapi** to send data. [![](https://databarrage.com/img/barrage-signup-button.png)](https://v1.databarrage.com/) # Documentation # * View the Barrage API documentation [here](https://v1.databarrage.com/documentation.html). * View the Barrage Console documentation [here](https://v1.databarrage.com/ui/ConsoleUserGuide.html). * View the Barrage Script documentation [here](https://v1.databarrage.com/script/ScriptUserGuide.html). All of Barrage's documentation is also available from within the Barrage console. # Example # A sample script is available [here](https://v1.databarrage.com/examples/restaurantPowerMeter.js). To configure, set your username and password on lines 11 and 12. # Support # Ask questions on [Stack Overflow's Barrage tag](http://stackoverflow.com/questions/tagged/barrage). # How is Barrage different? # Barrage provides a way to detect interesting events using sensors and get real-time, high-information alerts about those events. Event detection strategies that rely entirely on thresholds are inherently low-information. Their real-time alerts can't contain much more information than "this value has surpassed the threshold." But when you're using sensors so you can respond to events in real time, low-information alerts aren't good enough. You need to know whether that loud noise was a conversation, an alarm, or thunder to react appropriately. A threshold system can only deliver that information after further analysis, so your ability to respond is delayed. Barrage describes events as *patterns* instead of relying on thresholds. Patterns let you describe an event using multiple characteristics of the data, including: * magnitude * duration * repetition * rate of change You can also reference things like arithmetic and statistics as part of a pattern, in addition to the sensor values. With patterns, the detection process inherently distinguishes between different types of events. This makes Barrage's alerts real-time *and* high-information, because alerts can be associated with a particular pattern. So Barrage can send alerts about thunder to a log, alerts about alarms to specific staff, and alerts about loud conversations to the front desk. Ready to try Barrage? Download **barrageapi**, then sign up for your Barrage account: [![](https://databarrage.com/img/barrage-signup-button.png)](https://v1.databarrage.com/)