Skip to content

Commit f614d52

Browse files
nuustiknuustik
committed
Add event subscription support
1 parent 1fc675e commit f614d52

4 files changed

Lines changed: 240 additions & 10 deletions

File tree

‎README.rst‎

Lines changed: 81 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Before all examples, you need:
2323

2424
.. code:: javascript
2525
26-
import studio from cdp-client
26+
import studio from "cdp-client"
2727
2828
Global API
2929
~~~~~~~~~~
@@ -161,7 +161,7 @@ client.root()
161161
162162
client.root().then(function (system) {
163163
// use the system INode object to access connected structure.
164-
}
164+
});
165165
166166
client.find(path)
167167
^^^^^^^^^^^^^^^^^
@@ -188,7 +188,7 @@ client.find(path)
188188
189189
client.find("MyApp.CPULoad").then(function (load) {
190190
// use the load object referring to CPULoad in MyApp
191-
}
191+
});
192192
193193
Instance Methods / INode
194194
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -266,7 +266,7 @@ node.info()
266266
| | | this flag is set to true for the application that the client |
267267
| | | is connected to |
268268
+------------------+------------------------------+---------------------------------------------------------------+
269-
| Info.flags | studio.protocol.Info.Flags | Optional: Optional: Node flags. Any of: |
269+
| Info.flags | studio.protocol.Info.Flags | Optional: Node flags. Any of: |
270270
| | | eNone |
271271
| | | eNodeIsLeaf |
272272
| | | eValueIsPersistent |
@@ -348,7 +348,7 @@ node.child(name)
348348
349349
node.child("CPULoad").then(function (load) {
350350
// use the load object referring to CPULoad child in current node
351-
}
351+
});
352352
353353
node.subscribeToValues(valueConsumer, fs, sampleRate)
354354
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -431,7 +431,6 @@ node.subscribeToStructure(structureConsumer)
431431
Subscribe to structure changes on this node. Each time child is added or removed from current node
432432
structureConsumer function is called with the name of the node and change argument where ADD == 1 and REMOVE == 0.
433433

434-
435434
node.unsubscribeFromStructure(structureConsumer)
436435
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
437436

@@ -443,6 +442,82 @@ node.unsubscribeFromStructure(structureConsumer)
443442

444443
Unsubscribe given callback from structure changes on this node.
445444

445+
node.subscribeToEvents(eventConsumer, timestampFrom)
446+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
447+
448+
- Arguments
449+
450+
Function(event) eventConsumer
451+
452+
timestampFrom - If 0, then all events are passed from the start of the CDP application.
453+
If > 0, events starting from this timestamp (in UTC nanotime) are passed.
454+
If not defined, then events from the moment of subscription is passed.
455+
456+
- Usage
457+
458+
Subscribe to events on this node. On each event eventConsumer function is called with Event argument described here:
459+
460+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
461+
| Property | Type | Description |
462+
+===================+==================================+=================================================================================================================================+
463+
| Event.id | number | Optional: System unique eventId (CDP eventId + handle) |
464+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
465+
| Event.sender | string | Optional: Event sender full name |
466+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
467+
| Event.flags | studio.protocol.EventCodeFlags | Optional: Event code flags. Any of: |
468+
| | | eAlarmSet = 1; // The alarm's Set flag/state was set. The alarm changed state to "Unack-Set" |
469+
| | | eAlarmClr = 2; // The alarm's Set flag was cleared. The Unack state is unchanged. |
470+
| | | eAlarmAck = 4; // The alarm changed state from "Unacknowledged" to "Acknowledged". The Set state is unchanged. |
471+
| | | eReprise = 64; // A repetition/update of an event that has been reported before. Courtesy of late subscribers. |
472+
| | | eSourceObjectUnavailable = 256; // The provider of the event has become unavailable. (disconnected or similar) |
473+
| | | eNodeBoot = 1073741824; // The provider reports that the CDPEventNode just have booted. |
474+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
475+
| Event.status | studio.protocol.EventStatusFlags | Optional: Value primitive type the node holds if node may hold a value. Any of: |
476+
| | | eStatusOK = 0x0, // No alarm set |
477+
| | | eNotifySet = 0x1, // NOTIFY alarm set |
478+
| | | eWarningSet = 0x10, // WARNING alarm set |
479+
| | | eLowLevelSet = 0x20, // LOW LEVEL alarm set |
480+
| | | eHighLevelSet = 0x40, // HIGH LEVEL alarm set |
481+
| | | eErrorSet = 0x100, // ERROR alarm set |
482+
| | | eLowLowLevelSet = 0x200, // LOW-LOW LEVEL alarm set |
483+
| | | eHighHighLevelSet = 0x400, // HIGH-HIGH LEVEL alarm set |
484+
| | | eEmergencySet = 0x800, // EMERGENCY LEVEL alarm present |
485+
| | | eValueForced = 0x1000, // Signal value was forced (overridden) |
486+
| | | eRepeatBlocked = 0x2000, // Alarm is blocked due to too many repeats |
487+
| | | eProcessBlocked = 0x4000, // Alarm is blocked by the software |
488+
| | | eOperatorBlocked = 0x8000, // Alarm is blocked by the user |
489+
| | | eNotifyUnacked = 0x10000, // NOTIFY alarm unacknowledged |
490+
| | | eWarningUnacked = 0x100000, // WARNING alarm unacknowledged |
491+
| | | eErrorUnacked = 0x1000000, // ERROR alarm unacknowledged |
492+
| | | eEmergencyUnacked = 0x8000000, // EMERGENCY alarm unacknowledged |
493+
| | | eDisabled = 0x20000000, // Alarm is disabled |
494+
| | | eSignalFault = 0x40000000, // Signal has fault condition |
495+
| | | eComponentSuspended = 0x80000000 // Component is suspended |
496+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
497+
| Event.timestamp | string | Optional: time stamp, when this event was sent (in UTC nanotime) |
498+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
499+
| Event.data | string | Optional: name + value pairs |
500+
+-------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
501+
502+
- Example
503+
504+
.. code:: javascript
505+
506+
node.subscribeToEvents(function (event) {
507+
console.log("Event triggered by:" + event.sender);
508+
});
509+
510+
node.unsubscribeFromEvent(eventConsumer)
511+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
512+
513+
- Arguments
514+
515+
Function(event) eventConsumer
516+
517+
- Usage
518+
519+
Unsubscribe given callback from events on this node.
520+
446521
node.addChild(name, typeName)
447522
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
448523

