Device


glp/0/{SID}/(rq|fb)/dev/...


The IAP Device resource is a collection of objects in the request and feedback channels. Each set of device objects represents one device and its interface with datapoints, properties, etc.

Device topics are specified with the dev resource type, along with Edge Protocol IDHandle, and Object where appropriate. There are five device objects (cfg, do, if, sts, impl) described in the table below.  Devices almost always have at least one interface block. Most devices have many interface blocks in addition to the five device objects listed here.

An edge server can support devices from different technologies, and therefore each device’s edge protocol ID is included in the IAP topic. Each device also has a unique Handle.  See the description for Edge_Protocol_ID and Handle in the table in the IAP/MQ Topic Syntax.  

Clients subscribing to all device resources, regardless of its protocol, use the + wildcard in place of the edge protocol ID.  For example:  glp/0/{SID}/fb/dev/+/{Handle}/{Object}

Device Objects

There are five device objects:

Object

Topic

Purpose

Configuration

…/cfg/

There are several device configuration objects:

  • name
  • desc
  • loc

Assignment is accepted in the request channel, the complete device configuration object is reported in the feedback channel.

See Device Configuration for a full description of this object.

Do

…/do action

Method invocation for complex and often time-consuming tasks.  Device Do actions include the following:

  • add
  • create
  • deprovision
  • delete
  • join
  • load
  • message
  • provision
  • remove
  • repair
  • replace
  • reset
  • test
  • wink

Action assignment is accepted in the request channel, but action objects are not reflected in the feedback channel.

See Device Do Action for a full description of this object.

Implementation

…/impl

(Optional) Device implementation data, only available in the feedback channel.

See Implementation Detail Object for a full description of this object.

Interface

…/if/...

(Optional)  Reports the device’s interface in blocks of functionality. Interface block objects are published in the feedback channel and can be written to in the request channel. Tools cannot change the interface directly, but can change aspects within the interface (such as a light’s brightness).

See Interface Blocks for a full description of this object.

Status

…/sts

Device status information, available only in the feedback channel.

This includes the current state and other device-specific information, such as its network address in the device protocol.

See Device Status for a full description of this object.