Lobby

The Lobby object serves as the central entry point into the OBIX server, and lists the URIs for objects supported by the API.

get

Returns the OBIX lobby object.

Application

The real time data from the Sedona application can be accessed from using methods for reading and writing to the components. Each component is identified by a path which is used in the uri to specifiy the component to access and has 1 or more slots which contain the data to read/write to. Some components contain actions which can be called from the API.

get

Returns the Sedona component slots, actions and children.

A Component slot is where real time values are stored inside the application. Each slot within a component has a unique name and it can be written to if it is defined as writable.

The value is returned as a JSON object in the following format.

{
  "<type>": {
    "name": "slotName",
    "display": "slotName",
    "href": "http://SERVER_NAME/obixj/path/slotName/",
    "is": "typeName",
    "writable": "true",
    "val": "50"
  }
}

Where thetag defines the data type and it can be one of the following values.

  • bool: boolean value
  • byte: unsigned 8-bit integer (as field or array only)
  • short: unsigned 16-bit integer (as field or array only)
  • int: signed 32-bit integer
  • long: signed 64-bit integer
  • real: 32-bit floating point
  • double: 64-bit floating point
  • str: string of ASCII characters terminated by 0 (like C string)
get

Reads the value of a component's slot.

put

Writes a value to a component's slot.

A Component action slot is used to invoke a method within the application. For example "save" and "restart" are actions of the "app" component. Some actions require a value to be send in the body of the action.

get

Returns the component's action.

post

Calls a component's slot action.

Histories

Sedona Histories are stored within a database on the device. The history methods can be used to return time stamped data.

get

Returns a list of history databases with the application.

get

Returns a list of histories with the database.

get

Returns a list of histories with the database.

get

Returns a list of values for that fall with the requested query parameters.

Alarms

Sedona Alarms are stored within a database on the device. The alarm methods can be used to return the alarms. The Alarm feed object is used inconjuction with the OBIX watch to return new alarms as they occur.

get

Returns a list of alarm databases.

get

Returns a list of alarm databases.

get

Returns a list of active alarms that fall with the requested query parameters.

The alarm feed is used in conjuction with the watch to subscribe for alarms. To subscribe for alarms, post an add request to the API with the following body.

  POST http://localhost:8080/obixj/watchService/watch0/add
  BODY
  {
    "obj": {
      "list": {
        "uri": [
          { "val": "/obixj/alarms/~alarmFeed/" }
        ]
      }
    }
  }

  RESULTS BODY
  {
    "obj": {
      "is": "obix:WatchOut",
      "list": [
      {
        "name": "values",
        "of": "obix:obj",
        "feed": [
        {
          "name": "feed",
          "href": "/obixj/alarms/~alarmFeed/",
          "of": "obix:Alarm",
          "in": "obix:AlarmFilter"
        }  ]
      }  ]
    }
  }

After adding the feed to the watch, call pollChanges to receive any new alarms as they occur.

get

Returns the alarm feed object. Used inconjuction with watch to return alarms.

Watch

The OBIX Watch is used to return COV's and Alarm from the application. The following methods are required to be called to receive COV's from the OBIX watch.

  • Call make to create a new watch.
  • Add the alarm feed to the watch.
  • Add a component slot to the watch for every variable to be monitored.
  • Periodically call pollChanges to receive an event when the point changes value or a new alarm occurs.

The watch will be removed 10 seconds (adjustable) after the last pollChanges request was made.

get

Returns a list of OBIX watch objects.

get

Returns the make object.

post

Makes a new OBIX watch.

get

Returns the watch object

Real time values stored in component slots can be subscribed to by adding the slot path to the watch. Alarms can also be subscribed by adding the path to the alarmsFeed to the watch.

get

Returns the add object.

post

Adds an item to the watch.

get

Returns the remove object.

post

Removes an item from the watch.

Calling the pollChanges method will return any values that have change since the last pollChanges was called. If the alarm feed has been added then any alarm generated after the last pollChanges was called will be returned.

get

Returns the pollChanges object.

post

Polls the watch for any changed items..

get

Returns the pollRefresh object.

post

Returns a null object.

get

Returns the delete object.

post

Deletes the watch.

get

Returns the lease time as a reltime object. The default value is 10 seconds, the watch will be removed 10 seconds after the last pollChanges request is made

put

Sets the lease time for the object watch.