‎index.js‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ studio.protocol = (function(ProtoBuf) {
3737
obj.Node = studioBuilder.build("Node");
3838
obj.VariantValue = studioBuilder.build("VariantValue");
3939
obj.ValueRequest = studioBuilder.build("ValueRequest");
40+
obj.EventRequest = studioBuilder.build("EventRequest");
41+
obj.EventCodeFlags = studioBuilder.build("EventInfo.CodeFlags");
42+
obj.EventStatusFlags = studioBuilder.build("EventInfo.StatusFlags");
4043
obj.ChildAdd = studioBuilder.build("ChildAdd");
4144
obj.ChildRemove = studioBuilder.build("ChildRemove");
4245

@@ -335,6 +338,7 @@ studio.internal = (function(proto) {
335338
var childIterators = new Array();
336339
var valueSubscriptions = new Array();
337340
var structureSubscriptions = new Array();
341+
var eventSubscriptions = new Array();
338342
var lastValue;
339343
var lastInfo = null; //when we get this, if there are any child requests we need to fetch child fetch too
340344
var valid = true;
@@ -402,6 +406,8 @@ studio.internal = (function(proto) {
402406
lastInfo = protoInfo;
403407
id = protoInfo.node_id;
404408
this.async._makeGetterRequest();
409+
for (var i = 0; i < eventSubscriptions.length; i++)
410+
app.makeEventRequest(id, eventSubscriptions[i][1], false);
405411
};
406412

407413
this.add = function(node) {
@@ -448,6 +454,12 @@ studio.internal = (function(proto) {
448454
}
449455
};
450456

457+
this.receiveEvent = function (event) {
458+
for (var i = 0; i < eventSubscriptions.length; i++) {
459+
eventSubscriptions[i][0](event);
460+
}
461+
};
462+
451463
this.async = {};
452464

453465
this.async.onDone = function(resolve, reject, apiNode) {
@@ -495,6 +507,22 @@ studio.internal = (function(proto) {
495507
this._makeGetterRequest();
496508
};
497509

510+
this.async.subscribeToEvents = function(eventConsumer, startingFrom) {
511+
eventSubscriptions.push([eventConsumer, startingFrom]);
512+
app.makeEventRequest(id, startingFrom, false);
513+
};
514+
515+
this.async.unsubscribeFromEvents = function(eventConsumer) {
516+
for (var i = 0; i < eventSubscriptions.length; i++) {
517+
if (eventConsumer == eventSubscriptions[i][0]) {
518+
eventSubscriptions.splice(i, 1);
519+
break;
520+
}
521+
}
522+
if (eventSubscriptions.length === 0)
523+
app.makeEventRequest(id, 0, true);
524+
};
525+
498526
this.async.addChild = function(name, modelName) {
499527
app.makeChildAddRequest(id, name, modelName);
500528
};
@@ -655,6 +683,21 @@ studio.internal = (function(proto) {
655683
send(msg);
656684
};
657685

686+
this.makeEventRequest = function(id, startingFrom, stop) {
687+
var msg = new proto.Container();
688+
var request = new proto.EventRequest();
689+
request.node_id = id;
690+
if (stop) {
691+
request.stop = stop;
692+
}
693+
if (startingFrom != undefined) {
694+
request.starting_from = startingFrom;
695+
}
696+
msg.message_type = proto.ContainerType.eEventRequest;
697+
msg.event_request = [request];
698+
send(msg);
699+
};
700+
658701
this.makeChildAddRequest = function(id, name, modelName){
659702
var msg = new proto.Container();
660703
var request = new proto.ChildAdd();
@@ -783,6 +826,26 @@ studio.internal = (function(proto) {
783826
}
784827
}
785828

829+
function parseEventResponse(protoResponse) {
830+
for (var i = 0; i < protoResponse.length; i++) {
831+
var variantValue = protoResponse[i];
832+
for (var j = 0; j < variantValue.node_id.length; j++) {
833+
var node = nodeMap.get(variantValue.node_id[j]);
834+
if (node){
835+
var event = {
836+
id: variantValue.id,
837+
sender: variantValue.sender,
838+
code: variantValue.code,
839+
status: variantValue.status,
840+
timestamp: variantValue.timestamp,
841+
data: variantValue.data
842+
};
843+
node.receiveEvent(event);
844+
}
845+
}
846+
}
847+
}
848+
786849
function reauthenticate(userAuthResult, metadata) {
787850
var request = new studio.api.Request(metadata.systemName, metadata.applicationName, metadata.cdpVersion, metadata.systemUseNotification, userAuthResult);
788851
notificationListener.credentialsRequested(request)
@@ -824,6 +887,9 @@ studio.internal = (function(proto) {
824887
case proto.ContainerType.eStructureChangeResponse:
825888
parseStructureChangeResponse(protoContainer.structure_change_response);
826889
break;
890+
case proto.ContainerType.eEventResponse:
891+
parseEventResponse(protoContainer.event_response);
892+
break;
827893
case proto.ContainerType.eCurrentTimeResponse:
828894
break;
829895
case proto.ContainerType.eReauthResponse:
@@ -1038,6 +1104,37 @@ studio.api = (function(internal) {
10381104
node.async.unsubscribeFromStructure(structureConsumer);
10391105
};
10401106

1107+
1108+
/**
1109+
* Subscribe to value changes on this node.
1110+
*
1111+
* @param {valueConsumer} valueConsumer
1112+
* @param {fs} Maximum frequency that value updates are expected (controls how many changes are sent in a single packet). Defaults to 5 hz.
1113+
* @param {sampleRate} Maximum amount of value updates sent per second (controls the amount of data transferred). Zero means all samples must be provided. Defaults to 0.
1114+
*/
1115+
this.subscribeToValues = function(valueConsumer, fs=5, sampleRate=0) {
1116+
node.async.subscribeToValues(valueConsumer, fs, sampleRate);
1117+
};
1118+
1119+
/**
1120+
* Subscribe to events on this node.
1121+
*
1122+
* @param {eventConsumer} eventConsumer
1123+
* @param {startingFrom} If > 0, past events starting from this timestamp (in UTC nanotime) are re-forwarded.
1124+
*/
1125+
this.subscribeToEvents = function(eventConsumer, startingFrom) {
1126+
node.async.subscribeToEvents(eventConsumer, startingFrom);
1127+
};
1128+
1129+
/**
1130+
* Unsubscribe given callback from events on this node.
1131+
*
1132+
* @param {eventConsumer} eventConsumer
1133+
*/
1134+
this.unsubscribeFromEvents = function(eventConsumer) {
1135+
node.async.unsubscribeFromEvents(eventConsumer);
1136+
};
1137+
10411138
/**
10421139
* Add child Node to this Node.
10431140
*

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cdp-client",
3-
"version": "2.0.2",
3+
"version": "2.0.3",
44
"description": "A simple Javascript interface for the CDP Studio development platform that allows Javascript applications to interact with",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)