Methods

Methods

Methods are used in a request to retrieve data. They specify what type of data is needed and will return it. Permissions affect how data is interacted with by a user.

Request fields are sent in the top level JSON request. Response fields return in the updates field, methods will go into more detail on how updates are received.

List of methods

• List
• Set/Publish
• Remove
• Invoke
• Subscribe
• Unsubscribe
• Close

List

This method will retrieve a list of children, attributes, and configs. However, children without the read permission will not be displayed.

The response of list will update on any node change available to the current requester, there is no need to list on same node twice in same requester because second stream will return same state as the previous list stream's final state.

Request fields

• path (string)
  • Path of the node to retrieve a list on

Response columns

• name

• Name of the field

• Names that start with '$' are configs that can affect how system works

  • "$is"
    • profile of the node, must be the first update of a list stream, otherwise requester will treat it as a new node and clear other existing data
    • profile node should also be loaded to get all predefined configs/attributes of a node
    • profile nodes locate in /defs/profile/
  • "$permission"
    • a enum of the following values
      • read user has read access to the node, can be omitted
      • write user has write access to the node, can read node and write to node and its attributes
      • config user has full access to the node, can read/write and change configs

• Names that start with '@' are custom attributes

• Other names are children nodes, with map value of the children properties

  • children node must include $name if it has a display name
  • children node must include $is in the child object
  • children node must include $permission if it's not 'read'
  • children node should include $invokable if user is allowed to invoke it
  • children node should include $type if node support subscription
  • other properties of children nodes shouldn't appear in the list response.

• Names must not be blank or contain these characters: / \ ? * : | “ < >

• When % is used in name, it must be used only for UTF-8 based percent encode, not for other purpose.

• value

• updated value of the field

Response meta

• change (optional enum configuration)
  • enum value, can be "remove" or "update"
  • default value is "update"

Example usage

Request

{
  "rid": 1,
  "method": "list",
  "path": "/light"
}

Response

{
  "rid": 1,
  "stream": "open",
  "updates": [
    [
      "$is",
      "point/light"
    ],
    [
      "$permission",
      "write"
    ],
    [
      "@city",
      "San Francisco"
    ],
    [
      "point1",
      {
        "$is": "temperaturePoint",
        "$name": "Custom Name for Point1",
        "$invokable": "read"
      }
    ],
    [
      "point2",
      {
        "$is": "numericPoint",
        "$invokable": "write"
      }
    ],
    {
      "name": "point3",
      "change": "remove"
    }
  ]
}

Example Sequence Diagram of List

Set / Publish

This method will set values on a node, analogous to publishing to a topic in traditional message brokers.

Request fields

• path (type:path)
  • path of the node to set, can be a node path or attribute/config path
• permit (string, optional)
  • max permission of this Set
    • if $writable require "config" permission to change value, and requester do have "config" permission, but permit is "read", the action should still return a "permissionDenied" error.
• value (any primitive type)
• The type of the value must be acceptable to the type of the node.

Response columns

No response update.

Example usage

The value in this usage turns the lights on (true) or off (false).

Request

{
  "rid": 1,
  "method": "set",
  "permit": "write",
  "path": "/lights/Lights A",
  "value": false
}

Response

{
  "rid": 1,
  "stream": "closed"
}

Remove

This method will remove attributes or configs. Remove a overwritten config/attribute value will restore it to default value defined in profile

Request fields

• path (type:path)
  • attribute/config path to remove

Response columns

No response update.

Example usage

Request

{
  "rid": 1,
  "method": "remove",
  "path": "/light/@city"
}

Response

{
  "rid": 1,
  "stream": "closed"
}

Invoke

This method will invoke an action on a node. params list and

Request fields

• permit (string, optional)
  • max permission of this invoke
    • if action require "write" permission to invoke, and requester do have "write" permission, but permit is "read", the action should still return a "permissionDenied" error.
• params (map, optional)
  • The parameters are defined in the action node
  • Can be omitted if the action takes no parameters

Response columns

columns list is defined in the action node or its profile but invoke response can also return a column structure to overwrite the value the columns structure can only be returned once per action invoke. Columns can also have a "meta" field which is a key:value pair where value is always dynamic.

Response updates (rows)

columns results can have one or multiple rows if the invoke response' streamstatus is still "open", it can have more updates rows in future response until requester or responder close the stream

Example usage

Request

{
  "rid": 1,
  "method": "invoke",
  "permit": "read",
  "path": "/echo",
  "params": {
    "string": "dsaisawesome"
  }
}

Response

