1.0.3

Implement buffer feature, which uses an etsdb database to store updates that failed to send. Upon successfully sending an update, the DSLink will also send any unsent updates that are in the buffer. The buffer includes optional auto-purge functionality, which will erase the oldest unsent updates if the buffer exceeds a certain size. In order to more efficiently send the buffered updates, the rule format now includes %STARTBLOCK% and %ENDBLOCK% as delimeters for a repeatable block in a "batch update" request.

Author: d-shapiro

build.gradle

@@ -24,14 +24,18 @@ repositories {
 
 dependencies {
     //implementation 'org.iot-dsa:dslink-v2-websocket:+' //for a locally installed sdk
-    implementation 'com.github.iot-dsa-v2.sdk-dslink-java-v2:dslink-v2-websocket:+'
+    implementation 'com.github.iot-dsa-v2.sdk-dslink-java-v2:dslink-v2-websocket:v+'
     implementation 'commons-logging:commons-logging:+'
     implementation 'org.apache.commons:commons-lang3:3.6'
+    implementation 'commons-io:commons-io:2.6'
     implementation 'org.apache.cxf:cxf-rt-rs-security-oauth2:3.1.7'
     implementation 'org.apache.cxf:cxf-rt-rs-client:3.0.0-milestone1'
     implementation 'javax.xml.bind:jaxb-api:2.3.0'
     implementation 'javax.activation:activation:+'
 
+    testImplementation 'junit:junit:+'
+    testImplementation 'org.mockito:mockito-all:+'
+    
 }
 
 applicationDistribution.from(new File(project.projectDir, "/dslink.json"))

docs/Usage_Guide.md

@@ -15,6 +15,7 @@ Once you have a connection, you can set up a rule using the `Add Rule` action. T
 - Method: The REST method to use.
 - URL Parameters: A map of URL parameters to use when sending the REST request. If you want to use the value, timestamp, or status of an update in the params, use the placeholders `%VALUE%`, `%TIMESTAMP%` and `%STATUS%`.
 - Body: The body of the REST request, if applicable. Once again, use `%VALUE%`, `%TIMESTAMP%` and `%STATUS%` as placeholders.
+  - Note: If the REST API supports recieving multiple updates in one message, you can use `%STARTBLOCK%` and `%ENDBLOCK%` to denote the boundaries of a repeatable block. When needing to send many updates at once (in the case of having to catch up after a disconnect), the DSLink will repeat the block for each update and use commas to separate the blocks. Note that this will only work if all value, timestamp, and status placeholders are in the body and inside the repeatable block.
 - Minimum Refresh Rate: Optional, ensures that at least this many seconds elapse between updates. This means that the DSLink will suppress updates that are too close together. (Leave this parameter as 0 to not use this feature.)
 - Maximum Refresh Rate: Optional, ensures that an update gets sent every this many seconds. This means that if the DSA value updates too infrequently, the DSLink will send duplicate updates. (Leave this parameter as 0 to not use this feature.)
 ## Add a Rule Table
@@ -40,10 +41,12 @@ If you want to set up multiple rules in bulk, create a table of Rules in Atrius
   },
   "data": {
     "<BuildingOS meter id>": [
+      %STARTBLOCK%
       [
         "%TIMESTAMP%",
         %VALUE%
       ]
+      %ENDBLOCK%
     ]
   }
 }
@@ -56,10 +59,12 @@ e.g:
   },
   "data": {
     "b9c7c0a03de611e895505254009e602c": [
+      %STARTBLOCK%
       [
         "%TIMESTAMP%",
         %VALUE%
       ]
+      %ENDBLOCK%
     ]
   }
 }

dslink.json

@@ -1,6 +1,6 @@
 {
   "name": "dslink-java-v2-restadapter",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Java DSA to REST adpater DSLink",
   "main": "bin/dslink-java-v2-restadapter",
   "configs": {