Skip to content

Device Service Component Configuration

The following table describes the configuration variables that can be used with all Device Service components:

Parameter Type Description Valid Values Required
Library String The shared library implementing the Device Service component Y - when dynamic linking is used

N - when static linking is used
Factory String The name of the C function used to instantiate the component Y - when dynamic linking is used

N - when static linking is used
Name String The name of the Device Service Y
Topic String The name of the topic on which to publish scheduled reading events to the Bus N
RequestTopic String The name of the topic on which to receive requests from the Bus N
ReplyTopic String The name of the topic on which to publish request replies to the Bus N
StatusTopic String The name of the topic on which to publish change of operational state events to the Bus N
QueueMax Unsigned Integer The maximum size of the queue for requests Default 1 N
PreloadCache Boolean Specify true to load resource metadata cache with device profiles on initialization

Specify false to cache resource metadata on demand

Provides the optimal response time for the first request for a specified resource at the cost of increased memory use and start-up time
Valid values are as follows:
  • true
  • false (default)
N
Devices Object Provides provisioning data for devices Y
Schedules Array of Objects Scheduled Readings

This can be an empty array if only request processing is required
See "Schedule the Publication of Readings" Y
ProfileDir String The full path of the directory containing the device profiles Y
Profiles String The name of the JSON file that contains the list of device profiles to load

The file list is represented as an array of strings

This JSON file and the entries in the array are relative to the path defined in ProfileDir and have a .json extension

If not present, the profiles.json file in the path defined in ProfileDir is read to provide the profile files to load

A JSON file that matches the name of the JSON file specified in this parameter must be present in the path defined in ProfileDir
Default Profiles N
StateDir String The full path of the directory containing details of the device service state, such as schedules.json and devices.json Y
Driver Object Device Service-specific configuration

See the supported Device Service components for the available options
N
Scheduler String The name of the Scheduler component to use The name of an existing Scheduler component Y
ThreadPool String The name of the ThreadPool component to use The name of an existing ThreadPool component Y
Bus String The name of the Bus component to use The name of an existing Bus component Y
Logger String The name of the Logger component to use The name of an existing Logger component N
Back to top