DeviceBuilder

DeviceBuilder Input File

Introduction

The DeviceBuilder Input format is to list all resources that needs to be included in the device that will make up the application. It lists the resources that will be sensor/actuators/etc. that make up the functionality of the device. The input file format supports additional information per resource so that the OCF data model can be changed. The changes that are allowed are limited: the result still needs to be OCF compliant. for example:

removal of optional properties
removal of (post) method
changing of the interface (as required if removal of post)

The property that is being used to find the resource is the rt value. The rt value is being used as lookup towards the IoTDataModels/Core github repos where the resource will be used from.

DeviceBuilder Input File

Where to obtain information about OCF Devices and Resources

In OCF devices are defined by the Device Type. The Device Types can have mandatory resources.

Device Types are defined in the device specification.

But for ease of use (search) the list also can be found as interactive web page.

The list of standardized resources can be found in the Resource Type Specification.

For ease of use (search) the resources can also be found in the interactive web page.

Description of DeviceBuilder Input Format

The DeviceBuilder input file format is an JSON array that define each resource separately. The following properties are defined:

“path” : the path to be used in the implementation
- required
- type string
- must start with “/”
- must be unique over all resources
“rt” : the resource type that needs to be populated
- required
- array of strings
“if” : the interfaces that needs to be supported
- required
- array of strings
- order is maintained, the first listed interface is the default interface.
“remove_properties” : properties that will be removed
- optional
- array of strings
- example: “remove_properties : [“range”, “step” “value”]
“remove_methods” : methods to remove from the implementation[]
- optional
- array of strings
- example: “remove_methods” : [“post”]
“remove_queryparm” : query parameters to remove from the implementation[]
- optional
- array of strings
- example: “remove_methods” : [“units”]
- Note: works for temperature resource
“override_type” : override the type of the property value,
- optional
- string, optional, e.g. can be omitted
- example “override_type” : “integer”
- typical values “integer”, “number” or “string”

The advantage of the file format that it is:

Instructions per resource instance to change the behaviour.
Format may change by adding new fields to introduce new features to the tool.

Optimization

Use short paths names, note the examples are pretty long
- 1 or 2 characters to distinquish the different paths in the application will suffice.
Remove all properties that are not needed in the application.
For unwanted enums, please edit the resource to remove the unwanted enum values
- remove the enum values in the example and the schema

Examples with IoTivity

input-lightdevice.json

This input file describes the minimal light device, implementing only binary switch (on/off).

The input file is here
minimal define resources for oic.d.light:
- resource type : oic.r.switch.binary
```
[
    {
        "path" : "/binaryswitch",
        "rt"   : [ "oic.r.switch.binary" ],
        "if"   : ["oic.if.a", "oic.if.baseline" ],
        "remove_properties" : [ "range", "step" , "id", "precision", "n" ]
    }
]
```
  Note: IoTivity classic needs /oic/p entry, IoTivity Lite does NOT require and /oic/p entry. since IoTivity classic has optional implemented properties in the /oic/p resource.
DeviceBuilder command:
- Invoked from the top level github repo, where the script resides
- Creates output directory outside the github tree.
```
sh DeviceBuilder_IotivityLiteServer.sh ./test/input_DeviceBuilderInputFormat/input-lightdevice.json  ../lightdevice "oic.d.light"
```
actual copy of the generated data available here

input-lightdevice-dimming.json

The light device implementing binary switch (on/off) and the dimming resource.

The input file is here
Resource list for oic.d.light:
- Resource Type : oic.r.switch.binary
- Resource Type : oic.r.light.dimming

DeviceBuilder command

Invoked from the top level github repo, where the script resides

Creates output directory outside the github tree.

sh DeviceBuilder_IotivityLiteServer.sh ./test/input_DeviceBuilderInputFormat/input-lightdevice-dimming.json  ../lightdevice-dimming "oic.d.light"

actual copy of the generated data (old) is here

input-lightdevice-dimming-chroma.json

The light device implementing binary switch (on/off), dimming and colour chroma.

The input file is here
Resource list for oic.d.light
- Resource Type : oic.r.switch.binary
- Resource Type : oic.r.light.dimming
- Resource Type : oic.r.colour.chroma

DeviceBuilder command (IoTivity)

Invoked from the top level github repo, where the script resides