{
  "rid": 1,
  "stream": "closed",
  "columns": [
    {"name": "result", "type": "string", "meta": { "test": true, "unit": "F" } }
  ],
  "updates": [
    ["dsaisawesome"]
  ]
}

Stream Response

{
  "rid": 1,
  "stream": "open",
  "meta":{"mode":"refresh", "meta": {}},
  "columns": [
    {"name": "changes", "type": "string"}
  ],
  "updates": [
    ["first update"]
  ]
}

{
  "rid": 1,
  "stream": "closed",
  "updates": [
    ["second update"]
  ]
}

meta

The default table mode is stream. When the mode is omitted the last mode set will be used. modify is not allowed in stream mode.

mode: optional

• refresh : Clear all existing rows in requester cache and add the updates. If columns are sent, then all previous columns will be cleared.
• append : Append updates to the end of cache. If columns are sent, they will be added to the existing columns of the table.
• stream : Works similarly as append, but allows requester to safely control the cache size and remove data from beginning. If columns are sent, they will be added to the existing columns of the table.

modify: optional

• replace 0-10 : remove rows in the range and replace with new updates
• insert 0 : insert before the rows number, 0 means insert from beginning

meta: optional

• This is overall table metadata related to the table as a whole. This is solely used for information purposes about the table.

Example Sequence Diagram of Invoke with Streaming Response

Example Sequence Diagram of Invoke with Non-Streaming Response

Subscribe

This method will subscribe to a datapoint node to receive its value and value updatea.

Request fields

• paths (type:list)
  • a list of JSON objects about the subscription
    • path - Path of the node
    • sid - Subscription ID
    • qos (optional int, can be 0,1,2,3, default is 0) - the qos of the subscription
      • 0: default, responder/broker won't cache value for requester, if responder's updating speed is faster than requester's reading speed, broker only send requester the last state with the rollup of all skipped values.
      • 1: queued, responder/broker cache values for the requester, but would drop the queue as soon as the requester is disconnected.
      • 2: durable, responder/broker cache values for the requester, makes sure it doesn't miss data if requester's connection is slow, or when requester is offline for a while.
      • 3: durable & persist, both 1 and 2, responder/broker will backup the whole cache queue

Response columns

No response update to the direct response. the value update will be sent in the main subscription stream, which has the following columns

There are multiple elements in the updates field. Each element will contain:

• sid
  • Subscription ID (requester must keep track of which SIDs belong to which node)
• value
  • updated value
• ts (time string in iso8601 format)
  • last update time of the value

Response meta

• status (optional enum)
  • status of the value
    • ok - No issues with the node value (default is status is omitted)
    • stale - The value could potentially be out of date
    • disconnected - Never set by a dslink. The broker sets this if a connection is lost between the dslink and the broker.
• count (optional int)
  • if the response skip some value, this shows how many updates have happened since last response
  • only valid value is counted, if value status is not ok, and count is not specified explicitly, the count this updated is treated as 0\
  • skip value will happen when responder connection is slow, or when change happens on requester fater than the updateInterval
• sum (optional number)
  • the sum value if one or more numeric value is skipped
  • only valid numeric value is added to sum
• max (optional number)
  • the max value if one or more numeric value is skipped
• min (optional number)
  • the min value if one or more numeric value is skipped

Example usage

Request

{
  "rid": 1,
  "method": "subscribe",
  "paths": [
    {"path": "/point1", "sid": 0, "qos": 3},
    {"path": "/point2", "sid": 1},
    {"path": "/point3", "sid": 2} 
  ]
}

Response

{
  "rid": 1,
  "stream": "closed"
}

Update

"rid":0 is reserved for the subscription update and this stream will always be open

{
  "rid": 0,
  "updates": [
    [
      0,
      12,
      "2014-11-27T09:11.000-08:00"
    ],
    {
      "sid": 1,
      "status": "disconnected",
      "ts": "2014-11-27T09:11.000-08:00"
    },
    {
      "sid": 2,
      "value": 10,
      "ts": "2014-11-27T09:11.000-08:00",
      "count": 5,
      "sum": 75,
      "min": 10,
      "max": 20
    }
  ]
}

Unsubscribe

This method will unsubscribe from a datapoint and stop receiving new values on a node.

Request fields

• sids (list)
  • a list of subscription IDs to unsubscribe

Response columns

No response fields sent.

Example usage

Request

{
  "rid": 1,
  "method": "unsubscribe",
  "sids": [0]
}

Response

{
  "rid": 1,
  "stream": "closed"
}

Example Sequence Diagram of Subscribe and Unsubscribe

Close

This method will close a stream

Example usage

Request

{
  "rid": 1,
  "method": "close"
}

Response

If request is closed from requester side, response is not needed